VR-Link API Documentation for HLA Evolved
List of all members | Public Member Functions | Static Public Member Functions | Protected Attributes
DtLinearObjectRepository Class Reference

class DtLinearObjectRepository More...

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

Public Member Functions

 DtLinearObjectRepository ()
virtual ~DtLinearObjectRepository ()
 DtLinearObjectRepository (const DtLinearObjectRepository &orig)
DtLinearObjectRepositoryoperator= (const DtLinearObjectRepository &orig)
virtual DtStateRepositoryclone (bool copy) const
 Return a copy/empty object of the same type as this.
virtual bool setNumOfBreachLinearSegments (int newNumber)
 Set/Get the number of BreachableLinearObject Segment Records.
virtual int numOfBreachLinearSegments () const
virtual bool setBreachLinearSegment (int index, const DtBreachableSegmentRecord &record)
virtual bool breachLinearSegment (int index, DtBreachableSegmentRecord &record) const
virtual bool setNumOfBreachObjectSegments (int newNumber)
 Set/Get the number of BreachObject Segment Records.
virtual int numOfBreachObjectSegments () const
virtual bool setBreachObjectSegment (int index, const DtLinearSegmentRecord &record)
virtual bool breachObjectSegment (int index, DtLinearSegmentRecord &record) const
virtual bool setNumOfExhaustSmokeSegments (int newNumber)
 Set/Get the number of ExhaustSmokeObject Segment Records.
virtual int numOfExhaustSmokeSegments () const
virtual bool setExhaustSmokeSegment (int index, const DtExhaustSmokeRecord &record)
virtual bool exhaustSmokeSegment (int index, DtExhaustSmokeRecord &record) const
virtual bool setNumOfMinefldLaneMarkSegments (int newNumber)
 Set/Get the number of MinefieldLaneMarker Segment Records.
virtual int numOfMinefldLaneMarkSegments () const
virtual bool setMinefldLaneMarkSegment (int index, const DtMinefieldLaneMarkerRecord &record)
virtual bool minefldLaneMarkSegment (int index, DtMinefieldLaneMarkerRecord &record) const
virtual void printData () const
 Prints data to DtInfo.
virtual void printDataToStream (std::ostream &stream) const
 Prints data to the specified stream.
- Public Member Functions inherited from DtEnvironmentObjectRepository
 DtEnvironmentObjectRepository ()
virtual ~DtEnvironmentObjectRepository ()
 DtEnvironmentObjectRepository (const DtEnvironmentObjectRepository &orig)
DtEnvironmentObjectRepositoryoperator= (const DtEnvironmentObjectRepository &orig)
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
- Public Member Functions inherited from DtStateRepository
virtual ~DtStateRepository ()
 destructor
DtStateRepositoryoperator= (const DtStateRepository &orig)
 assignment operator
virtual void setGlobalId (const DtGlobalObjectDesignator &id)
 Get/Set global identifier, or name.
virtual const
DtGlobalObjectDesignator
globalId () const
virtual void setLocalId (const DtObjectId &id)
 Get/Set local identifier, or handle.
virtual const DtObjectIdlocalId () const

Static Public Member Functions

static DtLinearObjectRepositorycreate ()

Protected Attributes

int myNumOfBreachLinearSegments
DtBreachableSegmentRecordmyBreachLinearSegments
int myNumOfBreachObjectSegments
DtLinearSegmentRecordmyBreachObjectSegments
int myNumOfExhaustSmokeSegments
DtExhaustSmokeRecordmyExhaustSmokeSegments
int myNumOfMinefldLaneMarkSegments
DtMinefieldLaneMarkerRecordmyMinefldLaneMarkSegments
- Protected Attributes inherited from DtEnvironmentObjectRepository
DtEntityIdentifier myObjectId
DtGlobalObjectDesignator myReferencedObjId
DtForceType myForceId
DtSyntheticEnvironmentObjectType myObjectType
- Protected Attributes inherited from DtStateRepository
DtGlobalObjectDesignator myGlobalId
DtObjectId myLocalId

Additional Inherited Members

