makVrv::DtRotorWashUpdater Class Reference

Abstract rotorWash object updater interface. More...

Inheritance diagram for makVrv::DtRotorWashUpdater:

Public Member Functions
	DtRotorWashUpdater (DtDe &de, DtUniqueID id)
	CTOR.
virtual	~DtRotorWashUpdater ()
	Virtual DTOR.
virtual void	update (DtTime tNow)=0
	The update function called by DtTickableManager during update-ticks.
virtual DtTime	lastUpdateTime () const
	Get the time-stamp of the last update.
virtual void	setRotorWashModel (DtModel *rotorWashModel)
	Set the rotorWash model to be updated.
DtUniqueID	uniqueId () const
	Returns the distributed object id of this updater.
Public Member Functions inherited from makVrv::DtTickable
virtual bool	needsUpdate (DtTime tNow)
	The check function called by DtTickableManager to verify if an update is required.
virtual	~DtTickable ()
	Virtual DTOR.
virtual void	setUpdatePeriod (unsigned int period)
	Specify how often (in # of frames) this tickable should call update.
virtual unsigned int	updatePeriod () const
	Specify how often (in # of frames) this tickable should call update.

Protected Attributes
DtDe &	myDe
	The display engine.
DtUniqueID	myUniqueId
	This distributed object's unique identifier.
DtModel *	myRotorWashModel
	A pointer to the current rotorWash model being updated.
DtTime	myLastUpdateTime
	The last time stamp when the update() was called.
Protected Attributes inherited from makVrv::DtTickable
DtTickableManagerInterface *	myManager
	Pointer to manager for removal during destruction.
DtSignalConnectionManager	myConnections
unsigned int	myFrameCounter
unsigned int	myFrameToUpdate
unsigned int	myUpdatePeriod

Additional Inherited Members
Protected Member Functions inherited from makVrv::DtTickable
	DtTickable (DtTickableManagerInterface *manager)
	CTOR.
	DtTickable ()
	Unimplemented default CTOR.
virtual void	slot_managerAboutToBeDeleted ()

Detailed Description

Abstract rotorWash object updater interface.

DtRotorWashUpdaters are distributed objects, managed by DtTickableManager. They update the rotorWash of DtRotorWashModels

Constructor & Destructor Documentation

makVrv::DtRotorWashUpdater::DtRotorWashUpdater	(	DtDe &	de,
		DtUniqueID	id
	)

CTOR.

Parameters

[in]	de	is the display engine.
[in]	id	is a unique identifier for this distributed object.

virtual makVrv::DtRotorWashUpdater::~DtRotorWashUpdater ( )

virtual

Virtual DTOR.

Member Function Documentation

virtual void makVrv::DtRotorWashUpdater::update ( DtTime  tNow )

pure virtual

The update function called by DtTickableManager during update-ticks.

Parameters

[in]

tNow

is the current time-stamp.

Note

Derived classes should update the rotorWash at the end of their implementation of this function.

Implements makVrv::DtTickable.

Implemented in makVrv::DtTritonRotorWashUpdater.

virtual DtTime makVrv::DtRotorWashUpdater::lastUpdateTime ( ) const

virtual

Get the time-stamp of the last update.

Returns

The last update time.

virtual void makVrv::DtRotorWashUpdater::setRotorWashModel ( DtModel *  rotorWashModel )

virtual

Set the rotorWash model to be updated.

Parameters

[in]

rotorWashModel

is a pointer to the model to be updated

DtUniqueID makVrv::DtRotorWashUpdater::uniqueId ( ) const

inline

Returns the distributed object id of this updater.

Member Data Documentation

DtDe& makVrv::DtRotorWashUpdater::myDe

protected

The display engine.

DtUniqueID makVrv::DtRotorWashUpdater::myUniqueId

protected

This distributed object's unique identifier.

DtModel* makVrv::DtRotorWashUpdater::myRotorWashModel

protected

A pointer to the current rotorWash model being updated.

DtTime makVrv::DtRotorWashUpdater::myLastUpdateTime

protected

The last time stamp when the update() was called.

---

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

• /exports/nfedora7-1/nightly/docs/vrforcesDevelopment.vrf4-4-branch/include/vrvCore/DtRotorWashUpdater.h