VR-Link API Documentation for DIS
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Groups Pages
List of all members | Public Types | Public Member Functions | Static Public Member Functions | Protected Member Functions | Protected Attributes | Static Protected Attributes
DtAdditionalPassiveActivitiesPublisher Class Reference

Instances of DtAdditionalPassiveActivitiesPublisher are used to take care of the details associated with publishing the state of an active sonar. More...

+ Inheritance diagram for DtAdditionalPassiveActivitiesPublisher:
+ Collaboration diagram for DtAdditionalPassiveActivitiesPublisher:

Public Types

typedef
DtAdditionalPassiveActivitiesRepository *(* 
DtStateRepCreator )()
 Function prototype for functions that create DtAdditionalPassiveActivitiesRepositories. More...
 
- Public Types inherited from DtObjectPublisher
typedef DtAttributePdu *(* DtNonCoupledAttributePduCreator )(const DtPduWithAttributeRecordSets *, void *)
 Function prototype for functions that create DtAggregateStateRepositories. More...
 

Public Member Functions

 DtAdditionalPassiveActivitiesPublisher (DtAdditionalPassiveActivitiesRepository *stateRepToUse, DtExerciseConn *conn, const DtObjectId &id=DtObjectId::defaultId())
 CTOR. More...
 
 DtAdditionalPassiveActivitiesPublisher (DtExerciseConn *conn, const DtObjectId &id=DtObjectId::defaultId())
 CTOR. More...
 
 DtAdditionalPassiveActivitiesPublisher (DtExerciseConn *conn, const char *name, const DtObjectId &id=DtObjectId::defaultId())
 CTOR. More...
 
virtual ~DtAdditionalPassiveActivitiesPublisher ()
 Virtual DTOR. More...
 
virtual
DtAdditionalPassiveActivitiesRepository
apaStateRep ()
 Get the active sonar state repository for this active sonar publisher. More...
 
virtual
DtAdditionalPassiveActivitiesRepository
asr ()
 
virtual void tick ()
 Tick the publisher. More...
 
virtual void forceUpdate ()
 force a pdu to be sent on the next tick call, even if it is not needed. More...
 
virtual const DtObjectIdid () const
 Get the entity's identifier. More...
 
virtual const DtObjectIdlocalId () const
 The localId is the same as the globalId, a DtEntityIdentifier unique to this object. More...
 
virtual const
DtGlobalObjectDesignator
globalId () const
 Get the global object designator - same as id for DIS. More...
 
- Public Member Functions inherited from DtObjectPublisher
 DtObjectPublisher (DtExerciseConn *conn, DtStateRepository *stateRep, DtStateRepository *asSeenByRemote, bool okToDeleteStateRep=true)
 Constructor takes an DtExerciseConn which must have a lifetime greater than the ObjectPubliser. More...
 
virtual ~DtObjectPublisher ()
 Destructor. More...
 
virtual DtStateRepositorystateRep ()
 Returns a pointer to the DtStateRepository - through which you can set or inspect current state information. More...
 
virtual DtStateRepositorysr ()
 Returns a pointer to the DtStateRepository - through which you can set or inspect current state information. More...
 
virtual DtExerciseConnexerciseConn ()
 Get our exercise connection. More...
 
virtual void parallelTick ()
 Tick (update) this object in parallel threads. More...
 
virtual void setTimeThreshold (DtTime time)
 Set the heartbeat rate for this object. More...
 
virtual DtTime timeThreshold () const
 The heartbeat rate for this object. More...
 
virtual void setRelLocTimeThreshold (DtTime time)
 Set the heartbeat rate of relative location updates for this object. More...
 
virtual DtTime relLocTimeThreshold () const
 The relative location heartbeat rate for this object. More...
 
virtual DtStateRepositoryapproximateRemoteStateRep ()
 Returns a pointer to the approximate remote DtStateRepository – This state repository contains the contents of the last sent message. More...
 
virtual DtTime lastTimeUpdated () const
 Returns the value of wallclock time at the time an update was last received for the entity. More...
 
virtual DtTime lastTimeAttrUpdated () const
 
virtual DtTime lastSimTimeUpdated () const
 Returns the value of sim time at the time an update was last received for the entity. More...
 
virtual void setUseCustomThreshold (bool useCustom)
 Sets whether or not this object will use a custom threshold value, or the default. More...
 
virtual bool useCustomThreshold ()
 Returns whether or not this object will use a custom threshold value, or the default. More...
 
