VR-Forces 4.6 Class Documentation
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Properties Friends Macros Groups Pages
List of all members | Classes | Public Types | Public Member Functions | Static Public Member Functions | Protected Member Functions | Protected Attributes | Static Protected Attributes
DtExtendedPropertiesAggregateStateRepository Class Reference

DtExtendedPropertiesAggregateStateRepository class will interface with extended published data and parameter database and properties list to transfer network extended data to DtRwProperties. More...

Inheritance diagram for DtExtendedPropertiesAggregateStateRepository:
Inheritance graph
[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

 DtExtendedPropertiesAggregateStateRepository ()
 default constructor
virtual ~DtExtendedPropertiesAggregateStateRepository ()
 destructor
 DtExtendedPropertiesAggregateStateRepository (const DtExtendedPropertiesAggregateStateRepository &orig)
 copy constructor
virtual bool isInitialized () const
 Returns true if one of the initialize() functions has been called.
DtExtendedPropertiesAggregateStateRepositoryoperator= (const DtExtendedPropertiesAggregateStateRepository &orig)
 assignment operator
virtual DtStateRepositoryclone (bool copy=false) const
 Return a copy/empty object of the same type as this.
virtual int compare (const DtExtAggregateStateRepository *rhs)
 Compares us against the supplied state repository and returns what's changed.
const DtRwPropertiesstateProperties () const
const DtRwPropertiesparameterProperties () const
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.
virtual void initialize (DtVrfParameterDb *)
 Initialization functions.
virtual void initialize (DtRwProperties *stateProps, DtRwProperties *paramProps)
 Initializes the state rep with 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 DtUUID uuid () const
 Convenience functions for accessing the VRF UUID.
virtual void setUuid (const DtUUID &uuid)
- Public Member Functions inherited from DtExtAggregateStateRepository
 DtExtAggregateStateRepository ()
virtual ~DtExtAggregateStateRepository ()
 DtExtAggregateStateRepository (const DtExtAggregateStateRepository &orig)
DtExtAggregateStateRepositoryoperator= (const DtExtAggregateStateRepository &orig)
virtual int compareToMostRecent ()
virtual bool locationsDifferent (bool updateIfDifferent)
virtual DtString extendedData (const DtString &key) const
 Extended record data is a key/value pair.
const DtVrfExtendedRecordDataextendedRecordData () const
DtVrfExtendedRecordDataextendedRecordData ()
virtual void addEntity (const DtBaseEntityStateRepository *)
 Convenience routines to add/remove subordinates.
virtual void removeEntity (const DtBaseEntityStateRepository *)
virtual void addAggregate (const DtBaseEntityStateRepository *)
virtual void removeAggregate (const DtBaseEntityStateRepository *)
virtual void addSubordinate (const DtEntityIdentifier &)
 Adds/removes a subordinate from the subordinate order.
virtual void removeSubordinate (const DtEntityIdentifier &)
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 int numVrfVariableDatumRecords () const
 Number of fixed datum records that are supplied with a version of the VRF aggregate User records start after this value.
virtual bool getUserVariableDatum (int userRecordNumber, DtVariableDatumRecord &rec)
 Returns a user specified variable datum record. The userRecordNumber should be 0 based.
virtual bool setUserVariableDatum (int userRecordNumber, const DtVariableDatumRecord &record)
 Sets a user specified variable datum record. The userRecordNumber should be 0 based.
virtual void updateDataRecords ()
 Updates the VRF specific data records as follows: 0 - Supertype 1 - Appearance 2 - Ordered Subordinates 3 - DtIfVrfObjectData.
int appearance () const
void setAppearance (int)
const std::vector
< DtEntityIdentifier > & 
orderedSubordinates () const
virtual void setOrderedSubordinates (const std::vector< DtEntityIdentifier > &)
virtual void setSendVrfObjectDataRecord (bool shouldSend)
 Whether a separate VrfObjectData record should be sent to convey additional VRF object information.
virtual bool shouldSendVrfObjectDataRecord () const
virtual DtString formationName () const
virtual void setFormationName (const DtString &formationName)
- Public Member Functions inherited from DtVrfExtensions
 DtVrfExtensions ()
virtual ~DtVrfExtensions ()
 DtVrfExtensions (const DtVrfExtensions &orig)
DtVrfExtensionsoperator= (const DtVrfExtensions &orig)
virtual const DtStringname () const
virtual void setName (const DtString &n)
virtual const DtStringvrfObjectLabel () const
virtual void setVrfObjectLabel (const DtString &l)
virtual const DtStringechelonId () const
virtual void setEchelonId (const DtString &l)
virtual const DtStringoverlayParent () 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 setObjectType (const DtObjectType &)
virtual const DtObjectTypeobjectType () 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 DtStringrulesOfEngagement () 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 DtRangeItemsrangeItems () const
virtual DtIfVrfObjectDatavrfObjectDataMessage () 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
DtExtendedPropertiesAggregateStateRepository
create ()
 Create a new state repository.

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 DtExtAggregateStateRepository
virtual void extensionModified ()

Protected Attributes

DtRwPropertiesmyStateProperties
DtRwPropertiesmyParameterProperties
DtVrfParameterDbmyParameterDatabase
DtEntityType myLastCheckedEntityType
bool myOwnsProperties
bool myIsInitialized
std::list< PropertyDecoderInfomyAdditionalDecoders
std::list< PropertyEncoderInfomyAdditionalEncoders
std::vector< charmyPropertyBuffer
DtClock myClock
DtTime myLastEncodeTime
DtTime myLastDecodeTime
DtUUID myUUID
std::map< DtString, DtStringmyExtendedDataCache
 May be updated on access from extended data.
DtRangeItems myRangeItemsCache
- Protected Attributes inherited from DtExtAggregateStateRepository
DtExtAggregateStateRepositorymyLastCopy
DtAggregateExtendedRecordData myExtendedRecordData
int myAppearance
std::vector< DtEntityIdentifier > myOrderedSubordinates
charmySubordinateBuffer
int myBitLength
bool myRecordModified
DtString myFormationName
bool mySendVrfObjectDataRec
- Protected Attributes inherited from DtVrfExtensions
DtString myName
DtIfVrfObjectDatamyVrfObjectDataMessage

Static Protected Attributes

static DtRwProperties theEmptyProperties

Detailed Description

DtExtendedPropertiesAggregateStateRepository class will interface with extended published data and parameter database and properties list to transfer network extended data to DtRwProperties.

Member Typedef Documentation

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

Constructor & Destructor Documentation

DtExtendedPropertiesAggregateStateRepository::DtExtendedPropertiesAggregateStateRepository ( )

default constructor

virtual DtExtendedPropertiesAggregateStateRepository::~DtExtendedPropertiesAggregateStateRepository ( )
virtual

destructor

DtExtendedPropertiesAggregateStateRepository::DtExtendedPropertiesAggregateStateRepository ( const DtExtendedPropertiesAggregateStateRepository orig)

copy constructor

Member Function Documentation

virtual void DtExtendedPropertiesAggregateStateRepository::initialize ( DtVrfParameterDb )
virtual

Initialization functions.

One of these functions must be called before state properties can be used.Initializes the state rep based on a parameter database. State properties and parameter properties will be initialized based on this database and the entity type of the entity.

virtual void DtExtendedPropertiesAggregateStateRepository::initialize ( DtRwProperties stateProps,
DtRwProperties paramProps 
)
virtual

Initializes the state rep with state properties and parameter properties that have have already been initialized.

Does not take ownership of these properties. They must be deleted elsewhere.

virtual void DtExtendedPropertiesAggregateStateRepository::initialize ( )
virtual

Initializes the state rep without any state or parameter properties.

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

virtual bool DtExtendedPropertiesAggregateStateRepository::isInitialized ( ) const
virtual

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

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

assignment operator

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

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

Reimplemented from makVrfVrlinkExtToolkit::DtStateRepositoryWithExtendedAttributes< DtExtAggregateStateRepository >.

virtual int DtExtendedPropertiesAggregateStateRepository::compare ( const DtExtAggregateStateRepository rhs)
virtual

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

Reimplemented from DtExtAggregateStateRepository.

const DtRwProperties& DtExtendedPropertiesAggregateStateRepository::stateProperties ( ) const
inline
const DtRwProperties& DtExtendedPropertiesAggregateStateRepository::parameterProperties ( ) const
inline
virtual DtUUID DtExtendedPropertiesAggregateStateRepository::uuid ( ) const
virtual

Convenience functions for accessing the VRF UUID.

virtual void DtExtendedPropertiesAggregateStateRepository::setUuid ( const DtUUID uuid)
virtual
virtual DtString DtExtendedPropertiesAggregateStateRepository::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 DtExtAggregateStateRepository.

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

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

static DtExtendedPropertiesAggregateStateRepository* DtExtendedPropertiesAggregateStateRepository::create ( )
static
virtual void DtExtendedPropertiesAggregateStateRepository::updateExtensions ( )
virtual

Overridden to update property data.

Reimplemented from DtExtAggregateStateRepository.

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

Updates extended attributes from our properties.

Used to update attributes before publishing an object update.

virtual void DtExtendedPropertiesAggregateStateRepository::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 DtExtendedPropertiesAggregateStateRepository::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 DtExtendedPropertiesAggregateStateRepository::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 DtExtendedPropertiesAggregateStateRepository::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 DtExtendedPropertiesAggregateStateRepository::lastPropertyEncodeTime ( ) const
inlinevirtual

Last time properties were encoded.

virtual DtTime DtExtendedPropertiesAggregateStateRepository::lastPropertyDecodeTime ( ) const
inlinevirtual

Last time properties were decoded.

virtual void DtExtendedPropertiesAggregateStateRepository::initializeVrfObjectDataProperties ( )
protectedvirtual

Initializes the state rep to handle VRF object data properties.

virtual void DtExtendedPropertiesAggregateStateRepository::encodePropertyIfNeeded ( const DtSymbolString propName,
DtReaderWriter propRw 
)
protectedvirtual

Encode a particular property if an update is needed.

Member Data Documentation

DtRwProperties* DtExtendedPropertiesAggregateStateRepository::myStateProperties
protected
DtRwProperties* DtExtendedPropertiesAggregateStateRepository::myParameterProperties
protected
DtVrfParameterDb* DtExtendedPropertiesAggregateStateRepository::myParameterDatabase
protected
DtEntityType DtExtendedPropertiesAggregateStateRepository::myLastCheckedEntityType
protected
bool DtExtendedPropertiesAggregateStateRepository::myOwnsProperties
protected
bool DtExtendedPropertiesAggregateStateRepository::myIsInitialized
protected
std::list<PropertyDecoderInfo> DtExtendedPropertiesAggregateStateRepository::myAdditionalDecoders
protected
std::list<PropertyEncoderInfo> DtExtendedPropertiesAggregateStateRepository::myAdditionalEncoders
protected
std::vector<char> DtExtendedPropertiesAggregateStateRepository::myPropertyBuffer
protected
DtClock DtExtendedPropertiesAggregateStateRepository::myClock
protected
DtTime DtExtendedPropertiesAggregateStateRepository::myLastEncodeTime
protected
DtTime DtExtendedPropertiesAggregateStateRepository::myLastDecodeTime
protected
DtUUID DtExtendedPropertiesAggregateStateRepository::myUUID
mutableprotected
std::map<DtString, DtString> DtExtendedPropertiesAggregateStateRepository::myExtendedDataCache
mutableprotected

May be updated on access from extended data.

DtRangeItems DtExtendedPropertiesAggregateStateRepository::myRangeItemsCache
mutableprotected
DtRwProperties DtExtendedPropertiesAggregateStateRepository::theEmptyProperties
staticprotected

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

Document ID: Generated on Thu Apr 12 03:15:37 EDT 2018 from SVN revision 187986
Copyright © 2005-2018 VT MÄK. All Rights Reserved (www.mak.com)