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

This class extends DtControlObjectPublisher to support the publishing of VR-Forces state properties as extended attributes of the control object. More...

Inheritance diagram for DtExtendedPropertiesControlObjectPublisher:
Inheritance graph
[legend]

Public Member Functions

virtual ~DtExtendedPropertiesControlObjectPublisher ()
 Destructor.
virtual void tick ()
 Ticks the control object publisher and extended attributes publisher.
virtual
DtExtendedPropertiesControlObjectStateRepository
extPropControlObjectStateRep ()
 Returns a pointer to the DtExtendedPropertiesControlObjectStateRepository through which you can set or inspect the current state including state properties.
virtual
DtExtendedPropertiesControlObjectStateRepository
epcosr ()
- Public Member Functions inherited from DtControlObjectPublisher
 DtControlObjectPublisher (DtExerciseConn *conn, const DtObjectType &type, const DtGlobalObjectDesignator &id=DtGlobalObjectDesignator::nullId(), const DtEntityIdentifier &entId=DtEntityIdentifier::nullId())
 Create a new instance of the control object publisher which will, in turn, create the environmental process publisher, given a object id (DIS) or name (HLA).
 DtControlObjectPublisher (DtEnvironmentProcessRepository *sr, DtExerciseConn *conn, const DtObjectType &type, const DtGlobalObjectDesignator &id=DtGlobalObjectDesignator::nullId(), const DtEntityIdentifier &entId=DtEntityIdentifier::nullId())
 DtControlObjectPublisher (DtExerciseConn *conn, const DtObjectType &type, const DtDDMRegionSet *regionSetToUse, const DtGlobalObjectDesignator &id=DtVrfObjectIdGenerator::nullId(), const DtEntityIdentifier &entId=DtEntityIdentifier::nullId())
 DtControlObjectPublisher (DtEnvironmentProcessRepository *sr, DtExerciseConn *conn, const DtObjectType &type, const DtDDMRegionSet *regionSetToUse, const DtGlobalObjectDesignator &id=DtVrfObjectIdGenerator::nullId(), const DtEntityIdentifier &entId=DtEntityIdentifier::nullId())
virtual ~DtControlObjectPublisher ()
 Also destroys publisher.
virtual DtControlObjectRepositorycosr ()
 Synonym for environmentProcessStateRep().
virtual void setSendVrfObjectDataRecord (bool shouldSend)
 Sets whether a separate VrfObjectData record should be sent to convey additional VRF object information.
virtual void setExtendedData (const DtString &key, const DtString &value)
virtual void clearExtendedData ()
virtual void removeExtendedData (const DtString &key)
virtual DtString extendedData (const DtString &key) const

Static Public Member Functions

static
DtExtendedPropertiesControlObjectPublisher
create (DtExerciseConn *conn, const DtObjectType &type, DtVrfParameterDb *paramDb, DtRwProperties *stateProps=0, DtRwProperties *paramProps=0, const DtGlobalObjectDesignator &id=DtGlobalObjectDesignator::nullId(), const DtEntityIdentifier &entId=DtEntityIdentifier::nullId())
 Functions to create a DtExtendedPropertiesControlObjectPublisher.
static
DtExtendedPropertiesControlObjectPublisher
create (DtExerciseConn *conn, const DtObjectType &type, DtVrfParameterDb *paramDb, const DtDDMRegionSet *regionSetToUse, DtRwProperties *stateProps=0, DtRwProperties *paramProps=0, const DtGlobalObjectDesignator &id=DtVrfObjectIdGenerator::nullId(), const DtEntityIdentifier &entId=DtEntityIdentifier::nullId())
- Static Public Member Functions inherited from DtControlObjectPublisher
static DtGlobalObjectDesignator nextId (DtExerciseConn *)

Protected Member Functions

 DtExtendedPropertiesControlObjectPublisher (DtExerciseConn *conn, const DtObjectType &type, DtVrfParameterDb *paramDb, DtRwProperties *stateProps=0, DtRwProperties *paramProps=0, const DtGlobalObjectDesignator &id=DtGlobalObjectDesignator::nullId(), const DtEntityIdentifier &entId=DtEntityIdentifier::nullId())
 Constructor is protected because some pre-initialization is required before constructing.
 DtExtendedPropertiesControlObjectPublisher (DtExerciseConn *conn, const DtObjectType &type, DtVrfParameterDb *paramDb, const DtDDMRegionSet *regionSetToUse, DtRwProperties *stateProps=0, DtRwProperties *paramProps=0, const DtGlobalObjectDesignator &id=DtVrfObjectIdGenerator::nullId(), const DtEntityIdentifier &entId=DtEntityIdentifier::nullId())
 Constructor with region set.

Static Protected Member Functions

static void preinitialize (DtExerciseConn *conn, const DtObjectType &obj, DtVrfParameterDb *paramDb)
 Perform pre-initialization.

Protected Attributes