virtual void setAttributePduStrategy (DtAttributePduStrategy strat)
 Sets/Gets whether to couple the attribute PDU. More...
 
virtual DtAttributePduStrategy attributePduStrategy () const
 
virtual void encodeExtensions (DtStateRepository *stateRep, const DtStateRepository &asSeenByRemote)
 Encode State Repository Extensions. Extensions should be added to stateRep attributeRecords. More...
 
virtual void decodeExtensions (DtPdu *pdu, const DtStateRepository &stateRep)
 Decode State Repository Extensions. More...
 
DtNonCoupledAttributePduCreator setNonCoupledAttributePduCreator (DtNonCoupledAttributePduCreator creator)
 Give us a function to be used for creating non-coupled Attribute PDUs. More...
 
DtNonCoupledAttributePduCreator nonCoupledAttributePduCreator (void)
 

Static Public Member Functions

static void setStateRepCreator (DtStateRepCreator creator)
 Give us a function to be used for creating SRs. More...
 
static DtStateRepCreator stateRepCreator ()
 
static void setClassDfltTimeThreshold (DtTime threshold)
 
- Static Public Member Functions inherited from DtObjectPublisher
static void setDfltTimeThreshold (DtTime time)
 Set the default heartbeat rate. More...
 
static DtTime dfltTimeThreshold ()
 The default heartbeat rate, see setDfltTimeThreshold(). More...
 
static void setDfltRelLocTimeThreshold (DtTime time)
 Set the default heartbeat rate for relative location updates. More...
 
static DtTime dfltRelLocTimeThreshold ()
 The default heartbeat rate for relative location updates, see setDfltRelLocTimeThreshold() More...
 
static
DtNonCoupledAttributePduCreator 
setDefaultNonCoupledAttributePduCreator (DtNonCoupledAttributePduCreator creator)
 Give us a function to be used for creating non-coupled Attribute PDUs. More...
 
static
DtNonCoupledAttributePduCreator 
defaultNonCoupledAttributePduCreator (void)
 

Protected Member Functions

void init (const char *name, const DtEntityIdentifier &id)
 Not virtual since called from constructor. More...
 
 DtAdditionalPassiveActivitiesPublisher (const DtAdditionalPassiveActivitiesPublisher &orig)
 copy constructor – Not Implemented More...
 
DtAdditionalPassiveActivitiesPublisheroperator= (const DtAdditionalPassiveActivitiesPublisher &orig)
 assignment operator – Not Implemented More...
 
- Protected Member Functions inherited from DtObjectPublisher
virtual void send (DtPdu *pdu) const
 Puts the PDU on the network and updates timestamps. More...
 

Protected Attributes

DtObjectId myId
 
DtAdditionalPassiveActivitiesDecodermyAdditionalPassiveActivitiesDecoder
 
DtAdditionalPassiveActivitiesEncodermyAdditionalPassiveActivitiesEncoder
 
char * myName
 
- Protected Attributes inherited from DtObjectPublisher
DtExerciseConnmyExConn
 
DtStateRepositorymyStateRep
 
DtStateRepositorymyAsSeenByRemote
 
bool myOkToDeleteStateRepFlag
 
bool myUseCustomThreshold
 
DtTime myTimeThreshold
 Time threshold for the heartbeat rate. More...
 
DtTime myRelLocTimeThreshold
 Time threshold for heartbeat rate of relative location updates (only for embarked/attached entities) More...
 
DtTime mySimTimeLastUpdate
 Set in const send() method. More...
 
DtTime myRealTimeLastUpdate
 Set in const send() method. More...
 
DtTime myRealTimeLastAttrUpdate
 
DtNonCoupledAttributePduCreator myNonCoupledAttributePduCreator
 
DtAttributePduStrategy myAttributePduStrategy
 
std::vector
< DtStateRepositoryExtensionEncoder * > 
myStateRepositoryExtensionEncoderList
 
std::vector
< DtStateRepositoryExtensionDecoder * > 
myStateRepositoryExtensionDecoderList
 

Static Protected Attributes

static DtStateRepCreator theStateRepCreator
 
static DtTime theClassDfltTimeThreshold
 
static bool theClassDfltIsSetFlag
 
- Static Protected Attributes inherited from DtObjectPublisher
static
DtNonCoupledAttributePduCreator 
theDefaultNonCoupledAttributePduCreator
 
static DtTime theDfltTimeThreshold
 
static DtTime theDfltRelLocTimeThreshold
 

Detailed Description

