Public Member Functions | Protected Member Functions | Friends | List of all members

#include <seqtree.h>

Inheritance diagram for SeqTreeObj:
Inheritance graph
[legend]

Public Member Functions

virtual double get_duration () const =0
 
virtual STD_string get_program (programContext &context) const
 
virtual STD_string get_properties () const
 
virtual unsigned int event (eventContext &context) const
 
virtual RecoValList get_recovallist (unsigned int reptimes, LDRkSpaceCoords &coords) const
 
bool contains (const SeqTreeObj *sto) const
 
void tree (SeqTreeCallbackAbstract *display) const
 
virtual SeqValList get_freqvallist (freqlistAction action) const
 
virtual SeqValList get_delayvallist () const
 
virtual double get_rf_energy () const
 
- Public Member Functions inherited from SeqClass
SeqClassset_temporary ()
 
- Public Member Functions inherited from Labeled
 Labeled (const STD_string &label="unnamed")
 
Labeledset_label (const STD_string &label)
 
const STD_string & get_label () const
 
Labeledoperator= (const Labeled &l)
 

Protected Member Functions

virtual void query (queryContext &context) const
 
- Protected Member Functions inherited from SeqClass
void marshall_error () const
 
virtual void clear_container ()
 
virtual bool prep ()
 

Friends

class SeqObjList
 
class SeqObjVector
 
class SeqParallel
 

Additional Inherited Members

- Static Protected Member Functions inherited from SeqClass
static void clear_temporary ()
 
static void clear_containers ()
 

Detailed Description

This is the base class for all objects that can be part of the sequence tree

Definition at line 202 of file seqtree.h.

Member Function Documentation

§ contains()

bool SeqTreeObj::contains ( const SeqTreeObj sto) const

Returns true if 'sto' can be found in the objects branch of the sequence tree

§ event()

virtual unsigned int SeqTreeObj::event ( eventContext context) const
inlinevirtual

Queries the sequence tree for events, returns the number of events executed

Reimplemented in SeqPuls, SeqMethod, SeqAcq, SeqAcqEPI, SeqMagnReset, SeqSnapshot, SeqObjList, SeqDecoupling, SeqGradChan, SeqHalt, SeqParallel, SeqObjLoop, SeqTrigger, SeqGradChanParallel, SeqObjVector, SeqVecIter, and SeqGradChanList.

Definition at line 227 of file seqtree.h.

§ get_delayvallist()

virtual SeqValList SeqTreeObj::get_delayvallist ( ) const
inlinevirtual

Returns the list of delay values in the objects branch of the sequence tree

Reimplemented in SeqObjList, SeqParallel, SeqObjLoop, SeqDelayVector, and SeqObjVector.

Definition at line 258 of file seqtree.h.

§ get_duration()

virtual double SeqTreeObj::get_duration ( ) const
pure virtual

§ get_freqvallist()

virtual SeqValList SeqTreeObj::get_freqvallist ( freqlistAction  action) const
inlinevirtual

Returns the list of frequency values in the objects branch of the sequence tree

Reimplemented in SeqPuls, SeqAcq, SeqAcqEPI, SeqObjList, SeqDecoupling, SeqParallel, SeqObjLoop, and SeqObjVector.

Definition at line 253 of file seqtree.h.

§ get_program()

virtual STD_string SeqTreeObj::get_program ( programContext context) const
inlinevirtual

Returns the part in the pulse/gradient program of this sequence object. 'context' holds data about how the program should be generated, e.g. type of program and formatting.

Reimplemented in SeqPuls, SeqAcq, SeqAcqEPI, SeqObjList, SeqDecoupling, SeqHalt, SeqParallel, SeqObjLoop, SeqDelayVector, SeqTrigger, SeqGradChanParallel, SeqDelay, SeqObjVector, and SeqVecIter.

Definition at line 216 of file seqtree.h.

§ get_properties()

virtual STD_string SeqTreeObj::get_properties ( ) const
inlinevirtual

Returns a string describing the object

Reimplemented in SeqPuls, SeqAcq, SeqAcqEPI, SeqObjList, SeqGradChan, SeqObjLoop, SeqParallel, SeqPulsar, SeqGradChanParallel, SeqVecIter, and SeqGradChanList.

Definition at line 221 of file seqtree.h.

§ get_recovallist()

virtual RecoValList SeqTreeObj::get_recovallist ( unsigned int  reptimes,
LDRkSpaceCoords coords 
) const
inlinevirtual

Appends the k-space coordinates in this branch of the sequence tree to 'coords' and returns their ordering

Reimplemented in SeqAcq, SeqAcqEPI, SeqObjList, SeqParallel, SeqObjLoop, SeqObjVector, and SeqVecIter.

Definition at line 238 of file seqtree.h.

§ get_rf_energy()

virtual double SeqTreeObj::get_rf_energy ( ) const
inlinevirtual

Returns the RF power deposition in the objects branch of the sequence tree. The physical unit is unspecified, it depends on the current platform.

Reimplemented in SeqPuls, SeqObjList, SeqParallel, SeqObjLoop, and SeqObjVector.

Definition at line 264 of file seqtree.h.

§ query()

virtual void SeqTreeObj::query ( queryContext context) const
protectedvirtual

Query the sequence tree recursively

Reimplemented in SeqAcq, SeqAcqEPI, SeqObjList, SeqParallel, SeqObjLoop, SeqGradChanParallel, SeqObjVector, SeqVecIter, and SeqGradChanList.

§ tree()

void SeqTreeObj::tree ( SeqTreeCallbackAbstract display) const

Generates a graphical representation of the sequence tree using 'display'


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