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

Instances of DtAggregatePublisher are used for local or source simulations of aggregate entities, (i.e. More...

+ Inheritance diagram for DtAggregatePublisher:
+ Collaboration diagram for DtAggregatePublisher:

List of all members.

Public Types

typedef
DtAggregateStateRepository *(* 
DtStateRepCreator )()
 Function prototype for functions that create DtAggregateStateRepositories.

Public Member Functions

 DtAggregatePublisher (DtAggregateStateRepository *stateRepToUse, DtExerciseConn *conn, const char *name=0, const DtDDMRegionSet *regionSetToUse=0)
 Constructor -- stateRepToUse must have a valid entityType.
 DtAggregatePublisher (RTI::ObjectClassHandle h, DtExerciseConn *conn, const char *name=0, const DtDDMRegionSet *regionSetToUse=0)
 Constructor.
 DtAggregatePublisher (const DtEntityType &type, DtExerciseConn *conn, const char *name=0, const DtDDMRegionSet *regionSetToUse=0)
 Constructor.
 DtAggregatePublisher (const DtEntityType &type, DtExerciseConn *conn, DtDeadReckonTypes algorithm, DtForceType forceId, const char *name=0, const DtDDMRegionSet *regionSetToUse=0)
 Constructor.
 DtAggregatePublisher (DtHlaObjectWithStateRep *obj, DtExerciseConn *conn)
 Constructor that creates a publisher for an existing DtHlaObject.
virtual ~DtAggregatePublisher ()
 destructor
virtual
DtAggregateStateRepository
aggregateStateRep ()
 Returns a pointer to the AggregateStateRepository - through which you can set or inspect current state information.
virtual
DtAggregateStateRepository
asr ()
 Synonym for aggregateStateRep().
virtual void tick ()
 Tick (update) this object.

Static Public Member Functions

static DtStateRepCreator setStateRepCreator (DtStateRepCreator creator)
 Give us a function to be used for creating SRs.

Protected Member Functions

void createGeographicRegion (DtExerciseConn *conn)
 Creates the publishers region.
 DtAggregatePublisher (const DtAggregatePublisher &orig)
 copy constructor - not implemented.
DtAggregatePublisheroperator= (const DtAggregatePublisher &orig)
 assignment operator - not implemented.
const char * objectClassNameFromType (const DtEntityType &type)
 Non-virtual, since called from constructor.

Protected Attributes

DtBoost::shared_ptr
< DtGeodeticRegion
myGeodeticPublishingRegion

Static Protected Attributes

static DtStateRepCreator theStateRepCreator

Detailed Description

Instances of DtAggregatePublisher are used for local or source simulations of aggregate entities, (i.e.

these entities are not dependent on data being produced elsewhere on the network for their existence). These entities send data to the network.


Member Typedef Documentation

Function prototype for functions that create DtAggregateStateRepositories.


Constructor & Destructor Documentation

DtAggregatePublisher::DtAggregatePublisher ( DtAggregateStateRepository stateRepToUse,
DtExerciseConn conn,
const char *  name = 0,
const DtDDMRegionSet regionSetToUse = 0 
)

Constructor -- stateRepToUse must have a valid entityType.

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

Constructor.

DtAggregatePublisher::DtAggregatePublisher ( const DtEntityType type,
DtExerciseConn conn,
const char *  name = 0,
const DtDDMRegionSet regionSetToUse = 0 
)

Constructor.

DtAggregatePublisher::DtAggregatePublisher ( const DtEntityType type,
DtExerciseConn conn,
DtDeadReckonTypes  algorithm,
DtForceType  forceId,
const char *  name = 0,
const DtDDMRegionSet regionSetToUse = 0 
)

Constructor.

Constructor that creates a publisher for an existing DtHlaObject.

(DtHlaObjectWithStateRep is derived from DtHlaObject.) Typically used in conjunction with ownership management, when you want to take ownership and begin updating some attributes of an object that you have already discovered.

destructor

copy constructor - not implemented.


Member Function Documentation

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

References DtObjectPublisher::myStateRep.

Creates the publishers region.

Not virtual, since it is called from the constructor.

Exceptions:
DtExceptionif the region cannot be created
const char* DtAggregatePublisher::objectClassNameFromType ( const DtEntityType type) [protected]

Non-virtual, since called from constructor.

If you don't like the default mapping between entity type and object class, just pass the object class you want to the constructor.

DtAggregatePublisher& DtAggregatePublisher::operator= ( const DtAggregatePublisher orig) [protected]

assignment operator - not implemented.

Give us a function to be used for creating SRs.

virtual void DtAggregatePublisher::tick ( ) [virtual]

Tick (update) this object.

Reimplemented from DtObjectPublisher.


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)