- Protected Member Functions inherited from DtStateRepository
 DtStateRepository ()
 Constructors are protected since this is an abstract base class.
 DtStateRepository (const DtStateRepository &orig)
 copy constructor

Detailed Description

class DtLinearObjectRepository

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 ( )
virtual DtLinearObjectRepository::~DtLinearObjectRepository ( )
virtual
DtLinearObjectRepository::DtLinearObjectRepository ( const DtLinearObjectRepository orig)

Member Function Documentation

virtual bool DtLinearObjectRepository::breachLinearSegment ( int  index,
DtBreachableSegmentRecord record 
) const
virtual
virtual bool DtLinearObjectRepository::breachObjectSegment ( int  index,
DtLinearSegmentRecord record 
) const
virtual
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

Reimplemented from DtEnvironmentObjectRepository.

virtual bool DtLinearObjectRepository::exhaustSmokeSegment ( int  index,
DtExhaustSmokeRecord record 
) const
virtual
virtual bool DtLinearObjectRepository::minefldLaneMarkSegment ( int  index,
DtMinefieldLaneMarkerRecord record 
) const
virtual
virtual int DtLinearObjectRepository::numOfBreachLinearSegments ( ) const
virtual
virtual int DtLinearObjectRepository::numOfBreachObjectSegments ( ) const
virtual
virtual int DtLinearObjectRepository::numOfExhaustSmokeSegments ( ) const
virtual
virtual int DtLinearObjectRepository::numOfMinefldLaneMarkSegments ( ) const
virtual
DtLinearObjectRepository& DtLinearObjectRepository::operator= ( const DtLinearObjectRepository orig)
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::setBreachLinearSegment ( int  index,
const DtBreachableSegmentRecord record 
)
virtual
virtual bool DtLinearObjectRepository::setBreachObjectSegment ( int  index,
const DtLinearSegmentRecord record 
)
virtual
virtual bool DtLinearObjectRepository::setExhaustSmokeSegment ( int  index,
const DtExhaustSmokeRecord record 
)
virtual
virtual bool DtLinearObjectRepository::setMinefldLaneMarkSegment ( int  index,
const DtMinefieldLaneMarkerRecord record 
)
virtual
virtual bool DtLinearObjectRepository::setNumOfBreachLinearSegments ( int  newNumber)
virtual

Set/Get the number of BreachableLinearObject Segment Records.

Set returns false if the requested number is too large. Changing this number will erase all previous data.

virtual bool DtLinearObjectRepository::setNumOfBreachObjectSegments ( int  newNumber)
virtual

Set/Get the number of BreachObject Segment Records.

Set returns false if the request number is too large. Changing this number will erase all previous data.

virtual bool DtLinearObjectRepository::setNumOfExhaustSmokeSegments ( int  newNumber)
virtual

Set/Get the number of ExhaustSmokeObject Segment Records.

Set returns false if the requested number is too large. Changing this number will erase all previous data.

virtual bool DtLinearObjectRepository::setNumOfMinefldLaneMarkSegments ( int  newNumber)
virtual

Set/Get the number of MinefieldLaneMarker Segment Records.

Set returns false if the request number is too large. Changing this number will erase all previous data.

Member Data Documentation

DtBreachableSegmentRecord* DtLinearObjectRepository::myBreachLinearSegments
protected
DtLinearSegmentRecord* DtLinearObjectRepository::myBreachObjectSegments
protected
DtExhaustSmokeRecord* DtLinearObjectRepository::myExhaustSmokeSegments
protected
DtMinefieldLaneMarkerRecord* DtLinearObjectRepository::myMinefldLaneMarkSegments
protected
int DtLinearObjectRepository::myNumOfBreachLinearSegments
protected
int DtLinearObjectRepository::myNumOfBreachObjectSegments
protected
int DtLinearObjectRepository::myNumOfExhaustSmokeSegments
protected
int DtLinearObjectRepository::myNumOfMinefldLaneMarkSegments
protected

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

Document ID: Generated on Wed Aug 14 15:35:11 EDT 2013 from SVN revision 130445
Copyright © 2005-2013 VT MÄK. All Rights Reserved (www.mak.com)