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
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 ()
 Default CTOR. More...
 
 DtArealObjectRepository (const DtArealObjectRepository &orig)
 
virtual ~DtArealObjectRepository ()
 Virtual DTOR. More...
 
DtArealObjectRepositoryoperator= (const DtArealObjectRepository &orig)
 Assignment Operator. More...
 
virtual DtStateRepositoryclone (bool copy) const
 Return a copy/empty object of the same type as this. More...
 
virtual void setModifications (DtU8 mod)
 Set/Get Modifications. More...
 
virtual DtU8 modifications () const
 
virtual void setGeneralAppearance (DtU16 appearance)
 Set/Get General Appearance. More...
 
virtual DtU16 generalAppearance () const
 
virtual void setSpecificAppearance (DtU32 appearance)
 Set/Get Specific Appearance. More...
 
virtual DtU32 specificAppearance () const
 
virtual void setGeneralAppearanceAttribute (DtAppearAttribute attr, DtAppearAttrVal val)
 Set/Get General Appearance Attribute. More...
 
virtual DtAppearAttrVal generalAppearanceAttribute (DtAppearAttribute attr) const
 
virtual void setSpecificAppearanceAttribute (DtAppearAttribute attr, DtAppearAttrVal val)
 Set/Get Specific Appearance Attribute. More...
 
virtual DtU32 specificAppearanceAttribute (DtAppearAttribute attr) const
 
virtual bool setNumberOfPoints (int newNumberOfPoints)
 Set/Get the number of points. More...
 
virtual int numberOfPoints () const
 
virtual bool setPointLocation (int index, const DtVector &point)
 Set/Get a point location. More...
 
virtual bool getPointLocation (int index, DtVector &point) const
 
virtual void setPercentComplete (DtU32 percent)
 Set/Get Percent Complete. More...
 
virtual DtU32 percentComplete () const
 
virtual void setDamagedAppearance (DtDamageState damage)
 Set/Get Damaged Appearance. More...
 
virtual DtDamageState damagedAppearance () const
 
virtual void setObjectPreDistributed (bool predistributed)
 Set/Get Object Predistributed. More...
 
virtual bool objectPreDistributed () const
 
virtual void setDeactivated (bool onOff)
 Set/Get Deactivated. More...
 
virtual bool deactivated () const
 
virtual void setSmoking (bool onOff)
 Set/Get Smoking. More...
 
virtual bool smoking () const
 
virtual void setFlaming (bool onOff)
 Set/Get Flaming. More...
 
virtual bool flaming () const
 
virtual void printData () const
 Prints data to DtInfo. More...
 
virtual void printDataToStream (std::ostream &stream) const
 Prints data to the specified stream. More...
 
Minefield Object Attributes
virtual void setBreachedStatus (DtBreachStatus status)
 Set/Get Breached Status. More...
 
virtual DtBreachStatus breachedStatus () const
 Set/Get Breached Status. More...
 
virtual void setMineCount (DtU32 numMines)
 Set/Get Mine Count. More...
 
virtual DtU32 mineCount () const
 Set/Get Breached Status. More...
 
- Public Member Functions inherited from DtEnvironmentObjectRepository
 DtEnvironmentObjectRepository ()
 CTOR. More...
 
 DtEnvironmentObjectRepository (const DtEnvironmentObjectRepository &orig)
 Copy CTOR. More...
 
virtual ~DtEnvironmentObjectRepository ()
 DTOR. More...
 
DtEnvironmentObjectRepositoryoperator= (const DtEnvironmentObjectRepository &orig)
 Assignment operator. More...
 
virtual void setObjectId (const DtEntityIdentifier &identifier)
 Set/Get Environment Object ID. More...
 
virtual const DtEntityIdentifierobjectId () const
 
virtual void setReferencedObjectId (const DtGlobalObjectDesignator &rtiObject)
 Set/Get Referenced Object ID. More...
 
virtual const
DtGlobalObjectDesignator
referencedObjectId () const
 
virtual void setUpdateNumber (DtU16 num)
 Set/Get Update Number. More...
 
virtual DtU16 updateNumber () const
 
virtual void setForceId (const DtForceType value)
 Set/Get Force ID. More...
 
virtual DtForceType forceId () const
 
virtual void setObjectType (const DtSyntheticEnvironmentObjectType &type)
 Set/Get Object Type. More...
 
virtual const
DtSyntheticEnvironmentObjectType
objectType () const
 
