VR-Link API Documentation for HLA 1516
Public Types | Public Member Functions | Static Public Member Functions | Protected Member Functions | Protected Attributes
DtAggregateStateRepository Class Reference

A protocol independent representation of an aggregate. More...

+ Inheritance diagram for DtAggregateStateRepository:
+ Collaboration diagram for DtAggregateStateRepository:

List of all members.

Public Types

enum  { AGGREGATE_SR_MARKING_TEXT_LENGTH = 11 }
 Aggregate state PDU marking is 31 bytes long, RPR marking struct is 11. More...

Public Member Functions

 DtAggregateStateRepository ()
 default constructor
virtual ~DtAggregateStateRepository ()
 destructor
 DtAggregateStateRepository (const DtAggregateStateRepository &orig)
 copy constructor
DtAggregateStateRepositoryoperator= (const DtAggregateStateRepository &orig)
 assignment operator
virtual DtStateRepositoryclone (bool copy=false) const
 Return a copy/empty object of the same type as this.
virtual void setAggregateID (const DtEntityIdentifier &id)
 Set/Get the aggregate's identifier. Calls down to base class.
virtual const DtEntityIdentifieraggregateID () const
virtual void setForceId (DtForceType force)
 Set/Get the force type.
virtual DtForceType forceId () const
virtual void setAggregateState (DtAggregateState value)
 Set/Get the aggregate state.
virtual DtAggregateState aggregateState () const
virtual void setAggregateType (const DtEntityType &type)
 Set/Get the aggregate type. Calls down to base class.
virtual const DtEntityTypeaggregateType () const
virtual void setFormation (DtAggregateFormation value)
 Set/Get the formation.
virtual DtAggregateFormation formation () const
virtual void setMarkingCharacterSet (DtCharacterSet value)
 Set/Get marking character set.
virtual DtCharacterSet markingCharacterSet () const
virtual void setMarkingText (DtU8 *copyFrom)
 Set/Get marking text.
virtual void setMarkingText (const DtString &text)
virtual void getMarkingText (DtU8 *copyTo) const
virtual const char * markingText () const
virtual void setDimensions (const DtVector &dims)
 Set/Get the dimensions.
virtual const DtVectordimensions () const
const
DtGlobalObjectDesignatorList
entities () const
 Return the list of published entities in the aggregate.
DtGlobalObjectDesignatorListentities ()
DtGlobalObjectDesignatorListsubAggregates ()
 Return the list of published subaggregates in the aggregate.
const
DtGlobalObjectDesignatorList
subAggregates () const
virtual bool setNumberOfDIS_Subaggregates (int newNumberOfAggregates)
 Set/Get the number of DIS sub-aggregates.
virtual int numberOfDIS_Subaggregates () const
virtual bool setNumberOfDIS_Entities (int newNumberOfEntities)
 Set/Get the number of DIS entities.
virtual int numberOfDIS_Entities () const
virtual bool setNumberOfSilentSubaggregates (int newNumberOfAggregates)
 Set/Get the number of silent aggregates.
virtual int numberOfSilentSubaggregates () const
virtual bool setNumberOfSilentEntities (int newNumberOfEntities)
 Set/Get the number of silent entities.
virtual int numberOfSilentEntities () const
 Returns the number of silent entity list items.
virtual bool setSubaggregateID (int index, const DtGlobalObjectDesignator &aggID)
 Set/Get a DIS sub-aggregate ID.
virtual bool getSubaggregateID (int index, DtGlobalObjectDesignator &aggID) const
virtual bool setEntityID (int index, const DtGlobalObjectDesignator &entID)
 Set/Get a DIS entity ID.
virtual bool getEntityID (int index, DtGlobalObjectDesignator &entID) const
virtual bool setSilentAggregateList (int index, const DtSilentAggregateList &aggList)
 Set/Get a silent aggregate list.
virtual bool getSilentAggregateList (int index, DtSilentAggregateList &aggList) const
virtual bool setSilentEntityList (int index, const DtSilentEntityList &entList)
 Set/Get a silent entity list.
