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

#include <seqclass.h>

Inheritance diagram for SeqClass:
Inheritance graph
[legend]

Public Member Functions

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)
 

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

§ clear_container()

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

Definition at line 102 of file seqclass.h.

§ clear_containers()

static void SeqClass::clear_containers ( )
staticprotected

Clear the contents of all container objects

§ clear_temporary()

static void SeqClass::clear_temporary ( )
staticprotected

Delete all temporary objects

§ marshall_error()

void SeqClass::marshall_error ( ) const
protected

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

§ prep()

virtual bool SeqClass::prep ( )
inlineprotectedvirtual

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

Definition at line 116 of file seqclass.h.

§ set_temporary()

SeqClass& SeqClass::set_temporary ( )

Mark object as temporary so that it will be deleted automatically


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