makVrf::DtWeatherStateComponentNextFrame Class Reference

2) Define the next frame class. This will be used for write access.

Inheritance diagram for makVrf::DtWeatherStateComponentNextFrame:

Public Member Functions
	DtWeatherStateComponentNextFrame (DtStateData *)
const double	ambientAirTemperature () const
void	setAmbientAirTemperature (const double &)
const double	ambientAirPressure () const
void	setAmbientAirPressure (const double &)
const DtVrfWeatherCloudState	cloudState () const
void	setCloudState (const DtVrfWeatherCloudState &)
const double	precipitationIntensity () const
void	setPrecipitationIntensity (const double &)
const DtVrfWeatherPrecipitationType	precipitationType () const
void	setPrecipitationType (const DtVrfWeatherPrecipitationType &)
const double	windSpeed (double atAlt=0.) const
void	setWindSpeed (const double &)
void	setWindSpeed (const double &atAlt, const double &)
const double	windDirection (double atAlt=0.) const
void	setWindDirection (const double &)
void	setWindDirection (const double &atAlt, const double &)
const int	priority () const
void	setPriority (const int &)
const double	visibility (double atAltitude) const
void	setVisibility (const double &)
void	setVisibility (const double &, const double &)
const int	obscurant (double atAltitude) const
void	setObscurant (double baseAlt, const int &)
const double	underwaterVisibility () const
void	setUnderwaterVisibility (const double &)
const double	surfaceTransparency () const
void	setSurfaceTransparency (const double &)
const double	waterCurrentSpeed () const
void	setWaterCurrentSpeed (const double &)
const double	waterCurrentDirection () const
void	setWaterCurrentDirection (const double &)
const double	ambientWaterTemperature () const
void	setAmbientWaterTemperature (const double &)
const double	snowAccumulation () const
void	setSnowAccumulation (const double &)
const double	rainAccumulation () const
void	setRainAccumulation (const double &)
const double	snowMinimumAltitude () const
void	setSnowMinimumAltitude (const double &)
const double	snowRoadAccumulation () const
void	setSnowRoadAccumulation (const double &)
const double	tidalOffset () const
void	setTidalOffset (const double &)
const int	swellState () const
void	setSwellState (const int &)
const double	swellStateDirection () const
void	setSwellStateDirection (const double &)
const int	seaState () const
void	setSeaState (const int &)
const double	seaStateDirection () const
void	setSeaStateDirection (const double &)
const bool	windDrivenSeaStateEnabled () const
void	setWindDrivenSeaStateEnabled (const bool &)
const double	choppiness () const
void	setChoppiness (const double &)
const double	surgeDepth () const
void	setSurgeDepth (const double &)
const double	fogHeight () const
void	setFogHeight (const double &)
const unsigned int	flags () const
void	setFlags (const unsigned int &)
const bool	lightningPresent () const
void	setLightningPresent (const bool &)
const DtVector	fogColor () const
void	setFogColor (const DtVector &)
const double	thermoclineLayer1Depth () const
void	setThermoclineLayer1Depth (const double &)
const double	thermoclineLayer1Permeability () const
void	setThermoclineLayer1Permeability (const double &)
const double	thermoclineLayer2Depth () const
void	setThermoclineLayer2Depth (const double &)
const double	thermoclineLayer2Permeability () const
void	setThermoclineLayer2Permeability (const double &)
const double	thermoclineLayer3Depth () const
void	setThermoclineLayer3Depth (const double &)
const double	thermoclineLayer3Permeability () const
void	setThermoclineLayer3Permeability (const double &)
const double	thermoclineLayer4Depth () const
void	setThermoclineLayer4Depth (const double &)
const double	thermoclineLayer4Permeability () const
void	setThermoclineLayer4Permeability (const double &)
const double	thermoclineLayer5Depth () const
void	setThermoclineLayer5Depth (const double &)
const double	thermoclineLayer5Permeability () const
void	setThermoclineLayer5Permeability (const double &)
const double	airTemperatureAltitude () const
void	setAirTemperatureAltitude (const double &)
const double	airPressureAltitude () const
void	setAirPressureAltitude (const double &)
const bool	airTemperatureAltitudeIsSeaLevel () const
void	setAirTemperatureAltitudeIsSeaLevel (const bool &)
const bool	airPressureAltitudeIsSeaLevel () const
void	setAirPressureAltitudeIsSeaLevel (const bool &)
const double	seaLevelWaterConcentration () const
void	setSeaLevelWaterConcentration (const double &)
virtual void	makeWritable ()
virtual void	makeReadOnly ()
void	addWindLevel (double altitude, double windSpeed, double windDirection, double visibleDistance, int obscurant, int cloudType, double cloudDensity, double skyCoverage)
void	clearWindLevels ()
void	removeWindLevel (double baseAltitude)
bool	windSpeedAndDirectionAtAltitude (double altMSL, double &windSpeed, double &windDirection) const
void	setWindSpeedAndDirectionAtAltitude (const double &altMSL, const double &windSpeed, const double &windDirection)
bool	visibilityAndObscurantAtAltitude (double altMSL, double &distance, int &obs) const
void	setVisibilityAndObscurantAtAltitude (const double &altMSL, const double &distance, const int &obs)
void	setWindLevels (const DtRwWindLevels &)
const DtRwWindLevels &	windLevels () const
Public Member Functions inherited from makVrf::DtWeatherStateComponent
	DtWeatherStateComponent (DtStateData *storage)
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::WriteThermoclineLayerRepository	thermoclineLayer (int) const
VRF::WriteThermoclineLayerRepository	getOrCreateThermoclineLayer (int)
virtual void	setupWindLevels ()

Protected Attributes
VRF::WriteWeatherStateRepository	myWriteWeatherStateRepository
DtStateData *	myStateData
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

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::DtWeatherStateComponentNextFrame::DtWeatherStateComponentNextFrame

(

DtStateData *

)

Member Function Documentation

const double makVrf::DtWeatherStateComponentNextFrame::ambientAirTemperature

(

)

const

Next frame access write access. Ensure this is only used in a single thread (i.e.a controller thread)

void makVrf::DtWeatherStateComponentNextFrame::setAmbientAirTemperature

(

const double &

)

const double makVrf::DtWeatherStateComponentNextFrame::ambientAirPressure

(

)

const

void makVrf::DtWeatherStateComponentNextFrame::setAmbientAirPressure

(

const double &

)

const DtVrfWeatherCloudState makVrf::DtWeatherStateComponentNextFrame::cloudState

(

)

const

void makVrf::DtWeatherStateComponentNextFrame::setCloudState

(

const DtVrfWeatherCloudState &

)

const double makVrf::DtWeatherStateComponentNextFrame::precipitationIntensity

(

)

const

void makVrf::DtWeatherStateComponentNextFrame::setPrecipitationIntensity

(

const double &

)

const DtVrfWeatherPrecipitationType makVrf::DtWeatherStateComponentNextFrame::precipitationType

(

)

const

void makVrf::DtWeatherStateComponentNextFrame::setPrecipitationType

(

const DtVrfWeatherPrecipitationType &

)

const double makVrf::DtWeatherStateComponentNextFrame::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.

void makVrf::DtWeatherStateComponentNextFrame::setWindSpeed ( const double &  )

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.

void makVrf::DtWeatherStateComponentNextFrame::setWindSpeed ( const double &  atAlt, const double &    )

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::DtWeatherStateComponentNextFrame::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.

void makVrf::DtWeatherStateComponentNextFrame::setWindDirection ( const double &  )

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.

void makVrf::DtWeatherStateComponentNextFrame::setWindDirection ( const double &  atAlt, const double &    )

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::DtWeatherStateComponentNextFrame::priority

(

)

const

void makVrf::DtWeatherStateComponentNextFrame::setPriority

(

const int &

)

const double makVrf::DtWeatherStateComponentNextFrame::visibility ( 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.

void makVrf::DtWeatherStateComponentNextFrame::setVisibility ( const double &  )

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.

void makVrf::DtWeatherStateComponentNextFrame::setVisibility ( const double &  atAlt, const double &    )

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::DtWeatherStateComponentNextFrame::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.

void makVrf::DtWeatherStateComponentNextFrame::setObscurant ( double  atAlt, const int &    )

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::DtWeatherStateComponentNextFrame::underwaterVisibility

(

)

const

void makVrf::DtWeatherStateComponentNextFrame::setUnderwaterVisibility

(

const double &

)

const double makVrf::DtWeatherStateComponentNextFrame::surfaceTransparency

(

)

const

void makVrf::DtWeatherStateComponentNextFrame::setSurfaceTransparency

(

const double &

)

const double makVrf::DtWeatherStateComponentNextFrame::waterCurrentSpeed

(

)

const

void makVrf::DtWeatherStateComponentNextFrame::setWaterCurrentSpeed

(

const double &

)

const double makVrf::DtWeatherStateComponentNextFrame::waterCurrentDirection

(

)

const

void makVrf::DtWeatherStateComponentNextFrame::setWaterCurrentDirection

(

const double &

)

const double makVrf::DtWeatherStateComponentNextFrame::ambientWaterTemperature

(

)

const

void makVrf::DtWeatherStateComponentNextFrame::setAmbientWaterTemperature

(

const double &

)

const double makVrf::DtWeatherStateComponentNextFrame::snowAccumulation

(

)

const

void makVrf::DtWeatherStateComponentNextFrame::setSnowAccumulation

(

const double &

)

const double makVrf::DtWeatherStateComponentNextFrame::rainAccumulation

(

)

const

void makVrf::DtWeatherStateComponentNextFrame::setRainAccumulation

(

const double &

)

const double makVrf::DtWeatherStateComponentNextFrame::snowMinimumAltitude

(

)

const

void makVrf::DtWeatherStateComponentNextFrame::setSnowMinimumAltitude

(

const double &

)

const double makVrf::DtWeatherStateComponentNextFrame::snowRoadAccumulation

(

)

const

void makVrf::DtWeatherStateComponentNextFrame::setSnowRoadAccumulation

(

const double &

)

const double makVrf::DtWeatherStateComponentNextFrame::tidalOffset

(

)

const

void makVrf::DtWeatherStateComponentNextFrame::setTidalOffset

(

const double &

)

const int makVrf::DtWeatherStateComponentNextFrame::swellState

(

)

const

void makVrf::DtWeatherStateComponentNextFrame::setSwellState

(

const int &

)

const double makVrf::DtWeatherStateComponentNextFrame::swellStateDirection

(

)

const

void makVrf::DtWeatherStateComponentNextFrame::setSwellStateDirection

(

const double &

)

const int makVrf::DtWeatherStateComponentNextFrame::seaState

(

)

const

void makVrf::DtWeatherStateComponentNextFrame::setSeaState

(

const int &

)

const double makVrf::DtWeatherStateComponentNextFrame::seaStateDirection

(

)

const

void makVrf::DtWeatherStateComponentNextFrame::setSeaStateDirection

(

const double &

)

const bool makVrf::DtWeatherStateComponentNextFrame::windDrivenSeaStateEnabled

(

)

const

void makVrf::DtWeatherStateComponentNextFrame::setWindDrivenSeaStateEnabled

(

const bool &

)

const double makVrf::DtWeatherStateComponentNextFrame::choppiness

(

)

const

void makVrf::DtWeatherStateComponentNextFrame::setChoppiness

(

const double &

)

const double makVrf::DtWeatherStateComponentNextFrame::surgeDepth

(

)

const

void makVrf::DtWeatherStateComponentNextFrame::setSurgeDepth

(

const double &

)

const double makVrf::DtWeatherStateComponentNextFrame::fogHeight

(

)

const

void makVrf::DtWeatherStateComponentNextFrame::setFogHeight

(

const double &

)

const unsigned int makVrf::DtWeatherStateComponentNextFrame::flags

(

)

const

void makVrf::DtWeatherStateComponentNextFrame::setFlags

(

const unsigned int &

)

const bool makVrf::DtWeatherStateComponentNextFrame::lightningPresent

(

)

const

void makVrf::DtWeatherStateComponentNextFrame::setLightningPresent

(

const bool &

)

const DtVector makVrf::DtWeatherStateComponentNextFrame::fogColor

(

)

const

void makVrf::DtWeatherStateComponentNextFrame::setFogColor

(

const DtVector &

)

const double makVrf::DtWeatherStateComponentNextFrame::thermoclineLayer1Depth

(

)

const

void makVrf::DtWeatherStateComponentNextFrame::setThermoclineLayer1Depth

(

const double &

)

const double makVrf::DtWeatherStateComponentNextFrame::thermoclineLayer1Permeability

(

)

const

void makVrf::DtWeatherStateComponentNextFrame::setThermoclineLayer1Permeability

(

const double &

)

const double makVrf::DtWeatherStateComponentNextFrame::thermoclineLayer2Depth

(

)

const

void makVrf::DtWeatherStateComponentNextFrame::setThermoclineLayer2Depth

(

const double &

)

const double makVrf::DtWeatherStateComponentNextFrame::thermoclineLayer2Permeability

(

)

const

void makVrf::DtWeatherStateComponentNextFrame::setThermoclineLayer2Permeability

(

const double &

)

const double makVrf::DtWeatherStateComponentNextFrame::thermoclineLayer3Depth

(

)

const

void makVrf::DtWeatherStateComponentNextFrame::setThermoclineLayer3Depth

(

const double &

)

const double makVrf::DtWeatherStateComponentNextFrame::thermoclineLayer3Permeability

(

)

const

void makVrf::DtWeatherStateComponentNextFrame::setThermoclineLayer3Permeability

(

const double &

)

const double makVrf::DtWeatherStateComponentNextFrame::thermoclineLayer4Depth

(

)

const

void makVrf::DtWeatherStateComponentNextFrame::setThermoclineLayer4Depth

(

const double &

)

const double makVrf::DtWeatherStateComponentNextFrame::thermoclineLayer4Permeability

(

)

const

void makVrf::DtWeatherStateComponentNextFrame::setThermoclineLayer4Permeability

(

const double &

)

const double makVrf::DtWeatherStateComponentNextFrame::thermoclineLayer5Depth

(

)

const

void makVrf::DtWeatherStateComponentNextFrame::setThermoclineLayer5Depth

(

const double &

)

const double makVrf::DtWeatherStateComponentNextFrame::thermoclineLayer5Permeability

(

)

const

void makVrf::DtWeatherStateComponentNextFrame::setThermoclineLayer5Permeability

(

const double &

)

const double makVrf::DtWeatherStateComponentNextFrame::airTemperatureAltitude

(

)

const

void makVrf::DtWeatherStateComponentNextFrame::setAirTemperatureAltitude

(

const double &

)

const double makVrf::DtWeatherStateComponentNextFrame::airPressureAltitude

(

)

const

void makVrf::DtWeatherStateComponentNextFrame::setAirPressureAltitude

(

const double &

)

const bool makVrf::DtWeatherStateComponentNextFrame::airTemperatureAltitudeIsSeaLevel

(

)

const

void makVrf::DtWeatherStateComponentNextFrame::setAirTemperatureAltitudeIsSeaLevel

(

const bool &

)

const bool makVrf::DtWeatherStateComponentNextFrame::airPressureAltitudeIsSeaLevel

(

)

const

void makVrf::DtWeatherStateComponentNextFrame::setAirPressureAltitudeIsSeaLevel

(

const bool &

)

const double makVrf::DtWeatherStateComponentNextFrame::seaLevelWaterConcentration

(

)

const

void makVrf::DtWeatherStateComponentNextFrame::setSeaLevelWaterConcentration

(

const double &

)

void makVrf::DtWeatherStateComponentNextFrame::addWindLevel ( double  altitude, double  windSpeed, double  windDirection, double  visibleDistance, int  obscurant, int  cloudType, double  cloudDensity, double  skyCoverage  )

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.

void makVrf::DtWeatherStateComponentNextFrame::clearWindLevels ( )

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.

void makVrf::DtWeatherStateComponentNextFrame::removeWindLevel ( double  baseAltitude )

virtual

Must be exact match.

Reimplemented from makVrf::DtWeatherStateComponent.

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

virtual

Given the altitude, return the wind speed and direction.

Reimplemented from makVrf::DtWeatherStateComponent.

void makVrf::DtWeatherStateComponentNextFrame::setWindSpeedAndDirectionAtAltitude ( const double &  altMSL, const double &  windSpeed, const double &  windDirection  )

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::DtWeatherStateComponentNextFrame::visibilityAndObscurantAtAltitude ( double  altMSL, double &  distance, int &  obs  ) const

virtual

Given the altitude, return the visibility and obscurant.

Reimplemented from makVrf::DtWeatherStateComponent.

void makVrf::DtWeatherStateComponentNextFrame::setVisibilityAndObscurantAtAltitude ( const double &  altMSL, const double &  distance, const int &  obs  )

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.

void makVrf::DtWeatherStateComponentNextFrame::setWindLevels ( const DtRwWindLevels &  )

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 DtRwWindLevels& makVrf::DtWeatherStateComponentNextFrame::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.

Referenced by makVrf::DtWeatherStateComponentCurrentFrame::advanceFrame().

virtual void makVrf::DtWeatherStateComponentNextFrame::makeWritable ( )

virtual

Override to make component writable.

Reimplemented from makVrf::DtFrameStateInterface.

virtual void makVrf::DtWeatherStateComponentNextFrame::makeReadOnly ( )

virtual

Override to make component read-only.

Reimplemented from makVrf::DtFrameStateInterface.

VRF::WriteThermoclineLayerRepository makVrf::DtWeatherStateComponentNextFrame::thermoclineLayer ( int  ) const

protected

VRF::WriteThermoclineLayerRepository makVrf::DtWeatherStateComponentNextFrame::getOrCreateThermoclineLayer ( int  )

protected

Will add record at layer (and previous layers) if layer does not exist.

virtual void makVrf::DtWeatherStateComponentNextFrame::setupWindLevels ( )

protectedvirtual

Member Data Documentation

VRF::WriteWeatherStateRepository makVrf::DtWeatherStateComponentNextFrame::myWriteWeatherStateRepository

protected

DtStateData* makVrf::DtWeatherStateComponentNextFrame::myStateData

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