Public Member Functions | List of all members

Iterator for vectors. More...

#include <seqveciter.h>

Inheritance diagram for SeqVecIter:
Inheritance graph
[legend]

Public Member Functions

 SeqVecIter (const STD_string &object_label="unnamedSeqVecIter", unsigned int start=0)
 
 SeqVecIter (const SeqVecIter &svi)
 
SeqVecIteroperator= (const SeqVecIter &svi)
 
STD_string get_program (programContext &context) const
 
double get_duration () const
 
unsigned int event (eventContext &context) const
 
STD_string get_properties () const
 
void query (queryContext &context) const
 
RecoValList get_recovallist (unsigned int reptimes, LDRkSpaceCoords &coords) const
 
- Public Member Functions inherited from SeqCounter
 SeqCounter (const STD_string &object_label="unnamedSeqCounter")
 
 SeqCounter (const SeqCounter &sc)
 
SeqCounteroperator= (const SeqCounter &sc)
 
virtual int get_times () const
 
virtual void add_vector (const SeqVector &seqvector)
 
- Public Member Functions inherited from SeqTreeObj
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)
 

Additional Inherited Members

- Protected Member Functions inherited from SeqCounter
void clear_container ()
 
- Protected Member Functions inherited from SeqClass
void marshall_error () const
 
- Static Protected Member Functions inherited from SeqClass
static void clear_temporary ()
 
static void clear_containers ()
 

Detailed Description

Iterator for vectors.

Iterator to step manually through vectors. Each occurence of this iterator in the sequence tree will increment actual value of the vector by one. If the end of the vector is reached, iteration starts again at the beginning, i.e. the iteration is cyclical. Use add_vector() to append vectors which should be controlled by this iterator.

Definition at line 42 of file seqveciter.h.

Constructor & Destructor Documentation

§ SeqVecIter() [1/2]

SeqVecIter::SeqVecIter ( const STD_string &  object_label = "unnamedSeqVecIter",
unsigned int  start = 0 
)

Construct an empty iterator with the given label. Iteration will start at index 'start'.

§ SeqVecIter() [2/2]

SeqVecIter::SeqVecIter ( const SeqVecIter svi)

Copy constructor

Member Function Documentation

§ event()

unsigned int SeqVecIter::event ( eventContext context) const
virtual

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

Reimplemented from SeqTreeObj.

§ get_duration()

double SeqVecIter::get_duration ( ) const
virtual

Returns the duration of the sequence object.

Implements SeqTreeObj.

§ get_program()

STD_string SeqVecIter::get_program ( programContext context) const
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 from SeqTreeObj.

§ get_properties()

STD_string SeqVecIter::get_properties ( ) const
virtual

Returns a string describing the object

Reimplemented from SeqTreeObj.

§ get_recovallist()

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

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

Reimplemented from SeqTreeObj.

§ operator=()

SeqVecIter& SeqVecIter::operator= ( const SeqVecIter svi)

Assignment operator

§ query()

void SeqVecIter::query ( queryContext context) const
virtual

Query the sequence tree recursively

Reimplemented from SeqTreeObj.


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