 |
VR-Link API Documentation for HLA Evolved
|
|
VR-Link API Documentation for HLA Evolved
|
Instances of DtGriddedDataRepository are used to communicate environmental data defined on a grid. More...
Inheritance diagram for DtGriddedDataRepository: Collaboration diagram for DtGriddedDataRepository:Public Member Functions | |
| DtGriddedDataRepository () | |
| default constructor | |
| virtual | ~DtGriddedDataRepository () |
| destructor | |
| DtGriddedDataRepository (const DtGriddedDataRepository &orig) | |
| copy constructor | |
| virtual DtStateRepository * | clone (bool copy=false) const |
| Return a copy/empty object with the same type as this. | |
| DtGriddedDataRepository & | operator= (const DtGriddedDataRepository &orig) |
| Assignment operator. | |
| virtual void | setGridIdentifier (const DtEntityIdentifier &gridId) |
| Set/Get gridIdentifier. 2.0D4. | |
| virtual const DtEntityIdentifier & | gridIdentifier () const |
| virtual void | setGridID (const DtEntityIdentifier &gridId) |
| Set/Get gridId. | |
| virtual const DtEntityIdentifier & | gridID () const |
| virtual void | setFieldNumber (DtU16 num) |
| Set/Get field number. | |
| virtual DtU16 | fieldNumber () const |
| virtual void | setRecordNumber (DtU16 num) |
| Set/Get the record index number. | |
| virtual DtU16 | recordNumber () const |
| virtual void | setRecordTotal (DtU16 total) |
| Set/Get total number of records used to transmit the environmental data. | |
| virtual DtU16 | recordTotal () const |
| virtual void | setCoordSystem (DtEnvironmentDataCoordSystem sys) |
| Set/Get coordinate system. | |
| virtual DtEnvironmentDataCoordSystem | coordSystem () const |
| virtual bool | setNumGridAxes (DtU8 axes) |
| Set/Get number of grid axes. | |
| virtual DtU8 | numGridAxes () const |
| virtual void | setConstantGrid (DtEnvironmentGridType constant) |
| virtual DtEnvironmentGridType | constantGrid () const |
| virtual void | setEnvironmentType (const DtEnvironmentTypeRecord &type) |
| Set/Get environment type. | |
| virtual const DtEnvironmentTypeRecord & | environmentType () const |
| virtual void | setOrientation (const DtTaitBryan &orientation) |
| Set/Get orientation. | |
| virtual const DtTaitBryan & | orientation () const |
| virtual void | setSampleTime (int index, DtU32 time) |
| Set/Get sample time. | |
| virtual DtU32 | sampleTime (int index) const |
| virtual void | setTotalValues (DtU32 total) |
| Set/Get total values. | |
| virtual DtU32 | totalValues () const |
| virtual bool | setVectorDim (DtU8 dim) |
| Set/Get vector dimension. | |
| virtual DtU8 | vectorDim () const |
| virtual DtGridAxisType | gridAxisRecordType (int index) const |
| Get the grid axes record type for a particular record. | |
| virtual bool | setGridAxisRecord (int index, const DtGridAxisRecordFixed &init) |
| Set/Get the grid axis record type and values of record index to values specified by the initializer in the second argument. | |
| virtual bool | getGridAxisRecord (int index, DtGridAxisRecordFixed &record) const |
| virtual bool | setGridAxisRecord (int index, const DtGridAxisRecordVariable &init) |
| virtual bool | getGridAxisRecord (int index, DtGridAxisRecordVariable &record) const |
| virtual DtGridDataRecType | gridDataRecordType (int index) const |
| Get the grid data record type for a particular record. | |
| virtual bool | setGridDataRecord (int index, const DtGridDataRecordType0 &init) |
| Set/Get the grid data record type and values of record index to values specified by the initializer in the second argument. | |
| virtual bool | getGridDataRecord (int index, DtGridDataRecordType0 &record) const |
| virtual bool | setGridDataRecord (int index, const DtGridDataRecordType1 &init) |
| virtual bool | getGridDataRecord (int index, DtGridDataRecordType1 &record) const |
| virtual bool | setGridDataRecord (int index, const DtGridDataRecordType2 &init) |
| virtual bool | getGridDataRecord (int index, DtGridDataRecordType2 &record) const |
| virtual void | printData () const |
| print data contained within the repository to DtInfo | |
| virtual void | printDataToStream (std::ostream &stream) const |
| Print data to the specified stream. | |
Static Public Member Functions | |
| static DtGriddedDataRepository * | create () |
| Create a DtGriddedDataRepository. | |
Protected Attributes | |
| DtGriddedDataPdu | myPdu |
Instances of DtGriddedDataRepository are used to communicate environmental data defined on a grid.
default constructor
| virtual DtGriddedDataRepository::~DtGriddedDataRepository | ( | ) | [virtual] |
destructor
copy constructor
| virtual DtStateRepository* DtGriddedDataRepository::clone | ( | bool | copy = false | ) | const [virtual] |
Return a copy/empty object with the same type as this.
Implements DtStateRepository.
| virtual DtEnvironmentGridType DtGriddedDataRepository::constantGrid | ( | ) | const [virtual] |
| virtual DtEnvironmentDataCoordSystem DtGriddedDataRepository::coordSystem | ( | ) | const [virtual] |
| static DtGriddedDataRepository* DtGriddedDataRepository::create | ( | ) | [static] |
Create a DtGriddedDataRepository.
Caller is responsible for deletion.
| virtual const DtEnvironmentTypeRecord& DtGriddedDataRepository::environmentType | ( | ) | const [virtual] |
| virtual DtU16 DtGriddedDataRepository::fieldNumber | ( | ) | const [virtual] |
| virtual bool DtGriddedDataRepository::getGridAxisRecord | ( | int | index, |
| DtGridAxisRecordFixed & | record | ||
| ) | const [virtual] |
| virtual bool DtGriddedDataRepository::getGridAxisRecord | ( | int | index, |
| DtGridAxisRecordVariable & | record | ||
| ) | const [virtual] |
| virtual bool DtGriddedDataRepository::getGridDataRecord | ( | int | index, |
| DtGridDataRecordType0 & | record | ||
| ) | const [virtual] |
| virtual bool DtGriddedDataRepository::getGridDataRecord | ( | int | index, |
| DtGridDataRecordType1 & | record | ||
| ) | const [virtual] |
| virtual bool DtGriddedDataRepository::getGridDataRecord | ( | int | index, |
| DtGridDataRecordType2 & | record | ||
| ) | const [virtual] |
| virtual DtGridAxisType DtGriddedDataRepository::gridAxisRecordType | ( | int | index | ) | const [virtual] |
Get the grid axes record type for a particular record.
| virtual DtGridDataRecType DtGriddedDataRepository::gridDataRecordType | ( | int | index | ) | const [virtual] |
Get the grid data record type for a particular record.
| virtual const DtEntityIdentifier& DtGriddedDataRepository::gridID | ( | ) | const [virtual] |
| virtual const DtEntityIdentifier& DtGriddedDataRepository::gridIdentifier | ( | ) | const [virtual] |
| virtual DtU8 DtGriddedDataRepository::numGridAxes | ( | ) | const [virtual] |
| DtGriddedDataRepository& DtGriddedDataRepository::operator= | ( | const DtGriddedDataRepository & | orig | ) |
Assignment operator.
| virtual const DtTaitBryan& DtGriddedDataRepository::orientation | ( | ) | const [virtual] |
| virtual void DtGriddedDataRepository::printData | ( | ) | const [virtual] |
print data contained within the repository to DtInfo
Implements DtStateRepository.
| virtual void DtGriddedDataRepository::printDataToStream | ( | std::ostream & | stream | ) | const [virtual] |
Print data to the specified stream.
Reimplemented from DtStateRepository.
| virtual DtU16 DtGriddedDataRepository::recordNumber | ( | ) | const [virtual] |
| virtual DtU16 DtGriddedDataRepository::recordTotal | ( | ) | const [virtual] |
| virtual DtU32 DtGriddedDataRepository::sampleTime | ( | int | index | ) | const [virtual] |
| virtual void DtGriddedDataRepository::setConstantGrid | ( | DtEnvironmentGridType | constant | ) | [virtual] |
| virtual void DtGriddedDataRepository::setCoordSystem | ( | DtEnvironmentDataCoordSystem | sys | ) | [virtual] |
Set/Get coordinate system.
| virtual void DtGriddedDataRepository::setEnvironmentType | ( | const DtEnvironmentTypeRecord & | type | ) | [virtual] |
Set/Get environment type.
| virtual void DtGriddedDataRepository::setFieldNumber | ( | DtU16 | num | ) | [virtual] |
Set/Get field number.
| virtual bool DtGriddedDataRepository::setGridAxisRecord | ( | int | index, |
| const DtGridAxisRecordFixed & | init | ||
| ) | [virtual] |
Set/Get the grid axis record type and values of record index to values specified by the initializer in the second argument.
If index is out of bounds, or if the record type at the specified index does not match the parameter record type (for a get), then false is returned. If the space would exceed the maximum space permitted for a PDU (for a set) then false may be returned.
| virtual bool DtGriddedDataRepository::setGridAxisRecord | ( | int | index, |
| const DtGridAxisRecordVariable & | init | ||
| ) | [virtual] |
| virtual bool DtGriddedDataRepository::setGridDataRecord | ( | int | index, |
| const DtGridDataRecordType0 & | init | ||
| ) | [virtual] |
Set/Get the grid data record type and values of record index to values specified by the initializer in the second argument.
If index is out of bounds, or if the record type at the specified index does not match the parameter record type (for a get), then false is returned. If the space would exceed the maximum space permitted for a PDU (for a set) then false may be returned.
| virtual bool DtGriddedDataRepository::setGridDataRecord | ( | int | index, |
| const DtGridDataRecordType1 & | init | ||
| ) | [virtual] |
| virtual bool DtGriddedDataRepository::setGridDataRecord | ( | int | index, |
| const DtGridDataRecordType2 & | init | ||
| ) | [virtual] |
| virtual void DtGriddedDataRepository::setGridID | ( | const DtEntityIdentifier & | gridId | ) | [virtual] |
Set/Get gridId.
Deprecated, use Set/Get gridIdentifier
| virtual void DtGriddedDataRepository::setGridIdentifier | ( | const DtEntityIdentifier & | gridId | ) | [virtual] |
Set/Get gridIdentifier. 2.0D4.
| virtual bool DtGriddedDataRepository::setNumGridAxes | ( | DtU8 | axes | ) | [virtual] |
Set/Get number of grid axes.
| virtual void DtGriddedDataRepository::setOrientation | ( | const DtTaitBryan & | orientation | ) | [virtual] |
Set/Get orientation.
| virtual void DtGriddedDataRepository::setRecordNumber | ( | DtU16 | num | ) | [virtual] |
Set/Get the record index number.
| virtual void DtGriddedDataRepository::setRecordTotal | ( | DtU16 | total | ) | [virtual] |
Set/Get total number of records used to transmit the environmental data.
| virtual void DtGriddedDataRepository::setSampleTime | ( | int | index, |
| DtU32 | time | ||
| ) | [virtual] |
Set/Get sample time.
This is a 64-bit quantity. The argument index selects between the most significant 32-bit word (0) and least significant 32-bit word (1) of the complete 64-bit value.
| virtual void DtGriddedDataRepository::setTotalValues | ( | DtU32 | total | ) | [virtual] |
Set/Get total values.
| virtual bool DtGriddedDataRepository::setVectorDim | ( | DtU8 | dim | ) | [virtual] |
Set/Get vector dimension.
setVectorDim may return false if the PDU size exceeds the maximum allowable size for a PDU.
| virtual DtU32 DtGriddedDataRepository::totalValues | ( | ) | const [virtual] |
| virtual DtU8 DtGriddedDataRepository::vectorDim | ( | ) | const [virtual] |
DtGriddedDataPdu DtGriddedDataRepository::myPdu [protected] |