Instances of DtAdditionalPassiveActivitiesPublisher are used to take care of the details associated with publishing the state of an active sonar.

Member Typedef Documentation

typedef DtAdditionalPassiveActivitiesRepository*(* DtAdditionalPassiveActivitiesPublisher::DtStateRepCreator)()

Function prototype for functions that create DtAdditionalPassiveActivitiesRepositories.

Constructor & Destructor Documentation

DtAdditionalPassiveActivitiesPublisher::DtAdditionalPassiveActivitiesPublisher ( DtAdditionalPassiveActivitiesRepository stateRepToUse,
DtExerciseConn conn,
const DtObjectId id = DtObjectId::defaultId() 
)

CTOR.

DtAdditionalPassiveActivitiesPublisher::DtAdditionalPassiveActivitiesPublisher ( DtExerciseConn conn,
const DtObjectId id = DtObjectId::defaultId() 
)

CTOR.

DtAdditionalPassiveActivitiesPublisher::DtAdditionalPassiveActivitiesPublisher ( DtExerciseConn conn,
const char *  name,
const DtObjectId id = DtObjectId::defaultId() 
)

CTOR.

virtual DtAdditionalPassiveActivitiesPublisher::~DtAdditionalPassiveActivitiesPublisher ( )
virtual

Virtual DTOR.

DtAdditionalPassiveActivitiesPublisher::DtAdditionalPassiveActivitiesPublisher ( const DtAdditionalPassiveActivitiesPublisher orig)
protected

copy constructor – Not Implemented

Member Function Documentation

virtual DtAdditionalPassiveActivitiesRepository* DtAdditionalPassiveActivitiesPublisher::apaStateRep ( )
virtual

Get the active sonar state repository for this active sonar publisher.

DtAdditionalPassiveActivitiesRepository * DtAdditionalPassiveActivitiesPublisher::asr ( )
inlinevirtual
virtual void DtAdditionalPassiveActivitiesPublisher::forceUpdate ( )
virtual

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

Implements DtObjectPublisher.

virtual const DtGlobalObjectDesignator& DtAdditionalPassiveActivitiesPublisher::globalId ( ) const
virtual

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

Implements DtObjectPublisher.

virtual const DtObjectId& DtAdditionalPassiveActivitiesPublisher::id ( ) const
virtual

Get the entity's identifier.

Implements DtObjectPublisher.

void DtAdditionalPassiveActivitiesPublisher::init ( const char *  name,
const DtEntityIdentifier id 
)
protected

Not virtual since called from constructor.

virtual const DtObjectId& DtAdditionalPassiveActivitiesPublisher::localId ( ) const
virtual

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

Implements DtObjectPublisher.

DtAdditionalPassiveActivitiesPublisher& DtAdditionalPassiveActivitiesPublisher::operator= ( const DtAdditionalPassiveActivitiesPublisher orig)
protected

assignment operator – Not Implemented

static void DtAdditionalPassiveActivitiesPublisher::setClassDfltTimeThreshold ( DtTime  threshold)
static
static void DtAdditionalPassiveActivitiesPublisher::setStateRepCreator ( DtStateRepCreator  creator)
static

Give us a function to be used for creating SRs.

static DtStateRepCreator DtAdditionalPassiveActivitiesPublisher::stateRepCreator ( )
static
virtual void DtAdditionalPassiveActivitiesPublisher::tick ( )
virtual

Tick the publisher.

Implements DtObjectPublisher.

Member Data Documentation

DtAdditionalPassiveActivitiesDecoder* DtAdditionalPassiveActivitiesPublisher::myAdditionalPassiveActivitiesDecoder
protected
DtAdditionalPassiveActivitiesEncoder* DtAdditionalPassiveActivitiesPublisher::myAdditionalPassiveActivitiesEncoder
protected
DtObjectId DtAdditionalPassiveActivitiesPublisher::myId
protected
char* DtAdditionalPassiveActivitiesPublisher::myName
protected
bool DtAdditionalPassiveActivitiesPublisher::theClassDfltIsSetFlag
staticprotected
DtTime DtAdditionalPassiveActivitiesPublisher::theClassDfltTimeThreshold
staticprotected
DtStateRepCreator DtAdditionalPassiveActivitiesPublisher::theStateRepCreator
staticprotected

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

Document ID: Generated on Tue Feb 2 21:02:17 EST 2021 from SVN revision 223668
Copyright © 2005-2021 MAK Technologies. All Rights Reserved (www.mak.com)