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

Container for sequence objects. More...

#include <seqlist.h>

Inheritance diagram for SeqObjList:

Inheritance graph
[legend]

List of all members.

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)
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, JDXkSpaceCoords &coords) const
SeqValList get_freqvallist (freqlistAction action) const
SeqValList get_delayvallist () const
double get_rf_energy () const

Protected Member Functions

void clear_container ()


Detailed Description

Container for sequence objects.

This is a container class for other sequence objects.

Definition at line 79 of file seqlist.h.


Constructor & Destructor Documentation

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

Construct an empty sequence container with the given label

SeqObjList::SeqObjList ( const SeqObjList so  ) 

Constructs a copy of 'so'


Member Function Documentation

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

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

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

Special assignment for loops

Reimplemented in SeqObjLoop.

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

Special assignment for decoupling

Reimplemented in SeqDecoupling.

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

Special treatment for single non-container sequence objects

Reimplemented from SeqObjBase.

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

Special treatment for assignment from gradient objects

Definition at line 120 of file seqlist.h.

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

Special treatment for assignment from gradient objects

Definition at line 125 of file seqlist.h.

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

Special treatment for assignment from gradient objects

Definition at line 130 of file seqlist.h.

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

Special treatment for appending sequence objects

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

Special treatment for appending gradient objects

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

Special treatment for appending gradient objects

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

Special treatment for appending gradient objects

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 SeqDecoupling, and SeqObjLoop.

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 SeqDecoupling, SeqObjLoop, and SeqMethod.

double SeqObjList::get_duration (  )  const [virtual]

Returns the duration of the sequence object.

Implements SeqTreeObj.

Reimplemented in SeqDecoupling, and SeqObjLoop.

STD_string SeqObjList::get_properties (  )  const [virtual]

Returns a string describing the object

Reimplemented from SeqTreeObj.

Reimplemented in SeqObjLoop.

void SeqObjList::query ( queryContext context  )  const [virtual]

Query the sequence tree recursively

Reimplemented from SeqTreeObj.

Reimplemented in SeqObjLoop.

RecoValList SeqObjList::get_recovallist ( unsigned int  reptimes,
JDXkSpaceCoords 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.

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.

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.

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.

void SeqObjList::clear_container (  )  [inline, protected, virtual]

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.

Reimplemented in SeqDecoupling, and SeqDiffWeight.

Definition at line 169 of file seqlist.h.


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

Generated on Wed Sep 30 15:33:23 2009 by  doxygen 1.5.6