3) Define the current frame class. This will be used for read access.

Inheritance diagram for makVrf::DtWeatherStateComponentCurrentFrame:

Public Member Functions
	DtWeatherStateComponentCurrentFrame (DtStateData *)

virtual	~DtWeatherStateComponentCurrentFrame ()

const double	ambientAirTemperature () const

const double	ambientAirPressure () const

const DtVrfWeatherCloudState	cloudState () const

const double	precipitationIntensity () const

const DtVrfWeatherPrecipitationType	precipitationType () const

const double	windSpeed (double atAlt=0.) const

const double	windDirection (double atAlt=0.) const

const int	priority () const

const double	visibility (double atAltitude=0.) const

const int	obscurant (double atAltitude) const

const double	underwaterVisibility () const

const double	surfaceTransparency () const

const double	waterCurrentSpeed () const

const double	waterCurrentDirection () const

const double	ambientWaterTemperature () const

const double	snowAccumulation () const

const double	rainAccumulation () const

const double	snowMinimumAltitude () const

const double	snowRoadAccumulation () const

const double	tidalOffset () const

const int	swellState () const

const double	swellStateDirection () const

const int	seaState () const

const double	seaStateDirection () const

const bool	windDrivenSeaStateEnabled () const

const double	choppiness () const

const double	surgeDepth () const

const double	fogHeight () const

const DtVector	fogColor () const

const unsigned int	flags () const

const bool	lightningPresent () const

const double	thermoclineLayer1Depth () const

const double	thermoclineLayer1Permeability () const

const double	thermoclineLayer2Depth () const

const double	thermoclineLayer2Permeability () const

const double	thermoclineLayer3Depth () const

const double	thermoclineLayer3Permeability () const

const double	thermoclineLayer4Depth () const

const double	thermoclineLayer4Permeability () const

const double	thermoclineLayer5Depth () const

const double	thermoclineLayer5Permeability () const

const double	airTemperatureAltitude () const

const double	airPressureAltitude () const

const bool	airTemperatureAltitudeIsSeaLevel () const

const bool	airPressureAltitudeIsSeaLevel () const

const double	seaLevelWaterConcentration () const

bool	windSpeedAndDirectionAtAltitude (double altMSL, double &windSpeed, double &windDirection) const

bool	visibilityAndObscurantAtAltitude (double altMSL, double &distance, int &obs) const

const DtRwWindLevels &	windLevels () const

bool	readComponentValid () const

bool	findReadComponent ()

Public Member Functions inherited from makVrf::DtWeatherStateComponent
	DtWeatherStateComponent (DtStateData *storage)

virtual void	setVisibility (const double &)

virtual void	setVisibility (const double &atAlt, const double &)

virtual void	setWindSpeed (const double &)

virtual void	setWindSpeed (const double &atAlt, const double &)

virtual void	setWindDirection (const double &)

virtual void	setWindDirection (const double &atAlt, const double &)

virtual void	setObscurant (double atAlt, const int &)

virtual void	addWindLevel (double altitude, double windSpeed, double windDirection, double visibleDistance, int obscurant, int cloudType, double cloudDensity, double skyCoverage)

virtual void	clearWindLevels ()

virtual void	removeWindLevel (double baseAltitude)

virtual void	setWindSpeedAndDirectionAtAltitude (const double &altMSL, const double &windSpeed, const double &windDirection)

virtual void	setVisibilityAndObscurantAtAltitude (const double &altMSL, const double &distance, const int &obs)

virtual void	setWindLevels (const DtRwWindLevels &)

Public Member Functions inherited from makVrf::DtFrameStateInterface
	DtFrameStateInterface (const DtStateData *)

virtual	~DtFrameStateInterface ()

void	setIsWritable (bool b)

bool	isWritable () const

UInt64	stateId () const

UInt64	legionGlobalId () const

void	setLegionGlobalId (UInt64 d)

bool	isModified () const

void	clearModified ()

void	markModified ()

virtual DtStateComponent::StateComponentType	type () const

virtual DtStateComponent::StateComponentType	componentType () const =0

void	setId (UInt64 id)

virtual UInt64	id () const

virtual void	updateStateData (DtStateData *sd)

virtual Legion::ReadStateInstance	readStateInstance () const

virtual Legion::WriteStateInstance	writeStateInstance ()

void	emitComponentUpdated ()

bool	cleared () const

bool	advancedFrame () const

virtual void	frameAdvanced ()

virtual void	convertToRemote ()

virtual void	convertToLocal ()

virtual void	aboutToBeDeleted ()

Protected Member Functions
VRF::ReadThermoclineLayerRepository	thermoclineLayer (int) const

virtual void	updateWindLevels ()

void	advanceFrame (const DtWeatherStateComponentNextFrame &data)

Protected Member Functions inherited from makVrf::DtFrameStateInterface
virtual void	makeWritable ()

virtual void	makeReadOnly ()

Protected Attributes
VRF::ReadWeatherStateRepository	myReadWeatherStateRepository

DtStateData *	myStateData

unsigned int	myCallbackHandle

Protected Attributes inherited from makVrf::DtWeatherStateComponent
DtRwWindLevels	myWindLevels

Protected Attributes inherited from makVrf::DtFrameStateInterface
bool	myIsModified

UInt64	myId

UInt64	myStateId

UInt64	myLegionId

bool	myIsWritable

bool	myCleared

bool	myAdvancedFrame

Friends
class	DtWeatherStateComponentImplementation

Additional Inherited Members
Public Attributes inherited from makVrf::DtFrameStateInterface
boost::signals2::signal< void(DtFrameStateInterface *)>	signal_stateComponentAboutToBeDeleted

boost::signals2::signal< void(const DtFrameStateInterface *)>	signal_componentModified

Constructor & Destructor Documentation

makVrf::DtWeatherStateComponentCurrentFrame::DtWeatherStateComponentCurrentFrame ( DtStateData * )

virtual makVrf::DtWeatherStateComponentCurrentFrame::~DtWeatherStateComponentCurrentFrame ( )

virtual

Member Function Documentation

const double makVrf::DtWeatherStateComponentCurrentFrame::ambientAirTemperature ( ) const

Current frame state only can access current frame buffers. This ensures thread safety.

const double makVrf::DtWeatherStateComponentCurrentFrame::ambientAirPressure ( ) const

const DtVrfWeatherCloudState makVrf::DtWeatherStateComponentCurrentFrame::cloudState ( ) const

const double makVrf::DtWeatherStateComponentCurrentFrame::precipitationIntensity ( ) const

const DtVrfWeatherPrecipitationType makVrf::DtWeatherStateComponentCurrentFrame::precipitationType ( ) const

const double makVrf::DtWeatherStateComponentCurrentFrame::windSpeed ( double atAlt = 0. ) const

virtual

Accessors/mutators for wind level.

If altitude is same as a wind level will replace that wind level. altitude of 0 will set default wind speed and direction

Reimplemented from makVrf::DtWeatherStateComponent.

const double makVrf::DtWeatherStateComponentCurrentFrame::windDirection ( double atAlt = 0. ) const

virtual

Accessors/mutators for wind level.

If altitude is same as a wind level will replace that wind level. altitude of 0 will set default wind speed and direction

Reimplemented from makVrf::DtWeatherStateComponent.

const int makVrf::DtWeatherStateComponentCurrentFrame::priority ( ) const

const double makVrf::DtWeatherStateComponentCurrentFrame::visibility ( double atAlt = 0. ) const

virtual

Accessors/mutators for wind level.

If altitude is same as a wind level will replace that wind level. altitude of 0 will set default wind speed and direction

Reimplemented from makVrf::DtWeatherStateComponent.

const int makVrf::DtWeatherStateComponentCurrentFrame::obscurant ( double atAlt ) const

virtual

Accessors/mutators for wind level.

If altitude is same as a wind level will replace that wind level. altitude of 0 will set default wind speed and direction

Reimplemented from makVrf::DtWeatherStateComponent.

const double makVrf::DtWeatherStateComponentCurrentFrame::underwaterVisibility ( ) const

const double makVrf::DtWeatherStateComponentCurrentFrame::surfaceTransparency ( ) const

const double makVrf::DtWeatherStateComponentCurrentFrame::waterCurrentSpeed ( ) const

const double makVrf::DtWeatherStateComponentCurrentFrame::waterCurrentDirection ( ) const

const double makVrf::DtWeatherStateComponentCurrentFrame::ambientWaterTemperature ( ) const

const double makVrf::DtWeatherStateComponentCurrentFrame::snowAccumulation ( ) const

const double makVrf::DtWeatherStateComponentCurrentFrame::rainAccumulation ( ) const

const double makVrf::DtWeatherStateComponentCurrentFrame::snowMinimumAltitude ( ) const

const double makVrf::DtWeatherStateComponentCurrentFrame::snowRoadAccumulation ( ) const

const double makVrf::DtWeatherStateComponentCurrentFrame::tidalOffset ( ) const

const int makVrf::DtWeatherStateComponentCurrentFrame::swellState ( ) const

const double makVrf::DtWeatherStateComponentCurrentFrame::swellStateDirection ( ) const

const int makVrf::DtWeatherStateComponentCurrentFrame::seaState ( ) const

const double makVrf::DtWeatherStateComponentCurrentFrame::seaStateDirection ( ) const

const bool makVrf::DtWeatherStateComponentCurrentFrame::windDrivenSeaStateEnabled ( ) const

