AnimatLab  2
Test
AnimatCarlSim::CsNeuronDataColumn Class Reference

Carlsim Data column class. More...

#include <CsNeuronDataColumn.h>

+ Inheritance diagram for AnimatCarlSim::CsNeuronDataColumn:
+ Collaboration diagram for AnimatCarlSim::CsNeuronDataColumn:

Public Member Functions

 CsNeuronDataColumn ()
 Default constructor. More...
 
virtual ~CsNeuronDataColumn ()
 Destructor. More...
 
virtual void DataType (std::string strType)
 Sets the Data type of the variable we are collecting. This is the value passed into GetDataPointer. More...
 
virtual void Deactivate ()
 
virtual void Initialize ()
 Initializes this object. More...
 
virtual void Load (CStdXml &oXml)
 
virtual void NeuronID (const std::string &strValue)
 
virtual unsigned int NeuronID ()
 
virtual void QueryProperties (CStdPtrArray< TypeProperty > &aryProperties)
 
virtual bool SetData (const std::string &strDataType, const std::string &strValue, bool bThrowError=true)
 Set a variable based on a string data type name. More...
 
- Public Member Functions inherited from AnimatSim::Charting::DataColumn
 DataColumn ()
 Default constructor. More...
 
virtual ~DataColumn ()
 Destructor. More...
 
virtual void Activate ()
 
virtual int AppendSpaces ()
 Gets how many spaces to append. More...
 
virtual void AppendSpaces (int iSpaces)
 Sets whether to append spaces. More...
 
virtual int ColumnCount ()
 Gets the number of columns for this DataColumn. More...
 
virtual int ColumnIndex ()
 Gets the column index. More...
 
virtual void ColumnIndex (int iIndex)
 Sets the Column index. More...
 
virtual std::string DataType ()
 Gets the data type of the variable we are collecting. This is the value passed into GetDataPointer. More...
 
virtual float * DataValue ()
 Gets the pointer to the data value we are collecting. More...
 
virtual bool IsInitialized ()
 Query if this object is initialized. More...
 
virtual void IsInitialized (bool bVal)
 Sets whether this column is initialized. More...
 
virtual void Name (std::string strValue)
 Sets the name of the object. Blank is acceptable. More...
 
virtual bool operator< (DataColumn *lpColumn)
 Determines if this column has an index value less than the index value of the column being passed in. More...
 
virtual void QueryProperties (CStdPtrArray< TypeProperty > &aryProperties)
 Queries this object for a list of properties that can be changed using SetData. More...
 
virtual void ReInitialize ()
 Re-initialize this object. More...
 
virtual int RowIndex ()
 Gets the row index. More...
 
virtual void RowIndex (int iIndex)
 Sets the Row index. More...
 
virtual void SaveColumnNames (std::ofstream &oStream)
 Saves this DataColumn name to the out stream for the file. More...
 
virtual void SetSystemPointers (Simulator *lpSim, Structure *lpStructure, NeuralModule *lpModule, Node *lpNode, DataChart *lpChart, bool bVerify)
 Sets the system pointers. More...
 
virtual void StepSimulation ()
 Step the simulation for this object. More...
 
virtual std::string TargetID ()
 Gets the GUID ID of the item to chart. More...
 
virtual void TargetID (std::string strID)
 Sets the GUID ID of teh item to chart. More...
 
virtual void VerifySystemPointers ()
 Verify that system pointers have been set correctly. More...
 
- Public Member Functions inherited from AnimatSim::AnimatBase
 AnimatBase ()
 Constructs an AnimatBase object. More...
 
virtual ~AnimatBase ()
 Destroys the AnimatBase object.. More...
 
virtual bool AddItem (const std::string &strItemType, const std::string &strXml, bool bThrowError=true, bool bDoNotInit=false)
 Adds a new object to this parent. More...
 
virtual void AfterResetSimulation ()
 Called after a simulation reset for some objects. More...
 
virtual long CalculateSnapshotByteSize ()
 Calculates the snapshot byte size. More...
 
virtual void Copy (CStdSerialize *lpSource)
 
virtual void Enabled (bool bVal)
 Tells whether this item is enabled or not. This is not actually used for all objects, only specific ones. I am putting it in the base class though to prevent numerous duplications. More...
 
virtual bool Enabled ()
 Tells whether this item is enabled or not. This is not actually used for all objects, only specific ones. I am putting it in the base class though to prevent numerous duplications. More...
 
virtual float * GetDataPointer (const std::string &strDataType)
 Returns a float pointer to a data item of interest in this object. More...
 
