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. More...
	DtPointObjectRepository (const DtPointObjectRepository &orig)
	Copy CTOR. More...
virtual	~DtPointObjectRepository ()
	Virtual DTOR. More...
DtPointObjectRepository &	operator= (const DtPointObjectRepository &orig)
	Assignment operator. More...
virtual DtStateRepository *	clone (bool copy) const
	Return a copy/empty object of the same type as this. More...
virtual void	setLocation (const DtVector &location)
	Set/Get Location. More...
virtual const DtVector &	location () const
virtual void	setOrientation (const DtTaitBryan &orientation)
	Set/Get Orientation. More...
virtual const DtTaitBryan &	orientation () 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 void	printData () const
	Prints data to DtInfo. More...
virtual void	printDataToStream (std::ostream &stream) const
	Prints data to the specified stream. More...
General Appearance Attributes
virtual void	setPercentComplete (DtU32 percent)
	Set/Get Percent Complete. More...
virtual DtU32	percentComplete () const
	Set/Get Percent Complete. More...
virtual void	setDamagedAppearance (DtDamageState damage)
	Set/Get Damaged Appearance. More...
virtual DtDamageState	damagedAppearance () const
	Set/Get Percent Complete. More...
virtual void	setObjectPreDistributed (bool predistributed)
	Set/Get Object Predistributed. More...
virtual bool	objectPreDistributed () const
	Set/Get Percent Complete. More...
virtual void	setDeactivated (bool onOff)
	Set/Get Deactivated. More...
virtual bool	deactivated () const
	Set/Get Percent Complete. More...
virtual void	setSmoking (bool onOff)
	Set/Get Smoking. More...
virtual bool	smoking () const
	Set/Get Percent Complete. More...
virtual void	setFlaming (bool onOff)
	Set/Get Flaming. More...
virtual bool	flaming () const
	Set/Get Percent Complete. More...
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. More...
virtual DtBreachStatus	breachedStatus () const
	Set/Get Breached Status Usable for Log Crib, Abatis, Vehicle Defilade, and Infantry Fighting Position point objects only. More...
virtual void	setPercentOpacity (DtU8 percent)
	Set/Get Percent Opacity Usable for Air Burst and Ground Burst point objects only. More...
virtual DtU8	percentOpacity () const
	Set/Get Breached Status Usable for Log Crib, Abatis, Vehicle Defilade, and Infantry Fighting Position point objects only. More...
virtual void	setCylinderSize (DtU8 size)
	Set/Get Cylinder Size Usable for Air Burst and Ground Burst point objects only. More...
virtual DtU8	cylinderSize () const
	Set/Get Breached Status Usable for Log Crib, Abatis, Vehicle Defilade, and Infantry Fighting Position point objects only. More...
virtual void	setCylinderHeight (DtU8 height)
	Set/Get Cylinder Height Usable for Air Burst and Ground Burst point objects only. More...
virtual DtU8	cylinderHeight () const
	Set/Get Breached Status Usable for Log Crib, Abatis, Vehicle Defilade, and Infantry Fighting Position point objects only. More...
virtual void	setNumberOfBursts (DtU8 number)
	Set/Get Number Of Bursts Usable for Air Burst and Ground Burst point objects only. More...
virtual DtU8	numberOfBursts () const
	Set/Get Breached Status Usable for Log Crib, Abatis, Vehicle Defilade, and Infantry Fighting Position point objects only. More...
virtual void	setChemicalContent (DtChemicalContent chem)
	Set/Get Chemical Content Usable for Air Burst and Ground Burst point objects only. More...
virtual DtChemicalContent	chemicalContent () const
	Set/Get Breached Status Usable for Log Crib, Abatis, Vehicle Defilade, and Infantry Fighting Position point objects only. More...
virtual void	setCraterSize (DtU32 size)
	Set/Get Crater Size Usable for Crater point objects only. More...
virtual DtU32	craterSize () const
	Set/Get Breached Status Usable for Log Crib, Abatis, Vehicle Defilade, and Infantry Fighting Position point objects only. More...
virtual void	setNumberOfSegments (DtU32 number)
	Set/Get Number Of Segments Usable for Ribbon Bridge point objects only. More...
virtual DtU32	numberOfSegments () const
	Set/Get Breached Status Usable for Log Crib, Abatis, Vehicle Defilade, and Infantry Fighting Position point objects only. More...
Public Member Functions inherited from DtEnvironmentObjectRepository
	DtEnvironmentObjectRepository ()
	CTOR. More...
	DtEnvironmentObjectRepository (const DtEnvironmentObjectRepository &orig)
	Copy CTOR. More...
virtual	~DtEnvironmentObjectRepository ()
	DTOR. More...
DtEnvironmentObjectRepository &	operator= (const DtEnvironmentObjectRepository &orig)
	Assignment operator. More...
virtual void	setObjectId (const DtEntityIdentifier &identifier)
	Set/Get Environment Object ID. More...
virtual const DtEntityIdentifier &	objectId () const
virtual void	setReferencedObjectId (const DtGlobalObjectDesignator &rtiObject)
	Set/Get Referenced Object ID. More...
virtual const DtGlobalObjectDesignator &	referencedObjectId () 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...
DtStateRepository &	operator= (const DtStateRepository &orig)
	assignment operator More...
virtual void	setGlobalId (const DtString &id)
	Get/Set global identifier, or name. More...
virtual const DtString &	globalId () const
virtual void	setLocalId (const DtObjectId &id)
	Get/Set local identifier, or handle. More...
virtual const DtObjectId &	localId () const
virtual bool	publishesAttribute (const RTI::AttributeHandle &val) const
	Returns true if the attribute is published. More...
virtual void	setAttributeByHandle (const RTI::AttributeHandle &attrHdl, const char *attrValue, unsigned size)
	Set the attribute with the given handle. More...
virtual const char *	getAttributeByHandle (const RTI::AttributeHandle &attrHdl, unsigned &size) const
	Get a pointer to attribute value for the attribute with the given handle. More...
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. More...
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. More...
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. 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< DtString >	stateRepositoryExtensionNames () 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 DtPointObjectRepository *	create ()
	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
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 Types inherited from DtStateRepository
typedef std::map< DtString, DtStateRepositoryExtension * >	DtStateRepositoryExtensionMap
Public Attributes inherited from DtStateRepository
DtString	myGlobalId
DtObjectId	myLocalId
std::map< RTI::AttributeHandle, DtGenericAttributeInfo * >	myAttributesByHandle
	Attributes by handle. More...
DtStateRepositoryExtensionMap	myStateRepositoryExtensionMap
Static Public Attributes inherited from DtStateRepository
static std::map< DtString, DtSrExtCreatorFnc >	theStateRepositoryExtensionCreatorMap

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.

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::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::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

DtTaitBryan DtPointObjectRepository::myOrientation

protected

DtU32 DtPointObjectRepository::mySpecificAppearance

protected

---

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

• pointObjectRepository.h