DtControlObjectRepository class extends the DtControlObjectBaseRepository to be able to handle extended attributes. More...

Inheritance diagram for DtControlObjectRepository:

[legend]

Classes
struct	PropertyDecoderInfo
struct	PropertyEncoderInfo

Public Types
typedef void(*	PropertyDecoder )(const char buffer, unsigned size, int version, void usr)
typedef void(*	PropertyEncoder )(std::vector< char > &buffer, void *usr)

Public Member Functions
	DtControlObjectRepository ()
	default constructor
virtual	~DtControlObjectRepository ()
	destructor
	DtControlObjectRepository (const DtControlObjectRepository &orig)
	copy constructor
virtual bool	isInitialized () const
	Returns true if one of the initialize() functions has been called.
DtControlObjectRepository &	operator= (const DtControlObjectRepository &orig)
	assignment operator
virtual DtStateRepository *	clone (bool copy=false) const
	Return a copy/empty object of the same type as this.
virtual int	compare (const DtControlObjectRepository *rhs)
	Compares us against the supplied state repository and returns what's changed.
virtual const DtRwProperties &	stateProperties () const
virtual const DtRwProperties &	parameterProperties () const
virtual void	setUuidString (const DtString &uuidStr)
virtual DtString	uuidString () const
	Returns a string version of the VRF UUID of this object, if it can be determined.
void	mapPropertiesToRecordTypes (const DtRwProperties *properties, std::map< unsigned, DtString > &recTypesToAttrNames)
	Maps properties to DIS record types, if configured. Called from constructors.
virtual void	updateExtensions ()
	Overridden to update property data.
virtual bool	updatePropertiesFromAttributes (bool updatesOnly=true)
	Updates properties with new data from the extended attributes.
virtual void	updateAttributesFromProperties ()
	Updates extended attributes from our properties.
virtual void	addPropertyDecoder (const DtString &propName, PropertyDecoder decoder, void *usr)
	Adds an additional property and a function that to decode it.
virtual void	addPropertyEncoder (const DtString &propName, PropertyEncoder encoder, void *usr)
	Adds an additional property and a function that to encode it.
virtual bool	createVrfObjectDataMessage ()
	Allocates myVrfObjectDataMessage, a DtIfVrfObjectData used by VR-Forces as extended VRF object data message information.
virtual void	giveOwernshipOfProperties ()
	Tells the state rep to take ownership of the state and parameter properties, giving it responsibility to delete them on destruction.
virtual DtTime	lastPropertyEncodeTime () const
	Last time properties were encoded.
virtual DtTime	lastPropertyDecodeTime () const
	Last time properties were decoded.
Initialization functions. One of these must be called to support extended attributes.
Initializes the state rep with state properties and parameter properties that have have already been initialized. This can be more efficient if you are maintaining the properties lists elsewhere and want updates to be decoded directly into those lists. Does not take ownership of these properties. They must be deleted elsewhere.
virtual void	initialize (DtRwProperties stateProps, DtRwProperties paramProps)
virtual void	initialize (const DtRwProperties &stateProps, const DtRwProperties &paramProps)
	Initializes the state rep by making a copy of the given state properties and parameter properties that have have already been initialized.
virtual void	initialize ()
	Initializes the state rep without any state or parameter properties.

virtual bool	sensorsKilled () const
	Functions for accessing the sensors killed state.
virtual void	setSensorsKilled (bool killed)

virtual void	addPropertyUpdatedCallback (DtNoArgumentCallbackList::DtCallbackFunctionType fcn, void *usrData)
	Callbacks invoked just after state and parameter properties have been updated when the parameter or state properties have been updated.
virtual void	removePropertyUpdatedCallback (DtNoArgumentCallbackList::DtCallbackFunctionType fcn, void *usrData)
Public Member Functions inherited from makVrfVrlinkExtToolkit::DtStateRepositoryWithExtendedAttributes< DtControlObjectBaseRepository >
	DtStateRepositoryWithExtendedAttributes ()
	Constructor.
	DtStateRepositoryWithExtendedAttributes (const DtStateRepositoryWithExtendedAttributes< DtControlObjectBaseRepository > &orig)
	Copy Constructor.
	DtStateRepositoryWithExtendedAttributes ()
	Constructor.
	DtStateRepositoryWithExtendedAttributes (const DtStateRepositoryWithExtendedAttributes< DtControlObjectBaseRepository > &orig)
	Copy Constructor.