virtual NeuralModuleGetNeuralModule ()
 Gets the neural module. More...
 
virtual NodeGetNode ()
 Gets the node. More...
 
virtual SimulatorGetSimulator ()
 Gets the simulator pointer. More...
 
virtual StructureGetStructure ()
 Gets the structure for this node. More...
 
virtual bool HasProperty (const std::string &strName)
 Queries this object if it has a property with the given name. More...
 
virtual std::string ID ()
 Gets the unique GUID ID of this object. More...
 
virtual void ID (std::string strValue)
 Sets the unique GUID ID of the object. More...
 
virtual void Kill (bool bState=true)
 Kills. More...
 
virtual void Load (StdUtils::CStdXml &oXml)
 Loads the item using an XML data packet. More...
 
virtual void LoadKeyFrameSnapshot (byte *aryBytes, long &lIndex)
 Loads a key frame snapshot. More...
 
virtual std::string Name ()
 Gets the name of this object. More...
 
virtual AnimatPropertyType PropertyType (const std::string &strName)
 
virtual bool RemoveItem (const std::string &strItemType, const std::string &strID, bool bThrowError=true)
 Removes a child item from this parent. More...
 
virtual void Reset ()
 Resets this object. More...
 
virtual void ResetSimulation ()
 Resets the simulation back to time 0. More...
 
virtual void RigidBodyAdded (std::string strID)
 
virtual void RigidBodyRemoved (std::string strID)
 
virtual void SaveKeyFrameSnapshot (byte *aryBytes, long &lIndex)
 Saves a key frame snapshot. More...
 
virtual bool Selected ()
 Tells if this items is selected or not. More...
 
virtual void Selected (bool bValue, bool bSelectMultiple)
 Selects this object. More...
 
virtual bool SetData (const std::string &strDataType, const float fltValue, bool bThrowError=true)
 Set a variable based on a string data type name. More...
 
virtual bool SetData (const std::string &strDataType, const long lValue, bool bThrowError=true)
 Set a variable based on a string data type name. More...
 
virtual void SetSystemPointers (Simulator *lpSim, Structure *lpStructure, NeuralModule *lpModule, Node *lpNode, bool bVerify)
 Sets the system pointers. More...
 
virtual void SimPausing ()
 Called just before the simulation pauses. More...
 
virtual void SimStarting ()
 Called just before the simulation starts. More...
 
virtual void SimStopping ()
 Called just before the simulation stops. More...
 
virtual void TimeStepModified ()
 Notification method that the time step modified has been modified. Objects should recalculate any slice times as needed. More...
 
virtual std::string Type ()
 returns the string type name of this object. More...
 
virtual void Type (std::string strValue)
 Sets the class type for this object. More...
 
virtual void VisualSelectionModeChanged (int iNewMode)
 Visual selection mode changed. More...
 

Static Public Member Functions

static CsNeuronDataColumnCastToDerived (AnimatBase *lpBase)
 
- Static Public Member Functions inherited from AnimatSim::Charting::DataColumn
static DataColumnCastToDerived (AnimatBase *lpBase)
 

Protected Member Functions

virtual void FillInDeactivateData ()
 

Protected Attributes

bool m_bAddDataAtEnd
 
int m_iNeuronID
 
CsNeuronGroupm_lpNeuron
 
std::string m_strNeuronID
 
- Protected Attributes inherited from AnimatSim::Charting::DataColumn
bool m_bInitialized
 true it this chart has been initialized
 
int m_iAppendSpaces
 Determines whether how many other tabs are added after this data is written to the file.
 
int m_iColumnIndex
 
int m_iRowIndex
 
DataChartm_lpChart
 Pointer to the parent DataChart.
 
float * m_lpDataValue
 Pointer to the data variable we are collecting.
 
AnimatBasem_lpTarget
 Pointer to the target object that contains the data variable we will be collecting.
 
std::string m_strDataType
 The Data type of the variable we will be collecting. This is passed into the GetDataPointer method of the object.
 
std::string m_strTargetID
 GUID ID of the target object that contains the variable we will be collecting.
 
- Protected Attributes inherited from AnimatSim::AnimatBase
bool m_bEnabled
 Tells if this item is enabled or not. If it is not enabled then it is not run.
 
bool m_bSelected
 Tells whether the object is selected or not.
 
AnimatSim::Behavior::NeuralModulem_lpModule
 The pointer to this items parentNeuralModule. If this is not relevant for this object then this is NULL.
 
