VR-Link API Documentation for HLA 1.3
List of all members | Public Types | Public Member Functions | Static Public Member Functions | Protected Member Functions | Static Protected Attributes
DtArealObjectPublisher Class Reference

Instances of DtArealObjectPublisher are used for local or source simulations of areal objects. More...

+ Inheritance diagram for DtArealObjectPublisher:
+ Collaboration diagram for DtArealObjectPublisher:

Public Types

typedef DtArealObjectRepository *(* DtStateRepCreator )()
 Function prototype for functions that create DtArealObjectRepositories.

Public Member Functions

 DtArealObjectPublisher (DtArealObjectRepository *stateRepToUse, DtExerciseConn *conn, const char *name=0, const DtDDMRegionSet *regionSetToUse=0)
 Constructor – state rep must contain objectType.
 DtArealObjectPublisher (RTI::ObjectClassHandle h, DtExerciseConn *conn, const char *name=0, const DtDDMRegionSet *regionSetToUse=0)
 Constructor.
 DtArealObjectPublisher (const DtSyntheticEnvironmentObjectType &type, DtExerciseConn *conn, const char *name=0, const DtDDMRegionSet *regionSetToUse=0)
 Constructor - with object type specified.
virtual ~DtArealObjectPublisher ()
 destructor
virtual DtArealObjectRepositoryarealObjectStateRep ()
 Returns a pointer to the DtArealObjectRepository - through which you can set or inspect current state information.
virtual DtArealObjectRepositoryaosr ()
 Synonym for arealObjectStateRep().
- Public Member Functions inherited from DtObjectPublisher
 DtObjectPublisher (DtExerciseConn *conn, DtStateRepository *stateRep, DtStateRepository *asSeenByRemote, bool okToDeleteStateRep=true, const DtDDMRegionSet *regionSet=0)
 Constructor.
virtual ~DtObjectPublisher ()
 Destructor.
virtual void setHlaObject (const char *className, DtHlaStateEncoder *encoder=0, DtHlaStateDecoder *decoder=0, const char *objectName=0, const DtDDMRegionSet *regionSet=0)
 A DtObjectPublisher is not capable of communicating data through the RTI until setHlaObject is called.
virtual void setHlaObject (RTI::ObjectClassHandle hand, DtHlaStateEncoder *encoder=0, DtHlaStateDecoder *decoder=0, const char *objectName=0, const DtDDMRegionSet *regionSet=0)
 This version takes a classHandle and optional object name, and creates the DtHlaObject for you.
virtual void setHlaObject (DtHlaObjectWithStateRep *obj, DtHlaStateEncoder *encoder=0, DtHlaStateDecoder *decoder=0)
 This version takes an existing DtHlaObject, and uses it.
virtual void detachHlaObject ()
 Detach HLA object - bringing the DtObjectPublisher back to the state it was in before setHlaObject was called.
virtual DtStateRepositorystateRep ()
 Returns a pointer to the DtStateRepository - through which you can set or inspect current state information.
virtual DtStateRepositorysr ()
 Synonym for stateRep().
virtual DtStateRepositoryapproximateRemoteStateRep ()
 Returns a pointer to the approximate remote DtStateRepository – This state repository contains the contents of the last sent message.
virtual DtHlaStateDecoderdecoder ()
 Returns a pointer to the Decoder being used to decode state messages that we send back into the asSeenByRemote SR.
virtual DtHlaStateEncoderencoder ()
 Returns a pointer to the Encoder being used to encode current state into an outgoing message.
virtual DtHlaObjectWithStateRephlaObject ()
 Get the object's hlaObject.
virtual DtExerciseConnexerciseConn ()
 Get our exercise connection.
virtual const DtObjectIdid () const
 Get the object's local identifier.
virtual const DtObjectIdobjectId () const
 Get the object's local identifier.
virtual const DtObjectIdlocalId () const
 Get the object's local identifier.
virtual const DtStringname () const
 Get the object's name.
virtual const
DtGlobalObjectDesignator
globalId () const
 Get the HLA object's global object designator - the object name in RTI1.3.3, but the objectId in RTI1.0.3.
virtual void forceUpdate ()
 Specify a set of attributes that should be included in the ahvps the next time tick is called, even if they would not otherwise need to be sent.
virtual void forceUpdate (const RTI::AttributeHandleSet &set)
virtual void tick ()
 Tick (update) this object.
virtual void setDeleteObjInDtorFlag (bool onOff)
 Set/Get a flag that determines whether to try to delete the HLA object that we represent, upon destruction of this DtObjectPublisher.
virtual bool deleteObjInDtorFlag () const
virtual const DtDDMRegionSetpublishingRegions () const
virtual void addRegion (DtDDMRegionSP regionToAdd)
 Adds the specified region to the set of publishing regions, and calls associateRegionForUpdates on the RTI Ambassador.
