link to homepage

Institute for Neuroscience and Medicine

Navigation and service


API documentation

Sequence Class Reference

Super class for all sequence (non-pulse) modules. More...

#include <Sequence.h>

Inheritance diagram for Sequence:
Collaboration diagram for Sequence:

List of all members.

Public Member Functions

 Sequence ()
 Default constructor.
virtual ~Sequence ()
 Default destructor.
 Sequence (const Sequence &)
 Default copy constructor.
virtual void GetValue (double *dAllVal, double const time)
virtual double GetDuration ()=0
virtual bool Prepare (PrepareMode mode)
void SeqDiag (string fname="seq.bin")
void WriteSeqFile (ofstream *pfout, double &time)
long GetNumOfADCs ()

Protected Attributes

vector< string > m_prep_errors
 Preparation Error Messages of Modules.

Detailed Description

Super class for all sequence (non-pulse) modules.

Definition at line 32 of file Sequence.h.


Member Function Documentation

virtual double Sequence::GetDuration (  )  [pure virtual]

Get the duration of this module.

Returns:
Duration in ms

Reimplemented from Module.

Implemented in AtomicSequence, and ConcatSequence.

Referenced by WriteSeqFile().

Here is the caller graph for this function:

long Sequence::GetNumOfADCs (  ) 

Get the number of ADCs for this sequence.

Returns:
The nmuber of ADCs.

Definition at line 124 of file Sequence.cpp.

References ConcatSequence::begin(), ConcatSequence::end(), Module::GetChildren(), Module::GetNumOfTPOIs(), TPOI::GetPhase(), Prototype::GetType(), and Module::m_tpoi.

Referenced by Model::RunSequenceTree(), Simulator::SetSequence(), Simulator::Simulate(), and Model::Solve().

Here is the call graph for this function:

Here is the caller graph for this function:

virtual void Sequence::GetValue ( double *  dAllVal,
double const   time 
) [inline, virtual]

See Module::GetValue

Reimplemented from Module.

Reimplemented in AtomicSequence, ConcatSequence, and DelayAtomicSequence.

Definition at line 54 of file Sequence.h.

Referenced by WriteSeqFile().

Here is the caller graph for this function:

bool Sequence::Prepare ( PrepareMode  mode  )  [virtual]

Prepare the sequence.

Parameters:
mode Sets the preparation mode, one of enum PrepareMode {PREP_INIT,PREP_VERBOSE,PREP_UPDATE}.
Returns:
Success

Reimplemented from Module.

Reimplemented in AtomicSequence, ConcatSequence, and DelayAtomicSequence.

Definition at line 29 of file Sequence.cpp.

References Module::GetChildren(), Prototype::GetName(), Module::GetParent(), Prototype::HideAttribute(), and Module::m_parameters.

Here is the call graph for this function:

void Sequence::SeqDiag ( string  fname = "seq.bin"  ) 

Sequence Diag

Parameters:
fname File name

Definition at line 59 of file Sequence.cpp.

References WriteSeqFile().

Here is the call graph for this function:

void Sequence::WriteSeqFile ( ofstream *  pfout,
double &  time 
)

Write sequence file

Parameters:
pfout File output stream
time Time: More elaborate description, please.

Definition at line 69 of file Sequence.cpp.

References ConcatSequence::begin(), ConcatSequence::end(), Module::GetChildren(), GetDuration(), Module::GetNumOfTPOIs(), TPOI::GetPhase(), TPOI::GetTime(), Prototype::GetType(), GetValue(), and Module::m_tpoi.

Referenced by SeqDiag().

Here is the call graph for this function:

Here is the caller graph for this function:


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

Servicemeu