VR-Link API Documentation for DIS
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Groups Pages
List of all members | Public Member Functions | Static Public Member Functions | Protected Attributes
DtGriddedDataRepository Class Reference

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 More...
 
virtual ~DtGriddedDataRepository ()
 destructor More...
 
 DtGriddedDataRepository (const DtGriddedDataRepository &orig)
 copy constructor More...
 
virtual DtStateRepositoryclone (bool copy=false) const
 Return a copy/empty object with the same type as this. More...
 
DtGriddedDataRepositoryoperator= (const DtGriddedDataRepository &orig)
 Assignment operator. More...
 
virtual void setGridIdentifier (const DtEntityIdentifier &gridId)
 Set/Get gridIdentifier. 2.0D4. More...
 
virtual const DtEntityIdentifiergridIdentifier () const
 
virtual void setGridID (const DtEntityIdentifier &gridId)
 Set/Get gridId. More...
 
virtual const DtEntityIdentifiergridID () const
 
virtual void setFieldNumber (DtU16 num)
 Set/Get field number. More...
 
virtual DtU16 fieldNumber () const
 
virtual void setRecordNumber (DtU16 num)
 Set/Get the record index number. More...
 
virtual DtU16 recordNumber () const
 
virtual void setRecordTotal (DtU16 total)
 Set/Get total number of records used to transmit the environmental data. More...
 
virtual DtU16 recordTotal () const
 
virtual void setCoordSystem (DtEnvironmentDataCoordSystem sys)
 Set/Get coordinate system. More...
 
virtual
DtEnvironmentDataCoordSystem 
coordSystem () const
 
virtual bool setNumGridAxes (DtU8 axes)
 Set/Get number of grid axes. More...
 
virtual DtU8 numGridAxes () const
 
virtual void setConstantGrid (DtEnvironmentGridType constant)
 
virtual DtEnvironmentGridType constantGrid () const
 
virtual void setEnvironmentType (const DtEnvironmentTypeRecord &type)
 Set/Get environment type. More...
 
virtual const
DtEnvironmentTypeRecord
environmentType () const
 
virtual void setOrientation (const DtTaitBryan &orientation)
 Set/Get orientation. More...
 
virtual const DtTaitBryanorientation () const
 
virtual void setSampleTime (int index, DtU32 time)
 Set/Get sample time. More...
 
virtual DtU32 sampleTime (int index) const
 
virtual void setTotalValues (DtU32 total)
 Set/Get total values. More...
 
virtual DtU32 totalValues () const
 
virtual bool setVectorDim (DtU8 dim)
 Set/Get vector dimension. More...
 
virtual DtU8 vectorDim () const
 
virtual DtGridAxisType gridAxisRecordType (int index) const
 Get the grid axes record type for a particular record. More...
 
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. More...
 
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. More...
 
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. More...
 
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 More...
 
virtual void printDataToStream (std::ostream &stream) const
 Print data to the specified stream. More...
 
- Public Member Functions inherited from DtStateRepository
 DtStateRepository ()
 default constructor More...
 
 DtStateRepository (const DtStateRepository &orig)
 copy constructor More...
 
virtual ~DtStateRepository ()
 destructor More...
 
DtStateRepositoryoperator= (const DtStateRepository &orig)
 assignment operator More...
 
virtual void setGlobalId (const DtGlobalObjectDesignator &id)
 Get/Set global identifier, or name. More...
 
virtual const
DtGlobalObjectDesignator
globalId () const
 
virtual unsigned int numberOfAttributeRecords () const
 
virtual void setAttributeRecords (const DtAttributeRecordSet &records)
 The following functions are related to the extendability part of DIS 7. More...
 
virtual void setAttributeRecords (const DtStandardVariableRecordPtrVector &records)
 Replace the attribute record set with the records in the given vector. More...
 
virtual const
DtAttributeRecordSet
attributeRecordSet () const
 Return the attribute record set. More...
 
virtual DtAttributeRecordSetattributeRecordSet ()
 Return the attribute record set. More...
 
virtual const
DtStandardVariableRecordPtrVector
attributeRecords () const
 Return the attribute records Any changes to the returned record(s) will modify the records in the recordSet. More...
 
