Super class for all sequence (non-pulse) modules. More...

#include <Sequence.h>

Inheritance diagram for Sequence:

Collaboration diagram for Sequence:

Public Member Functions
	Sequence ()
	Default constructor.

virtual	~Sequence ()
	Default destructor.

	Sequence (const Sequence &)
	Default copy constructor.

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

virtual bool	Prepare (const PrepareMode mode)

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

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

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

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

virtual void	CollectSeqData (OutputSequenceData *seqdata)=0
	Recursively collect sequence data (for running on the scanner)

virtual long	GetNumOfADCs ()=0

Public Member Functions inherited from Module
	Module ()
	Constructor.

virtual	~Module ()
	Destructor.

	Module (const Module &)
	Copy constructor.

virtual Module *	Clone () const =0
	Clone a module.

void	Initialize (DOMNode *node)
	Initialize this module.

Module *	GetParent ()
	Get Parent.

virtual double	GetDuration ()=0

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 Attributes
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.

Private Attributes
double	m_aux1
	auxiliary general purpose variable for convinience

double	m_aux2
	auxiliary general purpose variable for convinience

double	m_aux3
	auxiliary general purpose variable for convinience

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 Member Functions inherited from Module
virtual string	GetInfo ()
	Get informations on this module.