DtGlobalEnvironmentObjectRepository Class Reference

This class creates a network state repository to aid sending tactical smoke objects. More...

Inheritance diagram for DtGlobalEnvironmentObjectRepository:

Public Member Functions
	DtGlobalEnvironmentObjectRepository ()
	DtGlobalEnvironmentObjectRepository (const DtGlobalEnvironmentObjectRepository &)
virtual void	sendUpdateWhenTimeChangesBy (double)
	When the time of day changes by this amount send an update. Default is 1 second.
virtual double	updateWhenTimeChangesBy () const
Public Member Functions inherited from DtWeatherObjectRepository
	DtWeatherObjectRepository ()
	DtWeatherObjectRepository (const DtWeatherObjectRepository &)
virtual bool	sendNeeded (const DtEnvironmentProcessRepository &asSeenByRemote)
void	setClock (DtClock *clock)
DtClock *	clock () const
double	lastUpdateTime () const
void	setLastUpdateTime (DtTime t)
Public Member Functions inherited from DtControlObjectRepository
	DtControlObjectRepository ()
virtual	~DtControlObjectRepository ()
	DtControlObjectRepository (const DtControlObjectRepository &orig)
DtControlObjectRepository &	operator= (const DtControlObjectRepository &orig)
virtual const DtControlObjectKind &	kind () const
virtual void	setKind (const DtControlObjectKind &k)
virtual const DtControlObjectCategory &	category () const
virtual void	setCategory (const DtControlObjectCategory &c)
const std::vector< DtVector > &	vertexList () const
virtual void	updateExtensions ()
virtual int	compare (const DtControlObjectRepository *rhs)
virtual int	compareToMostRecent ()
virtual bool	locationsDifferent (bool updateIfDifferent)
virtual void	emptyVertexList ()
virtual void	getBoundingVolume (DtVector &location, double &radius) const
const DtGeometricDataList &	geometricRecords () const
bool	geometricRecordsChanged () const
void	clearGeometricRecordsChanged ()
virtual void	updateDataRecords ()
virtual int	numberOfSubordinates () const
virtual bool	getSubordinate (int i, DtGlobalObjectDesignator &d)
virtual const DtGlobalObjectDesignatorList &	subordinates () const
virtual DtGlobalObjectDesignatorList &	subordinates ()
virtual void	setExtendedData (const std::map< DtString, DtString > &ed)
	Sets extended data for transport via extended data records.
virtual void	setExtendedData (const DtString &key, const DtString &value)
	Gets/sets extended data.
virtual double	orientation () const
	Returns the orientation of the given environmental in radians.
virtual void	setVertices (const DtList &pnt)
virtual void	appendVertex (const DtVector &)
virtual void	setVertex (int i, const DtVector &)
virtual void	removeVertex (int i)
virtual void	setObjectType (const DtObjectType &)
virtual DtForceType	forceType () const
virtual void	setForceType (DtForceType i)
virtual int	color () const
virtual void	setColor (int)
virtual const DtString &	parent () const
virtual void	setParent (const DtString &)
virtual const DtString &	userData () const
virtual void	setUserData (const DtString &)
virtual void	setVrfObjectName (const DtString &)
virtual const DtString &	vrfObjectName ()
virtual DtAppearance	appearance () const
virtual void	setAppearance (const DtAppearance &app)
virtual void	setNumberOfSubordinates (int)
virtual void	setSubordinate (int i, const DtGlobalObjectDesignator &)
virtual const DtGlobalObjectDesignator &	hostGlobalId () const
virtual void	setHostGlobalId (const DtGlobalObjectDesignator &)
virtual void	clearHostGlobalId ()
	Sets host global id to empty string.
virtual bool	getFontInformation (DtString &font, int &fontSize) const
	Deals with font and arrow head information via the extended data.
virtual void	setFontInformation (const DtString &, int fontSize)
virtual bool	getFontColor (unsigned int &color) const
	32 bit AGBR value
virtual void	setFontColor (unsigned int color)
virtual bool	getArrowInformation (int &arrowHeadPlacement, int &arrowStyle, int &arrowSize) const
virtual void	setArrowInformation (int arrowHeadPlacement, int arrowStyle, int arrowSize)
virtual void	setBoundingSphereRadius (double)
	Routines that are used to set/get information about the bounding sphere.
virtual double	boundingSphereRadius () const
virtual void	setBoundingSphereLocation (const DtVector &)
virtual const DtVector &	boundingSphereLocation () const
bool	hasBoundingSphereRecord () const
bool	hasBoundingRectRecord () const
	Routines that are used to set/get information about the bounding rectangle.
virtual void	setBoundingExtent (const DtVector &)
const DtVector &	boundingExtent () const
virtual void	setBoundingCornerLocation (const DtVector &)
virtual const DtVector &	boundingCornerLocation () const
virtual void	setBoundingOrientation (const DtTaitBryan &)
const DtTaitBryan &	boundingOrientation () const
virtual void	setProjected (bool)
	Gets/sets additional attribute values about the environmental.