virtual	~DtStateRepositoryWithExtendedAttributes ()
	Destructor.
virtual	~DtStateRepositoryWithExtendedAttributes ()
	Destructor.
DtStateRepositoryWithExtendedAttributes < DtControlObjectBaseRepository > &	operator= (const DtStateRepositoryWithExtendedAttributes< DtControlObjectBaseRepository > &orig)
	Assignment Operator.
DtStateRepositoryWithExtendedAttributes < DtControlObjectBaseRepository > &	operator= (const DtStateRepositoryWithExtendedAttributes< DtControlObjectBaseRepository > &orig)
	Assignment Operator.
virtual void	setAttributeByName (const DtString &attrName, const char *attrValue, unsigned size)
	Set the attribute with the given name.
virtual void	setAttributeByName (const DtString &attrName, const char *attrValue, unsigned size)
	Set the attribute with the given name.
virtual const char *	getAttributeByName (const DtString &attrName, unsigned &size, bool markAsRead=true) const
	Get a pointer to attribute value for the attribute with the given name.
virtual const char *	getAttributeByName (const DtString &attrName, unsigned &size) const
	Get a pointer to attribute value for the attribute with the given name.
virtual const char *	getAttributeByNameIfUpdated (const DtString &attrName, unsigned &size) const
	Get a pointer to attribute value for the attribute with the given name, but only if it's been updated since the last time we read it.
virtual const char *	getAttributeByNameIfUpdated (const DtString &attrName, unsigned &size) const
	Get a pointer to attribute value for the attribute with the given name, but only if it's been updated since the last time we read it.
virtual void	getAttributeNames (std::list< DtString > &attrNames) const
	Populates a list of all extended attribute names.
virtual void	getAttributeNames (std::list< DtString > &attrNames) const
	Populates a list of all extended attribute names.
virtual void	setRecordTypeAttributeNameMapping (const std::map< unsigned, DtString > &mapping)
	Sets the mapping between record types and attribute names.
virtual void	addRecordTypeAttributeNameMapping (unsigned recordType, const DtString &attrName)
	Adds a mapping between record type and attribute name.
virtual void	setObjectClassHandle (const RTI::ObjectClassHandle &objClassHdl)
	Sets the object class handle for the published/reflected object.
virtual void	printData () const
	Print data to the DtInfo stream.
virtual void	printDataToStream (std::ostream &stream) const
	Print data to the specified stream.
virtual void	setAttributeByHandle (const RTI::AttributeHandle &attrHdl, const char *attrValue, unsigned size)
	Set the attribute with the given handle.
virtual const char *	getAttributeByHandle (const RTI::AttributeHandle &attrHdl, unsigned &size) const
	Get a pointer to attribute value for the attribute with the given handle.
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.
virtual const DtAttributesByNameMap &	attributesByName () const
	Returns the mapping of all attributes by name.
virtual const DtAttributesByHandleMap &	attributesByHandle () const
	Returns the mapping of all attributes by handle.
virtual void	setAttributeRecords (const std::vector< DtStandardVariableRecord * > &records)
	Overridden to handle the saved attribute indices.
virtual void	setAttributeRecords (const std::vector< DtStandardVariableRecord * > &records, const DtSimulationAddress &address)
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 ()
Public Member Functions inherited from DtControlObjectBaseRepository
	DtControlObjectBaseRepository ()
	default constructor
virtual	~DtControlObjectBaseRepository ()
	destructor
	DtControlObjectBaseRepository (const DtControlObjectBaseRepository &orig)
	copy constructor
DtControlObjectBaseRepository &	operator= (const DtControlObjectBaseRepository &orig)
	assignment operator
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 int	compare (const DtControlObjectBaseRepository *rhs)
	Compares us against the supplied state repository and returns what's changed.
virtual int	compareToMostRecent ()
	Returns what has changed since the last time we called compare.
virtual bool	locationsDifferent (bool updateIfDifferent)
	Returns true if our stashed location is different than our current location.
virtual void	emptyVertexList ()
virtual void	getBoundingVolume (DtVector &location, double &radius) const
const DtGeometricDataList &	geometricRecords () const
bool	geometricRecordsChanged () const
void	clearGeometricRecordsChanged ()
virtual void	updateDataRecords ()
	If myNeedVrfObjectDataUpdate is true, update the vrf object data record.
virtual int	numberOfSubordinates () const
	Subordinate information. Not currently used by VRF.
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)
virtual double	orientation () const
	Returns the orientation of the given environmental in radians.
