#include <DelayAtomicSequence.h>

Inheritance diagram for DelayAtomicSequence:

Collaboration diagram for DelayAtomicSequence:

Public Member Functions
	DelayAtomicSequence ()
	Default constructor.

	DelayAtomicSequence (const DelayAtomicSequence &)
	Copy constructor.

	~DelayAtomicSequence ()
	Default destructor.

DelayAtomicSequence *	Clone () const

virtual bool	Prepare (const PrepareMode mode)
	Prepare the delay atomic sequence.

virtual void	GetValue (double *dAllVal, double const time)

bool	PrepareDelay (const PrepareMode mode)
	Prepare the delay atomic sequence.

virtual void	CollectSeqData (OutputSequenceData *seqdata)
	Collect sequence data (for running on the scanner)

Public Member Functions inherited from AtomicSequence
	AtomicSequence ()
	Default constructor.

	AtomicSequence (const AtomicSequence &)
	Copy constructor.

virtual	~AtomicSequence ()
	Default destructor.

Pulse *	GetPulse (int number)
	Get the pulse given by number.

int	GetNumberOfPulses ()
	Get the number of nested pulses.

double	GetDuration ()

void	Rotation (double *Grot)
	See Module::GetValue.

bool	HasNonLinGrad ()
	Check for nonlinear gradients in this atom.

void	SetNonLinGrad (bool val)
	Marh this atom, if nonlinear gradients are present.

void	CollectTPOIs ()
	Collect the TPOIs of child pulses.

virtual void	CollectSeqData (NDData< double > &seqdata, double &t, long &offset)
	Collect sequence data (for plotting the sequence diagram)

virtual long	GetNumOfADCs ()
	Get Number of ADCs in this atom.

void	GetValueLingeringEddyCurrents (double *dAllVal, double const time)
	GetValue of lingering eddy currents.

void	UpdateEddyCurrents ()
	update eddy currents in case generating gradient waveform has changed

void	PrepareEddyCurrents ()
	prepare lingering eddy currents in this atom for GetValue in next atom

bool	HasEddyCurrents ()
	true, if this atom contains eddy currents

void	SetEddyCurrents (bool val)
	true, if this atom contains eddy currents

Public Member Functions inherited from Sequence
	Sequence ()
	Default constructor.

virtual	~Sequence ()
	Default destructor.

	Sequence (const Sequence &)
	Default copy constructor.

void	SeqDiag (const string &fname="seq.h5")

bool	SeqISMRMRD (const string &fname="seq.h5")

void	OutputSeqData (map< string, string > &scanDefinitions, const string &outputDir="", const string &outFile="external.seq")

Public Member Functions inherited from Module
	Module ()
	Constructor.

virtual	~Module ()
	Destructor.

	Module (const Module &)
	Copy constructor.

void	Initialize (DOMNode *node)
	Initialize this module.

Module *	GetParent ()
	Get Parent.

virtual int	GetNumOfTPOIs ()
	Get the Number of TPOIs of this module.

vector< Module * >	GetChildren () const
	Get Children.

vector< Module * >	GetChildrenDynamic () const
	Get Children dynamic (old non-cached version for dynamic events such as eddy currents)

Module *	GetChild (unsigned int position) const
	Get Child.

int	GetNumberOfChildren () const
	Get number of Children.

bool	InsertChild (const string &name)
	Insert Child.

virtual Module *	GetPrototypeByAttributeValue (string name, string attrib)
	Get a Prototype by value of an attribute.

bool	AddDOMattribute (const string attribute, const string value)
	Add attribute and value to the DOM node of this module.

void	AddAllDOMattributes (bool show_hidden=true)

virtual TPOI *	GetTPOIs ()
	get the TPOIs of this module

void	DumpTree (const string &file="", Module *mod=NULL, int ichild=0, int level=0)
	Dump the sequence tree.

int	GetDepth (int depth=0)
	Return tree depth from this module (including depth of Containers)

int	GetHardwareMode ()
	Return the hardware mode of this module.

bool	WriteStaticXML (const string &xml_file)
	Rewrite XML-tree where all expressions are evaluated (for IDEA)

bool	StaticDOM (DOMDocument doc, DOMNode node, bool append=true)
	Create a DOM tree where all expressions are evaluated (for IDEA)

void	SetSeqTree (SequenceTree *pST)

SequenceTree *	GetSeqTree ()

Public Member Functions inherited from Prototype
	Prototype ()
	Constructor.

virtual	~Prototype ()
	Default destructor.

	Prototype (const Prototype &)
	Default copy constructor.

bool	IsPrepared ()
	Check if the Prototype is prepared.

void	SetName (string name)
	Set the name of this module.

DOMNode *	GetNode ()
	Get the DOMNode of this module.

void	SetNode (DOMNode *node)
	Set the DOMNode of this module.

string	GetClassType ()
	Get the class type of this prototype.

Type	GetType ()
	Get the module type of this module.

string	GetDOMattribute (const string attribute)
	Get attribute value from the DOMNode.

bool	HasDOMattribute (const string attribute)
	Check, if attribute exists in DOM node of this module.

Attribute *	GetAttribute (string name)
	Get an Attribute.

void	CopyObservers (Attribute a1, Attribute a2)
	Copy observers from one attribute to another.

bool	HasAttribute (string name)
	Check if an attribute exist.

void	HideAttribute (string attrib, bool observable=true)
	Hide an attribute.

string	GetName ()
	Get the name of this module.