virtual bool getSilentEntityList (int index, DtSilentEntityList &entList) const
virtual bool setNumberOfDatumRecords (int newNumberOfRecords)
 Set the number of variable datum records.
virtual int numberOfDatumRecords () const
 Get the number of variable datum records.
virtual bool setVariableDatumRecord (int index, const DtVariableDatumRecord &rec)
 Set/Get a variable datum record.
virtual bool getVariableDatumRecord (int index, DtVariableDatumRecord &rec) const
virtual DtVariableDatumRecordvariableDatumRecordRef (int index)
 Get a reference to a variable datum record.
virtual const
DtVariableDatumRecord
variableDatumRecordConstRef (int index) const
 Get a constant reference to a variable datum record.
virtual void printData () const
 Print the state data to the DtInfo Stream.
virtual void printDataToStream (std::ostream &stream) const
 Prints the state data to the stream.

Static Public Member Functions

static DtAggregateStateRepositorycreate ()

Protected Member Functions

DtAggregateStateRepositoryself () const
 Cast off const-ness for trivial internal change.

Protected Attributes

DtForceType myForceID
DtAggregateState myAggregateState
DtAggregateFormation myFormation
DtCharacterSet myMarkingCharSet
DtString myMarkingText
DtVector myDimensions
DtGlobalObjectDesignatorList myEntities
DtGlobalObjectDesignatorList mySubAggs
int myNumberOfSilentAggregateTypes
DtSilentAggregateListmySilentAggregates
int myNumberOfSilentEntityTypes
DtSilentEntityListmySilentEntities
int myNumberOfVariableDatumRecords
DtVariableDatumRecordmyVariableDatumRecords
DtVariableDatumRecord myDumRec

Detailed Description

A protocol independent representation of an aggregate.

Instances of DtAggregateStateRepository are used to maintain the state of an aggregate. It provides an interface which covers the various features which define the state of an aggregate.


Member Enumeration Documentation

anonymous enum

Aggregate state PDU marking is 31 bytes long, RPR marking struct is 11.

Enumerator:
AGGREGATE_SR_MARKING_TEXT_LENGTH 

Constructor & Destructor Documentation

default constructor

destructor

copy constructor


Member Function Documentation

virtual const DtEntityIdentifier& DtAggregateStateRepository::aggregateID ( ) const [virtual]
virtual const DtEntityType& DtAggregateStateRepository::aggregateType ( ) const [virtual]
virtual DtStateRepository* DtAggregateStateRepository::clone ( bool  copy = false) const [virtual]

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

Reimplemented from DtBaseEntityStateRepository.

virtual const DtVector& DtAggregateStateRepository::dimensions ( ) const [virtual]

Return the list of published entities in the aggregate.

virtual DtForceType DtAggregateStateRepository::forceId ( ) const [virtual]
virtual bool DtAggregateStateRepository::getEntityID ( int  index,
DtGlobalObjectDesignator entID 
) const [virtual]
virtual void DtAggregateStateRepository::getMarkingText ( DtU8 copyTo) const [virtual]
virtual bool DtAggregateStateRepository::getSilentAggregateList ( int  index,
DtSilentAggregateList aggList 
) const [virtual]
virtual bool DtAggregateStateRepository::getSilentEntityList ( int  index,
DtSilentEntityList entList 
) const [virtual]
virtual bool DtAggregateStateRepository::getSubaggregateID ( int  index,
DtGlobalObjectDesignator aggID 
) const [virtual]
virtual bool DtAggregateStateRepository::getVariableDatumRecord ( int  index,
DtVariableDatumRecord rec 
) const [virtual]
virtual const char* DtAggregateStateRepository::markingText ( ) const [virtual]
virtual int DtAggregateStateRepository::numberOfDatumRecords ( ) const [virtual]

Get the number of variable datum records.

virtual int DtAggregateStateRepository::numberOfDIS_Entities ( ) const [virtual]
virtual int DtAggregateStateRepository::numberOfSilentEntities ( ) const [virtual]

Returns the number of silent entity list items.

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

assignment operator

