SeqVecIter Class Reference
[Classes for sequence design (odinseq library)]

Iterator for vectors. More...

#include <seqveciter.h>

Inheritance diagram for SeqVecIter:

Inheritance graph
[legend]
Collaboration diagram for SeqVecIter:

Collaboration graph
[legend]
List of all members.

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

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::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::SeqVecIter ( const SeqVecIter svi  ) 

Copy constructor


Member Function Documentation

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

Assignment operator

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.

double SeqVecIter::get_duration (  )  const [virtual]

Returns the duration of the sequence object.

Implements SeqTreeObj.

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

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

Reimplemented from SeqTreeObj.

STD_string SeqVecIter::get_properties (  )  const [virtual]

Returns a string describing the object

Reimplemented from SeqTreeObj.


The documentation for this class was generated from the following file:
Generated on Sat Jun 14 12:32:47 2008 by  doxygen 1.5.1