VR-Forces 4.8 Class Documentation
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Properties Friends Macros Groups Pages
List of all members | Public Member Functions | Static Public Member Functions | Protected Member Functions | Protected Attributes
DtExtAggregateBaseStateRepository Class Reference
Inheritance diagram for DtExtAggregateBaseStateRepository:
Inheritance graph
[legend]

Public Member Functions

 DtExtAggregateBaseStateRepository ()
 default constructor More...
 
virtual ~DtExtAggregateBaseStateRepository ()
 destructor More...
 
 DtExtAggregateBaseStateRepository (const DtExtAggregateBaseStateRepository &orig)
 copy constructor More...
 
DtExtAggregateBaseStateRepositoryoperator= (const DtExtAggregateBaseStateRepository &orig)
 assignment operator More...
 
virtual DtStateRepositoryclone (bool copy=false) const
 Return a copy/empty object of the same type as this. More...
 
virtual int compare (const DtExtAggregateBaseStateRepository *rhs)
 Compares us against the supplied state repository and returns what's changed. More...
 
virtual int compareToMostRecent ()
 Returns what has changed since the last time we called compare. More...
 
virtual bool locationsDifferent (bool updateIfDifferent)
 Returns true if our stashed location is different than our current location. More...
 
virtual DtString extendedData (const DtString &key) const
 Extended record data is a key/value pair. More...
 
const DtVrfExtendedRecordDataextendedRecordData () const
 
DtVrfExtendedRecordDataextendedRecordData ()
 
virtual DtString uuidString () const
 Returns a string version of the VRF UUID of this object, if it can be determined. More...
 
virtual void addEntity (const DtBaseEntityStateRepository *)
 Convenience routines to add/remove subordinates. More...
 
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. More...
 
virtual void removeSubordinate (const DtEntityIdentifier &)
 
virtual void setExtendedData (const std::map< DtString, DtString > &ed)
 Sets extended data for transport via extended data records. More...
 
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. More...
 
virtual bool getUserVariableDatum (int userRecordNumber, DtVariableDatumRecord &rec)
 Returns a user specified variable datum record. The userRecordNumber should be 0 based. More...
 
virtual bool setUserVariableDatum (int userRecordNumber, const DtVariableDatumRecord &record)
 Sets a user specified variable datum record. The userRecordNumber should be 0 based. More...
 
virtual void updateDataRecords ()
 Updates the VRF specific data records as follows: 0 - Supertype 1 - Appearance 2 - Ordered Subordinates 3 - DtIfVrfObjectData. More...
 
int appearance () const
 Appearance as read from network or set by user. More...
 
void setAppearance (int)
 
const std::vector
< DtEntityIdentifier > & 
orderedSubordinates () const
 Gets/sets the list of subordinates in subordinate order. More...
 
virtual void setOrderedSubordinates (const std::vector< DtEntityIdentifier > &)
 
virtual void updateExtensions ()
 Updates internal variables from variable record datum. More...
 
virtual void setSendVrfObjectDataRecord (bool shouldSend)
 Whether a separate VrfObjectData record should be sent to convey additional VRF object information. More...
 
virtual bool shouldSendVrfObjectDataRecord () const
 
virtual DtString formationName () const
 The name of the current formation of the aggregate. More...
 
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. More...
 
virtual void removeRangeItem (int index)
 
virtual void setRangeItems (const DtRangeItems &)
 
const DtRangeItemsrangeItems () const
 
virtual bool createVrfObjectDataMessage ()
 
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. More...
 
virtual const DtVector32 & boundingVolume () const
 
virtual void setBoundingVolumeOffset (const DtVector32 &)
 
virtual const DtVector32 & boundingVolumeOffset () const
 

Static Public Member Functions

static
DtExtAggregateBaseStateRepository
create ()
 
- Static Public Member Functions inherited from DtVrfExtensions
static void setExpectedVrfMessageVersion (DtU32 version)
 The expected VRF message version of this application. More...
 
static DtU32 expectedVrfMessageVersion ()
 

Protected Member Functions

virtual void extensionModified ()
 

Protected Attributes

DtExtAggregateBaseStateRepositorymyLastCopy
 
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
 

Additional Inherited Members

- Static Protected Attributes inherited from DtVrfExtensions
static DtU32 theExpectedVrfMessageVersion
 

Constructor & Destructor Documentation

DtExtAggregateBaseStateRepository::DtExtAggregateBaseStateRepository ( )

default constructor

virtual DtExtAggregateBaseStateRepository::~DtExtAggregateBaseStateRepository ( )
virtual

destructor

DtExtAggregateBaseStateRepository::DtExtAggregateBaseStateRepository ( const DtExtAggregateBaseStateRepository orig)

copy constructor

Member Function Documentation

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

assignment operator

virtual DtStateRepository* DtExtAggregateBaseStateRepository::clone ( bool  copy = false) const
virtual
virtual int DtExtAggregateBaseStateRepository::compare ( const DtExtAggregateBaseStateRepository rhs)
virtual

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

virtual int DtExtAggregateBaseStateRepository::compareToMostRecent ( )
virtual

Returns what has changed since the last time we called compare.

virtual bool DtExtAggregateBaseStateRepository::locationsDifferent ( bool  updateIfDifferent)
virtual

Returns true if our stashed location is different than our current location.

virtual DtString DtExtAggregateBaseStateRepository::extendedData ( const DtString key) const
virtual

Extended record data is a key/value pair.

