Public Member Functions | List of all members

#include <seqsimvec.h>

Inheritance diagram for SeqSimultanVector:
Inheritance graph
[legend]

Public Member Functions

 SeqSimultanVector (const STD_string &object_label="unnamedSeqSimultanVector")
 
 SeqSimultanVector (const SeqSimultanVector &ssv)
 
SeqSimultanVectoroperator= (const SeqSimultanVector &ssv)
 
SeqSimultanVectoroperator+= (const SeqVector &sv)
 
SeqSimultanVectorclear ()
 
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
 
- Public Member Functions inherited from SeqVector
 SeqVector (const STD_string &object_label="unnamedSeqVector")
 
 SeqVector (const STD_string &object_label, unsigned int nindices, int slope=1, int offset=0)
 
 SeqVector (const SeqVector &sv)
 
virtual ~SeqVector ()
 
SeqVectoroperator= (const SeqVector &sv)
 
virtual int get_current_index () const
 
int get_acq_index () const
 
virtual bool is_acq_vector () const
 
virtual bool is_obj_vector () const
 
SeqVectorset_indexvec (const ivector &iv)
 
ivector get_indexvec () const
 
SeqVectorset_reorder_scheme (reorderScheme scheme, unsigned int nsegments=1)
 
SeqVectorset_encoding_scheme (encodingScheme scheme)
 
const SeqVectorget_reorder_vector () const
 
iarray get_index_matrix () const
 
int get_current_reord_index () const
 
STD_string get_reord_iterator (const STD_string &iterator) 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)
 
- Public Member Functions inherited from List< SeqVector, const SeqVector *, const SeqVector &>
 List ()
 
 ~List ()
 
Listoperator= (const List &l)
 
Listclear ()
 
Listappend (const SeqVector & item)
 
Listremove (const SeqVector & item)
 
unsigned int size () const
 
iter get_begin ()
 
iter get_end ()
 
constiter get_const_begin () const
 
constiter get_const_end () const
 

Additional Inherited Members

- Public Types inherited from List< SeqVector, const SeqVector *, const SeqVector &>
typedef STD_list< const SeqVector * >::iterator iter
 
typedef STD_list< const SeqVector * >::const_iterator constiter
 
- Protected Member Functions inherited from SeqVector
virtual svector get_reord_vector_commands (const STD_string &iterator) const
 
bool is_handled () const
 
- Protected Member Functions inherited from SeqClass
void marshall_error () const
 
virtual bool prep ()
 
- Static Protected Member Functions inherited from SeqClass
static void clear_temporary ()
 
static void clear_containers ()
 

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() [1/2]

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() [2/2]

SeqSimultanVector::SeqSimultanVector ( const SeqSimultanVector ssv)

Constructs a copy of 'ssv'

Member Function Documentation

§ clear()

SeqSimultanVector& SeqSimultanVector::clear ( )
inline

clears the list of managed vectors

Definition at line 56 of file seqsimvec.h.

§ get_loopcommand()

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.

§ get_nesting_relation()

nestingRelation SeqSimultanVector::get_nesting_relation ( ) const
virtual

Returns the nesting relation between the vector and its reordering vector

Reimplemented from SeqVector.

§ get_numof_iterations()

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.

§ get_vector_commands()

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.

§ get_vectorsize()

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.

§ is_qualvector()

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.

§ needs_unrolling_check()

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.

§ operator+=()

SeqSimultanVector& SeqSimultanVector::operator+= ( const SeqVector sv)

Appends sv to the list of managed vectors

§ operator=()

SeqSimultanVector& SeqSimultanVector::operator= ( const SeqSimultanVector ssv)

Assignment operator that makes this vector object become a copy of 'ssv'

§ prep_iteration()

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.


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