makVrv::DtTidalStreamWakeUpdater Class Reference

Abstract tidalStreamWake object updater interface.

DtTidalStreamWakeUpdaters are distributed objects, managed by DtTickableManager. They update the tidalStreamWake of DtTidalStreamWakeModels

Inheritance diagram for makVrv::DtTidalStreamWakeUpdater:

Public Member Functions
	DtTidalStreamWakeUpdater (DtDe &de, DtUniqueID id)
virtual	~DtTidalStreamWakeUpdater ()
virtual void	update (DtTime tNow)=0
virtual DtTime	lastUpdateTime () const
virtual void	setTidalStreamWakeModel (DtModel *tidalStreamWakeModel)
virtual void	setCurrentSpeed (double speed)
virtual void	setCurrentDirection (double dir)
DtUniqueID	uniqueId () const
Public Member Functions inherited from makVrv::DtTickable
virtual bool	needsUpdate (DtTime tNow)
virtual bool	updateIfNeeded (DtTime tNow)
virtual	~DtTickable ()
virtual void	setIsThreadSafe (bool safe)
virtual bool	isThreadSafe () const
virtual void	setTickableListState (TickableListState safeList)
virtual TickableListState	tickableListState () const
virtual void	setUpdatePeriod (unsigned int period)
virtual unsigned int	updatePeriod () const
virtual bool	lodSystemEnabled () const

Protected Attributes
DtDe &	myDe
DtUniqueID	myUniqueId
DtModel *	myTidalStreamWakeModel
DtTime	myLastUpdateTime
double	myCurrentSpeed
double	myCurrentDirection
Protected Attributes inherited from makVrv::DtTickable
DtTickableManagerInterface *	myManager
DtSignalConnectionManager	myConnections
unsigned int	myFrameCounter
unsigned int	myFrameToUpdate
unsigned int	myUpdatePeriod
DtTime	myLastUpdateTime
bool	myIsThreadSafe
TickableListState	myTickableListState

Additional Inherited Members
Public Types inherited from makVrv::DtTickable
enum	TickableListState { TickableNotOnList, TickableOnMainList, TickableOnThreadSafeList }
Protected Member Functions inherited from makVrv::DtTickable
	DtTickable (DtTickableManagerInterface *manager)
	DtTickable ()
virtual void	slot_managerAboutToBeDeleted ()

Constructor & Destructor Documentation

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

CTOR.

Parameters

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

virtual makVrv::DtTidalStreamWakeUpdater::~DtTidalStreamWakeUpdater ( )

virtual

Virtual DTOR.

Member Function Documentation

virtual void makVrv::DtTidalStreamWakeUpdater::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 tidalStreamWake at the end of their implementation of this function.

Implements makVrv::DtTickable.

Implemented in makVrv::DtTritonTidalStreamWakeUpdater.

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

virtual

Get the time-stamp of the last update.

Returns

The last update time.

virtual void makVrv::DtTidalStreamWakeUpdater::setTidalStreamWakeModel ( DtModel *  tidalStreamWakeModel )

virtual

Set the tidalStreamWake model to be updated.

Parameters

[in]

tidalStreamWakeModel

is a pointer to the model to be updated

virtual void makVrv::DtTidalStreamWakeUpdater::setCurrentSpeed ( double  speed )

virtual

In m/s. Only used to override global current speed. Set to -1. to start using global current speed again.

virtual void makVrv::DtTidalStreamWakeUpdater::setCurrentDirection ( double  dir )

virtual

In rad from North (clockwise). Only used for override. Set to -1 to start using global direction again.

DtUniqueID makVrv::DtTidalStreamWakeUpdater::uniqueId ( ) const

inline

Returns the distributed object id of this updater.

Member Data Documentation

DtDe& makVrv::DtTidalStreamWakeUpdater::myDe

protected

The display engine.

DtUniqueID makVrv::DtTidalStreamWakeUpdater::myUniqueId

protected

This distributed object's unique identifier.

DtModel* makVrv::DtTidalStreamWakeUpdater::myTidalStreamWakeModel

protected

A pointer to the current tidalStreamWake model being updated.

DtTime makVrv::DtTidalStreamWakeUpdater::myLastUpdateTime

protected

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

double makVrv::DtTidalStreamWakeUpdater::myCurrentSpeed

protected

In m/s. Only used to override global current speed.

double makVrv::DtTidalStreamWakeUpdater::myCurrentDirection

protected

In rad from North (clockwise). Only used for override.

---

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

• /data/exports/nrhent7-1/nightly/docs/vrForces.vrf5-0-branch/include/vrvCore/DtTidalStreamWakeUpdater.h