SilverLining
Public Member Functions | List of all members
SilverLining::WindVolume Class Reference

Defines an area of a given wind velocity and direction bounded by two altitudes. More...

#include <WindVolume.h>

Inheritance diagram for SilverLining::WindVolume:
Inheritance graph
[legend]
Collaboration diagram for SilverLining::WindVolume:
Collaboration graph
[legend]

Public Member Functions

 WindVolume ()
 Default constructor.
 
virtual ~WindVolume ()
 Destructor.
 
void SILVERLINING_API SetMinAltitude (double metersMSL)
 Set the minimum altitude affected by this object's wind settings.
 
double SILVERLINING_API GetMinAltitude () const
 Retrieves the minimum altitude, in meters above mean sea level, affected by this object.
 
void SILVERLINING_API SetMaxAltitude (double metersMSL)
 Set the maximum altitude affected by this object's wind settings.
 
double SILVERLINING_API GetMaxAltitude () const
 Retrieves the maximum altitude, in meters above mean sea level, affected by this object.
 
void SILVERLINING_API SetWindSpeed (double metersPerSecond)
 Set the wind velocity within this WindVolume, in meters per second.
 
double SILVERLINING_API GetWindSpeed () const
 Retrieves the wind velocity within this WindVolume, in meters per second.
 
void SILVERLINING_API SetDirection (double degreesFromNorth)
 Sets the wind direction, in degrees East from North.
 
double SILVERLINING_API GetDirection () const
 Retrieves the wind direction, in degrees East from North.
 
bool SILVERLINING_API Inside (double metersMSL) const
 Evaluates if a given altitude is affected by this WindVolume.
 
bool SILVERLINING_API Serialize (std::ostream &stream)
 Flattens this object and everything in it to a stream buffer.
 
bool SILVERLINING_API Unserialize (std::istream &stream)
 Restores this object from the stream created using Serialize()
 

Detailed Description

Defines an area of a given wind velocity and direction bounded by two altitudes.

Passed into AtmosphericConditions::SetWind() to define wind that will affect cloud motion.

Constructor & Destructor Documentation

◆ WindVolume()

SilverLining::WindVolume::WindVolume ( )
inline

Default constructor.

Creates a WindVolume with default settings of no wind from zero to 100,000 meters above mean sea level.

◆ ~WindVolume()

virtual SilverLining::WindVolume::~WindVolume ( )
inlinevirtual

Destructor.

Member Function Documentation

◆ GetDirection()

double SILVERLINING_API SilverLining::WindVolume::GetDirection ( ) const
inline

Retrieves the wind direction, in degrees East from North.

This is the direction the wind is blowing toward, not the direction it is coming from.

See also
SetDirection()

◆ GetMaxAltitude()

double SILVERLINING_API SilverLining::WindVolume::GetMaxAltitude ( ) const
inline

Retrieves the maximum altitude, in meters above mean sea level, affected by this object.

See also
SetMaxAltitude()

◆ GetMinAltitude()

double SILVERLINING_API SilverLining::WindVolume::GetMinAltitude ( ) const
inline

Retrieves the minimum altitude, in meters above mean sea level, affected by this object.

See also
SetMinAltitude()

◆ GetWindSpeed()

double SILVERLINING_API SilverLining::WindVolume::GetWindSpeed ( ) const
inline

Retrieves the wind velocity within this WindVolume, in meters per second.

See also
SetWindSpeed()

◆ Inside()

bool SILVERLINING_API SilverLining::WindVolume::Inside ( double  metersMSL) const
inline

Evaluates if a given altitude is affected by this WindVolume.

Parameters
metersMSLThe altitude to query on, in meters above mean sea level.
Returns
True if the given altitude is affected by this WindVolume object.

◆ Serialize()

bool SILVERLINING_API SilverLining::WindVolume::Serialize ( std::ostream &  stream)
inline

Flattens this object and everything in it to a stream buffer.

◆ SetDirection()

void SILVERLINING_API SilverLining::WindVolume::SetDirection ( double  degreesFromNorth)
inline

Sets the wind direction, in degrees East from North.

This is the direction the wind is coming from, not the direction it is blowing toward.

See also
GetDirection()

◆ SetMaxAltitude()

void SILVERLINING_API SilverLining::WindVolume::SetMaxAltitude ( double  metersMSL)
inline

Set the maximum altitude affected by this object's wind settings.

Parameters
metersMSLThe maximum altitude of this WindVolume in meters above mean sea level.
See also
GetMaxAltitude()

◆ SetMinAltitude()

void SILVERLINING_API SilverLining::WindVolume::SetMinAltitude ( double  metersMSL)
inline

Set the minimum altitude affected by this object's wind settings.

Parameters
metersMSLThe minimum altitude of this WindVolume in meters above mean sea level.
See also
GetMinAltitude()

◆ SetWindSpeed()

void SILVERLINING_API SilverLining::WindVolume::SetWindSpeed ( double  metersPerSecond)
inline

Set the wind velocity within this WindVolume, in meters per second.

See also
GetWindSpeed()

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