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

#include <seqclass.h>

Inheritance diagram for SeqClass:

Inheritance graph
[legend]

List of all members.

Public Member Functions

SeqClassset_temporary ()

Protected Member Functions

void marshall_error () const
virtual void clear_container ()
virtual bool prep ()

Static Protected Member Functions

static void clear_temporary ()
static void clear_containers ()

Friends

class SeqOperator
class SeqMethod
class SeqMethodProxy
class SystemInterface
class SeqPlatformProxy


Detailed Description

This is the base class for all Seq* classes. It provides functions that are common to all classes of the sequence library, e.g. functions for error/debug message handling and acces to proxies, i.e. geometryInfo, studyInfo and systemInfo.

Definition at line 62 of file seqclass.h.


Member Function Documentation

SeqClass& SeqClass::set_temporary (  ) 

Mark object as temporary so that it will be deleted automatically

void SeqClass::marshall_error (  )  const [protected]

Writes a marshalling error, i.e. mashalling without appropriate sub-object, to the log

static void SeqClass::clear_temporary (  )  [static, protected]

Delete all temporary objects

virtual void SeqClass::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 in SeqCounter, SeqDecoupling, SeqDiffWeight, SeqDiffWeightFlowComp, SeqObjList, and SeqObjVector.

Definition at line 102 of file seqclass.h.

static void SeqClass::clear_containers (  )  [static, protected]

Clear the contents of all container objects

virtual bool SeqClass::prep (  )  [inline, protected, virtual]

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 in SeqCounter, and SeqFreqChan.

Definition at line 116 of file seqclass.h.


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

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