virtual const
DtStandardVariableRecordPtrVector
attributeRecords (unsigned int recordType) const
 Return the attribute records of the given type (all records if type is 0) Any changes to the returned record(s) will modify the records in the recordSet. More...
 
virtual DtStandardVariableRecordattributeRecord (unsigned int recordType) const
 Return the (first) attribute record of the given type (first record if type is 0) Any changes to the returned record will modify the record in the recordSet. More...
 
virtual int removeAttributeRecord (unsigned int recordType, bool removeAll=true)
 Remove and discard the first record of the given record type (if there is one) or all them. More...
 
virtual
DtStandardVariableRecordPtrVector
getAttributeRecords (unsigned int recordType, DtStandardVariableRecordPtrVector &vec) const
 Get the attribute records of the given type (all if type is 0) Any changes to the returned record(s) will modify the records in the recordSet. More...
 
virtual
DtStandardVariableRecordPtrVector
getAttributeRecords (DtStandardVariableRecordPtrVector &vec) const
 Get the attribute records Any changes to the returned record(s) will modify the records in the recordSet. More...
 
virtual void addAttributeRecord (DtStandardVariableRecord *record)
 Add a clone of given record to the attribute record set. More...
 
virtual void addAttributeRecord (std::unique_ptr< DtStandardVariableRecord > record)
 Add the given record to the attribute record set. More...
 
virtual void clearAttributeRecords ()
 Clear all records. More...
 
virtual
DtStateRepositoryExtension
stateRepositoryExtension (DtString srExtName) const
 Returns pointer to a DtStateRepositoryExtension object with the given name Returns 0 if no extension with given name is found. More...
 
virtual std::vector< DtStringstateRepositoryExtensionNames () const
 Returns a set of the registered state repository extension names. More...
 
virtual void setStateRepositoryExtensions (std::map< DtString, DtStateRepositoryExtension * > extensions)
 Returns pointer to a DtStateRepositoryExtension object with the given name Returns 0 if no extension with given name is found. More...
 
virtual const std::map
< DtString,
DtStateRepositoryExtension * > 
stateRepositoryExtensions () const
 Returns pointer to a DtStateRepositoryExtension object with the given name Returns 0 if no extension with given name is found. More...
 

Static Public Member Functions

static DtGriddedDataRepositorycreate ()
 Create a DtGriddedDataRepository. More...
 
- Static Public Member Functions inherited from DtStateRepository
static bool addStateRepositoryExtension (DtString srExtName, DtSrExtCreatorFnc fnc)
 The following functions are for extending state repositories through State Repository Extension classes. More...
 

Protected Attributes

DtGriddedDataPdu myPdu
 

Additional Inherited Members

- Public Types inherited from DtStateRepository
typedef std::map< DtString,
DtStateRepositoryExtension * > 
DtStateRepositoryExtensionMap
 
- Public Attributes inherited from DtStateRepository
DtGlobalObjectDesignator myGlobalId
 
DtAttributeRecordSet myAttributeRecords
 
DtStandardVariableRecordPtrVector myReturnedRecords
 
DtStateRepositoryExtensionMap myStateRepositoryExtensionMap
 
- Static Public Attributes inherited from DtStateRepository
static std::map< DtString,
DtSrExtCreatorFnc
theStateRepositoryExtensionCreatorMap
 

Detailed Description

Instances of DtGriddedDataRepository are used to communicate environmental data defined on a grid.

Constructor & Destructor Documentation

DtGriddedDataRepository::DtGriddedDataRepository ( )

default constructor

virtual DtGriddedDataRepository::~DtGriddedDataRepository ( )
virtual

destructor

DtGriddedDataRepository::DtGriddedDataRepository ( const DtGriddedDataRepository orig)

copy constructor

Member Function Documentation

virtual DtStateRepository* DtGriddedDataRepository::clone ( bool  copy = false) const
virtual

Return a copy/empty object with the same type as this.

Reimplemented from 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

Reimplemented from 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

Member Data Documentation

DtGriddedDataPdu DtGriddedDataRepository::myPdu
protected

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

Document ID: Generated on Thu Oct 16 00:12:25 EDT 2025 from SVN revision 280738
Copyright © 1992-2025 MAK Technologies. All Rights Reserved (www.mak.com)