virtual bool	projected () const
virtual void	setClosedFigure (bool)
virtual bool	closedFigure () const
virtual void	setBound2D (bool)
virtual bool	bound2D () const
virtual void	setFillStyle (int)
	For those objects that support it. Note that point objects do not make use of these items.
virtual int	fillStyle () const
virtual void	setLineStyle (int)
virtual int	lineStyle () const
virtual void	setLineWidth (int)
virtual int	lineWidth () const
virtual void	setPhysicalLineHeight (double)
	Height of the line, in meters. When added to the altitude, can be considered a ceiling.
virtual double	physicalLineHeight () const
virtual void	setPhysicalLineWidth (double)
	Width of the line, in meters. Different than "lineWidth" which is more of a stylistic representation.
virtual double	physicalLineWidth () const
virtual void	setRelativeLocation (const DtVector &)
	If attached to an entity, the relative position (in body coordinatates) of this object from the origin of the attached object.
virtual const DtVector &	relativeLocation () const
virtual void	setVelocity (const DtVector &)
	Unused at this point – left for future possible expansion for movable/rotatable environmentals {
virtual const DtVector &	velocity () const
virtual void	setAcceleration (const DtVector &)
virtual const DtVector &	acceleration () const
virtual void	setDRAlogrithm (DtDeadReckonTypes)
virtual const DtDeadReckonTypes &	drAlgorithm () const
virtual void	setOffsetPoints (const std::vector< DtVector > &)
virtual const std::vector < DtVector > &	offsetPoints () const
virtual void	setCachePoints (bool)
	Set cachePoints to false to not cache the points that are set into the structure or read from the network into the myVertexList variable.
bool	cachePoints () const
virtual DtString	extendedData (const DtString &key) const
	Extended record data is a key/value pair.
const DtVrfExtendedRecordData &	extendedRecordData () const
DtVrfExtendedRecordData &	extendedRecordData ()
int	numberOfDatumRecords () const
void	setNumberOfDatumRecords (int)
Public Member Functions inherited from DtVrfExtensions
	DtVrfExtensions ()
virtual	~DtVrfExtensions ()
	DtVrfExtensions (const DtVrfExtensions &orig)
DtVrfExtensions &	operator= (const DtVrfExtensions &orig)
virtual const DtString &	name () const
virtual void	setName (const DtString &n)
virtual const DtString &	vrfObjectLabel () const
virtual void	setVrfObjectLabel (const DtString &l)
virtual const DtString &	echelonId () const
virtual void	setEchelonId (const DtString &l)
virtual const DtString &	overlayParent () const
virtual void	setOverlayParent (const DtString &l)
virtual bool	isVrfSimulated () const
virtual void	setIsVrfSimulated (bool vrf)
virtual DtU32	vrfSessionId () const
virtual void	setVrfSessionId (DtU32 id)
virtual void	setVrfMessageVersionSupported (DtU32 id)
virtual DtU32	vrfMessageVersionSupported () const
virtual const DtObjectType &	objectType () const
virtual void	setIsSubordinateOfForce (bool b)
virtual bool	isSubordinateOfForce () const
virtual int	superType () const
virtual void	setHasPlan (bool yesNo)
virtual bool	hasPlan () const
virtual void	setIsCurrentlyTasked (bool yesNo)
virtual bool	isCurrentlyTasked () const
virtual void	setRulesOfEngagement (const DtString &)
virtual const DtString &	rulesOfEngagement () const
virtual bool	setupFromVrfObjectData (const DtIfVrfObjectData &data)
virtual void	addRangeItem (const DtRangeItem &)
	Adds, removes and returns items in the range item list.
virtual void	removeRangeItem (int index)
virtual void	setRangeItems (const DtRangeItems &)
const DtRangeItems &	rangeItems () const
virtual bool	createVrfObjectDataMessage ()
virtual DtIfVrfObjectData *	vrfObjectDataMessage () const
virtual void	setIndependentlyTasked (bool yesNo)
virtual bool	independentlyTasked () const
virtual void	setUnderFire (bool yesNo)
virtual bool	underFire () const
virtual void	setExecutingPlan (bool yesNo)
virtual bool	executingPlan () const
virtual const std::map < DtString, DtString > &	extendedData () const
	Gets/sets extended data.
virtual void	setBoundingVolume (const DtVector32 &)
	Sets/gets bounding volume and bounding volume offset of an entity.
virtual const DtVector32 &	boundingVolume () const
	Sets/gets bounding volume and bounding volume offset of an entity.
virtual void	setBoundingVolumeOffset (const DtVector32 &)
	Sets/gets bounding volume and bounding volume offset of an entity.
virtual const DtVector32 &	boundingVolumeOffset () const
	Sets/gets bounding volume and bounding volume offset of an entity.

Static Public Member Functions
static DtEnvironmentProcessRepository *	create ()

Protected Member Functions
virtual bool	sendRecordsNeeded (const DtEnvironmentProcessRepository &asSeenByRemote)
virtual bool	sendTimeUpdateNeeded (DtTime dt, DtNetEnvironmentalRecord *rec, DtNetEnvironmentalRecord *recRemote)
virtual DtStateRepository *	clone (bool copy) const
Protected Member Functions inherited from DtWeatherObjectRepository
virtual bool	sendWeatherRecNeeded (DtTime dt, DtNetEnvironmentalRecord *rec, DtNetEnvironmentalRecord *recRemote)
virtual bool	sendV3WeatherRecNeeded (DtTime dt, DtNetEnvironmentalRecord *rec, DtNetEnvironmentalRecord *recRemote)
virtual bool	sendNetRecNeeded (DtNetEnvironmentalRecord *rec1, DtNetEnvironmentalRecord *rec2)
Protected Member Functions inherited from DtControlObjectRepository
virtual bool	createExtendedEnvironmentalStateRecord ()
virtual DtSimEnvironmentalObjectStateRecord *	extendedEnvironmentalStateRecord ()
virtual bool	createVrfObjectStateRecord ()
virtual DtVrfObjectDataEnvironmentalRecord *	vrfObjectStateRecord ()
virtual bool	createBoundingSphereRecord ()
virtual DtEnvironmentalBoundingSphereRecord *	boundingSphereRecord ()
virtual bool	createBoundingRectRecord ()
virtual DtEnvironmentalRectangularVolumeRecord *	boundingRectRecord ()
virtual void	setupKindFromType (const DtEntityType &type)
virtual void	getBoundingVolume (EnvGeomSpheriod *rec)
virtual void	clearGeometricRecords ()
virtual void	extensionModified ()

Protected Attributes
double	myUpdateWhenTimeChangesBy
Protected Attributes inherited from DtWeatherObjectRepository
DtClock *	myClock
DtTime	myLastUpdateTime

Additional Inherited Members
Public Types inherited from DtControlObjectRepository
typedef std::vector< DtVector >	DtCOVertexList
typedef std::vector < DtIttEnvironmentalProcessData * >	DtGeometricDataList
typedef std::map< int, DtIttSourceDataCreator >	DtIttSourceDataMap
Public Attributes inherited from DtControlObjectRepository
DtControlObjectKind	myKind
DtControlObjectCategory	myCategory
DtCOVertexList	myVertexList
DtSimEnvironmentalObjectStateRecord *	myExtEnvStateRecord
DtEnvironmentalBoundingSphereRecord *	myBoundingSphereRecord
DtVrfObjectDataEnvironmentalRecord *	myVrfObjectStateRecord
DtControlObjectRepository *	myLastCopy
DtEnvironmentalRectangularVolumeRecord *	myBoundingRectRecord
DtGeometricDataList	myGeometricRecords
bool	myGeometricRecordsChanged
bool	myNeedVrfObjectDataUpdate
bool	myCachePoints
int	myPointsSet
DtEnvironmentalProcessExtendedRecordData	myExtendedRecordData
Static Public Attributes inherited from DtControlObjectRepository
static DtIttSourceDataMap	thePuffFactory

Detailed Description

This class creates a network state repository to aid sending tactical smoke objects.

Constructor & Destructor Documentation

DtGlobalEnvironmentObjectRepository::DtGlobalEnvironmentObjectRepository

(

)

DtGlobalEnvironmentObjectRepository::DtGlobalEnvironmentObjectRepository

(

const DtGlobalEnvironmentObjectRepository &

)

Member Function Documentation

static DtEnvironmentProcessRepository* DtGlobalEnvironmentObjectRepository::create ( )

static

Reimplemented from DtWeatherObjectRepository.

virtual void DtGlobalEnvironmentObjectRepository::sendUpdateWhenTimeChangesBy ( double  )

virtual

When the time of day changes by this amount send an update. Default is 1 second.

virtual double DtGlobalEnvironmentObjectRepository::updateWhenTimeChangesBy ( ) const

virtual

virtual bool DtGlobalEnvironmentObjectRepository::sendRecordsNeeded ( const DtEnvironmentProcessRepository &  asSeenByRemote )

protectedvirtual

Reimplemented from DtWeatherObjectRepository.

virtual bool DtGlobalEnvironmentObjectRepository::sendTimeUpdateNeeded ( DtTime  dt, DtNetEnvironmentalRecord *  rec, DtNetEnvironmentalRecord *  recRemote  )

protectedvirtual

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

protectedvirtual

Reimplemented from DtWeatherObjectRepository.

Member Data Documentation

double DtGlobalEnvironmentObjectRepository::myUpdateWhenTimeChangesBy

protected

---

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

• /exports/nfedora7-1/nightly/docs/vrforcesDevelopment.vrf4-4-branch/include/vrfExtObjects/globalEnvironmentObjectRepository.h