virtual void removeRegion (DtDDMRegionSP regionToRemove)
 Removes the specified region from the set of publishing regions, and calls unassociateRegionForUpdates on the RTI Ambassador.
 DtObjectPublisher (DtExerciseConn *conn, const char *name=0)
 These constructors and init functions are obsolete, but are here for backwards compatibility with pre-3.4 releases.
void init (RTI::ObjectClassHandle hand, DtStateRepository *stateRep, DtStateRepository *asSeenByRemote, DtHlaStateEncoder *encoder=0, DtHlaStateDecoder *decoder=0)
void init (const char *className, DtStateRepository *stateRep, DtStateRepository *asSeenByRemote, DtHlaStateEncoder *encoder=0, DtHlaStateDecoder *decoder=0)

Static Public Member Functions

static DtStateRepCreator setStateRepCreator (DtStateRepCreator creator)
 Give us a function to be used for creating SRs.
- Static Public Member Functions inherited from DtObjectPublisher
static void removeObjectCb (DtHlaObject *obj, void *pub)
 Callback to be called when our underlying DtHlaObject goes away.

Protected Member Functions

 DtArealObjectPublisher (const DtArealObjectPublisher &orig)
 copy constructor – not implemented
DtArealObjectPublisheroperator= (const DtArealObjectPublisher &orig)
 copy constructor – not implemented
const char * objectClassNameFromType (const DtSyntheticEnvironmentObjectType &type)
- Protected Member Functions inherited from DtObjectPublisher
virtual void processRemoveObject (DtHlaObject *obj)
 Called by removeObjectCb to detachHlaObject when our underlying DtHlaObject goes away.

Static Protected Attributes

static DtStateRepCreator theStateRepCreator

Additional Inherited Members

- Protected Attributes inherited from DtObjectPublisher
DtExerciseConnmyExConn
DtHlaObjectWithStateRepmyHlaObj
DtStateRepositorymyStateRep
DtStateRepositorymyAsSeenByRemote
DtHlaStateEncodermyEncoder
DtHlaStateDecodermyDecoder
DtObjectId myObjectId
bool myOkToDeleteStateRepFlag
DtString myName
bool myDeleteObjInDtorFlag
DtDDMRegionSet myPublishingRegions

Detailed Description

Instances of DtArealObjectPublisher are used for local or source simulations of areal objects.

The type of areal object published depends on the object type specified: Object Types: MinefieldObject – Domain = 0 (other), Kind = 1 (obstacle), Category = 1

Object of types not specified will be published as OtherArealObjects

Member Typedef Documentation

typedef DtArealObjectRepository*(* DtArealObjectPublisher::DtStateRepCreator)()

Function prototype for functions that create DtArealObjectRepositories.

Constructor & Destructor Documentation

DtArealObjectPublisher::DtArealObjectPublisher ( DtArealObjectRepository stateRepToUse,
DtExerciseConn conn,
const char *  name = 0,
const DtDDMRegionSet regionSetToUse = 0 
)

Constructor – state rep must contain objectType.

DtArealObjectPublisher::DtArealObjectPublisher ( RTI::ObjectClassHandle  h,
DtExerciseConn conn,
const char *  name = 0,
const DtDDMRegionSet regionSetToUse = 0 
)

Constructor.

DtArealObjectPublisher::DtArealObjectPublisher ( const DtSyntheticEnvironmentObjectType type,
DtExerciseConn conn,
const char *  name = 0,
const DtDDMRegionSet regionSetToUse = 0 
)

Constructor - with object type specified.

virtual DtArealObjectPublisher::~DtArealObjectPublisher ( )
virtual

destructor

DtArealObjectPublisher::DtArealObjectPublisher ( const DtArealObjectPublisher orig)
protected

copy constructor – not implemented

Member Function Documentation

DtArealObjectRepository * DtArealObjectPublisher::aosr ( )
inlinevirtual
DtArealObjectRepository * DtArealObjectPublisher::arealObjectStateRep ( )
inlinevirtual

Returns a pointer to the DtArealObjectRepository - through which you can set or inspect current state information.

References DtObjectPublisher::myStateRep.

const char* DtArealObjectPublisher::objectClassNameFromType ( const DtSyntheticEnvironmentObjectType type)
protected
DtArealObjectPublisher& DtArealObjectPublisher::operator= ( const DtArealObjectPublisher orig)
protected

copy constructor – not implemented

static DtStateRepCreator DtArealObjectPublisher::setStateRepCreator ( DtStateRepCreator  creator)
static

Give us a function to be used for creating SRs.

Member Data Documentation

DtStateRepCreator DtArealObjectPublisher::theStateRepCreator
staticprotected

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

Document ID: Generated on Wed Aug 14 15:35:11 EDT 2013 from SVN revision 130445
Copyright © 2005-2013 VT MÄK. All Rights Reserved (www.mak.com)