virtual void	setVertices (const DtList &pnt)
	Sets the vertices to use in the publication of this object.
virtual void	appendVertex (const DtVector &)
virtual void	setVertex (int i, const DtVector &)
virtual void	removeVertex (int i)
virtual void	setObjectType (const DtObjectType &)
	Environmental record settings.
virtual DtForceType	forceType () const
	Returns the force type from the environmental header record (if it exists), else returns neutral by default.
virtual void	setForceType (DtForceType i)
virtual int	color () const
	Returns the color (rgb) value of this object.
virtual void	setColor (int)
virtual const DtString &	parent () const
	Returns the parent of this object.
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
	Returns the parent this object might be attached to.
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 &)
	Sets/gets the bounding sphere location.
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)
virtual void	setSendVrfObjectDataRecord (bool shouldSend)
	Whether a separate VrfObjectData record should be sent to convey additional VRF object information.
virtual bool	shouldSendVrfObjectDataRecord () const
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 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
virtual void	setBoundingVolume (const DtVector32 &)
	Sets/gets bounding volume and bounding volume offset of an entity.
virtual const DtVector32 &	boundingVolume () const
virtual void	setBoundingVolumeOffset (const DtVector32 &)
virtual const DtVector32 &	boundingVolumeOffset () const

Static Public Member Functions
static DtEnvironmentProcessRepository *	create ()
	Create a new state repository.
Static Public Member Functions inherited from makVrfVrlinkExtToolkit::DtStateRepositoryWithExtendedAttributes< DtControlObjectBaseRepository >
static void	setAttributeNameToHandleMap (const RTI::ObjectClassHandle &classHdl, const DtAttributeNameToHandleMap &attrNameToHdl)
	Set the attribute name to handle mapping.
static const DtAttributeNameToHandleMap &	attributeNameToHandleMap (const RTI::ObjectClassHandle &classHdl)
	Get the attribute name to handle mapping.
Static Public Member Functions inherited from DtControlObjectBaseRepository
static void	initializePuffFactory ()
	Adds mappings between environmental record types and the type of information to read off of the network into local environmental data structures.
static void	addToPuffFactory (int iRecordType, DtIttSourceDataCreator fcn)
static DtIttSourceData *	createPuffRecord (DtNetEnvironmentalRecord geometric, DtNetEnvironmentalRecord source)
static DtIttSourceData *	createPuffRecord (DtNetEnvironmentalRecord *rec)
Static Public Member Functions inherited from DtVrfExtensions
static void	setExpectedVrfMessageVersion (DtU32 version)
	The expected VRF message version of this application.
static DtU32	expectedVrfMessageVersion ()

Protected Member Functions
virtual void	initializeVrfObjectDataProperties ()
	Initializes the state rep to handle VRF object data properties.
virtual void	encodePropertyIfNeeded (const DtSymbolString &propName, DtReaderWriter *propRw)
	Encode a particular property if an update is needed.
Protected Member Functions inherited from makVrfVrlinkExtToolkit::DtStateRepositoryWithExtendedAttributes< DtControlObjectBaseRepository >
virtual void	markRecordAsUpdated (const DtStandardVariableRecord *record, DtSimulationAddress simAddr, unsigned recIdx) const
	Marks the attribute record internally as having been updated since last checked.
virtual void	markAllRecordsAsUpdated () const
	Marks all received records as updated.
virtual unsigned	recordType (const DtString &attrName) const
	Returns the record type for the attribute with a given name.
virtual const DtString &	attributeName (unsigned recType) const
	Returns the attribute name for the attribute with the given record type.
virtual unsigned	nextVrfAttributeRecordType ()
	Returns the next VRF attribute record type to use for new attributes.
DtExtendedAttributeInfo *	cacheNameAttributeMapping (const RTI::AttributeHandle &attrHdl, const DtString &attrName) const
	Caches the mapping of attribute name to attribute info and returns the info.
Protected Member Functions inherited from DtControlObjectBaseRepository
virtual bool	createExtendedEnvironmentalStateRecord ()
	createExtendedEnvironmentalStateRecord() allocates myExtEnvStateRecord, a DtSimEnvironmentalObjectStateRecord used by VR-Forces as extended environmental process state information:
virtual DtSimEnvironmentalObjectStateRecord *	extendedEnvironmentalStateRecord ()
	extendedEnvironmentalStateRecord() returns the myExtEnvStateRecord for inspection by the caller.
