Public Member Functions | Protected Member Functions | Friends | List of all members

Container for sequence objects. More...

#include <seqlist.h>

Inheritance diagram for SeqObjList:
Inheritance graph
[legend]

Public Member Functions

 SeqObjList (const STD_string &object_label="unnamedSeqObjList")
 
 SeqObjList (const SeqObjList &so)
 
SeqObjListoperator= (const SeqObjList &so)
 
SeqObjListoperator= (const SeqObjLoop &sl)
 
SeqObjListoperator= (const SeqDecoupling &sd)
 
SeqObjListoperator= (const SeqObjBase &soa)
 
SeqObjListoperator= (SeqGradObjInterface &sgoa)
 
SeqObjListoperator= (SeqGradChan &sgc)
 
SeqObjListoperator= (SeqGradChanList &sgcl)
 
SeqObjListoperator+= (const SeqObjBase &soa)
 
SeqObjListoperator+= (SeqGradObjInterface &sgoa)
 
SeqObjListoperator+= (SeqGradChan &sgc)
 
SeqObjListoperator+= (SeqGradChanList &sgcl)
 
SeqObjListset_gradrotmatrixvector (const SeqRotMatrixVector &matrixVec)
 
STD_string get_program (programContext &context) const
 
unsigned int event (eventContext &context) const
 
double get_duration () const
 
STD_string get_properties () const
 
void query (queryContext &context) const
 
RecoValList get_recovallist (unsigned int reptimes, LDRkSpaceCoords &coords) const
 
SeqValList get_freqvallist (freqlistAction action) const
 
SeqValList get_delayvallist () const
 
double get_rf_energy () const
 
- Public Member Functions inherited from SeqTreeObj
bool contains (const SeqTreeObj *sto) const
 
void tree (SeqTreeCallbackAbstract *display) 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< SeqObjBase, const SeqObjBase *, const SeqObjBase &>
 List ()
 
 ~List ()
 
Listoperator= (const List &l)
 
Listclear ()
 
Listappend (const SeqObjBase & item)
 
Listremove (const SeqObjBase & item)
 
unsigned int size () const
 
iter get_begin ()
 
iter get_end ()
 
constiter get_const_begin () const
 
constiter get_const_end () const
 

Protected Member Functions

void clear_container ()
 
bool prep ()
 
- Protected Member Functions inherited from SeqClass
void marshall_error () const
 

Friends

class SeqGradChan
 
class SeqOperator
 

Additional Inherited Members

- Public Types inherited from List< SeqObjBase, const SeqObjBase *, const SeqObjBase &>
typedef STD_list< const SeqObjBase * >::iterator iter
 
typedef STD_list< const SeqObjBase * >::const_iterator constiter
 
- Static Protected Member Functions inherited from SeqClass
static void clear_temporary ()
 
static void clear_containers ()
 

Detailed Description

Container for sequence objects.

This is a container class for other sequence objects.

Definition at line 86 of file seqlist.h.

Constructor & Destructor Documentation

§ SeqObjList() [1/2]

SeqObjList::SeqObjList ( const STD_string &  object_label = "unnamedSeqObjList")

Construct an empty sequence container with the given label

§ SeqObjList() [2/2]

SeqObjList::SeqObjList ( const SeqObjList so)

Constructs a copy of 'so'

Member Function Documentation

§ clear_container()

void SeqObjList::clear_container ( )
inlineprotectedvirtual

Overload this function in case the class is a container object, i.e. it contains other sequence objects. The function should clear all references to other sequence objects, i.e. to thos it contains.

Reimplemented from SeqClass.

Definition at line 185 of file seqlist.h.

§ event()

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

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

Reimplemented from SeqTreeObj.

Reimplemented in SeqMethod, and SeqObjLoop.

§ get_delayvallist()

SeqValList SeqObjList::get_delayvallist ( ) const
virtual

Returns the list of delay values in the objects branch of the sequence tree

