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...
DtArealObjectRepository &	operator= (const DtArealObjectRepository &orig)
	Assignment Operator. More...
virtual DtStateRepository *	clone (bool copy) const
	Return a copy/empty object of the same type as this. More...
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...
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 DtArealObjectRepository *	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
DtU16	myGeneralAppearance
DtU32	mySpecificAppearance
int	myNumberOfPoints
DtVector *	myPoints
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 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 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 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

int DtArealObjectRepository::myNumberOfPoints

protected

DtVector* DtArealObjectRepository::myPoints

protected

DtU32 DtArealObjectRepository::mySpecificAppearance

protected

---

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

• arealObjectRepository.h