makVrv::DtSimEntryUpdater Class Reference

The DtSimEntryUpdater is responsible for setting the update rate of each DtSimEnty. More...

Inheritance diagram for makVrv::DtSimEntryUpdater:

Public Types
enum	UpdateRate {   NoUpdates = 0x0000, At8s = 0x0001, At4s = 0x0002, At2s = 0x0004,   At1Hz = 0x0008, At2Hz = 0x0010, At4Hz = 0x0020, At8Hz = 0x0040,   At16Hz = 0x0080, At32Hz = 0x0100, At64Hz = 0x0200, At128Hz = 0x0400,   At256Hz = 0x0800, At512Hz = 0x1000, AnyUpdates = 0xFFFF }

Public Member Functions
virtual	~DtSimEntryUpdater ()
	DTOR. More...
virtual void	setUpdateRate (DtUniqueID id, UpdateRate rate)
	Set the rate at which the DtSimEntry represented by id gets updated. More...
virtual void	forceUpdate (DtUniqueID id)
	Force an update on the object with the provide id. More...
Public Member Functions inherited from makVrv::DtVirtualBaseClass
	DtVirtualBaseClass ()
	Do nothing constructor. More...
virtual	~DtVirtualBaseClass ()
	Virtual do nothing destructor. More...

Static Public Member Functions
static DtSimEntryUpdater &	instance (DtDe &de)
	Lazily create singleton. More...
static void	registerInstance (DtDe &de, DtSimEntryUpdater *instance)
	Register an instance. More...

Protected Member Functions
	DtSimEntryUpdater (DtDe &de)
	CTOR. More...

Protected Attributes
DtDe &	myDe

Detailed Description

The DtSimEntryUpdater is responsible for setting the update rate of each DtSimEnty.

The DtSimState's of a DtSimEnty are guaranteed to be updated at this rate. The DtSimEntryUpdater is a singleton.

Member Enumeration Documentation

enum makVrv::DtSimEntryUpdater::UpdateRate

Enumerator
NoUpdates
At8s	Send no updates.
At4s	1 update every 8 seconds;
At2s	1 update every 4 seconds;
At1Hz	1 update every 2 seconds;
At2Hz	1 update per second
At4Hz	2 updates per second
At8Hz	4 updates per second
At16Hz	8 updates per second
At32Hz	16 updates per second
At64Hz	32 updates per second
At128Hz	64 updates per second
At256Hz	128 updates per second
At512Hz	256 updates per second
AnyUpdates	512 updates per second

Constructor & Destructor Documentation

virtual makVrv::DtSimEntryUpdater::~DtSimEntryUpdater ( )

virtual

DTOR.

makVrv::DtSimEntryUpdater::DtSimEntryUpdater ( DtDe &  de )

protected

CTOR.

Member Function Documentation

static DtSimEntryUpdater& makVrv::DtSimEntryUpdater::instance ( DtDe &  de )

static

Lazily create singleton.

static void makVrv::DtSimEntryUpdater::registerInstance ( DtDe &  de, DtSimEntryUpdater *  instance  )

static

Register an instance.

virtual void makVrv::DtSimEntryUpdater::setUpdateRate ( DtUniqueID  id, UpdateRate  rate  )

virtual

Set the rate at which the DtSimEntry represented by id gets updated.

This will cause all the DtSimState's of the DtSimEntry to get updated at that rate. All DtStateView's will get updated at the rate at which they registered with their DtSimEntry.

virtual void makVrv::DtSimEntryUpdater::forceUpdate ( DtUniqueID  id )

virtual

Force an update on the object with the provide id.

Member Data Documentation

DtDe& makVrv::DtSimEntryUpdater::myDe

protected

---

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

• /data/exports/nrhent7-1/nightly/docs/vrForces.vrf4-8-branch/include/vrvCore/DtSimEntryUpdater.h