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
DtPointObjectRepository Class Reference

Instances of DtPointObjectRepository are used to maintain state information needed by point environment object entities. More...

+ Inheritance diagram for DtPointObjectRepository:
+ Collaboration diagram for DtPointObjectRepository:

Public Member Functions

 DtPointObjectRepository ()
 CTOR.
 DtPointObjectRepository (const DtPointObjectRepository &orig)
 Copy CTOR.
virtual ~DtPointObjectRepository ()
 Virtual DTOR.
DtPointObjectRepositoryoperator= (const DtPointObjectRepository &orig)
 Assignment operator.
virtual DtStateRepositoryclone (bool copy) const
 Return a copy/empty object of the same type as this.
virtual void setModifications (DtU8 mod)
 Set/Get Modifications.
virtual DtU8 modifications () const
virtual void setLocation (const DtVector &location)
 Set/Get Location.
virtual const DtVectorlocation () const
virtual void setOrientation (const DtTaitBryan &orientation)
 Set/Get Orientation.
virtual const DtTaitBryanorientation () const
virtual void setGeneralAppearance (DtU16 appearance)
 Set/Get General Appearance.
virtual DtU16 generalAppearance () const
virtual void setSpecificAppearance (DtU32 appearance)
 Set/Get Specific Appearance.
virtual DtU32 specificAppearance () const
virtual void setGeneralAppearanceAttribute (DtAppearAttribute attr, DtAppearAttrVal val)
 Set/Get General Appearance Attribute.
virtual DtAppearAttrVal generalAppearanceAttribute (DtAppearAttribute attr) const
virtual void setSpecificAppearanceAttribute (DtAppearAttribute attr, DtAppearAttrVal val)
 Set/Get Specific Appearance Attribute.
virtual DtU32 specificAppearanceAttribute (DtAppearAttribute attr) const
virtual void printData () const
 Prints data to DtInfo.
virtual void printDataToStream (std::ostream &stream) const
 Prints data to the specified stream.
General Appearance Attributes
virtual void setPercentComplete (DtU32 percent)
 Set/Get Percent Complete.
virtual DtU32 percentComplete () const
 Set/Get Percent Complete.
virtual void setDamagedAppearance (DtDamageState damage)
 Set/Get Damaged Appearance.
virtual DtDamageState damagedAppearance () const
 Set/Get Percent Complete.
virtual void setObjectPreDistributed (bool predistributed)
 Set/Get Object Predistributed.
virtual bool objectPreDistributed () const
 Set/Get Percent Complete.
virtual void setDeactivated (bool onOff)
 Set/Get Deactivated.
virtual bool deactivated () const
 Set/Get Percent Complete.
virtual void setSmoking (bool onOff)
 Set/Get Smoking.
virtual bool smoking () const
 Set/Get Percent Complete.
virtual void setFlaming (bool onOff)
 Set/Get Flaming.
virtual bool flaming () const
 Set/Get Percent Complete.
Specific Appearance Attributes

Note: Only the attributes valid for the specific type of point object should be used.

If the setters and getters for different types of specific point objects are called on a single repository, the appearance state can become corrupted.

virtual void setBreachedStatus (DtBreachStatus status)
 Set/Get Breached Status Usable for Log Crib, Abatis, Vehicle Defilade, and Infantry Fighting Position point objects only.
virtual DtBreachStatus breachedStatus () const
 Set/Get Breached Status Usable for Log Crib, Abatis, Vehicle Defilade, and Infantry Fighting Position point objects only.
virtual void setPercentOpacity (DtU8 percent)
 Set/Get Percent Opacity Usable for Air Burst and Ground Burst point objects only.
virtual DtU8 percentOpacity () const
 Set/Get Breached Status Usable for Log Crib, Abatis, Vehicle Defilade, and Infantry Fighting Position point objects only.
virtual void setCylinderSize (DtU8 size)
 Set/Get Cylinder Size Usable for Air Burst and Ground Burst point objects only.
