A DtSimCommand subclass which specifies a change to the global weather settings in the simulation engine. More...

Inheritance diagram for DtChangeGlobalWeatherCommand:

Public Member Functions
	DtChangeGlobalWeatherCommand ()
	default constructor
	DtChangeGlobalWeatherCommand (const DtString &writeName, DtReaderWriterRegistry *parentRegistry=NULL)
	Usual constructor.
	DtChangeGlobalWeatherCommand (const DtString &writeName, const DtChangeGlobalWeatherCommand &orig, DtReaderWriterRegistry *parentRegistry=NULL)
	copy constructor
virtual	~DtChangeGlobalWeatherCommand ()
	destructor
DtChangeGlobalWeatherCommand &	operator= (const DtChangeGlobalWeatherCommand &orig)
	assignment operator
int	type () const
virtual DtSimCommand *	clone (const DtString &name, DtReaderWriterRegistry *parentRegistry=0) const
virtual int	netRepSize () const
	Returns the size in bytes of the network representation of the class.
virtual bool	setFromNet (const char *contentBuffer, unsigned contentSize)
	Sets mySubsimCommand member from the incoming contentBuffer (cast to type DtNetSimSimCommand).
virtual bool	setToNet ()
	Calls netRep() to create the network buffer.
virtual DtString	stringRep () const
	Text representation of this command.

virtual void	setAirTurbidity (double factor)
	The air turbidity.
virtual double	airTurbidity () const
	The air turbidity.
virtual bool	airTurbiditySpecified () const
	Indicates whether or not the air turbidity is specified in the message.
virtual void	clearAirTurbidity ()
	Clears the specified flag for air turbidity.

virtual void	setCloudState (DtVrfWeatherCloudState type)
	The cloud state.
virtual DtVrfWeatherCloudState	cloudState () const
	The cloud state.
virtual bool	cloudStateSpecified () const
	Indicates whether or not the cloud state is specified in the message.
virtual void	clearCloudState ()
	Clears the specified flag for cloud state.

virtual void	setPrecipitationIntensity (double factor)
	The precipitation intensity.
virtual double	precipitationIntensity () const
	The precipitation intensity.
virtual bool	precipitationIntensitySpecified () const
	Indicates whether or not the precipitation type is specified in the message.
virtual void	clearPrecipitationIntensity ()
	Clears the specified flag for precipitation intensity.

virtual void	setPrecipitationType (DtVrfWeatherPrecipitationType type)
	The precipitation type.
virtual DtVrfWeatherPrecipitationType	precipitationType () const
	The precipitation type.
virtual bool	precipitationTypeSpecified () const
	Indicates whether or not the precipitation type is specified in the message.
virtual void	clearPrecipitationType ()
	Clears the specified flag for precipitation type.

virtual void	setVisibility (double distance)
	The visibility distance, specified in meters.
virtual double	visibility () const
	The visibility distance, specified in meters.
virtual bool	visibilitySpecified () const
	Indicates whether or not the visibility is specified in the message.
virtual void	clearVisibility ()
	Clears the specified flag for visibility.

virtual void	setWindDirection (double radians)
	The compass direction from which the wind is blowing, specified in radians.
virtual double	windDirection () const
	The compass direction from which the wind is blowing, specified in radians.
virtual bool	windDirectionSpecified () const
	Indicates whether or not the wind direction is specified in the message.
virtual void	clearWindDirection ()
	Clears the specified flag for wind direction.

virtual void	setWindSpeed (double value)
	The speed the wind is blowing, specified in meters per second.
virtual double	windSpeed () const
	The speed the wind is blowing, specified in meters per second.
virtual bool	windSpeedSpecified () const
	Indicates whether or not the wind speed is specified in the message.
virtual void	clearWindSpeed ()
	Clears the specified flag for wind speed.

virtual void	setGeneratedByRemoteWeatherSetter (bool value)
	Used internally by VRF.
virtual bool	generatedByRemoteWeatherSetter () const
	Used internally by VRF.
