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

Instances of DtAggregatePublisher are used to take care of the details associated with publishing the state of an aggregate. More...

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

List of all members.

Public Member Functions

 DtAggregatePublisher (DtAggregateStateRepository *stateRepToUse, DtExerciseConn *conn, const DtObjectId &id=DtObjectId::nullId())
 constructor
 DtAggregatePublisher (DtExerciseConn *conn, const DtObjectId &id=DtObjectId::nullId())
 constructor
 DtAggregatePublisher (const DtEntityType &type, DtExerciseConn *conn, const DtObjectId &id=DtObjectId::defaultId())
 constructor The default is = (-1,-1,-1)
 DtAggregatePublisher (const DtEntityType &type, DtExerciseConn *conn, DtDeadReckonTypes algorithm, DtForceType forceId, const DtObjectId &id=DtObjectId::defaultId())
 constructor The default is = (-1,-1,-1)
virtual ~DtAggregatePublisher ()
 destructor
virtual void tick ()
 Tick the publisher.
virtual void forceUpdate ()
 Cause the next tick call to send out the PDU even if its not needed.
virtual
DtAggregateStateRepository
aggregateStateRep ()
 Get the aggregate state repository for this aggregate publisher.
virtual
DtAggregateStateRepository
asr ()
 Get the aggregate state repository for this aggregate publisher.
virtual const DtObjectIdid () const
 Get the entity's identifier.
virtual const DtObjectIdlocalId () 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.

Static Public Member Functions

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

Protected Member Functions

void init (const DtEntityIdentifier &vehId)
 Not virtual since called from constructor.
 DtAggregatePublisher (const DtAggregatePublisher &orig)
 copy constructor -- Not Implemented
DtAggregatePublisheroperator= (const DtAggregatePublisher &orig)
 assignment operator -- Not Implemented

Protected Attributes

DtObjectId myId
DtAggregateStateDecodermyAggregateDecoder
DtAggregateStateEncodermyAggregateEncoder

Static Protected Attributes

static DtStateRepCreator theStateRepCreator
static DtTime theClassDfltTimeThreshold
static bool theClassDfltIsSetFlag

Private Types

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

Detailed Description

Instances of DtAggregatePublisher are used to take care of the details associated with publishing the state of an aggregate.


Member Typedef Documentation

Function prototype for functions that create DtAggregateStateRepositories.


Constructor & Destructor Documentation

constructor

constructor

constructor The default is = (-1,-1,-1)

constructor The default is = (-1,-1,-1)

destructor

copy constructor -- Not Implemented


Member Function Documentation

Get the aggregate state repository for this aggregate publisher.

Get the aggregate state repository for this aggregate publisher.

References DtObjectPublisher::myStateRep.

virtual void DtAggregatePublisher::forceUpdate ( ) [virtual]

Cause the next tick call to send out the PDU even if its not needed.

Implements DtObjectPublisher.

virtual const DtGlobalObjectDesignator& DtAggregatePublisher::globalId ( ) const [virtual]

Get the global object designator - same as id for DIS.

Implements DtObjectPublisher.

virtual const DtObjectId& DtAggregatePublisher::id ( ) const [virtual]

Get the entity's identifier.

Implements DtObjectPublisher.

Referenced by localId().

void DtAggregatePublisher::init ( const DtEntityIdentifier vehId) [protected]

Not virtual since called from constructor.

const DtObjectId & DtAggregatePublisher::localId ( ) const [inline, virtual]

Get the entity's localId - same as id for DIS.

Implements DtObjectPublisher.

References id().

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

assignment operator -- Not Implemented

static void DtAggregatePublisher::setClassDfltTimeThreshold ( DtTime  threshold) [static]

Give us a function to be used for creating SRs.

virtual void DtAggregatePublisher::tick ( ) [virtual]

Tick the publisher.

Implements 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)