Nodem_lpNode
 The pointer to this items parent Node. If this is not relevant for this object then this is NULL.
 
Simulatorm_lpSim
 The pointer to a Simulation.
 
AnimatSim::Environment::Structurem_lpStructure
 The pointer to this items parent Structure. If this is not relevant for this object then this is NULL.
 
std::string m_strID
 The unique Id for this object.
 
std::string m_strName
 The name for this object.
 
std::string m_strType
 The type for this object. Examples are Box, Plane, Neuron, etc..
 

Detailed Description

Carlsim Data column class.

Carlsim data columns only update their data at the end of the data chart run. The data, like spike times, are stored in the various CsNeuronGroup classes from the SpikeMonitor. These run in a separate thread, so we cannot update them using the standard StepSimulation mechanism that other DataColumns use. The easiest solution was to simply make sure the other threads are paused and then update the chart data when the chart was deactivated.

Author
dcofer
Date
10/12/2014

Definition at line 22 of file CsNeuronDataColumn.h.

Constructor & Destructor Documentation

AnimatCarlSim::CsNeuronDataColumn::CsNeuronDataColumn ( )

Default constructor.

Author
dcofer
Date
10/12/2014

Definition at line 24 of file CsNeuronDataColumn.cpp.

References m_bAddDataAtEnd.

AnimatCarlSim::CsNeuronDataColumn::~CsNeuronDataColumn ( )
virtual

Destructor.

Author
dcofer
Date
10/12/2014

Definition at line 37 of file CsNeuronDataColumn.cpp.

Member Function Documentation

void AnimatCarlSim::CsNeuronDataColumn::DataType ( std::string  strType)
virtual

Sets the Data type of the variable we are collecting. This is the value passed into GetDataPointer.

Author
dcofer
Date
3/18/2011
Parameters
strTypeData Type of the data to collect.

Reimplemented from AnimatSim::Charting::DataColumn.

Definition at line 67 of file CsNeuronDataColumn.cpp.

References m_bAddDataAtEnd, AnimatSim::Charting::DataColumn::m_strDataType, and StdUtils::Std_CheckString().

+ Here is the call graph for this function:

void AnimatCarlSim::CsNeuronDataColumn::Initialize ( )
virtual

Initializes this object.

After an object is loaded in it must be initialized before it can be used. This allows the object to retrieve any pointers or setup memory that it will need during execution. Each object is responsible for initializing any of its child objects, so you simply need to call this method on the containing class to init all child objects. It also calls VerifySystemPointers to make sure that the system pointers have been setup correctly.

Author
dcofer
Date
3/1/2011

Reimplemented from AnimatSim::Charting::DataColumn.

Definition at line 118 of file CsNeuronDataColumn.cpp.

References AnimatSim::AnimatBase::ID(), and AnimatSim::Charting::DataColumn::m_lpTarget.

+ Here is the call graph for this function:

bool AnimatCarlSim::CsNeuronDataColumn::SetData ( const std::string &  strDataType,
const std::string &  strValue,
bool  bThrowError = true 
)
virtual

Set a variable based on a string data type name.

This is a generic method that can be used to set any variable in an AnimatBase object by specifying the name of the variable and a string representation of that data. The GUI uses this method to set data into variables in the simulation when the user changes them in the UI. The value string can be as simple as a float or int, or as complex as an xml packet. It is the developers responsibilty to know what type of data is needed and to process it accordingly.

Author
dcofer
Date
2/22/2011
Parameters
strDataTypestring name of the data type to set.
strValueThe string value of the data. It is up to the developer to determine what this should be. For example, in most cases it is simply a float and you just have to convert it to a float and make the appropriate mutator method call. However, it can be any type of string, including an entire xml packet. It is the developers responsibility to know how to set and process the data as required.
bThrowErrortrue to throw error if there is a problem. If false then it will not return an error, just return false.
Returns
true if it succeeds, false if it fails.

Reimplemented from AnimatSim::Charting::DataColumn.

Definition at line 89 of file CsNeuronDataColumn.cpp.

References StdUtils::Std_CheckString().

+ Here is the call graph for this function:

Member Data Documentation

bool AnimatCarlSim::CsNeuronDataColumn::m_bAddDataAtEnd
protected

The Target item is queried during initialization to see if the data type for this column needs for its data to be updated at the end when it is deactivated, or if it is okay to do it the normal way.

Definition at line 27 of file CsNeuronDataColumn.h.

Referenced by CsNeuronDataColumn(), and DataType().


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