 |
VR-Link API Documentation for HLA 1516
|
|
VR-Link API Documentation for HLA 1516
|
Instances of DtVariableDatumRecord are used to hold a single variable datum record and to provide access to its network representation. More...
Collaboration diagram for DtVariableDatumRecord:Public Member Functions | |
| DtVariableDatumRecord () | |
| default constructor | |
| virtual | ~DtVariableDatumRecord () |
| destructor | |
| DtVariableDatumRecord (const DtVariableDatumRecord &orig) | |
| copy constructor | |
| DtVariableDatumRecord & | operator= (const DtVariableDatumRecord &orig) |
| assignment operator | |
| int | operator== (const DtVariableDatumRecord &otherguy) const |
| comparison operators | |
| int | operator!= (const DtVariableDatumRecord &otherguy) const |
| virtual void | setExternalBuffer (char *bufferPtr) |
| Set the working buffer to an externally supplied buffer. | |
| virtual void | setDatumBitLength (DtU32 newDatumBitLength) |
| Set/Get the datum length in bits. | |
| virtual DtU32 | datumBitLength () const |
| virtual int | datumByteLength () const |
| Get the datum length in bytes (padded to an 8 byte boundary). | |
| virtual void | setDatumID (DtDatumParam value) |
| Set/Get the variable datum ID. | |
| virtual DtDatumParam | datumID () const |
| virtual void | setDatumValFloat64 (DtFloat64 value) |
| Set/Get datum value as a DtFloat64. | |
| virtual DtFloat64 | datumValFloat64 () const |
| virtual void | setDatumValFloat32 (DtFloat32 value) |
| Set/Get datum value as a DtFloat32. | |
| virtual DtFloat32 | datumValFloat32 () const |
| virtual void | setDatumValInt32 (DtInt32 value) |
| Set/Get datum value as a DtInt32. | |
| virtual DtInt32 | datumValInt32 () const |
| virtual void | setDatumValU32 (DtU32 value) |
| Set/Get datum value as a DtU32. | |
| virtual DtU32 | datumValU32 () const |
| virtual void | setDatumValInt16 (DtInt16 value) |
| Set/Get datum value as a DtInt16. | |
| virtual DtInt16 | datumValInt16 () const |
| virtual void | setDatumValU16 (DtU16 value) |
| Set/Get datum value as a DtU16. | |
| virtual DtU16 | datumValU16 () const |
| virtual void | setDatumValU8 (DtU8 value) |
| Set/Get datum value as a DtU8. | |
| virtual DtU8 | datumValU8 () const |
| virtual void | setDatumValByteArray (const DtU8 *setFrom) |
| Set/Get datum value as a byte array. | |
| virtual void | getDatumValByteArray (DtU8 *copyTo) const |
| virtual char * | datumValPtr () |
| Get a pointer to the datum value inside of the record. | |
| virtual const char * | constDatumValPtr () const |
| Get a const pointer to the datum value inside of the record. | |
| virtual int | networkByteLength () const |
| Get the network byte length of the entire datum record. | |
| virtual const char * | networkDataBuffer () const |
| Get a pointer to the buffer which stores the network representation of the datum record. | |
| virtual void | printData () const |
| Print the contents of the record. | |
| virtual void | printDataToStream (std::ostream &str) const |
Protected Member Functions | |
| virtual DtNetVarDatum * | netStruct () |
| Cast the buffer to a DtNetVarDatum struct. | |
| virtual const DtNetVarDatum * | constNetStruct () const |
| Cast the buffer to a const DtNetVarDatum struct. | |
| virtual void | deleteIfNoExternal () |
| Delete the internal buffer if there is no external buffer. | |
| virtual int | datumByteSize (int datumBitLength) const |
| Compute the total datum size in bytes from the datum bit length. | |
| virtual int | recordByteSize (int datumBitLength) const |
| Compute the total record size in bytes from the datum bit length. | |
Protected Attributes | |
| char * | myRecordBuffer |
| char * | myExternalBuffer |
Instances of DtVariableDatumRecord are used to hold a single variable datum record and to provide access to its network representation.
default constructor
| virtual DtVariableDatumRecord::~DtVariableDatumRecord | ( | ) | [virtual] |
destructor
| DtVariableDatumRecord::DtVariableDatumRecord | ( | const DtVariableDatumRecord & | orig | ) |
copy constructor
| virtual const char* DtVariableDatumRecord::constDatumValPtr | ( | ) | const [virtual] |
Get a const pointer to the datum value inside of the record.
| virtual const DtNetVarDatum* DtVariableDatumRecord::constNetStruct | ( | ) | const [protected, virtual] |
Cast the buffer to a const DtNetVarDatum struct.
| virtual DtU32 DtVariableDatumRecord::datumBitLength | ( | ) | const [virtual] |
| virtual int DtVariableDatumRecord::datumByteLength | ( | ) | const [virtual] |
Get the datum length in bytes (padded to an 8 byte boundary).
| virtual int DtVariableDatumRecord::datumByteSize | ( | int | datumBitLength | ) | const [protected, virtual] |
Compute the total datum size in bytes from the datum bit length.
| virtual DtDatumParam DtVariableDatumRecord::datumID | ( | ) | const [virtual] |
| virtual DtFloat32 DtVariableDatumRecord::datumValFloat32 | ( | ) | const [virtual] |
| virtual DtFloat64 DtVariableDatumRecord::datumValFloat64 | ( | ) | const [virtual] |
| virtual DtInt16 DtVariableDatumRecord::datumValInt16 | ( | ) | const [virtual] |
| virtual DtInt32 DtVariableDatumRecord::datumValInt32 | ( | ) | const [virtual] |
| virtual char* DtVariableDatumRecord::datumValPtr | ( | ) | [virtual] |
Get a pointer to the datum value inside of the record.
| virtual DtU16 DtVariableDatumRecord::datumValU16 | ( | ) | const [virtual] |
| virtual DtU32 DtVariableDatumRecord::datumValU32 | ( | ) | const [virtual] |
| virtual DtU8 DtVariableDatumRecord::datumValU8 | ( | ) | const [virtual] |
| virtual void DtVariableDatumRecord::deleteIfNoExternal | ( | ) | [protected, virtual] |
Delete the internal buffer if there is no external buffer.
| virtual void DtVariableDatumRecord::getDatumValByteArray | ( | DtU8 * | copyTo | ) | const [virtual] |
| virtual DtNetVarDatum* DtVariableDatumRecord::netStruct | ( | ) | [protected, virtual] |
Cast the buffer to a DtNetVarDatum struct.
| virtual int DtVariableDatumRecord::networkByteLength | ( | ) | const [virtual] |
Get the network byte length of the entire datum record.
| virtual const char* DtVariableDatumRecord::networkDataBuffer | ( | ) | const [virtual] |
Get a pointer to the buffer which stores the network representation of the datum record.
| int DtVariableDatumRecord::operator!= | ( | const DtVariableDatumRecord & | otherguy | ) | const |
| DtVariableDatumRecord& DtVariableDatumRecord::operator= | ( | const DtVariableDatumRecord & | orig | ) |
assignment operator
| int DtVariableDatumRecord::operator== | ( | const DtVariableDatumRecord & | otherguy | ) | const |
comparison operators
| virtual void DtVariableDatumRecord::printData | ( | ) | const [virtual] |
Print the contents of the record.
| virtual void DtVariableDatumRecord::printDataToStream | ( | std::ostream & | str | ) | const [virtual] |
| virtual int DtVariableDatumRecord::recordByteSize | ( | int | datumBitLength | ) | const [protected, virtual] |
Compute the total record size in bytes from the datum bit length.
| virtual void DtVariableDatumRecord::setDatumBitLength | ( | DtU32 | newDatumBitLength | ) | [virtual] |
Set/Get the datum length in bits.
This method will re-allocate memory if the buffer is an internal buffer.
| virtual void DtVariableDatumRecord::setDatumID | ( | DtDatumParam | value | ) | [virtual] |
Set/Get the variable datum ID.
| virtual void DtVariableDatumRecord::setDatumValByteArray | ( | const DtU8 * | setFrom | ) | [virtual] |
Set/Get datum value as a byte array.
Data is copied to and from the network data buffer according to the specified length of the record.
| virtual void DtVariableDatumRecord::setDatumValFloat32 | ( | DtFloat32 | value | ) | [virtual] |
Set/Get datum value as a DtFloat32.
Set will set the datum bit length to 32.
| virtual void DtVariableDatumRecord::setDatumValFloat64 | ( | DtFloat64 | value | ) | [virtual] |
Set/Get datum value as a DtFloat64.
Set will set the datum bit length to 64.
| virtual void DtVariableDatumRecord::setDatumValInt16 | ( | DtInt16 | value | ) | [virtual] |
Set/Get datum value as a DtInt16.
Set will set the datum bit length to 16.
| virtual void DtVariableDatumRecord::setDatumValInt32 | ( | DtInt32 | value | ) | [virtual] |
Set/Get datum value as a DtInt32.
Set will set the datum bit length to 32.
| virtual void DtVariableDatumRecord::setDatumValU16 | ( | DtU16 | value | ) | [virtual] |
Set/Get datum value as a DtU16.
Set will set the datum bit length to 16.
| virtual void DtVariableDatumRecord::setDatumValU32 | ( | DtU32 | value | ) | [virtual] |
Set/Get datum value as a DtU32.
Set will set the datum bit length to 32.
| virtual void DtVariableDatumRecord::setDatumValU8 | ( | DtU8 | value | ) | [virtual] |
Set/Get datum value as a DtU8.
Set will set the datum bit length to 8.
| virtual void DtVariableDatumRecord::setExternalBuffer | ( | char * | bufferPtr | ) | [virtual] |
Set the working buffer to an externally supplied buffer.
char* DtVariableDatumRecord::myExternalBuffer [protected] |
char* DtVariableDatumRecord::myRecordBuffer [protected] |