Reimplemented from SeqTreeObj.

Reimplemented in SeqObjLoop.

§ get_duration()

double SeqObjList::get_duration ( ) const
virtual

Returns the duration of the sequence object.

Implements SeqTreeObj.

Reimplemented in SeqObjLoop.

§ get_freqvallist()

SeqValList SeqObjList::get_freqvallist ( freqlistAction  action) const
virtual

Returns the list of frequency values in the objects branch of the sequence tree

Reimplemented from SeqTreeObj.

Reimplemented in SeqObjLoop.

§ get_program()

STD_string SeqObjList::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.

Reimplemented in SeqObjLoop.

§ get_properties()

STD_string SeqObjList::get_properties ( ) const
virtual

Returns a string describing the object

Reimplemented from SeqTreeObj.

Reimplemented in SeqObjLoop.

§ get_recovallist()

RecoValList SeqObjList::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.

Reimplemented in SeqObjLoop.

§ get_rf_energy()

double SeqObjList::get_rf_energy ( ) const
virtual

Returns the RF power deposition in the objects branch of the sequence tree. The physical unit is unspecified, it depends on the current platform.

Reimplemented from SeqTreeObj.

Reimplemented in SeqObjLoop.

§ operator+=() [1/4]

SeqObjList& SeqObjList::operator+= ( const SeqObjBase soa)

Special treatment for appending sequence objects

§ operator+=() [2/4]

SeqObjList& SeqObjList::operator+= ( SeqGradObjInterface sgoa)

Special treatment for appending gradient objects

§ operator+=() [3/4]

SeqObjList& SeqObjList::operator+= ( SeqGradChan sgc)

Special treatment for appending gradient objects

§ operator+=() [4/4]

SeqObjList& SeqObjList::operator+= ( SeqGradChanList sgcl)

Special treatment for appending gradient objects

§ operator=() [1/7]

SeqObjList& SeqObjList::operator= ( const SeqObjList so)

Assignment operator that makes this sequence container become a copy of 'so'

§ operator=() [2/7]

SeqObjList& SeqObjList::operator= ( const SeqObjLoop sl)

Special assignment for loops

§ operator=() [3/7]

SeqObjList& SeqObjList::operator= ( const SeqDecoupling sd)

Special assignment for decoupling

§ operator=() [4/7]

SeqObjList& SeqObjList::operator= ( const SeqObjBase soa)

Special treatment for single non-container sequence objects

§ operator=() [5/7]

SeqObjList& SeqObjList::operator= ( SeqGradObjInterface sgoa)
inline

Special treatment for assignment from gradient objects

Definition at line 127 of file seqlist.h.

§ operator=() [6/7]

SeqObjList& SeqObjList::operator= ( SeqGradChan sgc)
inline

Special treatment for assignment from gradient objects

Definition at line 132 of file seqlist.h.

§ operator=() [7/7]

SeqObjList& SeqObjList::operator= ( SeqGradChanList sgcl)
inline

Special treatment for assignment from gradient objects

Definition at line 137 of file seqlist.h.

§ prep()

bool SeqObjList::prep ( )
protectedvirtual

Overload this function to prepare objects before the measurement. This function will then be called automatically after editing the sequence parameters and before the measurement is started. This function should not alter the physical properties of the sequence object, e.g. its duration.

Reimplemented from SeqClass.

§ query()

void SeqObjList::query ( queryContext context) const
virtual

Query the sequence tree recursively

Reimplemented from SeqTreeObj.

Reimplemented in SeqObjLoop.

§ set_gradrotmatrixvector()

SeqObjList& SeqObjList::set_gradrotmatrixvector ( const SeqRotMatrixVector matrixVec)
inline

Specifies an extra vector of rotatition matrices to be used with this container. The part held by this container will be executed with the current rotation matrix. The sequence vector 'matrixVec' can then be attached to a loop to iterate over the different matrices.

Definition at line 167 of file seqlist.h.


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