virtual void setRequesterSimId (const DtSimulationAddress &addr)
 Set/Get Requester Simulation ID. More...
 
virtual const DtSimulationAddress requesterSimId () const
 
virtual void setReceivingSimId (const DtSimulationAddress &addr)
 Set/Get Receiving Simulation ID. More...
 
virtual const DtSimulationAddress receivingSimId () const
 
- 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::auto_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 DtArealObjectRepositorycreate ()
 Static creation method. More...
 
- Static Public Member Functions inherited from DtEnvironmentObjectRepository
static
DtEnvironmentObjectRepository
create ()
 
- 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

DtU8 myModifications
 
DtU16 myGeneralAppearance
 
DtU32 mySpecificAppearance
 
int myNumberOfPoints
 
DtVectormyPoints
 
- Protected Attributes inherited from DtEnvironmentObjectRepository
DtEntityIdentifier myObjectId
 
DtGlobalObjectDesignator myReferencedObjId
 
DtU16 myUpdateNumber
 
DtForceType myForceId
 
DtSyntheticEnvironmentObjectType myObjectType
 
DtSimulationAddress myRequesterSimId
 
DtSimulationAddress myReceivingSimId
 

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 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 ( )

Default CTOR.

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

Virtual DTOR.

Member Function Documentation

virtual DtBreachStatus DtArealObjectRepository::breachedStatus ( ) const
virtual

Set/Get Breached Status.

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

Static creation method.

virtual DtDamageState DtArealObjectRepository::damagedAppearance ( ) const
virtual
virtual bool DtArealObjectRepository::deactivated ( ) const
virtual
virtual bool DtArealObjectRepository::flaming ( ) const
virtual
virtual DtU16 DtArealObjectRepository::generalAppearance ( ) const
virtual
virtual DtAppearAttrVal DtArealObjectRepository::generalAppearanceAttribute ( DtAppearAttribute  attr) const
virtual
virtual bool DtArealObjectRepository::getPointLocation ( int  index,
DtVector point 
) const
virtual
virtual DtU32 DtArealObjectRepository::mineCount ( ) const
virtual

Set/Get Breached Status.

virtual DtU8 DtArealObjectRepository::modifications ( ) const
virtual
virtual int DtArealObjectRepository::numberOfPoints ( ) const
virtual
virtual bool DtArealObjectRepository::objectPreDistributed ( ) const
virtual
DtArealObjectRepository& DtArealObjectRepository::operator= ( const DtArealObjectRepository orig)

Assignment Operator.

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 ( DtBreachStatus  status)
virtual

Set/Get Breached Status.

virtual void DtArealObjectRepository::setDamagedAppearance ( 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::setGeneralAppearance ( DtU16  appearance)
virtual

Set/Get General Appearance.

virtual void DtArealObjectRepository::setGeneralAppearanceAttribute ( DtAppearAttribute  attr,
DtAppearAttrVal  val 
)
virtual

Set/Get General Appearance Attribute.

virtual void DtArealObjectRepository::setMineCount ( DtU32  numMines)
virtual

Set/Get Mine Count.

virtual void DtArealObjectRepository::setModifications ( DtU8  mod)
virtual

Set/Get Modifications.

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 ( 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 void DtArealObjectRepository::setSpecificAppearance ( DtU32  appearance)
virtual

Set/Get Specific Appearance.

virtual void DtArealObjectRepository::setSpecificAppearanceAttribute ( DtAppearAttribute  attr,
DtAppearAttrVal  val 
)
virtual

Set/Get Specific Appearance Attribute.

virtual bool DtArealObjectRepository::smoking ( ) const
virtual
virtual DtU32 DtArealObjectRepository::specificAppearance ( ) const
virtual
virtual DtU32 DtArealObjectRepository::specificAppearanceAttribute ( DtAppearAttribute  attr) const
virtual

Member Data Documentation

DtU16 DtArealObjectRepository::myGeneralAppearance
protected
DtU8 DtArealObjectRepository::myModifications
protected
int DtArealObjectRepository::myNumberOfPoints
protected
DtVector* DtArealObjectRepository::myPoints
protected
DtU32 DtArealObjectRepository::mySpecificAppearance
protected

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

Document ID: Generated on Tue Aug 10 00:12:31 EDT 2021 from SVN revision 232765
Copyright © 2005-2021 MAK Technologies. All Rights Reserved (www.mak.com)