SeqTreeObj Class Reference
[Internal Classes for sequence design (odinseq library)]
#include <seqtree.h>
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, JDXkSpaceCoords &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 |
Protected Member Functions | |
| virtual void | query (queryContext &context) const |
Friends | |
| class | SeqObjList |
| class | SeqObjVector |
| class | SeqParallel |
Detailed Description
This is the base class for all objects that can be part of the sequence treeDefinition at line 191 of file seqtree.h.
Member Function Documentation
| virtual double SeqTreeObj::get_duration | ( | ) | const [pure virtual] |
Returns the duration of the sequence object.
Implemented in SeqAcq, SeqAcqEPI, SeqDecoupling, SeqDelayVector, SeqDur, SeqGradChanList, SeqGradObjInterface, SeqObjList, SeqObjLoop, SeqObjVector, SeqParallel, SeqPuls, SeqTrigger, SeqHalt, SeqSnapshot, and SeqVecIter.
| virtual STD_string SeqTreeObj::get_program | ( | programContext & | context | ) | const [inline, virtual] |
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 SeqAcq, SeqAcqEPI, SeqDecoupling, SeqDelay, SeqDelayVector, SeqGradChanParallel, SeqObjList, SeqObjLoop, SeqObjVector, SeqParallel, SeqPuls, SeqTrigger, SeqHalt, and SeqVecIter.
| virtual STD_string SeqTreeObj::get_properties | ( | ) | const [inline, virtual] |
Returns a string describing the object
Reimplemented in SeqAcq, SeqAcqEPI, SeqGradChan, SeqGradChanList, SeqGradChanParallel, SeqObjList, SeqObjLoop, SeqParallel, SeqPuls, SeqPulsar, and SeqVecIter.
| virtual unsigned int SeqTreeObj::event | ( | eventContext & | context | ) | const [inline, virtual] |
Queries the sequence tree for events, returns the number of events executed
Reimplemented in SeqAcq, SeqAcqEPI, SeqDecoupling, SeqGradChan, SeqGradChanList, SeqGradChanParallel, SeqObjList, SeqObjLoop, SeqMethod, SeqObjVector, SeqParallel, SeqPuls, SeqTrigger, SeqHalt, SeqSnapshot, and SeqVecIter.
| virtual RecoValList SeqTreeObj::get_recovallist | ( | unsigned int | reptimes, | |
| JDXkSpaceCoords & | coords | |||
| ) | const [inline, virtual] |
Appends the k-space coordinates in this branch of the sequence tree to 'coords' and returns their ordering
Reimplemented in SeqAcq, SeqAcqEPI, SeqObjList, SeqObjLoop, SeqObjVector, and SeqParallel.
| bool SeqTreeObj::contains | ( | const SeqTreeObj * | sto | ) | const |
Returns true if 'sto' can be found in the objects branch of the sequence tree
Reimplemented in SeqAcqEPI.
| void SeqTreeObj::tree | ( | SeqTreeCallbackAbstract * | display | ) | const |
Generates a graphical representation of the sequence tree using 'display'
Reimplemented in SeqAcqEPI.
| virtual SeqValList SeqTreeObj::get_freqvallist | ( | freqlistAction | action | ) | const [inline, virtual] |
Returns the list of frequency values in the objects branch of the sequence tree
Reimplemented in SeqAcqEPI, SeqObjList, SeqObjLoop, SeqObjVector, and SeqParallel.
| virtual SeqValList SeqTreeObj::get_delayvallist | ( | ) | const [inline, virtual] |
Returns the list of delay values in the objects branch of the sequence tree
Reimplemented in SeqDelayVector, SeqObjList, SeqObjLoop, SeqObjVector, and SeqParallel.
| virtual double SeqTreeObj::get_rf_energy | ( | ) | const [inline, virtual] |
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 SeqObjList, SeqObjLoop, SeqObjVector, SeqParallel, and SeqPuls.
| virtual void SeqTreeObj::query | ( | queryContext & | context | ) | const [protected, virtual] |
Query the sequence tree recursively
Reimplemented in SeqAcq, SeqAcqEPI, SeqGradChanList, SeqGradChanParallel, SeqObjList, SeqObjLoop, SeqObjVector, and SeqParallel.
The documentation for this class was generated from the following file:
