DtVrfEnvironmentalWeatherStateRecord Class Reference

Inheritance diagram for DtVrfEnvironmentalWeatherStateRecord:

Public Member Functions
	DtVrfEnvironmentalWeatherStateRecord ()
	DtVrfEnvironmentalWeatherStateRecord (const DtVrfEnvironmentalWeatherStateRecord &orig)
const DtVrfEnvironmentalWeatherStateRecord &	operator= (const DtVrfEnvironmentalWeatherStateRecord &orig)
virtual	~DtVrfEnvironmentalWeatherStateRecord ()
virtual DtEnvironmentalRecord *	clone () const
virtual void	setFogHeight (double)
virtual double	fogHeight ()
virtual void	setSnowAccumulation (double)
virtual double	snowAccumulation ()
virtual void	setSnowMinimumAltitude (double)
virtual double	snowMinimumAltitude ()
virtual void	setSnowRoadAccumulation (double)
virtual double	snowRoadAccumulation ()
virtual void	setRainAccumulation (double)
virtual double	rainAccumulation ()
virtual void	setAirPressureAltitude (double)
virtual double	airPressureAltitude ()
virtual void	setAirTemperatureAltitude (double)
virtual double	airTemperatureAltitude ()
virtual void	setAirPressureAltitudeIsSeaLevel (bool seaLevel)
virtual bool	airPressureAltitudeIsSeaLevel ()
virtual void	setAirTemperatureAltitudeIsSeaLevel (bool seaLevel)
virtual bool	airTemperatureAltitudeIsSeaLevel ()
virtual void	setSeaLevelWaterConcentration (double)
virtual double	seaLevelWaterConcentration ()
virtual bool	createNetworkRepresentation ()
const DtNetWeatherStateRecord *	objStateNetRep () const
DtNetWeatherStateRecord *	objStateNetRep ()
virtual void	setFromNet (const DtNetEnvironmentalRecord &buffer, int protocolVersion)
virtual int	netRepSize () const
virtual void	setAirTurbidity (double value)
virtual double	airTurbidity () const
virtual void	setPriority (int value)
virtual int	priority () const
virtual void	setAmbientAirTemperature (double value)
virtual double	ambientAirTemperature () const
virtual void	setAirPressure (double value)
virtual double	airPressure () const
virtual void	setCloudState (unsigned int value)
virtual unsigned int	cloudState () const
virtual void	setPrecipitationIntensity (double value)
virtual double	precipitationIntensity () const
virtual void	setPrecipitationType (unsigned int value)
virtual unsigned int	precipitationType () const
virtual void	setWindSpeed (double value)
virtual double	windSpeed () const
virtual void	setWindDirection (double value)
virtual double	windDirection () const
virtual void	setVisibility (double value)
virtual double	visibility () const
virtual void	setIllumination (double value)
virtual double	illumination () const
virtual void	setUnderwaterVisibility (double underwaterVisibility)
virtual double	underwaterVisibility ()
virtual void	setSurfaceTransparency (double transparency)
virtual double	surfaceTransparency ()
virtual void	setWaterCurrentSpeed (double waterCurrentSpeed)
virtual double	waterCurrentSpeed ()
virtual void	setWaterCurrentDirection (double waterCurrentDirection)
virtual double	waterCurrentDirection ()
virtual void	setAmbientWaterTemperature (double waterTemperature)
virtual double	ambientWaterTemperature ()
virtual void	setTidalOffset (double tidalOffset)
virtual double	tidalOffset ()
virtual void	setTidalDirection (bool tidalDirection)
virtual bool	tidalDirection ()
virtual void	setSwellState (unsigned int state)
virtual unsigned int	swellState ()
virtual void	setSwellStateDirection (double direction)
virtual double	swellStateDirection ()
virtual void	setSeaState (unsigned int douglasScale)
virtual unsigned int	seaState ()
virtual void	setSeaStateDirection (double radiansFromNorth)
virtual double	seaStateDirection ()
void	setWindDrivenSeaStateEnabled (bool enabled)
bool	windDrivenSeaStateEnabled ()
virtual void	setChoppiness (double choppiness)
virtual double	choppiness ()
virtual void	setSurgeDepth (double depth)
virtual double	surgeDepth ()
virtual void	setFogColor (double red, double green, double blue)
virtual void	getFogColor (double &red, double &green, double &blue)
virtual DtVector	fogColor ()
virtual void	setThermoclineLayer1Depth (double depth)
virtual double	thermoclineLayer1Depth ()
virtual void	setThermoclineLayer1Permeability (double depth)
virtual double	thermoclineLayer1Permeability ()
virtual void	setThermoclineLayer2Depth (double depth)
virtual double	thermoclineLayer2Depth ()
virtual void	setThermoclineLayer2Permeability (double depth)
virtual double	thermoclineLayer2Permeability ()
virtual void	setThermoclineLayer3Depth (double depth)
virtual double	thermoclineLayer3Depth ()
virtual void	setThermoclineLayer3Permeability (double depth)
virtual double	thermoclineLayer3Permeability ()
virtual void	setThermoclineLayer4Depth (double depth)
virtual double	thermoclineLayer4Depth ()
virtual void	setThermoclineLayer4Permeability (double depth)
virtual double	thermoclineLayer4Permeability ()
virtual void	setThermoclineLayer5Depth (double depth)
virtual double	thermoclineLayer5Depth ()
virtual void	setThermoclineLayer5Permeability (double depth)
virtual double	thermoclineLayer5Permeability ()
virtual void	setFlags (DtU32 value)
virtual DtU32	flags () const
virtual double	timeOfDay () const
virtual time_t	dateAndTimeOfDay () const
virtual double	timeOfDayAdvancementSpeed () const

Protected Member Functions
virtual bool	resizeNetRep (int newSize)
virtual void	reworkStateRepForVersion (int bytesToCopy, int iVersion)
DtVrfEnvironmentalWeatherStateRecord *	self () const

Protected Attributes
int	myNetRepSize
double	myOldTimeOfDayAdvancementSpeed
time_t	myOldTimeOfDay

Constructor & Destructor Documentation

DtVrfEnvironmentalWeatherStateRecord::DtVrfEnvironmentalWeatherStateRecord

(

)

DtVrfEnvironmentalWeatherStateRecord::DtVrfEnvironmentalWeatherStateRecord

(

const DtVrfEnvironmentalWeatherStateRecord &

orig

)

Copy constructor.

virtual DtVrfEnvironmentalWeatherStateRecord::~DtVrfEnvironmentalWeatherStateRecord ( )

virtual

Member Function Documentation

const DtVrfEnvironmentalWeatherStateRecord& DtVrfEnvironmentalWeatherStateRecord::operator=

(

const DtVrfEnvironmentalWeatherStateRecord &

orig

)

virtual DtEnvironmentalRecord* DtVrfEnvironmentalWeatherStateRecord::clone ( ) const

virtual

virtual void DtVrfEnvironmentalWeatherStateRecord::setAirTurbidity ( double  value )

virtual

virtual double DtVrfEnvironmentalWeatherStateRecord::airTurbidity ( ) const

virtual

virtual void DtVrfEnvironmentalWeatherStateRecord::setPriority ( int  value )

virtual

virtual int DtVrfEnvironmentalWeatherStateRecord::priority ( ) const

virtual

virtual void DtVrfEnvironmentalWeatherStateRecord::setAmbientAirTemperature ( double  value )

virtual

virtual double DtVrfEnvironmentalWeatherStateRecord::ambientAirTemperature ( ) const

virtual

virtual void DtVrfEnvironmentalWeatherStateRecord::setAirPressure ( double  value )

virtual

virtual double DtVrfEnvironmentalWeatherStateRecord::airPressure ( ) const

virtual

virtual void DtVrfEnvironmentalWeatherStateRecord::setCloudState ( unsigned int  value )

virtual

virtual unsigned int DtVrfEnvironmentalWeatherStateRecord::cloudState ( ) const

virtual

virtual void DtVrfEnvironmentalWeatherStateRecord::setPrecipitationIntensity ( double  value )

virtual

virtual double DtVrfEnvironmentalWeatherStateRecord::precipitationIntensity ( ) const

virtual

virtual void DtVrfEnvironmentalWeatherStateRecord::setPrecipitationType ( unsigned int  value )

virtual

virtual unsigned int DtVrfEnvironmentalWeatherStateRecord::precipitationType ( ) const

virtual

virtual void DtVrfEnvironmentalWeatherStateRecord::setWindSpeed ( double  value )

virtual

virtual double DtVrfEnvironmentalWeatherStateRecord::windSpeed ( ) const

virtual

virtual void DtVrfEnvironmentalWeatherStateRecord::setWindDirection ( double  value )

virtual

virtual double DtVrfEnvironmentalWeatherStateRecord::windDirection ( ) const

virtual

virtual void DtVrfEnvironmentalWeatherStateRecord::setVisibility ( double  value )

virtual

virtual double DtVrfEnvironmentalWeatherStateRecord::visibility ( ) const

virtual

virtual void DtVrfEnvironmentalWeatherStateRecord::setIllumination ( double  value )

virtual

virtual double DtVrfEnvironmentalWeatherStateRecord::illumination ( ) const

virtual

virtual void DtVrfEnvironmentalWeatherStateRecord::setUnderwaterVisibility ( double  underwaterVisibility )

virtual

virtual double DtVrfEnvironmentalWeatherStateRecord::underwaterVisibility ( )

virtual

virtual void DtVrfEnvironmentalWeatherStateRecord::setSurfaceTransparency ( double  transparency )

virtual

virtual double DtVrfEnvironmentalWeatherStateRecord::surfaceTransparency ( )

virtual

virtual void DtVrfEnvironmentalWeatherStateRecord::setWaterCurrentSpeed ( double  waterCurrentSpeed )

virtual

virtual double DtVrfEnvironmentalWeatherStateRecord::waterCurrentSpeed ( )

virtual

virtual void DtVrfEnvironmentalWeatherStateRecord::setWaterCurrentDirection ( double  waterCurrentDirection )

virtual

virtual double DtVrfEnvironmentalWeatherStateRecord::waterCurrentDirection ( )

virtual

virtual void DtVrfEnvironmentalWeatherStateRecord::setAmbientWaterTemperature ( double  waterTemperature )

virtual

virtual double DtVrfEnvironmentalWeatherStateRecord::ambientWaterTemperature ( )

virtual

virtual void DtVrfEnvironmentalWeatherStateRecord::setTidalOffset ( double  tidalOffset )

virtual

virtual double DtVrfEnvironmentalWeatherStateRecord::tidalOffset ( )

virtual

virtual void DtVrfEnvironmentalWeatherStateRecord::setTidalDirection ( bool  tidalDirection )

virtual

virtual bool DtVrfEnvironmentalWeatherStateRecord::tidalDirection ( )

virtual

virtual void DtVrfEnvironmentalWeatherStateRecord::setSwellState ( unsigned int  state )

virtual

virtual unsigned int DtVrfEnvironmentalWeatherStateRecord::swellState ( )

virtual

virtual void DtVrfEnvironmentalWeatherStateRecord::setSwellStateDirection ( double  direction )

virtual

virtual double DtVrfEnvironmentalWeatherStateRecord::swellStateDirection ( )

virtual

virtual void DtVrfEnvironmentalWeatherStateRecord::setSeaState ( unsigned int  douglasScale )

virtual

Sea state according to the Douglas Sea Scale.

virtual unsigned int DtVrfEnvironmentalWeatherStateRecord::seaState ( )

virtual

Sea state according to the Douglas Sea Scale.

virtual void DtVrfEnvironmentalWeatherStateRecord::setSeaStateDirection ( double  radiansFromNorth )

virtual

The direction waves travel from in radians from North.

virtual double DtVrfEnvironmentalWeatherStateRecord::seaStateDirection ( )

virtual

The direction waves travel from in radians from North.

void DtVrfEnvironmentalWeatherStateRecord::setWindDrivenSeaStateEnabled

(

bool

enabled

)

Flag for enabling sea-state to be driven by wind.

bool DtVrfEnvironmentalWeatherStateRecord::windDrivenSeaStateEnabled

(

)

Flag for enabling sea-state to be driven by wind.

virtual void DtVrfEnvironmentalWeatherStateRecord::setChoppiness ( double  choppiness )

virtual

virtual double DtVrfEnvironmentalWeatherStateRecord::choppiness ( )

virtual

virtual void DtVrfEnvironmentalWeatherStateRecord::setSurgeDepth ( double  depth )

virtual

virtual double DtVrfEnvironmentalWeatherStateRecord::surgeDepth ( )

virtual

virtual void DtVrfEnvironmentalWeatherStateRecord::setFogColor ( double  red, double  green, double  blue  )

virtual

virtual void DtVrfEnvironmentalWeatherStateRecord::getFogColor ( double &  red, double &  green, double &  blue  )

virtual

virtual DtVector DtVrfEnvironmentalWeatherStateRecord::fogColor ( )

virtual

virtual void DtVrfEnvironmentalWeatherStateRecord::setFogHeight ( double  )

virtual

Fog height (in meters)

virtual double DtVrfEnvironmentalWeatherStateRecord::fogHeight ( )

virtual

virtual void DtVrfEnvironmentalWeatherStateRecord::setSnowAccumulation ( double  )

virtual

Snow Accumulation (in meters)

virtual double DtVrfEnvironmentalWeatherStateRecord::snowAccumulation ( )

virtual

virtual void DtVrfEnvironmentalWeatherStateRecord::setSnowMinimumAltitude ( double  )

virtual

Snow Minimum Altitude (in meters)

virtual double DtVrfEnvironmentalWeatherStateRecord::snowMinimumAltitude ( )

virtual

virtual void DtVrfEnvironmentalWeatherStateRecord::setSnowRoadAccumulation ( double  )

virtual

Snow Road Accumulation (in meters)

virtual double DtVrfEnvironmentalWeatherStateRecord::snowRoadAccumulation ( )

virtual

virtual void DtVrfEnvironmentalWeatherStateRecord::setRainAccumulation ( double  )

virtual

Rain Accumulation (in meters)

virtual double DtVrfEnvironmentalWeatherStateRecord::rainAccumulation ( )

virtual

virtual void DtVrfEnvironmentalWeatherStateRecord::setAirPressureAltitude ( double  )

virtual

Air pressure altitude (in meters)

virtual double DtVrfEnvironmentalWeatherStateRecord::airPressureAltitude ( )

virtual

virtual void DtVrfEnvironmentalWeatherStateRecord::setAirTemperatureAltitude ( double  )

virtual

Air temperature altitude (in meters)

virtual double DtVrfEnvironmentalWeatherStateRecord::airTemperatureAltitude ( )

virtual

virtual void DtVrfEnvironmentalWeatherStateRecord::setAirPressureAltitudeIsSeaLevel ( bool  seaLevel )

virtual

Flag to either use sea level or specific altitude for air pressure.

virtual bool DtVrfEnvironmentalWeatherStateRecord::airPressureAltitudeIsSeaLevel ( )

virtual

virtual void DtVrfEnvironmentalWeatherStateRecord::setAirTemperatureAltitudeIsSeaLevel ( bool  seaLevel )

virtual

Flag to either use sea level or specific altitude for air temperature.

virtual bool DtVrfEnvironmentalWeatherStateRecord::airTemperatureAltitudeIsSeaLevel ( )

virtual

virtual void DtVrfEnvironmentalWeatherStateRecord::setSeaLevelWaterConcentration ( double  )

virtual

Sea level water concentration (in PPMV (parts per million by volume))

virtual double DtVrfEnvironmentalWeatherStateRecord::seaLevelWaterConcentration ( )

virtual

virtual void DtVrfEnvironmentalWeatherStateRecord::setThermoclineLayer1Depth ( double  depth )

virtual

virtual double DtVrfEnvironmentalWeatherStateRecord::thermoclineLayer1Depth ( )

virtual

virtual void DtVrfEnvironmentalWeatherStateRecord::setThermoclineLayer1Permeability ( double  depth )

virtual

virtual double DtVrfEnvironmentalWeatherStateRecord::thermoclineLayer1Permeability ( )

virtual

virtual void DtVrfEnvironmentalWeatherStateRecord::setThermoclineLayer2Depth ( double  depth )

virtual

virtual double DtVrfEnvironmentalWeatherStateRecord::thermoclineLayer2Depth ( )

virtual

virtual void DtVrfEnvironmentalWeatherStateRecord::setThermoclineLayer2Permeability ( double  depth )

virtual

virtual double DtVrfEnvironmentalWeatherStateRecord::thermoclineLayer2Permeability ( )

virtual

virtual void DtVrfEnvironmentalWeatherStateRecord::setThermoclineLayer3Depth ( double  depth )

virtual

virtual double DtVrfEnvironmentalWeatherStateRecord::thermoclineLayer3Depth ( )

virtual

virtual void DtVrfEnvironmentalWeatherStateRecord::setThermoclineLayer3Permeability ( double  depth )

virtual

virtual double DtVrfEnvironmentalWeatherStateRecord::thermoclineLayer3Permeability ( )

virtual

virtual void DtVrfEnvironmentalWeatherStateRecord::setThermoclineLayer4Depth ( double  depth )

virtual

virtual double DtVrfEnvironmentalWeatherStateRecord::thermoclineLayer4Depth ( )

virtual

virtual void DtVrfEnvironmentalWeatherStateRecord::setThermoclineLayer4Permeability ( double  depth )

virtual

virtual double DtVrfEnvironmentalWeatherStateRecord::thermoclineLayer4Permeability ( )

virtual

virtual void DtVrfEnvironmentalWeatherStateRecord::setThermoclineLayer5Depth ( double  depth )

virtual

virtual double DtVrfEnvironmentalWeatherStateRecord::thermoclineLayer5Depth ( )

virtual

virtual void DtVrfEnvironmentalWeatherStateRecord::setThermoclineLayer5Permeability ( double  depth )

virtual

virtual double DtVrfEnvironmentalWeatherStateRecord::thermoclineLayer5Permeability ( )

virtual

virtual void DtVrfEnvironmentalWeatherStateRecord::setFlags ( DtU32  value )

virtual

virtual DtU32 DtVrfEnvironmentalWeatherStateRecord::flags ( ) const

virtual

virtual bool DtVrfEnvironmentalWeatherStateRecord::createNetworkRepresentation ( )

virtual

const DtNetWeatherStateRecord* DtVrfEnvironmentalWeatherStateRecord::objStateNetRep

(

)

const

DtNetWeatherStateRecord* DtVrfEnvironmentalWeatherStateRecord::objStateNetRep

(

)

virtual void DtVrfEnvironmentalWeatherStateRecord::setFromNet ( const DtNetEnvironmentalRecord &  buffer, int  protocolVersion  )

virtual

virtual int DtVrfEnvironmentalWeatherStateRecord::netRepSize ( ) const

virtual

virtual double DtVrfEnvironmentalWeatherStateRecord::timeOfDay ( ) const

virtual

Only here for support of previous network access. The new network delivery has date/time of day in a separate packet.

virtual time_t DtVrfEnvironmentalWeatherStateRecord::dateAndTimeOfDay ( ) const

virtual

virtual double DtVrfEnvironmentalWeatherStateRecord::timeOfDayAdvancementSpeed ( ) const

virtual

virtual bool DtVrfEnvironmentalWeatherStateRecord::resizeNetRep ( int  newSize )

protectedvirtual

virtual void DtVrfEnvironmentalWeatherStateRecord::reworkStateRepForVersion ( int  bytesToCopy, int  iVersion  )

protectedvirtual

DtVrfEnvironmentalWeatherStateRecord* DtVrfEnvironmentalWeatherStateRecord::self ( ) const

protected

Member Data Documentation

int DtVrfEnvironmentalWeatherStateRecord::myNetRepSize

protected

double DtVrfEnvironmentalWeatherStateRecord::myOldTimeOfDayAdvancementSpeed

protected

time_t DtVrfEnvironmentalWeatherStateRecord::myOldTimeOfDay

protected

---

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

• /data/exports/nrhent7-1/nightly/docs/vrForces.vrf5-1-branch/include/vrfExtObjects/vrfEnvironmentalWeatherStateRecord.h