DtExtEntityStateRepository class extends the DtExtEntityBaseStateRepository to be able to handle extended attributes.

Inheritance diagram for DtExtEntityStateRepository:

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
	DtExtEntityStateRepository ()

	DtExtEntityStateRepository (const DtExtEntityStateRepository &orig)

virtual	~DtExtEntityStateRepository () override

virtual bool	isInitialized () const

DtExtEntityStateRepository &	operator= (const DtExtEntityStateRepository &orig)

virtual DtStateRepository *	clone (bool copy=false) const override

virtual int	compare (const DtExtEntityStateRepository *rhs)

virtual const DtRwProperties &	stateProperties () const

virtual const DtRwProperties &	parameterProperties () const

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

virtual bool	updatePropertiesFromAttributes (bool updatesOnly=true)

virtual void	updateAttributesFromProperties ()

virtual void	addPropertyDecoder (const DtString &propName, PropertyDecoder decoder, void *usr, unsigned disRecordType=0)

virtual void	addPropertyEncoder (const DtString &propName, PropertyEncoder encoder, void *usr, unsigned disRecordType=0)

virtual void	addVrfObjectDataDecoder (const DtString &propName, PropertyDecoder decoder, void *usr, unsigned disRecordType=0)

virtual void	addVrfObjectDataEncoder (const DtString &propName, PropertyEncoder encoder, void *usr, unsigned disRecordType=0)

virtual void	removePropertyEncodersAndDecoders ()

virtual bool	createVrfObjectDataMessage () override

virtual void	giveOwernshipOfProperties ()

virtual DtTime	lastPropertyEncodeTime () const

virtual DtTime	lastPropertyDecodeTime () const

Initialization functions. One of these must be called to support extended attributes.
virtual void	initialize (DtRwProperties stateProps, DtRwProperties paramProps)

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

virtual void	initialize ()


virtual bool	sensorsKilled () const

virtual void	setSensorsKilled (bool killed)


virtual DtSimulationAddress	simEngineAddress () const

virtual void	setSimEngineAddress (DtSimulationAddress addr)


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

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

Public Member Functions inherited from makVrfVrlinkExtToolkit::DtStateRepositoryWithExtendedAttributes< DtExtEntityBaseStateRepository >
	DtStateRepositoryWithExtendedAttributes ()

	DtStateRepositoryWithExtendedAttributes (const DtStateRepositoryWithExtendedAttributes< DtExtEntityBaseStateRepository > &orig)

	DtStateRepositoryWithExtendedAttributes ()

	DtStateRepositoryWithExtendedAttributes (const DtStateRepositoryWithExtendedAttributes< DtExtEntityBaseStateRepository > &orig)

virtual	~DtStateRepositoryWithExtendedAttributes ()

virtual	~DtStateRepositoryWithExtendedAttributes ()

DtStateRepositoryWithExtendedAttributes < DtExtEntityBaseStateRepository > &	operator= (const DtStateRepositoryWithExtendedAttributes< DtExtEntityBaseStateRepository > &orig)

DtStateRepositoryWithExtendedAttributes < DtExtEntityBaseStateRepository > &	operator= (const DtStateRepositoryWithExtendedAttributes< DtExtEntityBaseStateRepository > &orig)

virtual void	setAttributeByName (const DtString &attrName, const char *attrValue, unsigned size)

virtual void	setAttributeByName (const DtString &attrName, const char *attrValue, unsigned size) override

virtual const char *	getAttributeByName (const DtString &attrName, unsigned &size, DtGetAttributeFilter filter=DtNoAttributeFilter, bool markAsRead=true) const

virtual const char *	getAttributeByName (const DtString &attrName, unsigned &size, DtGetAttributeFilter filter=DtNoAttributeFilter, bool markAsRead=true) const override

virtual void	getAttributeNames (std::list< DtString > &attrNames) const

virtual void	getAttributeNames (std::list< DtString > &attrNames) const override

virtual void	setRecordTypeAttributeNameMapping (const std::map< unsigned, DtString > &mapping)

virtual void	addRecordTypeAttributeNameMapping (unsigned recordType, const DtString &attrName)

virtual void	setAttributeNameToHandleMap (DtAttributeNameToHandleMapPtr attributeMapping)

virtual void	printData () const

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

virtual void	setAttributeByHandle (const RTI::AttributeHandle &attrHdl, const char *attrValue, unsigned size) override

virtual const char *	getAttributeByHandle (const RTI::AttributeHandle &attrHdl, unsigned &size, DtGetAttributeFilter filter=DtNoAttributeFilter) const override

virtual const DtAttributesByNameMap &	attributesByName () const override

virtual const DtAttributesByHandleMap &	attributesByHandle () const override

virtual void	setAttributeRecords (const DtStandardVariableRecordPtrVector &records)

virtual void	setAttributeRecords (const DtStandardVariableRecordPtrVector &records, const DtSimulationAddress &address)

virtual const DtStandardVariableRecordPtrVector &	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 DtExtEntityBaseStateRepository
	DtExtEntityBaseStateRepository ()

virtual	~DtExtEntityBaseStateRepository () override

	DtExtEntityBaseStateRepository (const DtExtEntityBaseStateRepository &orig)

DtExtEntityBaseStateRepository &	operator= (const DtExtEntityBaseStateRepository &orig)

const DtEntityType &	objectType () const

virtual int	compare (const DtExtEntityBaseStateRepository *rhs)

virtual int	compareToMostRecent ()

virtual int	compareArtParts (const std::list< int > &)

virtual int	compareArtParts (const DtArticulatedPart source, const DtArticulatedPart target)

virtual bool	locationsDifferent (bool updateIfDifferent)

virtual void	setDiGuyStateRepository (DtDIGuyObjectStateRepository *diGuyStateRep) override

virtual void	setBodyWeight (double)

virtual double	bodyWeight () const

bool	needsVrfDataUpdate () const

void	clearVrfDataNeedsUpdate ()

bool	hasVrfObjectDataMessage () const

void	setHasVrfObjectDataMessage (bool)

virtual DtExtDiGuyStateRepository *	extDiGuyStateRepository ()

virtual const DtExtDiGuyStateRepository *	extDiGuyStateRepository () const

virtual void	createDiGuyStateRep () override

virtual bool	setupFromVrfObjectData (const DtIfVrfObjectData &data) override

virtual void	setSendVrfObjectDataRecord (bool shouldSend)

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 void	setIsSubordinateOfForce (bool b)

virtual bool	isSubordinateOfForce () 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 void	setIsClutterEntity (bool yesNo)

virtual bool	isClutterEntity () const

virtual void	addRangeItem (const DtRangeItem &)

virtual void	removeRangeItem (int index)

virtual void	setRangeItems (const DtRangeItems &)

const DtRangeItems &	rangeItems () const

bool	isVrfObject () 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 void	setExtendedData (const std::map< DtString, DtString > &)

virtual const std::map < DtString, DtString > &	extendedData () const

virtual void	setExtendedData (const DtString &key, const DtString &value)

virtual DtString	extendedData (const DtString &) const

virtual void	setBoundingVolume (const DtVector32 &)

virtual const DtVector32 &	boundingVolume () const

virtual void	setBoundingVolumeOffset (const DtVector32 &)

virtual const DtVector32 &	boundingVolumeOffset () const

Static Public Member Functions
static DtExtEntityStateRepository *	create ()

Static Public Member Functions inherited from makVrfVrlinkExtToolkit::DtStateRepositoryWithExtendedAttributes< DtExtEntityBaseStateRepository >
static DtStateRepositoryWithExtendedAttributes < DtExtEntityBaseStateRepository > *	create ()

static DtStateRepositoryWithExtendedAttributes < DtExtEntityBaseStateRepository > *	create ()

Static Public Member Functions inherited from DtExtEntityBaseStateRepository
static DtExtEntityBaseStateRepository *	create ()

Static Public Member Functions inherited from DtVrfExtensions
static void	setExpectedVrfMessageVersion (DtU32 version)

static DtU32	expectedVrfMessageVersion ()

Protected Member Functions
virtual void	initializeVrfObjectDataProperties ()

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

Protected Member Functions inherited from makVrfVrlinkExtToolkit::DtStateRepositoryWithExtendedAttributes< DtExtEntityBaseStateRepository >
virtual void	markRecordAsUpdated (const DtStandardVariableRecord *record, unsigned recIdx) const

virtual void	markAllRecordsAsUpdated () const

virtual unsigned	recordType (const DtString &attrName) const

virtual const DtString &	attributeName (unsigned recType) const

virtual unsigned	nextVrfAttributeRecordType ()

void	printAttributeNotFoundDebugStatement (const DtString &attrName, const DtString &reason=DtString::nullString()) const

void	printAttributeNotFoundDebugStatement (const DtString &attrName) const

DtExtendedAttributeInfoPtr	cacheNameAttributeMapping (const RTI::AttributeHandle &attrHdl, const DtString &attrName) const