virtual DtU8 cylinderSize () const
 Set/Get Breached Status Usable for Log Crib, Abatis, Vehicle Defilade, and Infantry Fighting Position point objects only.
virtual void setCylinderHeight (DtU8 height)
 Set/Get Cylinder Height Usable for Air Burst and Ground Burst point objects only.
virtual DtU8 cylinderHeight () const
 Set/Get Breached Status Usable for Log Crib, Abatis, Vehicle Defilade, and Infantry Fighting Position point objects only.
virtual void setNumberOfBursts (DtU8 number)
 Set/Get Number Of Bursts Usable for Air Burst and Ground Burst point objects only.
virtual DtU8 numberOfBursts () const
 Set/Get Breached Status Usable for Log Crib, Abatis, Vehicle Defilade, and Infantry Fighting Position point objects only.
virtual void setChemicalContent (DtChemicalContent chem)
 Set/Get Chemical Content Usable for Air Burst and Ground Burst point objects only.
virtual DtChemicalContent chemicalContent () const
 Set/Get Breached Status Usable for Log Crib, Abatis, Vehicle Defilade, and Infantry Fighting Position point objects only.
virtual void setCraterSize (DtU32 size)
 Set/Get Crater Size Usable for Crater point objects only.
virtual DtU32 craterSize () const
 Set/Get Breached Status Usable for Log Crib, Abatis, Vehicle Defilade, and Infantry Fighting Position point objects only.
virtual void setNumberOfSegments (DtU32 number)
 Set/Get Number Of Segments Usable for Ribbon Bridge point objects only.
virtual DtU32 numberOfSegments () const
 Set/Get Breached Status Usable for Log Crib, Abatis, Vehicle Defilade, and Infantry Fighting Position point objects only.
- 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 setUpdateNumber (DtU16 num)
 Set/Get Update Number.
virtual DtU16 updateNumber () 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 DtGlobalObjectDesignator &id)
 Get/Set global identifier, or name.
virtual const
DtGlobalObjectDesignator
globalId () const
virtual void setAttributeRecords (const std::vector< DtStandardVariableRecord * > &records)
 The following functions are related to the extendability part of DIS 7.
virtual const std::vector
< DtStandardVariableRecord * > 
attributeRecords (unsigned int recordType=0) const
virtual void getAttributeRecords (std::vector< DtStandardVariableRecord * > &vec, unsigned int recordType=0) const
virtual void addAttributeRecord (DtStandardVariableRecord *record)
virtual void clearAttributeRecords ()
virtual void setAttributeRecords (const std::vector< DtStandardVariableRecord * > &records, const DtSimulationAddress &address)
virtual void setSimAddr (const DtSimulationAddress &id)
 Get/Set default simulation address. Set by VR-Link for publishers (based on exercise connection)
virtual const DtSimulationAddresssimAddr () const
virtual unsigned int numberOfAttributeRecords () const

Static Public Member Functions

static DtPointObjectRepositorycreate ()
 Static creation method.

Protected Attributes

DtU8 myModifications
DtVector myLocation
DtTaitBryan myOrientation
DtU16 myGeneralAppearance
DtU32 mySpecificAppearance
- 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
DtGlobalObjectDesignator myGlobalId
DtSimulationAddress myDefaultSimulationAddress
std::map< DtSimulationAddress,
std::vector
< DtStandardVariableRecord * > > 
myRecordsMap
- Static Public Attributes inherited from DtStateRepository
static bool theAllowCoupledPdusFlag

Detailed Description

Instances of DtPointObjectRepository are used to maintain state information needed by point environment object entities.

The type of point object published depends on the object type Object Type: BreachablePointObject – Domain = 1 (land), Kind = 1 (obstacle) or 2 (prepared position), Category = 1 or 2 BurstPointObject – Domain = 0 (other), Kind = 5 (tactical smoke), Category = 1 or 2 CraterObject – Domain = 1 (land), Kind = 1 (obstacle), Category = 3 RibbonBridgeObject – Domain = 1 (land), Kind = 4 (passageway), Category = 3 StructureObject – Domain = 1 (land), Kind = 3 (cult. feature) or 4 (passageway), Category = 1 or 2 Object types not specified will be published as OtherPointObjects