The value and key is always a string representation and is up to the developer to determine the format of the value. The values are set through the publisher

Reimplemented from DtVrfExtensions.

const DtVrfExtendedRecordData& DtExtAggregateBaseStateRepository::extendedRecordData ( ) const
inline
DtVrfExtendedRecordData& DtExtAggregateBaseStateRepository::extendedRecordData ( )
inline
virtual DtString DtExtAggregateBaseStateRepository::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 in DtExtAggregateStateRepository.

virtual void DtExtAggregateBaseStateRepository::addEntity ( const DtBaseEntityStateRepository *  )
virtual

Convenience routines to add/remove subordinates.

Note that this will also effect the subordinate order that is used by VRF.

virtual void DtExtAggregateBaseStateRepository::removeEntity ( const DtBaseEntityStateRepository *  )
virtual
virtual void DtExtAggregateBaseStateRepository::addAggregate ( const DtBaseEntityStateRepository *  )
virtual
virtual void DtExtAggregateBaseStateRepository::removeAggregate ( const DtBaseEntityStateRepository *  )
virtual
virtual void DtExtAggregateBaseStateRepository::addSubordinate ( const DtEntityIdentifier &  )
virtual

Adds/removes a subordinate from the subordinate order.

virtual void DtExtAggregateBaseStateRepository::removeSubordinate ( const DtEntityIdentifier &  )
virtual
virtual void DtExtAggregateBaseStateRepository::setExtendedData ( const std::map< DtString, DtString > &  ed)
virtual

Sets extended data for transport via extended data records.

Reimplemented from DtVrfExtensions.

virtual void DtExtAggregateBaseStateRepository::setExtendedData ( const DtString key,
const DtString value 
)
virtual

Reimplemented from DtVrfExtensions.

virtual int DtExtAggregateBaseStateRepository::numVrfVariableDatumRecords ( ) const
virtual

Number of fixed datum records that are supplied with a version of the VRF aggregate User records start after this value.

Use get/setUserVariableDatum to set records that will not conflict with VRF records

virtual bool DtExtAggregateBaseStateRepository::getUserVariableDatum ( int  userRecordNumber,
DtVariableDatumRecord &  rec 
)
virtual

Returns a user specified variable datum record. The userRecordNumber should be 0 based.

virtual bool DtExtAggregateBaseStateRepository::setUserVariableDatum ( int  userRecordNumber,
const DtVariableDatumRecord &  record 
)
virtual

Sets a user specified variable datum record. The userRecordNumber should be 0 based.

virtual void DtExtAggregateBaseStateRepository::updateDataRecords ( )
virtual

Updates the VRF specific data records as follows: 0 - Supertype 1 - Appearance 2 - Ordered Subordinates 3 - DtIfVrfObjectData.

virtual void DtExtAggregateBaseStateRepository::setSendVrfObjectDataRecord ( bool  shouldSend)
virtual

Whether a separate VrfObjectData record should be sent to convey additional VRF object information.

virtual bool DtExtAggregateBaseStateRepository::shouldSendVrfObjectDataRecord ( ) const
virtual
int DtExtAggregateBaseStateRepository::appearance ( ) const
inline

Appearance as read from network or set by user.

References myAppearance.

void DtExtAggregateBaseStateRepository::setAppearance ( int  i)
inline

References myAppearance, and myRecordModified.

const std::vector< DtEntityIdentifier > & DtExtAggregateBaseStateRepository::orderedSubordinates ( ) const
inline

Gets/sets the list of subordinates in subordinate order.

References myOrderedSubordinates.

virtual void DtExtAggregateBaseStateRepository::setOrderedSubordinates ( const std::vector< DtEntityIdentifier > &  )
virtual
virtual DtString DtExtAggregateBaseStateRepository::formationName ( ) const
virtual

The name of the current formation of the aggregate.

virtual void DtExtAggregateBaseStateRepository::setFormationName ( const DtString formationName)
virtual
virtual void DtExtAggregateBaseStateRepository::updateExtensions ( )
virtual

Updates internal variables from variable record datum.

Reimplemented in DtExtAggregateStateRepository.

static DtExtAggregateBaseStateRepository* DtExtAggregateBaseStateRepository::create ( )
static
virtual void DtExtAggregateBaseStateRepository::extensionModified ( )
protectedvirtual

Reimplemented from DtVrfExtensions.

Member Data Documentation

DtExtAggregateBaseStateRepository* DtExtAggregateBaseStateRepository::myLastCopy
protected
DtAggregateExtendedRecordData DtExtAggregateBaseStateRepository::myExtendedRecordData
protected
int DtExtAggregateBaseStateRepository::myAppearance
protected

Referenced by appearance(), and setAppearance().

std::vector<DtEntityIdentifier> DtExtAggregateBaseStateRepository::myOrderedSubordinates
protected

Referenced by orderedSubordinates().

char* DtExtAggregateBaseStateRepository::mySubordinateBuffer
protected
int DtExtAggregateBaseStateRepository::myBitLength
protected
bool DtExtAggregateBaseStateRepository::myRecordModified
protected

Referenced by setAppearance().

DtString DtExtAggregateBaseStateRepository::myFormationName
protected
bool DtExtAggregateBaseStateRepository::mySendVrfObjectDataRec
protected

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

Document ID: Generated on Thu Aug 27 10:56:05 EDT 2020 from SVN revision 217100
Copyright © 2005-2020 MAK Technologies. All Rights Reserved (www.mak.com)