virtual bool	createVrfObjectStateRecord ()
	createVrfObjectStateRecord() allocates myVrfObjectStateRecord, a DtVrfObjectDataEnvironmentalRecord used by VR-Forces as extended vrf object state information:
virtual DtVrfObjectDataEnvironmentalRecord *	vrfObjectStateRecord ()
	extendedVrfObjectStateRecord() returns the myVrfObjectStateRecord for inspection by the caller.
virtual bool	createBoundingSphereRecord ()
	createBoundingSphereRecord() allocates myBoundingSphereRecord
virtual DtEnvironmentalBoundingSphereRecord *	boundingSphereRecord ()
	boundingSphereRecord() returns the myBoundingSphereRecord for inspection by the caller.
virtual bool	createBoundingRectRecord ()
	createBoundingRectRecord() allocates myBoundingRectRecord
virtual DtEnvironmentalRectangularVolumeRecord *	boundingRectRecord ()
	boundingRectRecord() returns the myBoundingRectRecord for inspection by the caller.
virtual void	setupKindFromType (const DtEntityType &type)
	Sets up internal object kind and category from object type.
virtual void	getBoundingVolume (EnvGeomSpheriod *rec)
virtual void	clearGeometricRecords ()
virtual void	extensionModified ()
	Override to set myNeedVrfObjectDataUpdate to true.

Protected Attributes
DtRwProperties *	myStateProperties
DtRwProperties *	myParameterProperties
DtEntityType	myLastCheckedEnvType
bool	myOwnsProperties
bool	myIsInitialized
std::list< PropertyDecoderInfo >	myAdditionalDecoders
std::list< PropertyEncoderInfo >	myAdditionalEncoders
std::vector< char >	myPropertyBuffer
DtClock	myClock
DtTime	myLastEncodeTime
DtTime	myLastDecodeTime
bool	mySensorsKilled
bool	myReceivedVrfObjectDataVersion
bool	myReceivedVrfPropertyVersion
int	myPropertyVersion
DtString	myUUIDString
std::map< DtString, DtString >	myExtendedDataCache
DtRangeItems	myRangeItemsCache
DtNoArgumentCallbackList	myPropertyUpdatedCallbacks
Protected Attributes inherited from makVrfVrlinkExtToolkit::DtStateRepositoryWithExtendedAttributes< DtControlObjectBaseRepository >
std::map< DtString, AttrInfo >	myAttributeInfo
	Map of attributes to their indices within the VR-Link attribute records.
std::set< DtString >	myUpdatedAttributes
std::vector< char >	myTempBuffer
unsigned	myNextVrfAttributeRecordType
DtAttributeNameToHandleMap *	myAttributeHandlesByName
DtAttributesByHandleMap	myAttributesByHandle
	Attributes by handle.
DtAttributesByNameMap	myAttributesByName
	Attributes by name.
std::map< unsigned, DtString >	myNamesByRecordType
	Mappings between attribute names and DIS variable record types, for those attributes that have this set.
std::map< DtString, unsigned >	myRecordTypesByName

Additional Inherited Members
Public Attributes inherited from DtControlObjectBaseRepository
DtControlObjectKind	myKind
DtControlObjectCategory	myCategory
DtCOVertexList	myVertexList
	Keeps a list of all geometry point records to use to update internal model datas from.
DtSimEnvironmentalObjectStateRecord *	myExtEnvStateRecord
	DtSimEnvironmentalObjectStateRecord is a special form of DtEnvironmentalRecord, used to decode custom data that might be published from a VR-Forces back end, such as label, force type, appearance, etc.
DtEnvironmentalBoundingSphereRecord *	myBoundingSphereRecord
DtVrfObjectDataEnvironmentalRecord *	myVrfObjectStateRecord
DtControlObjectBaseRepository *	myLastCopy
DtEnvironmentalRectangularVolumeRecord *	myBoundingRectRecord
DtGeometricDataList	myGeometricRecords
bool	myGeometricRecordsChanged
bool	myNeedVrfObjectDataUpdate
bool	myCachePoints
int	myPointsSet
DtEnvironmentalProcessExtendedRecordData	myExtendedRecordData
bool	mySendVrfObjectDataRec
Static Public Attributes inherited from DtControlObjectBaseRepository
static DtIttSourceDataMap	thePuffFactory
	This information is needed for ITT puff clouds.
