SimObject::ID Class Reference
Class containing all the id's necessary to uniquely identify a simulation object. More...
#include <SimObject.h>
Public Types | |
| typedef long long | Packed |
| Type for the compress / packed form of the ID. | |
| typedef shared_ptr < std::vector< Packed > > | Vector |
| Vector of packed IDs. | |
| typedef SimObjectIDSortedVector | SortedVector |
Public Member Functions | |
| ID (nodeid_t nid, engineid_t eid, object_type_t tid, local_objectid_t oid) | |
| ID (void) | |
| ID (const Packed &pid) | |
| Initialize from a packed repsesentation. | |
| bool | operator< (const ID &other) const |
| bool | isInTheSameSTEngineWith (const ID &other) const |
| Packed | packed () |
| Compress / packed form of the ID. | |
| bool | operator== (const ID &other) const |
| Compare two IDs. | |
| bool | operator!= (const ID &other) const |
| Compare two IDs. | |
| string | toString (void) const |
| Provide a readable form of the id. | |
Static Public Member Functions | |
| static SimObject::ID | makeID (const Packed &pid) |
Public Attributes | |
| local_objectid_t | localid |
| Local ID; i.e. the ID local to the simulation engine the object belongs to. | |
| nodeid_t | node |
| ID of MPI node. | |
| object_type_t | type |
| ID of object type. | |
| engineid_t | eng |
| ID of simulation engine (closely related to thread). | |
Static Public Attributes | |
| static const ID | Invalid |
| Constant of an invalid object ID. | |
Detailed Description
Class containing all the id's necessary to uniquely identify a simulation object.Definition at line 109 of file SimObject.h.
Member Typedef Documentation
| typedef long long SimObject::ID::Packed |
| typedef shared_ptr< std::vector< Packed > > SimObject::ID::Vector |
Definition at line 125 of file SimObject.h.
Constructor & Destructor Documentation
| SimObject::ID::ID | ( | nodeid_t | nid, | |
| engineid_t | eid, | |||
| object_type_t | tid, | |||
| local_objectid_t | oid | |||
| ) | [inline, explicit] |
Definition at line 119 of file SimObject.h.
| SimObject::ID::ID | ( | void | ) | [inline] |
Definition at line 123 of file SimObject.h.
| SimObject::ID::ID | ( | const Packed & | pid | ) | [inline, explicit] |
Member Function Documentation
| static SimObject::ID SimObject::ID::makeID | ( | const Packed & | pid | ) | [inline, static] |
Definition at line 135 of file SimObject.h.
Definition at line 154 of file SimObject.h.
Referenced by DistributedMultiThreadNetwork::_addSpikeMessage_().
| SimObject::ID::Packed SimObject::ID::packed | ( | ) |
| string SimObject::ID::toString | ( | void | ) | const |
Provide a readable form of the id.
Definition at line 35 of file SimObject.cpp.
References eng, localid, node, and type.
Referenced by SingleThreadNetwork::_addSpikeMessage_(), MultiThreadNetwork::_addSpikeMessage_(), DistributedNetwork::_addSpikeMessage_(), SingleThreadNetwork::_connect_(), MultiThreadNetwork::_connect_(), DistributedNetwork::_connect_(), DistributedNetwork::_insert_(), and DistributedNetwork::_mount_().
Member Data Documentation
Local ID; i.e. the ID local to the simulation engine the object belongs to.
Definition at line 161 of file SimObject.h.
Referenced by DistributedNetwork::getFirstSenderSpikePort(), SingleThreadSimEngine::one_way_link(), operator!=(), operator<(), operator==(), toString(), and SingleThreadSimEngine::two_way_link().
ID of MPI node.
Definition at line 164 of file SimObject.h.
Referenced by SingleThreadNetwork::_addObject_(), DistributedSingleThreadNetwork::_addSpikeMessage_(), DistributedMultiThreadNetwork::_addSpikeMessage_(), DistributedNetwork::_connect_(), SingleThreadNetwork::_insert_(), MultiThreadNetwork::_insert_(), DistributedNetwork::_insert_(), SingleThreadNetwork::_mount_(), MultiThreadNetwork::_mount_(), DistributedNetwork::_mount_(), DistributedSingleThreadNetwork::addGenericAnalogMessage(), DistributedMultiThreadNetwork::addGenericAnalogMessage(), DistributedAnalogMessageCreator::addIncomingAnalogMessage(), DistributedNetwork::getFirstSenderSpikePort(), isInTheSameSTEngineWith(), operator!=(), operator<(), operator==(), SimNetwork::record(), and toString().
ID of object type.
Definition at line 167 of file SimObject.h.
Referenced by DistributedNetwork::_addSpikeMessage_(), DistributedNetwork::_connect_(), MTAnalogMessageCreator::addAnalogMessage(), DistributedNetwork::getFirstSenderSpikePort(), SingleThreadSimEngine::one_way_link(), operator!=(), operator<(), operator==(), toString(), and SingleThreadSimEngine::two_way_link().
ID of simulation engine (closely related to thread).
Definition at line 170 of file SimObject.h.
Referenced by SingleThreadNetwork::_addObject_(), MultiThreadNetwork::_addSpikeMessage_(), DistributedSingleThreadNetwork::_addSpikeMessage_(), DistributedMultiThreadNetwork::_addSpikeMessage_(), SingleThreadNetwork::_insert_(), MultiThreadNetwork::_insert_(), DistributedNetwork::_insert_(), SingleThreadNetwork::_mount_(), MultiThreadNetwork::_mount_(), DistributedNetwork::_mount_(), MTAnalogMessageCreator::addAnalogMessage(), DistributedIncomingAnalogMsgDispatcher::addDelayerCycledIncomingAnalogMessage(), MultiThreadNetwork::addGenericAnalogMessage(), DistributedMultiThreadNetwork::addGenericAnalogMessage(), MultiThreadNetwork::addLocalSpikeMessage(), DistributedNetwork::getFirstSenderSpikePort(), isInTheSameSTEngineWith(), MultiThreadSimEngine::one_way_link(), operator!=(), operator<(), operator==(), SimNetwork::record(), toString(), and MultiThreadSimEngine::two_way_link().
const SimObject::ID SimObject::ID::Invalid [static] |
Constant of an invalid object ID.
Definition at line 185 of file SimObject.h.
Referenced by SingleThreadNetwork::_addObject_(), MultiThreadNetwork::_addObject_(), DistributedNetwork::_addObject_(), MultiThreadNetwork::_insert_(), DistributedNetwork::_insert_(), MultiThreadNetwork::_mount_(), DistributedNetwork::_mount_(), and ConnectionsProjection::operator()().
The documentation for this class was generated from the following files:
- /home/tnatschl/PCSIM-Sandbox/pcsim/pcsim/simcore/SimObject.h
- /home/tnatschl/PCSIM-Sandbox/pcsim/pcsim/simcore/SimObject.cpp
