VR-Link API Documentation for HLA 1.3
 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
DtLinearObjectRepository Class Reference

Instances of DtLinearObjectRepository are used to maintain state information needed by linear object entities. More...

+ Inheritance diagram for DtLinearObjectRepository:
+ Collaboration diagram for DtLinearObjectRepository:

Public Member Functions

 DtLinearObjectRepository ()
 CTOR.
 DtLinearObjectRepository (const DtLinearObjectRepository &orig)
 Copy CTOR.
virtual ~DtLinearObjectRepository ()
 Virtual DTOR.
DtLinearObjectRepositoryoperator= (const DtLinearObjectRepository &orig)
 Assignment operator.
virtual DtStateRepositoryclone (bool copy) const
 Return a copy/empty object of the same type as this.
virtual void printData () const
 Prints data to DtInfo.
virtual void printDataToStream (std::ostream &stream) const
 Prints data to the specified stream.
Set/Get the number of Segment Records.

Set returns false if the requested number is too large.

Changing this number will erase all previous data.

virtual bool setNumSegments (int newNumber)
virtual int numSegments () const
virtual bool setSegment (int index, const DtLinearSegmentRecord &record)
virtual bool segment (int index, DtLinearSegmentRecord &record) const
- Public Member Functions inherited from DtEnvironmentObjectRepository
 DtEnvironmentObjectRepository ()
 CTOR.
 DtEnvironmentObjectRepository (const DtEnvironmentObjectRepository &orig)
 Copy CTOR.
virtual ~DtEnvironmentObjectRepository ()
 DTOR.
DtEnvironmentObjectRepositoryoperator= (const DtEnvironmentObjectRepository &orig)
 Assignment operator.
virtual void setObjectId (const DtEntityIdentifier &identifier)
 Set/Get Environment Object ID.
virtual const DtEntityIdentifierobjectId () const
virtual void setReferencedObjectId (const DtGlobalObjectDesignator &rtiObject)
 Set/Get Referenced Object ID.
virtual const
DtGlobalObjectDesignator
referencedObjectId () const
virtual void setForceId (const DtForceType value)
 Set/Get Force ID.
virtual DtForceType forceId () const
virtual void setObjectType (const DtSyntheticEnvironmentObjectType &type)
 Set/Get Object Type.
virtual const
DtSyntheticEnvironmentObjectType
objectType () const
virtual void setRequesterSimId (const DtSimulationAddress &addr)
 Set/Get Requester Simulation ID.
virtual const DtSimulationAddress requesterSimId () const
virtual void setReceivingSimId (const DtSimulationAddress &addr)
 Set/Get Receiving Simulation ID.
virtual const DtSimulationAddress receivingSimId () const
- Public Member Functions inherited from DtStateRepository
 DtStateRepository ()
 default constructor
 DtStateRepository (const DtStateRepository &orig)
 copy constructor
virtual ~DtStateRepository ()
 destructor
DtStateRepositoryoperator= (const DtStateRepository &orig)
 assignment operator
virtual void setGlobalId (const DtString &id)
 Get/Set global identifier, or name.
virtual const DtStringglobalId () const
virtual void setLocalId (const DtObjectId &id)
 Get/Set local identifier, or handle.
virtual const DtObjectIdlocalId () const
virtual bool publishesAttribute (const RTI::AttributeHandle &val) const
 Returns true if the attribute is published.
virtual void setAttributeByHandle (const RTI::AttributeHandle &attrHdl, const char *attrValue, unsigned size)
 Set the attribute with the given handle.
virtual const char * getAttributeByHandle (const RTI::AttributeHandle &attrHdl, unsigned &size) const
 Get a pointer to attribute value for the attribute with the given handle.
virtual void setAttributeByName (const DtString &attrName, const char *attrValue, unsigned size, DtHlaObject *hlaObj)
 Set the attribute with the given name. Note that in order to do this you must provide a DtHlaObject.
virtual const char * getAttributeByName (const DtString &attrName, unsigned &size, DtHlaObject *hlaObj) const
 Get a pointer to attribute value for the attribute with the given name.