Static Protected Attributes inherited from makVrfVrlinkExtToolkit::DtStateRepositoryWithExtendedAttributes< DtControlObjectBaseRepository >
static std::map < RTI::ObjectClassHandle, DtAttributeNameToHandleMap >	theAttributeHandlesByName
	A map of attribute handles by name for each object class supported by this repository.

Detailed Description

DtControlObjectRepository class extends the DtControlObjectBaseRepository to be able to handle extended attributes.

Member Typedef Documentation

typedef void(* DtControlObjectRepository::PropertyDecoder)(const char *buffer, unsigned size, int version, void *usr)

typedef void(* DtControlObjectRepository::PropertyEncoder)(std::vector< char > &buffer, void *usr)

Constructor & Destructor Documentation

DtControlObjectRepository::DtControlObjectRepository ( )

default constructor

virtual DtControlObjectRepository::~DtControlObjectRepository ( )

virtual

destructor

DtControlObjectRepository::DtControlObjectRepository ( const DtControlObjectRepository & orig )

copy constructor

Member Function Documentation

virtual void DtControlObjectRepository::initialize	(	DtRwProperties *	stateProps,
		DtRwProperties *	paramProps
	)

virtual

virtual void DtControlObjectRepository::initialize	(	const DtRwProperties &	stateProps,
		const DtRwProperties &	paramProps
	)

virtual

Initializes the state rep by making a copy of the given state properties and parameter properties that have have already been initialized.

Maintains ownership of the new properties and will delete them on destruction.

virtual void DtControlObjectRepository::initialize ( )

virtual

Initializes the state rep without any state or parameter properties.

No properties will be processed unless you add a specific property encoder or decoder using addPropertyEncoder or addPropertyDecoder.

virtual bool DtControlObjectRepository::isInitialized ( ) const

virtual

Returns true if one of the initialize() functions has been called.

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

assignment operator

virtual DtStateRepository* DtControlObjectRepository::clone ( bool copy = false ) const

virtual

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

Reimplemented from makVrfVrlinkExtToolkit::DtStateRepositoryWithExtendedAttributes< DtControlObjectBaseRepository >.

Reimplemented in DtCloudLayerRepository, DtWeatherObjectRepository, and DtGlobalEnvironmentObjectRepository.

virtual int DtControlObjectRepository::compare ( const DtControlObjectRepository * rhs )

virtual

Compares us against the supplied state repository and returns what's changed.

virtual const DtRwProperties& DtControlObjectRepository::stateProperties ( ) const

inlinevirtual

References DtRwProperties::emptyProperties().

virtual const DtRwProperties& DtControlObjectRepository::parameterProperties ( ) const

inlinevirtual

References DtRwProperties::emptyProperties().

virtual void DtControlObjectRepository::setUuidString ( const DtString & uuidStr )

virtual

virtual DtString DtControlObjectRepository::uuidString ( ) const

virtual

Returns a string version of the VRF UUID of this object, if it can be determined.

VRF has multiple ways of sending the UUID. This method only works when the UUID is sent via the object's extendedData. If sent by other means, such as using state properties (which is the default in 4.6 and later), the returned string will be empty.

Reimplemented from DtControlObjectBaseRepository.

virtual bool DtControlObjectRepository::sensorsKilled ( ) const

virtual

Functions for accessing the sensors killed state.

virtual void DtControlObjectRepository::setSensorsKilled ( bool killed )

virtual

void DtControlObjectRepository::mapPropertiesToRecordTypes	(	const DtRwProperties *	properties,
		std::map< unsigned, DtString > &	recTypesToAttrNames
	)

Maps properties to DIS record types, if configured. Called from constructors.

static DtEnvironmentProcessRepository* DtControlObjectRepository::create ( )

static

Create a new state repository.

Reimplemented from makVrfVrlinkExtToolkit::DtStateRepositoryWithExtendedAttributes< DtControlObjectBaseRepository >.

Reimplemented in DtCloudLayerRepository, DtWeatherObjectRepository, and DtGlobalEnvironmentObjectRepository.

virtual void DtControlObjectRepository::updateExtensions ( )

virtual

Overridden to update property data.

Reimplemented from DtControlObjectBaseRepository.

Reimplemented in DtCloudLayerRepository.

virtual bool DtControlObjectRepository::updatePropertiesFromAttributes ( bool updatesOnly = true )

virtual

Updates properties with new data from the extended attributes.

Used to update properties after receiving an object update. If updatesOnly is true (default), only attributes updated since last property update will be processed. Returns true if any properties were updated.

