TOBI Interface A  0.1
tia::DataPacket3Impl Class Reference
+ Inheritance diagram for tia::DataPacket3Impl:
+ Collaboration diagram for tia::DataPacket3Impl:

Public Member Functions

 DataPacket3Impl ()
 Default constructor -- building an empty DataPacket.
virtual ~DataPacket3Impl ()
 Destructor.
 DataPacket3Impl (const DataPacket3Impl &src)
 Copy constructor -- does NOT copy the raw memory representation.
DataPacket3Imploperator= (const DataPacket3Impl &src)
void reset ()
 Resets the whole DataPacket (samples are deleted).
void reset (void *mem)
 Resets the whole DataPacket to be (re)build a DataPacket from raw memory.
void incPacketID ()
 Increase the static sample number by one.
void setPacketID (boost::uint64_t nr)
 Set the packet ID.
void insertDataBlock (std::vector< double > v, boost::uint32_t signal_flag, boost::uint16_t blocks, bool prepend=false)
 Insert data (only one signal type) from a hardware device into the DataPacket (will be automatically placed correct).
void setConnectionPacketNr (boost::uint64_t)
 Set the packet number (can differ from the samplenumber -- e.g. if sending with different rates)
boost::uint64_t getConnectionPacketNr ()
 Set the packet number (can differ from the samplenumber -- e.g. if sending with different rates)
void setTimestamp ()
 Set the timestamp to localtime.
boost::uint64_t getTimestamp ()
 Get the timestamp (microseconds since signal server has been started) of the datapacket.
bool hasFlag (boost::uint32_t f)
 Check, if a flag is already set.
boost::uint16_t getNrOfSignalTypes ()
 Get the number of signal types stored in the DataPacket.
boost::uint32_t getFlags ()
 Get the flags (including packetversion) of the DataPacket.
boost::uint64_t getPacketID ()
 Get the sample number of the DataPacket.
virtual std::vector
< boost::uint16_t > 
getNrOfSamples ()
 TODO.
std::vector< boost::uint16_t > getNrSamplesPerChannel ()
 Get a vector containing the blocksizes for every signal type.
std::vector< boost::uint16_t > getNrOfChannels ()
 Get a vector containing the number of values (NOT channels!) for every signal type.
boost::uint16_t getNrOfSamples (boost::uint32_t flag)
 TODO.
boost::uint16_t getNrSamplesPerChannel (boost::uint32_t flag)
 Get the number of blocks for a specific signal type.
boost::uint16_t getNrOfChannels (boost::uint32_t flag)
 Get the number of values for a specific signal type.
const std::vector< double > & getData ()
 Get all samples stored in the DataPacket as a vector.
std::vector< double > getSingleDataBlock (boost::uint32_t flag)
 Get a vector containing all samples for a specific signal type.
void * getRaw ()
 Get a pointer to a memory region, containing the raw representation of the DataPacket.
boost::uint32_t getRawMemorySize ()
 Get the size (in bytes) of the raw memory region holding the raw DataPacket.
boost::uint32_t getRequiredRawMemorySize ()
 Get the required size (in bytes) to hold a given raw DataPacket.
boost::uint32_t getRequiredRawMemorySize (void *mem, boost::uint32_t bytes_available)
 Get the required size (in bytes) to hold raw DataPacket stored in RAW memory. This function can be used to check, wether a memory region is able to hold a whole DataPacket by analyzing its header. If the RAW memory Region is too small to hold the DataPacket, 0 is returned.

Detailed Description

Definition at line 75 of file data_packet_3_impl.h.


The documentation for this class was generated from the following files:
 All Data Structures Files Functions Variables Typedefs Enumerations