Static Public Member Functions
static DtSimCommand *	creator ()
Protected Attributes
DtRwReal	myAirTurbidity
DtRwInt	myCloudState
DtRwReal	myPrecipitationIntensity
DtRwInt	myPrecipitationType
DtRwReal	myWindDirection
DtRwReal	myWindSpeed
DtRwReal	myVisibility
DtRwBoolean	myGeneratedByRemoteWeatherSetter

Detailed Description

A DtSimCommand subclass which specifies a change to the global weather settings in the simulation engine.

The command may partially specify the global weather, such as specifying the wind and not the visibility. Only items that are specified will be changed by the command. Others will be left unchanged.

Constructor & Destructor Documentation

DtChangeGlobalWeatherCommand::DtChangeGlobalWeatherCommand ( )

default constructor

DtChangeGlobalWeatherCommand::DtChangeGlobalWeatherCommand	(	const DtString &	writeName,
		DtReaderWriterRegistry *	parentRegistry = `NULL`
	)

Usual constructor.

DtChangeGlobalWeatherCommand::DtChangeGlobalWeatherCommand	(	const DtString &	writeName,
		const DtChangeGlobalWeatherCommand &	orig,
		DtReaderWriterRegistry *	parentRegistry = `NULL`
	)

copy constructor

virtual DtChangeGlobalWeatherCommand::~DtChangeGlobalWeatherCommand ( ) [virtual]

destructor

Member Function Documentation

DtChangeGlobalWeatherCommand& DtChangeGlobalWeatherCommand::operator= ( const DtChangeGlobalWeatherCommand & orig )

assignment operator

int DtChangeGlobalWeatherCommand::type ( ) const [virtual]

Returns:: The type of this DtSimCommand (specified in radioMsgTypes.h)

Implements DtSimCommand.

virtual DtSimCommand* DtChangeGlobalWeatherCommand::clone	(	const DtString &	name,
		DtReaderWriterRegistry *	parentRegistry = `0`
	)		const `[virtual]`

Returns:: A new instance of this class, copied from the original.

Implements DtSimCommand.

virtual int DtChangeGlobalWeatherCommand::netRepSize ( ) const [virtual]

Returns the size in bytes of the network representation of the class.

This is the size in bytes of the DtNetSimSimCommand structure. Derived classes should take into acount the size returned by this class when overriding (they should call down to this class and add the result to their additional size).

Reimplemented from DtSimCommand.

virtual bool DtChangeGlobalWeatherCommand::setFromNet	(	const char *	contentBuffer,
		unsigned	contentSize
	)		`[virtual]`

Sets mySubsimCommand member from the incoming contentBuffer (cast to type DtNetSimSimCommand).

Derived classes should call down to this function first, and then extract their own data starting at the location contentBuffer + DtSimCommand::netRepSize().

Reimplemented from DtSimCommand.

virtual bool DtChangeGlobalWeatherCommand::setToNet ( ) [virtual]

Calls netRep() to create the network buffer.

Casts the resulting myNetRep to type DtNetSimSimCommand*, and then sets the mySubsimCommand member in the DtNetSimSimCommand from mySubsimCommand. Derived classes should call down to the base class version of setToNet() at the start of the function (before doing any processing on the network representation) They can then start to fill in their network data, starting at the location myNetRep + DtSimCommand::netRepSize().

Reimplemented from DtSimCommand.

virtual void DtChangeGlobalWeatherCommand::setAirTurbidity ( double factor ) [virtual]

The air turbidity.

virtual double DtChangeGlobalWeatherCommand::airTurbidity ( ) const [virtual]

The air turbidity.

virtual bool DtChangeGlobalWeatherCommand::airTurbiditySpecified ( ) const [virtual]

Indicates whether or not the air turbidity is specified in the message.

virtual void DtChangeGlobalWeatherCommand::clearAirTurbidity ( ) [virtual]

Clears the specified flag for air turbidity.

virtual void DtChangeGlobalWeatherCommand::setCloudState ( DtVrfWeatherCloudState type ) [virtual]

The cloud state.

virtual DtVrfWeatherCloudState DtChangeGlobalWeatherCommand::cloudState ( ) const [virtual]

The cloud state.