Constructor & Destructor Documentation

DtPointObjectRepository::DtPointObjectRepository ( )

CTOR.

DtPointObjectRepository::DtPointObjectRepository ( const DtPointObjectRepository orig)

Copy CTOR.

virtual DtPointObjectRepository::~DtPointObjectRepository ( )
virtual

Virtual DTOR.

Member Function Documentation

virtual DtBreachStatus DtPointObjectRepository::breachedStatus ( ) const
virtual

Set/Get Breached Status Usable for Log Crib, Abatis, Vehicle Defilade, and Infantry Fighting Position point objects only.

virtual DtChemicalContent DtPointObjectRepository::chemicalContent ( ) const
virtual

Set/Get Breached Status Usable for Log Crib, Abatis, Vehicle Defilade, and Infantry Fighting Position point objects only.

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

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

Reimplemented from DtEnvironmentObjectRepository.

virtual DtU32 DtPointObjectRepository::craterSize ( ) const
virtual

Set/Get Breached Status Usable for Log Crib, Abatis, Vehicle Defilade, and Infantry Fighting Position point objects only.

static DtPointObjectRepository* DtPointObjectRepository::create ( )
static

Static creation method.

Reimplemented from DtEnvironmentObjectRepository.

virtual DtU8 DtPointObjectRepository::cylinderHeight ( ) const
virtual

Set/Get Breached Status Usable for Log Crib, Abatis, Vehicle Defilade, and Infantry Fighting Position point objects only.

virtual DtU8 DtPointObjectRepository::cylinderSize ( ) const
virtual

Set/Get Breached Status Usable for Log Crib, Abatis, Vehicle Defilade, and Infantry Fighting Position point objects only.

virtual DtDamageState DtPointObjectRepository::damagedAppearance ( ) const
virtual

Set/Get Percent Complete.

virtual bool DtPointObjectRepository::deactivated ( ) const
virtual

Set/Get Percent Complete.

virtual bool DtPointObjectRepository::flaming ( ) const
virtual

Set/Get Percent Complete.

virtual DtU16 DtPointObjectRepository::generalAppearance ( ) const
virtual
virtual DtAppearAttrVal DtPointObjectRepository::generalAppearanceAttribute ( DtAppearAttribute  attr) const
virtual
virtual const DtVector& DtPointObjectRepository::location ( ) const
virtual
virtual DtU8 DtPointObjectRepository::modifications ( ) const
virtual
virtual DtU8 DtPointObjectRepository::numberOfBursts ( ) const
virtual

Set/Get Breached Status Usable for Log Crib, Abatis, Vehicle Defilade, and Infantry Fighting Position point objects only.

virtual DtU32 DtPointObjectRepository::numberOfSegments ( ) const
virtual

Set/Get Breached Status Usable for Log Crib, Abatis, Vehicle Defilade, and Infantry Fighting Position point objects only.

virtual bool DtPointObjectRepository::objectPreDistributed ( ) const
virtual

Set/Get Percent Complete.

DtPointObjectRepository& DtPointObjectRepository::operator= ( const DtPointObjectRepository orig)

Assignment operator.

virtual const DtTaitBryan& DtPointObjectRepository::orientation ( ) const
virtual
virtual DtU32 DtPointObjectRepository::percentComplete ( ) const
virtual

Set/Get Percent Complete.

virtual DtU8 DtPointObjectRepository::percentOpacity ( ) const
virtual

Set/Get Breached Status Usable for Log Crib, Abatis, Vehicle Defilade, and Infantry Fighting Position point objects only.

virtual void DtPointObjectRepository::printData ( ) const
virtual

Prints data to DtInfo.

Reimplemented from DtEnvironmentObjectRepository.

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