Protected Member Functions inherited from DtExtEntityBaseStateRepository
virtual void	extensionModified () override

Protected Attributes
DtRwProperties *	myStateProperties

DtRwProperties *	myParameterProperties

bool	myOwnsProperties

bool	myIsInitialized

std::list< PropertyDecoderInfo >	myVrfObjectDataDecoders

std::list< PropertyDecoderInfo >	myAdditionalDecoders

std::list< PropertyEncoderInfo >	myAdditionalEncoders

std::vector< char >	myPropertyBuffer

DtClock	myClock

DtTime	myLastEncodeTime

DtTime	myLastDecodeTime

bool	mySensorsKilled

bool	myReceivedVrfObjectDataVersion

bool	myReceivedVrfPropertyVersion

DtSimulationAddress	mySimEngineAddress

int	myPropertyVersion

DtRangeItems	myRangeItemsCache

DtNoArgumentCallbackList	myPropertyUpdatedCallbacks

Protected Attributes inherited from makVrfVrlinkExtToolkit::DtStateRepositoryWithExtendedAttributes< DtExtEntityBaseStateRepository >
std::map< DtString, unsigned >	myAttributeInfo

std::set< DtString >	myUpdatedAttributes

std::vector< char >	myTempBuffer

unsigned	myNextVrfAttributeRecordType

std::set< DtString >	myWarnedAttributes

DtAttributeNameToHandleMapPtr	myAttributeHandlesByName

DtAttributesByHandleMap	myAttributesByHandle

DtAttributesByNameMap	myAttributesByName

std::map< unsigned, DtString >	myNamesByRecordType

std::map< DtString, unsigned >	myRecordTypesByName

Protected Attributes inherited from DtExtEntityBaseStateRepository
DtExtEntityBaseStateRepository *	myLastCopy

bool	myVrfObjectDataUpdated

bool	myHasVrfObjectDataMessage

bool	mySendVrfObjectDataRec

Protected Attributes inherited from DtVrfExtensions
DtString	myName

DtIfVrfObjectData *	myVrfObjectDataMessage

Additional Inherited Members
Static Protected Attributes inherited from DtVrfExtensions
static DtU32	theExpectedVrfMessageVersion

Member Typedef Documentation

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

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

Constructor & Destructor Documentation

DtExtEntityStateRepository::DtExtEntityStateRepository ( )

Default CTOR.

DtExtEntityStateRepository::DtExtEntityStateRepository ( const DtExtEntityStateRepository & orig )

Copy CTOR.

virtual DtExtEntityStateRepository::~DtExtEntityStateRepository ( )

overridevirtual

Virtual DTOR.

Member Function Documentation

static DtExtEntityStateRepository* DtExtEntityStateRepository::create ( )

static

Creator method. Caller responsible for deletion.

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

virtual

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 DtExtEntityStateRepository::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 DtExtEntityStateRepository::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 DtExtEntityStateRepository::isInitialized ( ) const

virtual

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

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

Assignment operator.

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

overridevirtual

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

Reimplemented from makVrfVrlinkExtToolkit::DtStateRepositoryWithExtendedAttributes< DtExtEntityBaseStateRepository >.

Reimplemented in DtEntityStateRepWithTemperature, MyVrlinkEntityStateRep, and MyVrlinkEntityStateRep.

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

virtual

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

virtual const DtRwProperties& DtExtEntityStateRepository::stateProperties ( ) const

inlinevirtual

References DtRwProperties::emptyProperties().

virtual const DtRwProperties& DtExtEntityStateRepository::parameterProperties ( ) const

inlinevirtual

References DtRwProperties::emptyProperties().

virtual bool DtExtEntityStateRepository::sensorsKilled ( ) const

virtual

Functions for accessing the sensors killed state.

virtual void DtExtEntityStateRepository::setSensorsKilled ( bool killed )

virtual

Functions for accessing the sensors killed state.

virtual DtSimulationAddress DtExtEntityStateRepository::simEngineAddress ( ) const

virtual

Functions for accessing the address of the simulating sim engine.

virtual void DtExtEntityStateRepository::setSimEngineAddress ( DtSimulationAddress addr )

virtual

Functions for accessing the address of the simulating sim engine.

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

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

virtual bool DtExtEntityStateRepository::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 DtExtEntityStateRepository::updateAttributesFromProperties ( )

virtual

Updates extended attributes from our properties. Used to update attributes before publishing an object update.