virtual void DtAggregateStateRepository::printData ( ) const [virtual]

Print the state data to the DtInfo Stream.

Reimplemented from DtBaseEntityStateRepository.

virtual void DtAggregateStateRepository::printDataToStream ( std::ostream &  stream) const [virtual]

Prints the state data to the stream.

Reimplemented from DtBaseEntityStateRepository.

Cast off const-ness for trivial internal change.

Non-virtual since can't override on return type.

Reimplemented from DtBaseEntityStateRepository.

virtual void DtAggregateStateRepository::setAggregateID ( const DtEntityIdentifier id) [virtual]

Set/Get the aggregate's identifier. Calls down to base class.

Set/Get the aggregate state.

virtual void DtAggregateStateRepository::setAggregateType ( const DtEntityType type) [virtual]

Set/Get the aggregate type. Calls down to base class.

virtual void DtAggregateStateRepository::setDimensions ( const DtVector dims) [virtual]

Set/Get the dimensions.

virtual bool DtAggregateStateRepository::setEntityID ( int  index,
const DtGlobalObjectDesignator entID 
) [virtual]

Set/Get a DIS entity ID.

Returns false if the index is invalid. Can be done through entities() instead.

virtual void DtAggregateStateRepository::setForceId ( DtForceType  force) [virtual]

Set/Get the force type.

Set/Get the formation.

Set/Get marking character set.

virtual void DtAggregateStateRepository::setMarkingText ( DtU8 copyFrom) [virtual]

Set/Get marking text.

virtual void DtAggregateStateRepository::setMarkingText ( const DtString text) [virtual]
virtual bool DtAggregateStateRepository::setNumberOfDatumRecords ( int  newNumberOfRecords) [virtual]

Set the number of variable datum records.

Returns false if the number of records is too large. This will erase the contents of existing datum records.

virtual bool DtAggregateStateRepository::setNumberOfDIS_Entities ( int  newNumberOfEntities) [virtual]

Set/Get the number of DIS entities.

Set returns false if the requested number is too large. Changing this number will erase all previous data. Can be done through entities() instead.

virtual bool DtAggregateStateRepository::setNumberOfDIS_Subaggregates ( int  newNumberOfAggregates) [virtual]

Set/Get the number of DIS sub-aggregates.

Set returns false if the requested number is too large. Changing this number will erase all previous data. Can be done through subAggregates() instead.

virtual bool DtAggregateStateRepository::setNumberOfSilentEntities ( int  newNumberOfEntities) [virtual]

Set/Get the number of silent entities.

Set returns false if the requested number is too large. Changing this number will erase all previous data.

virtual bool DtAggregateStateRepository::setNumberOfSilentSubaggregates ( int  newNumberOfAggregates) [virtual]

Set/Get the number of silent aggregates.

Set returns false if the requested number is too large. Changing this number will erase all previous data.

virtual bool DtAggregateStateRepository::setSilentAggregateList ( int  index,
const DtSilentAggregateList aggList 
) [virtual]

Set/Get a silent aggregate list.

Returns false if the index is invalid.

virtual bool DtAggregateStateRepository::setSilentEntityList ( int  index,
const DtSilentEntityList entList 
) [virtual]

Set/Get a silent entity list.

Returns false if the index is invalid.

virtual bool DtAggregateStateRepository::setSubaggregateID ( int  index,
const DtGlobalObjectDesignator aggID 
) [virtual]

Set/Get a DIS sub-aggregate ID.

Returns false if the index is invalid. Can be done through subAggregates() instead.

virtual bool DtAggregateStateRepository::setVariableDatumRecord ( int  index,
const DtVariableDatumRecord rec 
) [virtual]

Set/Get a variable datum record.

Returns false if the index is invalid.

Return the list of published subaggregates in the aggregate.

Get a constant reference to a variable datum record.

Get a reference to a variable datum record.


Member Data Documentation


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

Document ID: Generated on Mon May 14 08:06:18 EDT 2012 from SVN revision 114750
Copyright © 2005-2012 VT MÄK Inc. All Rights Reserved (www.mak.com)