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

Instances of DtEmitterSystemPublisher are used to take care of the details associated with publishing the state of an emitter system. More...

+ Inheritance diagram for DtEmitterSystemPublisher:
+ Collaboration diagram for DtEmitterSystemPublisher:

List of all members.

Public Types

typedef
DtEmitterSystemRepository *(* 
DtStateRepCreator )()
 Function prototype for functions that create DtEmitterSystemRepositories.

Public Member Functions

 DtEmitterSystemPublisher (DtEmitterSystemRepository *stateRepToUse, DtExerciseConn *conn, const DtObjectId &id=DtObjectId::defaultId())
 Constructor defaultId returns an id of (-1,-1,-1).
 DtEmitterSystemPublisher (DtExerciseConn *conn, const DtObjectId &id=DtObjectId::defaultId())
 Constructor defaultId returns an id of (-1,-1,-1).
 DtEmitterSystemPublisher (DtExerciseConn *conn, const char *name, const DtObjectId &id=DtObjectId::defaultId())
 Constructor defaultId() returns an id of (-1,-1,-1).
virtual ~DtEmitterSystemPublisher ()
 destructor
virtual void forceUpdate ()
 force a pdu to be sent on the next tick call, even if it is not needed.
virtual void tick ()
 Tick the publisher.
virtual DtEmitterSystemRepositoryemitterSystemStateRep ()
 Get the emitter system state repository for this emitter system publisher.
virtual DtEmitterSystemRepositoryesr ()
virtual const DtObjectIdid () const
 Get the entity's identifier.
virtual const DtObjectIdlocalId () const
 The localId is the same as the globalId, a DtEntityIdentifier unique to this object.
virtual const
DtGlobalObjectDesignator
globalId () const
 Get the global object designator - same as id for DIS.
virtual void setBeamAzimuthThreshold (double threshold)
 Set the EE_AZ_THRSH_DFLT.
virtual double beamAzimuthThreshold () const
 Returns the azimuth threshold (in radians).
virtual void setBeamElevationThreshold (double threshold)
 Set the EE_EL_THRSH_DFLT.
virtual double beamElevationThreshold () const
 Returns the elevation threshold (in radians).

Static Public Member Functions

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

Protected Member Functions

void init (const char *name, const DtEntityIdentifier &id)
 Not virtual since called from constructor.
 DtEmitterSystemPublisher (const DtEmitterSystemPublisher &orig)
 copy constructor -- Not Implemented
DtEmitterSystemPublisheroperator= (const DtEmitterSystemPublisher &orig)
 assignment operator -- Not Implemented

Protected Attributes

DtObjectId myId
DtEmitterSystemStateDecodermyEmitterSystemDecoder
DtEmitterSystemStateEncodermyEmitterSystemEncoder
char * myName

Static Protected Attributes

static DtStateRepCreator theStateRepCreator
static DtTime theClassDfltTimeThreshold
static bool theClassDfltIsSetFlag

Detailed Description

Instances of DtEmitterSystemPublisher are used to take care of the details associated with publishing the state of an emitter system.


Member Typedef Documentation

Function prototype for functions that create DtEmitterSystemRepositories.


Constructor & Destructor Documentation

Constructor defaultId returns an id of (-1,-1,-1).

Constructor defaultId returns an id of (-1,-1,-1).

Constructor defaultId() returns an id of (-1,-1,-1).

destructor

copy constructor -- Not Implemented


Member Function Documentation

virtual double DtEmitterSystemPublisher::beamAzimuthThreshold ( ) const [virtual]

Returns the azimuth threshold (in radians).

virtual double DtEmitterSystemPublisher::beamElevationThreshold ( ) const [virtual]

Returns the elevation threshold (in radians).

Get the emitter system state repository for this emitter system publisher.

virtual void DtEmitterSystemPublisher::forceUpdate ( ) [virtual]

force a pdu to be sent on the next tick call, even if it is not needed.

Implements DtObjectPublisher.

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

Implements DtObjectPublisher.

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

Get the entity's identifier.

Implements DtObjectPublisher.

void DtEmitterSystemPublisher::init ( const char *  name,
const DtEntityIdentifier id 
) [protected]

Not virtual since called from constructor.

virtual const DtObjectId& DtEmitterSystemPublisher::localId ( ) const [virtual]

The localId is the same as the globalId, a DtEntityIdentifier unique to this object.

Implements DtObjectPublisher.

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

assignment operator -- Not Implemented

virtual void DtEmitterSystemPublisher::setBeamAzimuthThreshold ( double  threshold) [virtual]

Set the EE_AZ_THRSH_DFLT.

Default value is 1 degree.

Parameters:
thresholdThreshold in radians.
virtual void DtEmitterSystemPublisher::setBeamElevationThreshold ( double  threshold) [virtual]

Set the EE_EL_THRSH_DFLT.

Default value is 1 degree.

Parameters:
thresholdThreshold in radians.
static void DtEmitterSystemPublisher::setClassDfltTimeThreshold ( DtTime  threshold) [static]

Give us a function to be used for creating SRs.

virtual void DtEmitterSystemPublisher::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)