virtual void DtExtEntityStateRepository::addPropertyDecoder	(	const DtString &	propName,
		PropertyDecoder	decoder,
		void *	usr,
		unsigned	disRecordType = `0`
	)

virtual

Adds an additional property and a function that decodes it. Can be used to extend this class to look for additional properties that are not defined in the parameter database for the entity. Properties will be decoded in the order in which the decoders are added to the list. If disRecordType is specified, properties with the specified record type will use this decoder.

virtual void DtExtEntityStateRepository::addPropertyEncoder	(	const DtString &	propName,
		PropertyEncoder	encoder,
		void *	usr,
		unsigned	disRecordType = `0`
	)

virtual

Adds an additional property and a function that encodes 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. If disRecordType is specified, the property will be encoded with the specified record type.

virtual void DtExtEntityStateRepository::addVrfObjectDataDecoder	(	const DtString &	propName,
		PropertyDecoder	decoder,
		void *	usr,
		unsigned	disRecordType = `0`
	)

virtual

Similar to addPropertyDecoder, adds an additional property and a function that to decode it. However, VRF Object Data is intended specifically for VRF specific necessary object metadata. As a result, this decoder will not be called until it is verified that the VRF Object Data version of the object matches our own. Properties will be decoded in the order in which the decoders are added to the list. If disRecordType is specified, properties with the specified record type will use this decoder.

virtual void DtExtEntityStateRepository::addVrfObjectDataEncoder	(	const DtString &	propName,
		PropertyEncoder	encoder,
		void *	usr,
		unsigned	disRecordType = `0`
	)

virtual

Similar to addPropertyEncoder, adds an additional property and a function that to encode it. However, VRF Object Data is intended specifically for VRF specific necessary object metadata. Properties will be encoded in the order in which the encoders are added to the list. If disRecordType is specified, the property will be encoded with the specified record type.

virtual void DtExtEntityStateRepository::removePropertyEncodersAndDecoders ( )

virtual

Removes all additional property encoders and decoders.

virtual bool DtExtEntityStateRepository::createVrfObjectDataMessage ( )

overridevirtual

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 DtExtEntityStateRepository::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 DtExtEntityStateRepository::lastPropertyEncodeTime ( ) const

inlinevirtual

Last time properties were encoded.

virtual DtTime DtExtEntityStateRepository::lastPropertyDecodeTime ( ) const

inlinevirtual

Last time properties were decoded.

virtual void DtExtEntityStateRepository::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 DtExtEntityStateRepository::removePropertyUpdatedCallback	(	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 DtExtEntityStateRepository::initializeVrfObjectDataProperties ( )

protectedvirtual

Initializes the state rep to handle VRF object data properties.

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

protectedvirtual

Encode a particular property if an update is needed.

Member Data Documentation

DtRwProperties* DtExtEntityStateRepository::myStateProperties

protected

DtRwProperties* DtExtEntityStateRepository::myParameterProperties

protected

bool DtExtEntityStateRepository::myOwnsProperties

protected

bool DtExtEntityStateRepository::myIsInitialized

protected

std::list<PropertyDecoderInfo> DtExtEntityStateRepository::myVrfObjectDataDecoders

protected

std::list<PropertyDecoderInfo> DtExtEntityStateRepository::myAdditionalDecoders

protected

std::list<PropertyEncoderInfo> DtExtEntityStateRepository::myAdditionalEncoders

protected

std::vector<char> DtExtEntityStateRepository::myPropertyBuffer

protected

DtClock DtExtEntityStateRepository::myClock

protected

DtTime DtExtEntityStateRepository::myLastEncodeTime

protected

DtTime DtExtEntityStateRepository::myLastDecodeTime

protected

bool DtExtEntityStateRepository::mySensorsKilled

protected

bool DtExtEntityStateRepository::myReceivedVrfObjectDataVersion

protected

bool DtExtEntityStateRepository::myReceivedVrfPropertyVersion

protected

DtSimulationAddress DtExtEntityStateRepository::mySimEngineAddress

protected

int DtExtEntityStateRepository::myPropertyVersion

mutableprotected

DtRangeItems DtExtEntityStateRepository::myRangeItemsCache

mutableprotected

DtNoArgumentCallbackList DtExtEntityStateRepository::myPropertyUpdatedCallbacks

protected

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

/data/exports/nrhent7-1/nightly/docs/vrForces.vrf5-2-branch/include/vrfExtObjects/extEntityStateRepository.h

Classes

Public Types

Public Member Functions

Static Public Member Functions

Protected Member Functions

Protected Attributes

Additional Inherited Members

Member Typedef Documentation

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation