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

Instances of DtArealObjectRepository are used to maintain state information needed by areal object entities. More...

+ Inheritance diagram for DtArealObjectRepository:
+ Collaboration diagram for DtArealObjectRepository:

Public Member Functions

 DtArealObjectRepository ()
virtual ~DtArealObjectRepository ()
 DtArealObjectRepository (const DtArealObjectRepository &orig)
DtArealObjectRepositoryoperator= (const DtArealObjectRepository &orig)
virtual DtStateRepositoryclone (bool copy) const
 Return a copy/empty object of the same type as this.
virtual bool setNumberOfPoints (int newNumberOfPoints)
 Set/Get the number of points.
virtual int numberOfPoints () const
virtual bool setPointLocation (int index, const DtVector &point)
 Set/Get a point location.
virtual bool getPointLocation (int index, DtVector &point) const
virtual void setPercentComplete (const DtU32 percent)
 Set/Get Percent Complete.
virtual DtU32 percentComplete () const
virtual void setDamagedAppearance (const DtDamageState damage)
 Set/Get Damaged Appearance.
virtual DtDamageState damagedAppearance () const
virtual void setObjectPreDistributed (bool predistributed)
 Set/Get Object Predistributed.
virtual bool objectPreDistributed () const
virtual void setDeactivated (bool onOff)
 Set/Get Deactivated.
virtual bool deactivated () const
virtual void setSmoking (bool onOff)
 Set/Get Smoking.
virtual bool smoking () const
virtual void setFlaming (bool onOff)
 Set/Get Flaming.
virtual bool flaming () const
virtual void setBreachedStatus (const DtBreachedStatus status)
 Set/Get Breached Status.
virtual DtBreachedStatus breachedStatus () const
virtual void setMineCount (const DtU32 numMines)
 Set/Get Mine Count.
virtual DtU32 mineCount () 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 DtArealObjectRepositorycreate ()

Protected Attributes

int myNumberOfPoints
DtVectormyPoints
DtU32 myPercentComplete
DtDamageState myDamagedAppearance
bool myObjectPreDistributed
bool myDeactivated
bool mySmoking
bool myFlaming
DtBreachedStatus myBreachedStatus
DtU32 myMineCount
- 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

Instances of DtArealObjectRepository are used to maintain state information needed by areal object entities.

The type of areal object published depends on the object type specified: Object Types: MinefieldObject – Domain = 0 (other), Kind = 1 (obstacle), Category = 1

Object of types not specified will be published as OtherArealObjects

Constructor & Destructor Documentation

DtArealObjectRepository::DtArealObjectRepository ( )
virtual DtArealObjectRepository::~DtArealObjectRepository ( )
virtual
DtArealObjectRepository::DtArealObjectRepository ( const DtArealObjectRepository orig)

Member Function Documentation

virtual DtBreachedStatus DtArealObjectRepository::breachedStatus ( ) const
virtual
virtual DtStateRepository* DtArealObjectRepository::clone ( bool  copy) const
virtual

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

Reimplemented from DtEnvironmentObjectRepository.

static DtArealObjectRepository* DtArealObjectRepository::create ( )
static

Reimplemented from DtEnvironmentObjectRepository.

virtual DtDamageState DtArealObjectRepository::damagedAppearance ( ) const
virtual
virtual bool DtArealObjectRepository::deactivated ( ) const
virtual
virtual bool DtArealObjectRepository::flaming ( ) const
virtual
virtual bool DtArealObjectRepository::getPointLocation ( int  index,
DtVector point 
) const
virtual
virtual DtU32 DtArealObjectRepository::mineCount ( ) const
virtual
virtual int DtArealObjectRepository::numberOfPoints ( ) const
virtual
virtual bool DtArealObjectRepository::objectPreDistributed ( ) const
virtual
DtArealObjectRepository& DtArealObjectRepository::operator= ( const DtArealObjectRepository orig)
virtual DtU32 DtArealObjectRepository::percentComplete ( ) const
virtual
virtual void DtArealObjectRepository::printData ( ) const
virtual

Prints data to DtInfo.

Reimplemented from DtEnvironmentObjectRepository.

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

Prints data to the specified stream.

Reimplemented from DtEnvironmentObjectRepository.

virtual void DtArealObjectRepository::setBreachedStatus ( const DtBreachedStatus  status)
virtual

Set/Get Breached Status.

virtual void DtArealObjectRepository::setDamagedAppearance ( const DtDamageState  damage)
virtual

Set/Get Damaged Appearance.

virtual void DtArealObjectRepository::setDeactivated ( bool  onOff)
virtual

Set/Get Deactivated.

virtual void DtArealObjectRepository::setFlaming ( bool  onOff)
virtual

Set/Get Flaming.

virtual void DtArealObjectRepository::setMineCount ( const DtU32  numMines)
virtual

Set/Get Mine Count.

virtual bool DtArealObjectRepository::setNumberOfPoints ( int  newNumberOfPoints)
virtual

Set/Get the number of points.

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

virtual void DtArealObjectRepository::setObjectPreDistributed ( bool  predistributed)
virtual

Set/Get Object Predistributed.

virtual void DtArealObjectRepository::setPercentComplete ( const DtU32  percent)
virtual

Set/Get Percent Complete.

virtual bool DtArealObjectRepository::setPointLocation ( int  index,
const DtVector point 
)
virtual

Set/Get a point location.

Returns false if the index is invalid.

virtual void DtArealObjectRepository::setSmoking ( bool  onOff)
virtual

Set/Get Smoking.

virtual bool DtArealObjectRepository::smoking ( ) const
virtual

Member Data Documentation

DtBreachedStatus DtArealObjectRepository::myBreachedStatus
protected
DtDamageState DtArealObjectRepository::myDamagedAppearance
protected
bool DtArealObjectRepository::myDeactivated
protected
bool DtArealObjectRepository::myFlaming
protected
DtU32 DtArealObjectRepository::myMineCount
protected
int DtArealObjectRepository::myNumberOfPoints
protected
bool DtArealObjectRepository::myObjectPreDistributed
protected
DtU32 DtArealObjectRepository::myPercentComplete
protected
DtVector* DtArealObjectRepository::myPoints
protected
bool DtArealObjectRepository::mySmoking
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)