JEMRIS  2.8.1
open-source MRI simulations
List of all members | Public Member Functions | Protected Attributes | Private Attributes
Sequence Class Referenceabstract

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")
 
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. More...
 
virtual ~Module ()
 Destructor. More...
 
 Module (const Module &)
 Copy constructor. More...
 
virtual ModuleClone () const =0
 Clone a module. More...
 
void Initialize (DOMNode *node)
 Initialize this module. More...
 
ModuleGetParent ()
 Get Parent. More...
 
virtual double GetDuration ()=0
 
virtual int GetNumOfTPOIs ()
 Get the Number of TPOIs of this module. More...
 
vector< Module * > GetChildren () const
 Get Children. More...
 
ModuleGetChild (unsigned int position) const
 Get Child. More...
 
int GetNumberOfChildren () const
 Get number of Children. More...
 
bool InsertChild (const string &name)
 Insert Child. More...
 
virtual ModuleGetPrototypeByAttributeValue (string name, string attrib)
 Get a Prototype by value of an attribute. More...
 
bool AddDOMattribute (const string attribute, const string value)
 Add attribute and value to the DOM node of this module. More...
 
void AddAllDOMattributes (bool show_hidden=true)
 
virtual TPOIGetTPOIs ()
 get the TPOIs of this module More...
 
void DumpTree (const string &file="", Module *mod=NULL, int ichild=0, int level=0)
 Dump the sequence tree. More...
 
int GetDepth (int depth=0)
 Return tree depth from this module (including depth of Containers) More...
 
int GetHardwareMode ()
 Return the hardware mode of this module. More...
 
bool WriteStaticXML (const string &xml_file)
 Rewrite XML-tree where all expressions are evaluated (for IDEA) More...
 
bool StaticDOM (DOMDocument *doc, DOMNode *node, bool append=true)
 Create a DOM tree where all expressions are evaluated (for IDEA) More...
 
void SetSeqTree (SequenceTree *pST)
 
SequenceTreeGetSeqTree ()
 
- Public Member Functions inherited from Prototype
 Prototype ()
 Constructor. More...
 
virtual ~Prototype ()
 Default destructor. More...
 
 Prototype (const Prototype &)
 Default copy constructor. More...
 
bool IsPrepared ()
 Check if the Prototype is prepared. More...
 
void SetName (string name)
 Set the name of this module. More...
 
DOMNode * GetNode ()
 Get the DOMNode of this module. More...
 
void SetNode (DOMNode *node)
 Set the DOMNode of this module. More...
 
string GetClassType ()
 Get the class type of this prototype. More...
 
Type GetType ()
 Get the module type of this module. More...
 
string GetDOMattribute (const string attribute)
 Get attribute value from the DOMNode. More...
 
bool HasDOMattribute (const string attribute)
 Check, if attribute exists in DOM node of this module. More...
 
AttributeGetAttribute (string name)
 Get an Attribute. More...
 
void CopyObservers (Attribute *a1, Attribute *a2)
 Copy observers from one attribute to another. More...
 
bool HasAttribute (string name)
 Check if an attribute exist. More...
 
void HideAttribute (string attrib, bool observable=true)
 Hide an attribute. More...
 
string GetName ()
 Get the name of this module. More...
 
bool Observe (Attribute *attrib, string prot_name, string attrib_name, bool verbose)
 Set up the list of observations. More...
 
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. More...
 
template<typename T >
bool NewState (const T &val)
 Check the state of an attribute. More...
 
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. More...
 

Protected Attributes

vector< string > m_prep_errors
 Preparation Error Messages of Modules.
 
- Protected Attributes inherited from Module
SequenceTreem_seq_tree
 Reference to the sequence tree.
 
Parametersm_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. More...
 
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. More...
 
- Protected Member Functions inherited from Module
virtual string GetInfo ()
 Get informations on this module. More...
 

Detailed Description

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

Member Function Documentation

virtual long Sequence::GetNumOfADCs ( )
pure virtual

Get the number of ADCs for this sequence.

Returns
The number of ADCs.

Implemented in AtomicSequence, ConcatSequence, and Container.

+ Here is the caller graph for this function:

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

See Module::GetValue

Reimplemented from Module.

Reimplemented in AtomicSequence, DelayAtomicSequence, Container, and ConcatSequence.

+ Here is the call graph for this function:

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

Sequence output

Parameters
fnameoutput filename

+ Here is the call graph for this function:

+ Here is the caller graph for this function:

bool Sequence::Prepare ( const PrepareMode  mode)
virtual

Prepare the sequence.

Parameters
modeSets the preparation mode, one of enum PrepareMode {PREP_INIT,PREP_VERBOSE,PREP_UPDATE}.
Returns
Success

Reimplemented from Module.

Reimplemented in DelayAtomicSequence, Container, ContainerSequence, AtomicSequence, and ConcatSequence.

+ Here is the call graph for this function:

+ Here is the caller graph for this function:

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

Sequence Diag

Parameters
fnameFile name

Two extra: time, receiver phase

Extra axis for META

+ 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:

-- last change 17.06.2016 | Tony Stoecker | Imprint --