virtual const char * getAttributeByHandleIfUpdated (const RTI::AttributeHandle &attrHdl, unsigned &size) const
 Get a pointer to attribute value for the attribute with the given handle, but only if it's been updated since the last time we read it.

Static Public Member Functions

static DtLinearObjectRepositorycreate ()
 Static creation method.

Protected Attributes

int myNumSegments
DtLinearSegmentRecordmySegments
- Protected Attributes inherited from DtEnvironmentObjectRepository
DtEntityIdentifier myObjectId
DtGlobalObjectDesignator myReferencedObjId
DtU16 myUpdateNumber
DtForceType myForceId
DtSyntheticEnvironmentObjectType myObjectType
DtSimulationAddress myRequesterSimId
DtSimulationAddress myReceivingSimId

Additional Inherited Members

- Public Attributes inherited from DtStateRepository
DtString myGlobalId
DtObjectId myLocalId
std::map< RTI::AttributeHandle,
DtGenericAttributeInfo * > 
myAttributesByHandle
 Attributes by handle.

Detailed Description

Instances of DtLinearObjectRepository are used to maintain state information needed by linear object entities.

The states of BreachableLinearObjects, BreachObjects, ExhaustSmokeObjects, and MinefieldLaneMarkerObjects are all maintained within this class. In order to publish a specific type of object, the object type needs to be set to that of the object to be published. That specific object will then be published and updated.

One Object Repository is used for all types of linear objects, since there is one PDU that is used for all types of linear object

The type of Linear Object published depends on the object type Object type: Exhaust Smoke – Domain = 0 (other), Kind = 5 (tactical smoke) Category = 1 Minefield Lane Marker – Domain = 1 (land), Kind = 6 (obstacle), Category = 1 Breach Object – Domain = 1 (land), Kind = 7 (obstacle breach), Category = 1 Breachable Linear Object – Couldn't figure out Object type... currently not implemented in the mapper Any object types not specified will be published as OtherLinearObjects

Constructor & Destructor Documentation

DtLinearObjectRepository::DtLinearObjectRepository ( )

CTOR.

DtLinearObjectRepository::DtLinearObjectRepository ( const DtLinearObjectRepository orig)

Copy CTOR.

virtual DtLinearObjectRepository::~DtLinearObjectRepository ( )
virtual

Virtual DTOR.

Member Function Documentation

virtual DtStateRepository* DtLinearObjectRepository::clone ( bool  copy) const
virtual

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

Reimplemented from DtEnvironmentObjectRepository.

static DtLinearObjectRepository* DtLinearObjectRepository::create ( )
static

Static creation method.

Reimplemented from DtEnvironmentObjectRepository.

virtual int DtLinearObjectRepository::numSegments ( ) const
virtual
DtLinearObjectRepository& DtLinearObjectRepository::operator= ( const DtLinearObjectRepository orig)

Assignment operator.

virtual void DtLinearObjectRepository::printData ( ) const
virtual

Prints data to DtInfo.

Reimplemented from DtEnvironmentObjectRepository.

virtual void DtLinearObjectRepository::printDataToStream ( std::ostream &  stream) const
virtual

Prints data to the specified stream.

Reimplemented from DtEnvironmentObjectRepository.

virtual bool DtLinearObjectRepository::segment ( int  index,
DtLinearSegmentRecord record 
) const
virtual
virtual bool DtLinearObjectRepository::setNumSegments ( int  newNumber)
virtual
virtual bool DtLinearObjectRepository::setSegment ( int  index,
const DtLinearSegmentRecord record 
)
virtual

Member Data Documentation

int DtLinearObjectRepository::myNumSegments
protected
DtLinearSegmentRecord* DtLinearObjectRepository::mySegments
protected

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

Document ID: Generated on Tue Mar 1 02:56:17 EST 2016 from SVN revision 162687
Copyright © 2005-2014 VT MÄK. All Rights Reserved (www.mak.com)