bool	Observe (Attribute *attrib, string prot_name, string attrib_name, bool verbose)
	Set up the list of observations.

bool	Observe (Attribute *attrib, string prot_name, string attrib_name, string attrib_keyword, bool verbose)

template<typename T >
bool	Notify (const T &val)
	Notify all observers of an attribute.

template<typename T >
bool	NewState (const T &val)
	Check the state of an attribute.

vector< double > *	GetVector ()
	Each Prototype has a double vector as a private member, which values can be filled through XML and accessed from attributes within the same Prototype.

Protected Member Functions
virtual string	GetInfo ()
	Get information on this module.

double	GetDelay ()
	Get delay length.

Private Attributes
string	m_start
	Name of the sequence after which the delay shall starts.

string	m_stop
	Name of the sequence from after which the delay shall starts.

string	m_delay_type
	Type of this delay.

double	m_await_time
	Rest time. Real length of Delay in ms. Is calculated during runtime.

double	m_delay_time
	Declared length of Delay.

int	m_iMYpos

int	m_iS1pos

int	m_iS2pos

vector< Sequence * >	m_seqs
	Durations of other modules which have to be observed

DelayType	m_dt
	Type of this delay.

int	m_adc
	Number of ADCs

int	m_adc_flag
	ADC flag

bool	m_phase_lock
	Lock phase of ADCs to the phase of the last RF pulse event

Additional Inherited Members
Static Public Member Functions inherited from Prototype
static bool	ReplaceString (string &str, const string &s1, const string &s2)
	A global sub-string replacer.

static bool	ReplaceSymbolString (string &str, const string &s1, const string &s2)
	A global sub-string replacer which replaces only complete symbol strings.

static vector< string >	Tokenize (const string &str, const string &delimiters=",")
	A global string tokenizer.

Protected Attributes inherited from Sequence
vector< string >	m_prep_errors
	Preparation Error Messages of Modules.

Protected Attributes inherited from Module
SequenceTree *	m_seq_tree
	Reference to the sequence tree.

Parameters *	m_parameters
	Pointer to the sole instance of the Parameters.

TPOI	m_tpoi
	Time points of interest are stored the referred repository.

string	m_info
	Information string for this module.

double	m_duration
	The duration of this module.

int	m_calls
	Number of calls of this module.

int	m_hardware_mode
	Hardware mode (-1: simulation only; 0: both; 1: hardware only)

Protected Attributes inherited from Prototype
bool	m_aux
	auxiliary helper variable for debugging purposes

bool	m_prepared
	True, after the first call to Prepare.

string	m_name
	Name of this Prototype.

DOMNode *	m_node
	The node configuring this Module.

Type	m_type
	The type of the module: one of MOD_PULSE, MOD_ATOM, MOD_CONCAT.

vector< double >	m_vector
	A vector which elements are accessible through loop counters.

map< string, Attribute * >	m_attributes
	Map to connect a keyword with an Attribute.

vector< Attribute * >	m_obs_attribs
	Vector of observed Attributes.

vector< string >	m_obs_attrib_keyword
	Vector of user-defined Attribute names.

Detailed Description

Prototype of a delay.

Member Function Documentation

◆ Clone()

DelayAtomicSequence * DelayAtomicSequence::Clone ( ) const

inlinevirtual

See Module::clone

Reimplemented from AtomicSequence.

Here is the call graph for this function:

◆ CollectSeqData()

void DelayAtomicSequence::CollectSeqData ( OutputSequenceData * seqdata )

virtual

Collect sequence data (for running on the scanner)

Reimplemented from AtomicSequence.

Here is the call graph for this function:

◆ GetDelay()

double DelayAtomicSequence::GetDelay ( )

protected

Get delay length.

Returns: delay in ms

Here is the call graph for this function:

Here is the caller graph for this function:

◆ GetInfo()

string DelayAtomicSequence::GetInfo ( )

protectedvirtual

Get information on this module.

Returns: Information for display.

Reimplemented from AtomicSequence.

◆ GetValue()

virtual void DelayAtomicSequence::GetValue	(	double *	dAllVal,
		double const	time )

inlinevirtual

See Module::GetValue()

Reimplemented from AtomicSequence.

◆ Prepare()

bool DelayAtomicSequence::Prepare ( const PrepareMode mode )

virtual

Prepare the delay atomic sequence.

Parameters

mode	Sets the preparation mode, one of enum PrepareMode {PREP_INIT,PREP_VERBOSE,PREP_UPDATE}.

Returns: Success.

Reimplemented from AtomicSequence.

Here is the call graph for this function:

◆ PrepareDelay()

bool DelayAtomicSequence::PrepareDelay ( const PrepareMode mode )

Prepare the delay atomic sequence.

Search start and stop sequences and their positions on this level of the tree
Observe timing of modules between start and stop

Parameters

mode	Sets the preparation mode, one of enum PrepareMode {PREP_INIT,PREP_VERBOSE,PREP_UPDATE}.

Returns: Success

Here is the call graph for this function:

Here is the caller graph for this function:

The documentation for this class was generated from the following files:

/Users/stoeckert/DZNE/workspace/jemris/src/DelayAtomicSequence.h
/Users/stoeckert/DZNE/workspace/jemris/src/DelayAtomicSequence.cpp

Public Member Functions

Protected Member Functions

Private Attributes

Additional Inherited Members

Detailed Description

Member Function Documentation

◆ Clone()

◆ CollectSeqData()

◆ GetDelay()

◆ GetInfo()

◆ GetValue()

◆ Prepare()

◆ PrepareDelay()