AnalogRecorder Class Reference

#include <AnalogRecorder.h>

Inheritance diagram for AnalogRecorder:

Inheritance graph
[legend]
Collaboration diagram for AnalogRecorder:

Collaboration graph
[legend]

List of all members.

Public Member Functions

 AnalogRecorder (unsigned samplingTime=1)
virtual ~AnalogRecorder ()
virtual void setAnalogInput (double v, analog_port_id_t port=0)
 Analog input to given port.
const std::vector< double > & getRecordedValues () const
virtual int advance (AdvanceInfo const &)
 Calculate the next state and output/propagate the result to succesors/outgoing objects.
virtual int reset (double dt)
 Called at the beginning of a simulation at t=0.
virtual void setActive (bool active)
void printAnalogValues () const
virtual double getManagedDelay () const
virtual int nSpikeInputPorts () const
virtual int nSpikeOutputPorts () const
virtual int nAnalogInputPorts () const
virtual int nAnalogOutputPorts () const
virtual PortType outputPortType (port_t o) const
virtual PortType inputPortType (port_t i) const

Public Attributes

unsigned samplingTime
 Sampling time interval for recorded signal in number of simulation timesteps [range=(1,1e6)].

Protected Attributes

double input
double summationPoint
std::vector< doublevalues
double stepsLeftBeforeSample
bool isActive

Friends

class STandMTAnalogMsgExchangeTest
class DistributedAnalogCommunicationFinalTest
class DistributedSingleThreadNetworkTest
class DistributedMultiThreadNetworkTest
class LocalAnalogMessageDispatchTest
class AnalogRecorderTest


Detailed Description

Definition at line 8 of file AnalogRecorder.h.


Constructor & Destructor Documentation

AnalogRecorder::AnalogRecorder ( unsigned  samplingTime = 1  ) 

Definition at line 8 of file AnalogRecorder.cpp.

AnalogRecorder::~AnalogRecorder (  )  [virtual]

Definition at line 14 of file AnalogRecorder.cpp.


Member Function Documentation

void AnalogRecorder::setAnalogInput ( double  value,
analog_port_id_t  port = 0 
) [virtual]

Analog input to given port.

Reimplemented from SimObject.

Definition at line 20 of file AnalogRecorder.cpp.

References isActive, and summationPoint.

const vector< double > & AnalogRecorder::getRecordedValues (  )  const

Definition at line 77 of file AnalogRecorder.cpp.

References values.

int AnalogRecorder::advance ( AdvanceInfo const &   )  [virtual]

Calculate the next state and output/propagate the result to succesors/outgoing objects.

The return value of advance contains several bits of information which can be decoded with the bit masks ADVANCEFLAG_* like ADVANCEFLAG_HASSPIKED and ADVANCEFLAG_DEACTIVATE.

Reimplemented from SimObject.

Definition at line 39 of file AnalogRecorder.cpp.

References input, isActive, samplingTime, stepsLeftBeforeSample, summationPoint, and values.

int AnalogRecorder::reset ( double  dt  )  [virtual]

Called at the beginning of a simulation at t=0.

Reimplemented from SimObject.

Definition at line 57 of file AnalogRecorder.cpp.

References input, isActive, stepsLeftBeforeSample, summationPoint, and values.

void AnalogRecorder::setActive ( bool  active  )  [virtual]

Definition at line 27 of file AnalogRecorder.cpp.

References input, isActive, stepsLeftBeforeSample, and summationPoint.

void AnalogRecorder::printAnalogValues (  )  const

Definition at line 88 of file AnalogRecorder.cpp.

References values.

virtual double AnalogRecorder::getManagedDelay (  )  const [inline, virtual]

Reimplemented from SimObject.

Definition at line 30 of file AnalogRecorder.h.

virtual int AnalogRecorder::nSpikeInputPorts (  )  const [inline, virtual]

Reimplemented from SimObject.

Definition at line 31 of file AnalogRecorder.h.

virtual int AnalogRecorder::nSpikeOutputPorts (  )  const [inline, virtual]

Reimplemented from SimObject.

Definition at line 32 of file AnalogRecorder.h.

virtual int AnalogRecorder::nAnalogInputPorts (  )  const [inline, virtual]

Reimplemented from SimObject.

Definition at line 33 of file AnalogRecorder.h.

virtual int AnalogRecorder::nAnalogOutputPorts (  )  const [inline, virtual]

Reimplemented from SimObject.

Definition at line 34 of file AnalogRecorder.h.

virtual PortType AnalogRecorder::outputPortType ( port_t  o  )  const [inline, virtual]

Reimplemented from SimObject.

Definition at line 35 of file AnalogRecorder.h.

References SimObject::undefined.

virtual PortType AnalogRecorder::inputPortType ( port_t  i  )  const [inline, virtual]

Reimplemented from SimObject.

Definition at line 36 of file AnalogRecorder.h.


Friends And Related Function Documentation

friend class STandMTAnalogMsgExchangeTest [friend]

Definition at line 50 of file AnalogRecorder.h.

friend class DistributedAnalogCommunicationFinalTest [friend]

Definition at line 51 of file AnalogRecorder.h.

friend class DistributedSingleThreadNetworkTest [friend]

Definition at line 52 of file AnalogRecorder.h.

friend class DistributedMultiThreadNetworkTest [friend]

Definition at line 53 of file AnalogRecorder.h.

friend class LocalAnalogMessageDispatchTest [friend]

Definition at line 54 of file AnalogRecorder.h.

friend class AnalogRecorderTest [friend]

Definition at line 55 of file AnalogRecorder.h.


Member Data Documentation

Sampling time interval for recorded signal in number of simulation timesteps [range=(1,1e6)].

Definition at line 36 of file AnalogRecorder.h.

Referenced by advance().

Definition at line 42 of file AnalogRecorder.h.

Referenced by advance(), reset(), and setActive().

Definition at line 43 of file AnalogRecorder.h.

Referenced by advance(), reset(), setActive(), and setAnalogInput().

std::vector<double> AnalogRecorder::values [protected]

Definition at line 44 of file AnalogRecorder.h.

Referenced by advance(), getRecordedValues(), printAnalogValues(), and reset().

Definition at line 45 of file AnalogRecorder.h.

Referenced by advance(), reset(), and setActive().

Definition at line 46 of file AnalogRecorder.h.

Referenced by advance(), reset(), setActive(), and setAnalogInput().


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

Generated on Wed Jul 9 16:34:46 2008 for PCSIM by  doxygen 1.5.5