DtVrfParameterDbmyParameterDb
makVrfVrlinkExtToolkit::DtExtendedAttributesObjectPublishermyExtAttrPublisher

Static Protected Attributes

static DtBoost::shared_ptr
< DtObjectClassChooser
theObjectClassChooser

Private Member Functions

 DtExtendedPropertiesControlObjectPublisher (const DtExtendedPropertiesControlObjectPublisher &)
 Unimplemented.
DtExtendedPropertiesControlObjectPublisheroperator= (const DtExtendedPropertiesControlObjectPublisher &)
 Unimplemented.

Detailed Description

This class extends DtControlObjectPublisher to support the publishing of VR-Forces state properties as extended attributes of the control object.

Constructor & Destructor Documentation

DtExtendedPropertiesControlObjectPublisher::DtExtendedPropertiesControlObjectPublisher ( DtExerciseConn *  conn,
const DtObjectType type,
DtVrfParameterDb paramDb,
DtRwProperties stateProps = 0,
DtRwProperties paramProps = 0,
const DtGlobalObjectDesignator id = DtGlobalObjectDesignator::nullId(),
const DtEntityIdentifier &  entId = DtEntityIdentifier::nullId() 
)
protected

Constructor is protected because some pre-initialization is required before constructing.

Call one of the create functions instead.

DtExtendedPropertiesControlObjectPublisher::DtExtendedPropertiesControlObjectPublisher ( DtExerciseConn *  conn,
const DtObjectType type,
DtVrfParameterDb paramDb,
const DtDDMRegionSet *  regionSetToUse,
DtRwProperties stateProps = 0,
DtRwProperties paramProps = 0,
const DtGlobalObjectDesignator id = DtVrfObjectIdGenerator::nullId(),
const DtEntityIdentifier &  entId = DtEntityIdentifier::nullId() 
)
protected

Constructor with region set.

Constructor is protected because some pre-initialization is required before constructing. Call one of the create functions instead.

virtual DtExtendedPropertiesControlObjectPublisher::~DtExtendedPropertiesControlObjectPublisher ( )
virtual

Destructor.

DtExtendedPropertiesControlObjectPublisher::DtExtendedPropertiesControlObjectPublisher ( const DtExtendedPropertiesControlObjectPublisher )
private

Unimplemented.

Member Function Documentation

static DtExtendedPropertiesControlObjectPublisher* DtExtendedPropertiesControlObjectPublisher::create ( DtExerciseConn *  conn,
const DtObjectType type,
DtVrfParameterDb paramDb,
DtRwProperties stateProps = 0,
DtRwProperties paramProps = 0,
const DtGlobalObjectDesignator id = DtGlobalObjectDesignator::nullId(),
const DtEntityIdentifier &  entId = DtEntityIdentifier::nullId() 
)
static

Functions to create a DtExtendedPropertiesControlObjectPublisher.

Unfortunately access to constructors must be hidden so that the create function can perform necessary pre-initialization before construction.

static DtExtendedPropertiesControlObjectPublisher* DtExtendedPropertiesControlObjectPublisher::create ( DtExerciseConn *  conn,
const DtObjectType type,
DtVrfParameterDb paramDb,
const DtDDMRegionSet *  regionSetToUse,
DtRwProperties stateProps = 0,
DtRwProperties paramProps = 0,
const DtGlobalObjectDesignator id = DtVrfObjectIdGenerator::nullId(),
const DtEntityIdentifier &  entId = DtEntityIdentifier::nullId() 
)
static
static void DtExtendedPropertiesControlObjectPublisher::preinitialize ( DtExerciseConn *  conn,
const DtObjectType obj,
DtVrfParameterDb paramDb 
)
staticprotected

Perform pre-initialization.

Must be called before the publisher is constructed. Called by the create functions.

virtual void DtExtendedPropertiesControlObjectPublisher::tick ( )
virtual

Ticks the control object publisher and extended attributes publisher.

Reimplemented from DtControlObjectPublisher.

virtual DtExtendedPropertiesControlObjectStateRepository* DtExtendedPropertiesControlObjectPublisher::extPropControlObjectStateRep ( )
virtual

Returns a pointer to the DtExtendedPropertiesControlObjectStateRepository through which you can set or inspect the current state including state properties.

virtual DtExtendedPropertiesControlObjectStateRepository* DtExtendedPropertiesControlObjectPublisher::epcosr ( )
virtual
DtExtendedPropertiesControlObjectPublisher& DtExtendedPropertiesControlObjectPublisher::operator= ( const DtExtendedPropertiesControlObjectPublisher )
private

Unimplemented.

Member Data Documentation

DtVrfParameterDb* DtExtendedPropertiesControlObjectPublisher::myParameterDb
protected
makVrfVrlinkExtToolkit::DtExtendedAttributesObjectPublisher* DtExtendedPropertiesControlObjectPublisher::myExtAttrPublisher
protected
DtBoost::shared_ptr<DtObjectClassChooser> DtExtendedPropertiesControlObjectPublisher::theObjectClassChooser
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)