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

This class extends DtVrfEntityPublisher to support the publishing of VR-Forces state properties as extended attributes of the entity. More...

Inheritance diagram for DtExtendedPropertiesEntityPublisher:
Inheritance graph
[legend]

Public Member Functions

 DtExtendedPropertiesEntityPublisher (const DtEntityType &type, DtExerciseConn *conn, DtVrfParameterDb *paramDb, DtRwProperties *stateProps=0, DtRwProperties *paramProps=0, const DtGlobalObjectDesignator &glId=DtGlobalObjectDesignator::nullId(), const DtEntityIdentifier &entId=DtEntityIdentifier::nullId())
 Constructor.
virtual ~DtExtendedPropertiesEntityPublisher ()
 Destructor.
virtual void tick ()
 Ticks the entity publisher and extended attributes publisher.
virtual
DtExtendedPropertiesEntityStateRepository
extPropEntityStateRep ()
 Returns a pointer to the DtExtendedPropertiesEntityStateRepository through which you can set or inspect the current state including state properties.
virtual
DtExtendedPropertiesEntityStateRepository
epensr ()
- Public Member Functions inherited from DtVrfEntityPublisher
 DtVrfEntityPublisher (const DtEntityType &type, DtExerciseConn *conn, const DtGlobalObjectDesignator &glId=DtGlobalObjectDesignator::nullId(), const DtEntityIdentifier &entId=DtEntityIdentifier::nullId())
 Create a new instance of the VRF entity publisher which will, in turn, create the VR-Link entity publisher, given a object id (DIS) or name (HLA).
virtual ~DtVrfEntityPublisher ()
 Also destroys publisher.
virtual
DtExtEntityStateRepository
entityProcessStateRep ()
 Returns a pointer to the DtExtEntityStateRepository - through which you can set or inspect current state information.
virtual
DtExtEntityStateRepository
entityStateRep ()
virtual
DtExtEntityStateRepository
ensr ()
 Synonym for entityProcessStateRep().
virtual DtEntPublisherDecoderdecoder ()
 Returns a pointer to the Decoder being used to decode PDUs that we send back into the asSeenByRemote ESR.
virtual DtEntPublisherEncoderencoder ()
 Returns a pointer to the Encoder being used to encode current state into an entity state PDU.
virtual void setPublishesDiGuyInfo (bool has)
virtual bool publishesDiGuyInfo ()
virtual void setSendDiGuyPdus (bool yesNo)
 Tell the publisher to send DI Guy PDU's.
virtual bool sendDiGuyPdus () const
 Determine whether this publisher will send DI Guy PDU's.
virtual void createAndSendDiGuyPdus ()
 Override this to have your own custom marshalling of DI-Guy PDUs.
DtStateRepositorysr ()
 VRL support for common functions.
const DtStringname () const
virtual const DtObjectId & id () const
 Get the entity's identifier.
virtual const DtObjectId & localId () const
 Get the entity's localId - same as id for DIS.
virtual const
DtGlobalObjectDesignator
globalId () const
 Get the global object designator - same as id for DIS.
virtual void forceUpdate ()
 Force a state update to be sent during the next call to tick, even if nothing would normally cause a send.
virtual bool sendVrfObjectData ()
 Sends vrf object data update from the ensr() to the network.
virtual DtEntityPublisher * entityPublisher ()
 Returns a pointer to myPublisher (the VR-Link DtEntityPublisher)
virtual void setSendVrfObjectDataRecord (bool shouldSend)
 Sets whether a separate VrfObjectData message should be sent to convey additional VRF object information.
virtual void processDataInteraction (DtDataInteraction *i)
 Used internally. Should not be directly called.

Protected Attributes

DtVrfParameterDbmyParameterDb
makVrfVrlinkExtToolkit::DtExtendedAttributesObjectPublishermyExtAttrPublisher
- Protected Attributes inherited from DtVrfEntityPublisher
DtEntityPublisher * myPublisher
DtTime myTimeLastVrfDataSend
bool myPublishesDIGuyInfo

Static Protected Attributes

static DtBoost::shared_ptr
< DtObjectClassChooser
theObjectClassChooser
- Static Protected Attributes inherited from DtVrfEntityPublisher
static DtTime theVrfDataTimeThreshold
static bool myDiGuyEncodersSetup

Private Member Functions

 DtExtendedPropertiesEntityPublisher (const DtExtendedPropertiesEntityPublisher &)
 Unimplemented.
DtExtendedPropertiesEntityPublisheroperator= (const DtExtendedPropertiesEntityPublisher &)
 Unimplemented.

Additional Inherited Members

- Static Public Member Functions inherited from DtVrfEntityPublisher
static void setVrfDataTimeThreshold (DtTime time)
static DtTime vrfDataTimeThreshold ()
- Protected Member Functions inherited from DtVrfEntityPublisher
 DtVrfEntityPublisher ()
 Alternate constructor that performs no initialization.
void initialize (const DtEntityType &type, DtExerciseConn *conn, const DtGlobalObjectDesignator &glId, const DtEntityIdentifier &entId)
 Called by the constructor to initialize the publisher.
virtual bool sendVrfDataUpdate ()
 Sends out a vrf data update message if needed.
virtual bool needsVrfObjectDataUpdate ()
 Return true if the vrf object data message needs to be updated from a heartbeat or if the object data has changed.
virtual bool sendMessage (const DtSimulationAddress &receiver, DtSimInterfaceContent *message)
 Methods for sending out the object update Fill out the addressing and bookkeeping data, create interaction, and send (Calls set content and send below) Returns true if content could be set (and message sent); otherwise, false.
virtual bool setContentForNet (DtDataInteraction *dataInter, DtSimInterfaceContent *content) const
 Fill out the payload data.
virtual void sendMessageInteraction (const DtSimulationAddress &receiver, DtDataInteraction &data)
 Send the message interaction.
virtual void processSendVrfObjectDataMessage (DtDataInteraction *interaction)
 Send message if interaction is requesting the entity id we are publishing.
- Static Protected Member Functions inherited from DtVrfEntityPublisher
static void dataInteractionCallback (DtDataInteraction *i, void *usr)
 Used internally to see if a request is made of this object to send a vrf object update.

Detailed Description

This class extends DtVrfEntityPublisher to support the publishing of VR-Forces state properties as extended attributes of the entity.

Constructor & Destructor Documentation

DtExtendedPropertiesEntityPublisher::DtExtendedPropertiesEntityPublisher ( const DtEntityType &  type,
DtExerciseConn *  conn,
DtVrfParameterDb paramDb,
DtRwProperties stateProps = 0,
DtRwProperties paramProps = 0,
const DtGlobalObjectDesignator glId = DtGlobalObjectDesignator::nullId(),
const DtEntityIdentifier &  entId = DtEntityIdentifier::nullId() 
)

Constructor.

virtual DtExtendedPropertiesEntityPublisher::~DtExtendedPropertiesEntityPublisher ( )
virtual

Destructor.

DtExtendedPropertiesEntityPublisher::DtExtendedPropertiesEntityPublisher ( const DtExtendedPropertiesEntityPublisher )
private

Unimplemented.

Member Function Documentation

virtual void DtExtendedPropertiesEntityPublisher::tick ( )
virtual

Ticks the entity publisher and extended attributes publisher.

Reimplemented from DtVrfEntityPublisher.

virtual DtExtendedPropertiesEntityStateRepository* DtExtendedPropertiesEntityPublisher::extPropEntityStateRep ( )
virtual

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

virtual DtExtendedPropertiesEntityStateRepository* DtExtendedPropertiesEntityPublisher::epensr ( )
virtual
DtExtendedPropertiesEntityPublisher& DtExtendedPropertiesEntityPublisher::operator= ( const DtExtendedPropertiesEntityPublisher )
private

Unimplemented.

Member Data Documentation

DtVrfParameterDb* DtExtendedPropertiesEntityPublisher::myParameterDb
protected
makVrfVrlinkExtToolkit::DtExtendedAttributesObjectPublisher* DtExtendedPropertiesEntityPublisher::myExtAttrPublisher
protected
DtBoost::shared_ptr<DtObjectClassChooser> DtExtendedPropertiesEntityPublisher::theObjectClassChooser
staticprotected

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

Document ID: Generated on Wed Jul 25 16:57:45 EDT 2018 from SVN revision 190790
Copyright © 2005-2018 VT MÄK. All Rights Reserved (www.mak.com)