Prints data to the specified stream.

Reimplemented from DtEnvironmentObjectRepository.

virtual void DtPointObjectRepository::setBreachedStatus ( DtBreachStatus  status)
virtual

Set/Get Breached Status Usable for Log Crib, Abatis, Vehicle Defilade, and Infantry Fighting Position point objects only.

virtual void DtPointObjectRepository::setChemicalContent ( DtChemicalContent  chem)
virtual

Set/Get Chemical Content Usable for Air Burst and Ground Burst point objects only.

virtual void DtPointObjectRepository::setCraterSize ( DtU32  size)
virtual

Set/Get Crater Size Usable for Crater point objects only.

virtual void DtPointObjectRepository::setCylinderHeight ( DtU8  height)
virtual

Set/Get Cylinder Height Usable for Air Burst and Ground Burst point objects only.

virtual void DtPointObjectRepository::setCylinderSize ( DtU8  size)
virtual

Set/Get Cylinder Size Usable for Air Burst and Ground Burst point objects only.

virtual void DtPointObjectRepository::setDamagedAppearance ( DtDamageState  damage)
virtual

Set/Get Damaged Appearance.

virtual void DtPointObjectRepository::setDeactivated ( bool  onOff)
virtual

Set/Get Deactivated.

virtual void DtPointObjectRepository::setFlaming ( bool  onOff)
virtual

Set/Get Flaming.

virtual void DtPointObjectRepository::setGeneralAppearance ( DtU16  appearance)
virtual

Set/Get General Appearance.

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

Set/Get General Appearance Attribute.

virtual void DtPointObjectRepository::setLocation ( const DtVector location)
virtual

Set/Get Location.

virtual void DtPointObjectRepository::setModifications ( DtU8  mod)
virtual

Set/Get Modifications.

virtual void DtPointObjectRepository::setNumberOfBursts ( DtU8  number)
virtual

Set/Get Number Of Bursts Usable for Air Burst and Ground Burst point objects only.

Note: 6-bit unsigned int (max value: 63)

virtual void DtPointObjectRepository::setNumberOfSegments ( DtU32  number)
virtual

Set/Get Number Of Segments Usable for Ribbon Bridge point objects only.

virtual void DtPointObjectRepository::setObjectPreDistributed ( bool  predistributed)
virtual

Set/Get Object Predistributed.

virtual void DtPointObjectRepository::setOrientation ( const DtTaitBryan orientation)
virtual

Set/Get Orientation.

virtual void DtPointObjectRepository::setPercentComplete ( DtU32  percent)
virtual

Set/Get Percent Complete.

virtual void DtPointObjectRepository::setPercentOpacity ( DtU8  percent)
virtual

Set/Get Percent Opacity Usable for Air Burst and Ground Burst point objects only.

virtual void DtPointObjectRepository::setSmoking ( bool  onOff)
virtual

Set/Get Smoking.

virtual void DtPointObjectRepository::setSpecificAppearance ( DtU32  appearance)
virtual

Set/Get Specific Appearance.

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

Set/Get Specific Appearance Attribute.

virtual bool DtPointObjectRepository::smoking ( ) const
virtual

Set/Get Percent Complete.

virtual DtU32 DtPointObjectRepository::specificAppearance ( ) const
virtual
virtual DtU32 DtPointObjectRepository::specificAppearanceAttribute ( DtAppearAttribute  attr) const
virtual

Member Data Documentation

DtU16 DtPointObjectRepository::myGeneralAppearance
protected
DtVector DtPointObjectRepository::myLocation
protected
DtU8 DtPointObjectRepository::myModifications
protected
DtTaitBryan DtPointObjectRepository::myOrientation
protected
DtU32 DtPointObjectRepository::mySpecificAppearance
protected

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

Document ID: Generated on Thu Feb 22 04:26:36 EST 2018 from SVN revision 186468
Copyright © 2005-2016 VT MÄK. All Rights Reserved (www.mak.com)