const double makVrf::DtWeatherStateComponentCurrentFrame::choppiness ( ) const

const double makVrf::DtWeatherStateComponentCurrentFrame::surgeDepth ( ) const

const double makVrf::DtWeatherStateComponentCurrentFrame::fogHeight ( ) const

const DtVector makVrf::DtWeatherStateComponentCurrentFrame::fogColor ( ) const

const unsigned int makVrf::DtWeatherStateComponentCurrentFrame::flags ( ) const

const bool makVrf::DtWeatherStateComponentCurrentFrame::lightningPresent ( ) const

const double makVrf::DtWeatherStateComponentCurrentFrame::thermoclineLayer1Depth ( ) const

const double makVrf::DtWeatherStateComponentCurrentFrame::thermoclineLayer1Permeability ( ) const

const double makVrf::DtWeatherStateComponentCurrentFrame::thermoclineLayer2Depth ( ) const

const double makVrf::DtWeatherStateComponentCurrentFrame::thermoclineLayer2Permeability ( ) const

const double makVrf::DtWeatherStateComponentCurrentFrame::thermoclineLayer3Depth ( ) const

const double makVrf::DtWeatherStateComponentCurrentFrame::thermoclineLayer3Permeability ( ) const

const double makVrf::DtWeatherStateComponentCurrentFrame::thermoclineLayer4Depth ( ) const

const double makVrf::DtWeatherStateComponentCurrentFrame::thermoclineLayer4Permeability ( ) const

const double makVrf::DtWeatherStateComponentCurrentFrame::thermoclineLayer5Depth ( ) const

const double makVrf::DtWeatherStateComponentCurrentFrame::thermoclineLayer5Permeability ( ) const

const double makVrf::DtWeatherStateComponentCurrentFrame::airTemperatureAltitude ( ) const

const double makVrf::DtWeatherStateComponentCurrentFrame::airPressureAltitude ( ) const

const bool makVrf::DtWeatherStateComponentCurrentFrame::airTemperatureAltitudeIsSeaLevel ( ) const

const bool makVrf::DtWeatherStateComponentCurrentFrame::airPressureAltitudeIsSeaLevel ( ) const

const double makVrf::DtWeatherStateComponentCurrentFrame::seaLevelWaterConcentration ( ) const

bool makVrf::DtWeatherStateComponentCurrentFrame::windSpeedAndDirectionAtAltitude	(	double	altMSL,
		double &	windSpeed,
		double &	windDirection
	)		const

virtual

Given the altitude, return the wind speed and direction.

Reimplemented from makVrf::DtWeatherStateComponent.

bool makVrf::DtWeatherStateComponentCurrentFrame::visibilityAndObscurantAtAltitude	(	double	altMSL,
		double &	distance,
		int &	obs
	)		const

virtual

Given the altitude, return the visibility and obscurant.

Reimplemented from makVrf::DtWeatherStateComponent.

const DtRwWindLevels& makVrf::DtWeatherStateComponentCurrentFrame::windLevels ( ) const

virtual

Accessors/mutators for wind level.

If altitude is same as a wind level will replace that wind level. altitude of 0 will set default wind speed and direction

Reimplemented from makVrf::DtWeatherStateComponent.

bool makVrf::DtWeatherStateComponentCurrentFrame::readComponentValid ( ) const

bool makVrf::DtWeatherStateComponentCurrentFrame::findReadComponent ( )

VRF::ReadThermoclineLayerRepository makVrf::DtWeatherStateComponentCurrentFrame::thermoclineLayer ( int ) const

protected

virtual void makVrf::DtWeatherStateComponentCurrentFrame::updateWindLevels ( )

protectedvirtual

void makVrf::DtWeatherStateComponentCurrentFrame::advanceFrame ( const DtWeatherStateComponentNextFrame & data )

inlineprotected

References makVrf::DtWeatherStateComponentNextFrame::windLevels().

Friends And Related Function Documentation

friend class DtWeatherStateComponentImplementation

friend

Member Data Documentation

VRF::ReadWeatherStateRepository makVrf::DtWeatherStateComponentCurrentFrame::myReadWeatherStateRepository

protected

DtStateData* makVrf::DtWeatherStateComponentCurrentFrame::myStateData

protected

unsigned int makVrf::DtWeatherStateComponentCurrentFrame::myCallbackHandle

protected

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

/data/exports/nrhent7-1/nightly/docs/vrForces.vrf5-1-branch/include/vrfStateData/weatherStateComponent.h

Public Member Functions

Protected Member Functions

Protected Attributes

Friends

Additional Inherited Members

Constructor & Destructor Documentation

Member Function Documentation

Friends And Related Function Documentation

Member Data Documentation