virtual bool DtChangeGlobalWeatherCommand::cloudStateSpecified ( ) const [virtual]

Indicates whether or not the cloud state is specified in the message.

virtual void DtChangeGlobalWeatherCommand::clearCloudState ( ) [virtual]

Clears the specified flag for cloud state.

virtual void DtChangeGlobalWeatherCommand::setPrecipitationIntensity ( double factor ) [virtual]

The precipitation intensity.

virtual double DtChangeGlobalWeatherCommand::precipitationIntensity ( ) const [virtual]

The precipitation intensity.

virtual bool DtChangeGlobalWeatherCommand::precipitationIntensitySpecified ( ) const [virtual]

Indicates whether or not the precipitation type is specified in the message.

virtual void DtChangeGlobalWeatherCommand::clearPrecipitationIntensity ( ) [virtual]

Clears the specified flag for precipitation intensity.

virtual void DtChangeGlobalWeatherCommand::setPrecipitationType ( DtVrfWeatherPrecipitationType type ) [virtual]

The precipitation type.

virtual DtVrfWeatherPrecipitationType DtChangeGlobalWeatherCommand::precipitationType ( ) const [virtual]

The precipitation type.

virtual bool DtChangeGlobalWeatherCommand::precipitationTypeSpecified ( ) const [virtual]

Indicates whether or not the precipitation type is specified in the message.

virtual void DtChangeGlobalWeatherCommand::clearPrecipitationType ( ) [virtual]

Clears the specified flag for precipitation type.

virtual void DtChangeGlobalWeatherCommand::setVisibility ( double distance ) [virtual]

The visibility distance, specified in meters.

virtual double DtChangeGlobalWeatherCommand::visibility ( ) const [virtual]

The visibility distance, specified in meters.

virtual bool DtChangeGlobalWeatherCommand::visibilitySpecified ( ) const [virtual]

Indicates whether or not the visibility is specified in the message.

virtual void DtChangeGlobalWeatherCommand::clearVisibility ( ) [virtual]

Clears the specified flag for visibility.

virtual void DtChangeGlobalWeatherCommand::setWindDirection ( double radians ) [virtual]

The compass direction from which the wind is blowing, specified in radians.

virtual double DtChangeGlobalWeatherCommand::windDirection ( ) const [virtual]

The compass direction from which the wind is blowing, specified in radians.

virtual bool DtChangeGlobalWeatherCommand::windDirectionSpecified ( ) const [virtual]

Indicates whether or not the wind direction is specified in the message.

virtual void DtChangeGlobalWeatherCommand::clearWindDirection ( ) [virtual]

Clears the specified flag for wind direction.

virtual void DtChangeGlobalWeatherCommand::setWindSpeed ( double value ) [virtual]

The speed the wind is blowing, specified in meters per second.

virtual double DtChangeGlobalWeatherCommand::windSpeed ( ) const [virtual]

The speed the wind is blowing, specified in meters per second.

virtual bool DtChangeGlobalWeatherCommand::windSpeedSpecified ( ) const [virtual]

Indicates whether or not the wind speed is specified in the message.

virtual void DtChangeGlobalWeatherCommand::clearWindSpeed ( ) [virtual]

Clears the specified flag for wind speed.

virtual void DtChangeGlobalWeatherCommand::setGeneratedByRemoteWeatherSetter ( bool value ) [virtual]

Used internally by VRF.

This value is set to true if this command was generated by a VRF Sim engine that is not simulating the weather, to communicate weather changes to another sim engine. It defaults to false, and should typically be left as the default.

virtual bool DtChangeGlobalWeatherCommand::generatedByRemoteWeatherSetter ( ) const [virtual]

Used internally by VRF.

This value is set to true if this command was generated by a VRF Sim engine that is not simulating the weather, to communicate weather changes to another sim engine. It defaults to false, and should typically be left as the default.

virtual DtString DtChangeGlobalWeatherCommand::stringRep ( ) const [virtual]

Text representation of this command.

Implements DtSimCommand.

static DtSimCommand* DtChangeGlobalWeatherCommand::creator ( ) [static]