virtual void DtControlObjectRepository::updateAttributesFromProperties ( )

virtual

Updates extended attributes from our properties.

Used to update attributes before publishing an object update.

virtual void DtControlObjectRepository::addPropertyDecoder	(	const DtString &	propName,
		PropertyDecoder	decoder,
		void *	usr
	)

virtual

Adds an additional property and a function that to decode it.

Can be used to extend this class to look for additional properties that are not defined in the parameter database for the entity. Is also used by default for VRF object data. Properties will be decoded in the order in which the decoders are added to the list.

virtual void DtControlObjectRepository::addPropertyEncoder	(	const DtString &	propName,
		PropertyEncoder	encoder,
		void *	usr
	)

virtual

Adds an additional property and a function that to encode it.

Can be used to extend this class to look for additional properties that are not defined in the parameter database for the entity. Is also used by default for VRF object data. Properties will be encoded in the order in which the encoders are added to the list.

virtual bool DtControlObjectRepository::createVrfObjectDataMessage ( )

virtual

Allocates myVrfObjectDataMessage, a DtIfVrfObjectData used by VR-Forces as extended VRF object data message information.

Overrides the default version to create a DtIfVrfObjectDataStateProperties, which can be more efficiently updated from state properties.

Reimplemented from DtVrfExtensions.

virtual void DtControlObjectRepository::giveOwernshipOfProperties ( )

virtual

Tells the state rep to take ownership of the state and parameter properties, giving it responsibility to delete them on destruction.

virtual DtTime DtControlObjectRepository::lastPropertyEncodeTime ( ) const

inlinevirtual

Last time properties were encoded.

virtual DtTime DtControlObjectRepository::lastPropertyDecodeTime ( ) const

inlinevirtual

Last time properties were decoded.

virtual void DtControlObjectRepository::addPropertyUpdatedCallback	(	DtNoArgumentCallbackList::DtCallbackFunctionType	fcn,
		void *	usrData
	)

virtual

Callbacks invoked just after state and parameter properties have been updated when the parameter or state properties have been updated.

virtual void DtControlObjectRepository::removePropertyUpdatedCallback	(	DtNoArgumentCallbackList::DtCallbackFunctionType	fcn,
		void *	usrData
	)

virtual

virtual void DtControlObjectRepository::initializeVrfObjectDataProperties ( )

protectedvirtual

Initializes the state rep to handle VRF object data properties.

virtual void DtControlObjectRepository::encodePropertyIfNeeded	(	const DtSymbolString &	propName,
		DtReaderWriter *	propRw
	)

protectedvirtual

Encode a particular property if an update is needed.

Member Data Documentation

DtRwProperties* DtControlObjectRepository::myStateProperties

protected

DtRwProperties* DtControlObjectRepository::myParameterProperties

protected

DtEntityType DtControlObjectRepository::myLastCheckedEnvType

protected

bool DtControlObjectRepository::myOwnsProperties

protected

bool DtControlObjectRepository::myIsInitialized

protected

std::list<PropertyDecoderInfo> DtControlObjectRepository::myAdditionalDecoders

protected

std::list<PropertyEncoderInfo> DtControlObjectRepository::myAdditionalEncoders

protected

std::vector<char> DtControlObjectRepository::myPropertyBuffer

protected

DtClock DtControlObjectRepository::myClock

protected

DtTime DtControlObjectRepository::myLastEncodeTime

protected

DtTime DtControlObjectRepository::myLastDecodeTime

protected

bool DtControlObjectRepository::mySensorsKilled

protected

bool DtControlObjectRepository::myReceivedVrfObjectDataVersion

protected

bool DtControlObjectRepository::myReceivedVrfPropertyVersion

protected

int DtControlObjectRepository::myPropertyVersion

mutableprotected

DtString DtControlObjectRepository::myUUIDString

mutableprotected

std::map<DtString, DtString> DtControlObjectRepository::myExtendedDataCache

mutableprotected

DtRangeItems DtControlObjectRepository::myRangeItemsCache

mutableprotected

DtNoArgumentCallbackList DtControlObjectRepository::myPropertyUpdatedCallbacks

protected

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

/exports/nfedora7-1/nightly/docs/vrforcesDevelopment.tot/include/vrfExtObjects/controlObjectRepository.h

Classes

Public Types

Public Member Functions

Static Public Member Functions

Protected Member Functions

Protected Attributes

Additional Inherited Members

Detailed Description

Member Typedef Documentation

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation