ODIN
Public Member Functions | List of all members

#include <seqpuls.h>

Inheritance diagram for SeqFlipAngVector:
Inheritance graph
[legend]

Public Member Functions

unsigned int get_vectorsize () const
 
bool needs_unrolling_check () const
 
bool prep_iteration () const
 
svector get_vector_commands (const STD_string &iterator) 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 unsigned int get_numof_iterations () const
 
virtual int get_current_index () const
 
int get_acq_index () const
 
virtual bool is_qualvector () const
 
virtual bool is_acq_vector () const
 
virtual bool is_obj_vector () const
 
virtual STD_string get_loopcommand () 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
 
virtual nestingRelation get_nesting_relation () 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)
 

Additional Inherited Members

- 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 void clear_container ()
 
virtual bool prep ()
 
- Static Protected Member Functions inherited from SeqClass
static void clear_temporary ()
 
static void clear_containers ()
 

Detailed Description

A vector class to iterate through a list of flip angles, only to be used by SeqPuls

Definition at line 182 of file seqpuls.h.

Member Function Documentation

◆ get_vector_commands()

svector SeqFlipAngVector::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 SeqFlipAngVector::get_vectorsize ( ) const
inlinevirtual

Overload this function to return the number of elements in the vector (regardless of reordering)

Reimplemented from SeqVector.

Definition at line 190 of file seqpuls.h.

◆ needs_unrolling_check()

bool SeqFlipAngVector::needs_unrolling_check ( ) const
inlinevirtual

Overload this function to trigger a check whether the loop must possibly be unrolled in pulse or gradient program

Reimplemented from SeqVector.

Definition at line 191 of file seqpuls.h.

◆ prep_iteration()

bool SeqFlipAngVector::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: