Holds the set of rotorwash effects for a helicopter. Creates a.

See Also: DtRotorWashProcess which will update values for the currently active rotor wash (based on soil type) for a particular helicopter. The updated rotorwash values are held in the; DtRotorWashState. The; DtRotorWashState has a; DtRotorWashDistributor object. The DtRotorWashDistributorObject will send the updated values on to the DtRotorWashModel for the active rotorwash.

Public Member Functions
	DtRotorWashSet (DtDe &de)

virtual	~DtRotorWashSet ()

virtual void	addRotorWash (DtUniqueID helicopterId, DtUniqueID rotorWashId, const std::string &modelDef)

virtual void	removeRotorWash (DtUniqueID rotorWashId)

virtual bool	hasRotorWash (DtUniqueID rotorWashId)

virtual void	start (DtUniqueID rotorWashId)

virtual void	stop (DtUniqueID rotorWashId)

virtual void	setRotorDiameter (DtUniqueID rotorWashId, double rotorDiameter)

virtual void	setDefaultRotorDiameter (DtUniqueID rotorWashId, double rotorDiameter)

virtual void	setRotorWindSpeed (DtUniqueID rotorWashId, double rotorWindSpeed)

virtual void	setDefaultRotorWindSpeed (DtUniqueID rotorWashId, double rotorWindSpeed)

virtual const DtRotorWashState *	findActiveRotorWashState ()

virtual const DtRotorWashState *	findRotorWashState (DtUniqueID rotorWashId)

virtual void	update (DtTime tNow)

virtual int	numRotorWashes ()

virtual void	getRotorWashIDs (std::vector< DtUniqueID > &rotorWashIds)

virtual DtUniqueID	helicopterID ()

virtual DtUniqueID	localWindID ()


virtual void	updateRotorWashProcess (DtTime tNow, const DtRotorWashState *rwState)

virtual void	updateRotorWashAgent (const DtRotorWashState *rwState)

virtual void	zeroOutLocalWindSpeed (void)

Protected Types
typedef std::map< DtUniqueID, DtRotorWashState >	RotorWashIDtoRotorWashStateMap

Protected Member Functions
virtual void	updateAgent (DtRotorWashDistributorAgent *rwAgent)

virtual void	updateWind ()

Protected Attributes
DtDe &	myDe

RotorWashIDtoRotorWashStateMap	myRotorWashIDToRotorWashState

DtRotorWashProcess *	myRotorWashProcess

bool	myHasWind

bool	myDefaultWindSpeedAllowed

bool	myDefaultDiameterAllowed

DtUniqueID	myHelicopterId

DtUniqueID	myLocalWindId

Private Member Functions
	DtRotorWashSet ()

	DtRotorWashSet (const DtRotorWashSet &)

DtRotorWashSet &	operator= (const DtRotorWashSet &)

Member Typedef Documentation

typedef std::map<DtUniqueID, DtRotorWashState> makVrv::DtRotorWashSet::RotorWashIDtoRotorWashStateMap

protected

Constructor & Destructor Documentation

makVrv::DtRotorWashSet::DtRotorWashSet ( DtDe & de )

CTOR.

virtual makVrv::DtRotorWashSet::~DtRotorWashSet ( )

virtual

DTOR.

makVrv::DtRotorWashSet::DtRotorWashSet ( )

private

Default Constructor not implemented � default constructor not allowed.

makVrv::DtRotorWashSet::DtRotorWashSet ( const DtRotorWashSet & )

private

Copy Constructor not implemented � Copy not allowed.

Member Function Documentation

virtual void makVrv::DtRotorWashSet::addRotorWash	(	DtUniqueID	helicopterId,
		DtUniqueID	rotorWashId,
		const std::string &	modelDef
	)

virtual

create the rotorwash model agent

virtual void makVrv::DtRotorWashSet::removeRotorWash ( DtUniqueID rotorWashId )

virtual

remove the rotorwash model agent

virtual bool makVrv::DtRotorWashSet::hasRotorWash ( DtUniqueID rotorWashId )

virtual

Is this rotor wash ID in this set.

virtual void makVrv::DtRotorWashSet::start ( DtUniqueID rotorWashId )

virtual

Start the rotorwash model agent.

virtual void makVrv::DtRotorWashSet::stop ( DtUniqueID rotorWashId )

virtual

Stop the rotorwash model agent.

virtual void makVrv::DtRotorWashSet::setRotorDiameter	(	DtUniqueID	rotorWashId,
		double	rotorDiameter
	)

virtual

Set the diameter of the rotors (tip to tip) generating the wake.

virtual void makVrv::DtRotorWashSet::setDefaultRotorDiameter	(	DtUniqueID	rotorWashId,
		double	rotorDiameter
	)

virtual

Set a default diameter of the rotors (tip to tip) generating the wake if setRotorDiameter is not used (probably around 20)

virtual void makVrv::DtRotorWashSet::setRotorWindSpeed	(	DtUniqueID	rotorWashId,
		double	rotorWindSpeed
	)

virtual

Set the speed of the down-draft created by the rotors.

virtual void makVrv::DtRotorWashSet::setDefaultRotorWindSpeed	(	DtUniqueID	rotorWashId,
		double	rotorWindSpeed
	)

virtual

Set a default speed of the down-draft created by the rotors if setRotorWindSpeed is not used (probably around 100 m/s)

virtual const DtRotorWashState* makVrv::DtRotorWashSet::findActiveRotorWashState ( )

virtual

Retrieve a const versino of the state for the current active (unpaused) rotorwash Returns NULL if there is no active rotorwash.

virtual const DtRotorWashState* makVrv::DtRotorWashSet::findRotorWashState ( DtUniqueID rotorWashId )

virtual

Retrieve a const versino of the state for rotorwash by id Returns NULL if the id cannot be found.

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

virtual

Update the process with the current active rotorwash.

virtual void makVrv::DtRotorWashSet::updateRotorWashProcess	(	DtTime	tNow,
		const DtRotorWashState *	rwState
	)

virtual

calling these 2 in order is same as calling the update above

virtual void makVrv::DtRotorWashSet::updateRotorWashAgent ( const DtRotorWashState * rwState )

virtual

calling these 2 in order is same as calling the update above

virtual void makVrv::DtRotorWashSet::zeroOutLocalWindSpeed ( void )

virtual

except if there is no rotor wash state, in which case you have to call this

virtual int makVrv::DtRotorWashSet::numRotorWashes ( )

virtual

How many rotorwashes does this set have (rotorwashes are created on demand so a DtRotorWashSet could have 0,1,2,..7)

virtual void makVrv::DtRotorWashSet::getRotorWashIDs ( std::vector< DtUniqueID > & rotorWashIds )

virtual

Get the rotor wash IDs in this set.

virtual DtUniqueID makVrv::DtRotorWashSet::helicopterID ( )

virtual

What entity are we on? (returns 0 if no entity) A DtRotorWashSet has one helicopter.

virtual DtUniqueID makVrv::DtRotorWashSet::localWindID ( )

virtual

Retrieve wind id for interfacing with DtEnvironment, DtLocalWindObjectManager (returns 0 if no wind yet) A DtRotorWashSet has one wind.

virtual void makVrv::DtRotorWashSet::updateAgent ( DtRotorWashDistributorAgent * rwAgent )

protectedvirtual

update the agent from the updated rotor wash process

virtual void makVrv::DtRotorWashSet::updateWind ( )

protectedvirtual

update the wind from the updated rotor wash process

DtRotorWashSet& makVrv::DtRotorWashSet::operator= ( const DtRotorWashSet & )

private

Assignment Operator not implemented � Copy not allowed.

Member Data Documentation

DtDe& makVrv::DtRotorWashSet::myDe

protected

RotorWashIDtoRotorWashStateMap makVrv::DtRotorWashSet::myRotorWashIDToRotorWashState

protected

DtRotorWashProcess* makVrv::DtRotorWashSet::myRotorWashProcess

protected

bool makVrv::DtRotorWashSet::myHasWind

protected

bool makVrv::DtRotorWashSet::myDefaultWindSpeedAllowed

protected

bool makVrv::DtRotorWashSet::myDefaultDiameterAllowed

protected

DtUniqueID makVrv::DtRotorWashSet::myHelicopterId

protected

DtUniqueID makVrv::DtRotorWashSet::myLocalWindId

protected

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

/data/exports/nrhent7-1/nightly/docs/vrForces.vrf5-2-branch/include/vrvCore/DtRotorWashSet.h

Public Member Functions

Protected Types

Protected Member Functions

Protected Attributes

Private Member Functions

Member Typedef Documentation

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation