link to homepage

Institute for Neuroscience and Medicine

Navigation and service


API documentation

Concat sequence prototype. More...

#include <ConcatSequence.h>

Inheritance diagram for ConcatSequence:
Collaboration diagram for ConcatSequence:

List of all members.

Public Member Functions

 ConcatSequence ()
 Default constructor.
 ConcatSequence (const ConcatSequence &)
 ~ConcatSequence ()
 Default destructor.
ConcatSequenceClone () const
virtual bool Prepare (PrepareMode mode)
 Prepare the sequence.
virtual void GetValue (double *dAllVal, double const time)
virtual void GetValue (double *dAllVal, double const time, double *pos[3])
double GetDuration ()
virtual int GetNumOfTPOIs ()
 Default destructor.
virtual unsigned int GetMyRepetitions ()
 Get the number of repetitions.
void SetRepetitions (unsigned int val)
 Set the number of repetitions.
void SetRepCounter (unsigned int val, bool record=false)
 Set the current repetition counter of this ConcatSequence.
unsigned int GetMyRepCounter ()
 Get the current repetition counter of this ConcatSequence.
RepIter begin ()
RepIter end ()

Protected Member Functions

virtual string GetInfo ()
 Create a DOM tree where all expressions are evaluated (for IDEA).

Protected Attributes

unsigned int m_repetitions
 The number of repetitions for this container.
unsigned int m_counter
 Current value of the repetition counter for this container.

Detailed Description

Concat sequence prototype.

Definition at line 34 of file ConcatSequence.h.


Constructor & Destructor Documentation

ConcatSequence::ConcatSequence ( const ConcatSequence cs  ) 

Copy constructor.

Definition at line 28 of file ConcatSequence.cpp.

References m_counter, and m_repetitions.


Member Function Documentation

RepIter ConcatSequence::begin (  )  [inline]

Get the initial iterator for counting repetitions.

Returns:
The first repetition iterator.

Definition at line 120 of file ConcatSequence.h.

References m_counter, Prototype::NewState(), and SetRepCounter().

Referenced by GetDuration(), Sequence::GetNumOfADCs(), GetNumOfTPOIs(), GetValue(), Model::RunSequenceTree(), and Sequence::WriteSeqFile().

Here is the call graph for this function:

Here is the caller graph for this function:

ConcatSequence* ConcatSequence::Clone (  )  const [inline, virtual]

See Module::clone

Implements Module.

Definition at line 56 of file ConcatSequence.h.

References ConcatSequence().

Here is the call graph for this function:

RepIter ConcatSequence::end (  )  [inline]

Get the final iterator for counting repetitions.

Returns:
The final repetition iterator.

Definition at line 127 of file ConcatSequence.h.

References m_repetitions.

Referenced by GetDuration(), Sequence::GetNumOfADCs(), GetNumOfTPOIs(), GetValue(), Model::RunSequenceTree(), and Sequence::WriteSeqFile().

Here is the caller graph for this function:

double ConcatSequence::GetDuration (  )  [virtual]

See Module::GetDuration

Implements Sequence.

Definition at line 60 of file ConcatSequence.cpp.

References begin(), end(), Module::GetChildren(), Prototype::GetName(), Module::m_duration, and Prototype::Notify().

Referenced by GetValue(), TrajectoryMotion::LoadFile(), Trajectory1D::LoadFile(), and SequenceTree::Populate().

Here is the call graph for this function:

Here is the caller graph for this function:

string ConcatSequence::GetInfo (  )  [protected, virtual]

Create a DOM tree where all expressions are evaluated (for IDEA).

Parameters:
node the DOM
Returns:
success or failure Get informations on this ConcatSequence
The number of the repetitions

Reimplemented from Module.

Definition at line 129 of file ConcatSequence.cpp.

References m_repetitions.

unsigned int ConcatSequence::GetMyRepCounter (  )  [inline]

Get the current repetition counter of this ConcatSequence.

Returns:
The current repetition counter.

Definition at line 113 of file ConcatSequence.h.

References m_counter.

virtual unsigned int ConcatSequence::GetMyRepetitions (  )  [inline, virtual]

Get the number of repetitions.

Returns:
The number of repetitions.

Definition at line 92 of file ConcatSequence.h.

References m_repetitions.

Referenced by SetRepCounter().

Here is the caller graph for this function:

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

See Module::GetValue

Reimplemented from Sequence.

Definition at line 93 of file ConcatSequence.cpp.

References begin(), end(), Module::GetChildren(), and GetDuration().

Here is the call graph for this function:

virtual void ConcatSequence::GetValue ( double *  dAllVal,
double const   time,
double *  pos[3] 
) [inline, virtual]

See Module::GetValue

Definition at line 74 of file ConcatSequence.h.

bool ConcatSequence::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 Sequence.

Definition at line 34 of file ConcatSequence.cpp.

References m_counter, m_repetitions, Prototype::m_type, and SetRepCounter().

Referenced by SequenceTree::Populate(), and Model::Solve().

Here is the call graph for this function:

Here is the caller graph for this function:

void ConcatSequence::SetRepCounter ( unsigned int  val,
bool  record = false 
)

Set the current repetition counter of this ConcatSequence.

Parameters:
val The current repetition counter.

Definition at line 47 of file ConcatSequence.cpp.

References GetMyRepetitions(), m_counter, and Prototype::Notify().

Referenced by begin(), RepIter::operator++(), and Prepare().

Here is the call graph for this function:

Here is the caller graph for this function:

void ConcatSequence::SetRepetitions ( unsigned int  val  ) 

Set the number of repetitions.

Parameters:
val The number of repetitions. val>0 required.

Definition at line 54 of file ConcatSequence.cpp.

References m_repetitions.


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

Servicemeu