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 () override

virtual const double	ambientAirTemperature () const override

virtual const double	ambientAirPressure () const override

virtual const DtVrfWeatherCloudState	cloudState () const override

virtual const double	precipitationIntensity () const override

virtual const DtVrfWeatherPrecipitationType	precipitationType () const override

virtual const double	windSpeed (double atAlt=0.) const override

virtual const double	windDirection (double atAlt=0.) const override

virtual const int	priority () const override

virtual const double	visibility (double atAltitude=0.) const override

virtual const int	obscurant (double atAltitude) const override

virtual const double	underwaterVisibility () const override

virtual const double	surfaceTransparency () const override

virtual const double	waterCurrentSpeed () const override

virtual const double	waterCurrentDirection () const override

virtual const double	ambientWaterTemperature () const override

virtual const double	snowAccumulation () const override

virtual const double	rainAccumulation () const override

virtual const double	snowMinimumAltitude () const override

virtual const double	snowRoadAccumulation () const override

virtual const double	tidalOffset () const override

virtual const int	swellState () const override

virtual const double	swellStateDirection () const override

virtual const int	seaState () const override

virtual const double	seaStateDirection () const override

virtual const bool	windDrivenSeaStateEnabled () const override

virtual const double	choppiness () const override

virtual const double	surgeDepth () const override

virtual const double	fogHeight () const override

virtual const DtVector	fogColor () const override

virtual const unsigned int	flags () const override

virtual const bool	lightningPresent () const override

virtual const double	thermoclineLayer1Depth () const override

virtual const double	thermoclineLayer1Permeability () const override

virtual const double	thermoclineLayer2Depth () const override

virtual const double	thermoclineLayer2Permeability () const override

virtual const double	thermoclineLayer3Depth () const override

virtual const double	thermoclineLayer3Permeability () const override

virtual const double	thermoclineLayer4Depth () const override

virtual const double	thermoclineLayer4Permeability () const override

virtual const double	thermoclineLayer5Depth () const override

virtual const double	thermoclineLayer5Permeability () const override

virtual const double	airTemperatureAltitude () const override

virtual const double	airPressureAltitude () const override

virtual const bool	airTemperatureAltitudeIsSeaLevel () const override

virtual const bool	airPressureAltitudeIsSeaLevel () const override

virtual const double	seaLevelWaterConcentration () const override

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

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

virtual const DtRwWindLevels &	windLevels () const override

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 (DtStateData *)

virtual	~DtFrameStateInterface ()

void	setIsWritable (bool b)

bool	isWritable () const

UInt64	stateId () const

UInt64	legionGlobalId () const

void	setLegionGlobalId (UInt64 d)

virtual bool	isModified () const

virtual void	clearModified ()

virtual void	markModified ()

virtual DtStateComponent::StateComponentType	type () const

virtual DtStateComponent::StateComponentType	componentType () const =0

virtual const char *	stringType () 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

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

DtStateData *	myStateData

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 ( )

overridevirtual

Member Function Documentation

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

overridevirtual

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

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

overridevirtual

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

overridevirtual

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

overridevirtual

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

overridevirtual

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

overridevirtual

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.

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

overridevirtual

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.

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

overridevirtual

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

overridevirtual

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.

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

overridevirtual

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.

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

overridevirtual

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

overridevirtual

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

overridevirtual

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

overridevirtual

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

overridevirtual

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

overridevirtual

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

overridevirtual

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

overridevirtual

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

overridevirtual

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

overridevirtual

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

overridevirtual

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

overridevirtual

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

overridevirtual

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

overridevirtual

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

overridevirtual

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

overridevirtual

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

overridevirtual

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

overridevirtual

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

overridevirtual

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

overridevirtual

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

overridevirtual

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

overridevirtual

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

overridevirtual

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

overridevirtual

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

overridevirtual

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

overridevirtual

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

overridevirtual

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

overridevirtual

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

overridevirtual

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

overridevirtual

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

overridevirtual

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

overridevirtual

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

overridevirtual

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

overridevirtual

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

overridevirtual

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

overridevirtual

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

overridevirtual

Given the altitude, return the wind speed and direction.

Reimplemented from makVrf::DtWeatherStateComponent.

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

overridevirtual

Given the altitude, return the visibility and obscurant.

Reimplemented from makVrf::DtWeatherStateComponent.

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

overridevirtual

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

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-2-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