SeqSimultanVector Class Reference
[Internal Classes for sequence design (odinseq library)]
#include <seqsimvec.h>
Public Member Functions | |
| SeqSimultanVector (const STD_string &object_label="unnamedSeqSimultanVector") | |
| SeqSimultanVector (const SeqSimultanVector &ssv) | |
| SeqSimultanVector & | operator= (const SeqSimultanVector &ssv) |
| SeqSimultanVector & | operator+= (const SeqVector &sv) |
| SeqSimultanVector & | clear () |
| svector | get_vector_commands (const STD_string &iterator) const |
| unsigned int | get_vectorsize () const |
| unsigned int | get_numof_iterations () const |
| STD_string | get_loopcommand () const |
| nestingRelation | get_nesting_relation () const |
| bool | needs_unrolling_check () const |
| bool | prep_iteration () const |
| bool | is_qualvector () const |
Detailed Description
This vector class is used to group other vector objects together so that they can be updated simultaneously at each iteration.Definition at line 28 of file seqsimvec.h.
Constructor & Destructor Documentation
| SeqSimultanVector::SeqSimultanVector | ( | const STD_string & | object_label = "unnamedSeqSimultanVector" |
) | [inline] |
Construct an empty vector of sequence objects with the given label
Definition at line 35 of file seqsimvec.h.
| SeqSimultanVector::SeqSimultanVector | ( | const SeqSimultanVector & | ssv | ) |
Constructs a copy of 'ssv'
Member Function Documentation
| SeqSimultanVector& SeqSimultanVector::operator= | ( | const SeqSimultanVector & | ssv | ) |
Assignment operator that makes this vector object become a copy of 'ssv'
| SeqSimultanVector& SeqSimultanVector::operator+= | ( | const SeqVector & | sv | ) |
Appends sv to the list of managed vectors
| SeqSimultanVector& SeqSimultanVector::clear | ( | ) | [inline] |
clears the list of managed vectors
Reimplemented from List< I, P, R >.
Definition at line 56 of file seqsimvec.h.
| svector SeqSimultanVector::get_vector_commands | ( | const STD_string & | iterator | ) | const [virtual] |
If the vector is used as a variable in the code-generated pulse program, overload this function to return a unique label/command for the vector which is either attached to the loop (Bruker), or executed at the beginning of the loop (EPIC).
Reimplemented from SeqVector.
| unsigned int SeqSimultanVector::get_vectorsize | ( | ) | const [virtual] |
Overload this function to return the number of elements in the vector (regardless of reordering)
Reimplemented from SeqVector.
| unsigned int SeqSimultanVector::get_numof_iterations | ( | ) | const [virtual] |
Returns the number of iterations with proper consideration of reordering, e.g. if the vector has N values distributed over M reordering segments, this function will return N/M.
Reimplemented from SeqVector.
| STD_string SeqSimultanVector::get_loopcommand | ( | ) | const [virtual] |
Overload this function to return the command to iterate to the next item at the end of the loop
Reimplemented from SeqVector.
| nestingRelation SeqSimultanVector::get_nesting_relation | ( | ) | const [virtual] |
Returns the nesting relation between the vector and its reordering vector
Reimplemented from SeqVector.
| bool SeqSimultanVector::needs_unrolling_check | ( | ) | const [virtual] |
Overload this function to trigger a check whether the loop must possibly be unrolled in pulse or gradient program
Reimplemented from SeqVector.
| bool SeqSimultanVector::prep_iteration | ( | ) | const [virtual] |
Overload this function to prepare objects at run-time before the execution of a loop repetition return 'false' when preparation fails
Reimplemented from SeqVector.
| bool SeqSimultanVector::is_qualvector | ( | ) | const [virtual] |
Overload this function to tell whether the vector qualitatively alters the sequence concerning timings and RF power deposition. This is useful for accelerating duration and SAR calculations (Siemens).
Reimplemented from SeqVector.
Reimplemented in SeqDiffWeight, and SeqDiffWeightFlowComp.
The documentation for this class was generated from the following file:
