VR-Vantage API Documentation
List of all members | Public Member Functions | Static Public Member Functions | Private Member Functions
DtControlObjectPublisher Class Reference

This class will wrap a VR-Link DtEnvironmentalProcessPublisher to allow for easier creation of a publisher that is compatible with VR-Forces. More...

Inheritance diagram for DtControlObjectPublisher:
Inheritance graph
[legend]

Public Member Functions

 DtControlObjectPublisher (DtExerciseConn *conn, const DtObjectType &type, const DtGlobalObjectDesignator &id=DtVrfObjectIdGenerator::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 (DtExerciseConn *conn, const DtObjectType &type, const DtDDMRegionSet *regionSetToUse, const DtGlobalObjectDesignator &id=DtVrfObjectIdGenerator::nullId())
virtual ~DtControlObjectPublisher ()
 Also destroys publisher.
virtual void tick ()
 Class method taken from publisher class for environmentals at VR-Link level.
virtual DtControlObjectRepositorycosr ()
 Synonym for environmentProcessStateRep().
virtual DtCtrlPublisherDecoderdecoder ()
 Returns a pointer to the Decoder being used to decode PDUs that we send back into the asSeenByRemote ESR.
virtual DtCtrlPublisherEncoderencoder ()
 Returns a pointer to the Encoder being used to encode current state into an entity state PDU.

Static Public Member Functions

static DtGlobalObjectDesignator nextId (DtExerciseConn *)

Private Member Functions

 DtControlObjectPublisher (const DtControlObjectPublisher &)
 Unimplemented.
DtControlObjectPublisheroperator= (const DtControlObjectPublisher &)

Detailed Description

This class will wrap a VR-Link DtEnvironmentalProcessPublisher to allow for easier creation of a publisher that is compatible with VR-Forces.

If you want to create and publish environmental objects that can be used by VR-Forces, you can use a publisher of this class to facilitate in that creation

Constructor & Destructor Documentation

DtControlObjectPublisher::DtControlObjectPublisher ( DtExerciseConn *  conn,
const DtObjectType type,
const DtGlobalObjectDesignator &  id = DtVrfObjectIdGenerator::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).

This class will use the default factory as supplied in the DtVrfObjectIdGenerator class

The state repository will initially be set to the DtControlObjectRepository class. You can change it in the global DtControlObjectPublisher class before calling this creator

DtControlObjectPublisher::DtControlObjectPublisher ( DtExerciseConn *  conn,
const DtObjectType type,
const DtDDMRegionSet *  regionSetToUse,
const DtGlobalObjectDesignator &  id = DtVrfObjectIdGenerator::nullId() 
)
virtual DtControlObjectPublisher::~DtControlObjectPublisher ( )
virtual

Also destroys publisher.

DtControlObjectPublisher::DtControlObjectPublisher ( const DtControlObjectPublisher )
private

Unimplemented.

Member Function Documentation

static DtGlobalObjectDesignator DtControlObjectPublisher::nextId ( DtExerciseConn *  )
static
virtual void DtControlObjectPublisher::tick ( )
virtual

Class method taken from publisher class for environmentals at VR-Link level.

This will simply call down to the publisher to handle the method This function should be called once per frame for each environment process object. It determines if any data needs to be sent to the other exercise participants, and sends that data.

virtual DtControlObjectRepository* DtControlObjectPublisher::cosr ( )
virtual

Synonym for environmentProcessStateRep().

virtual DtCtrlPublisherDecoder* DtControlObjectPublisher::decoder ( )
virtual

Returns a pointer to the Decoder being used to decode PDUs that we send back into the asSeenByRemote ESR.

virtual DtCtrlPublisherEncoder* DtControlObjectPublisher::encoder ( )
virtual

Returns a pointer to the Encoder being used to encode current state into an entity state PDU.

DtControlObjectPublisher& DtControlObjectPublisher::operator= ( const DtControlObjectPublisher )
private

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


Copyright © 2005-2013 VT MÄK Inc. All Rights Reserved (www.mak.com)