CloudStateSegment Struct Reference

The CloudStateSegment structure contains the cloud layer data along a partial line section. Cloud data includes parameters like cloud type, visibility, etc. The cloud parameters have the same value along the entire line section. The line section is determined by its starting position and distance.

Public Member Functions
	CloudStateSegment ()
CloudLayerCloudType	cloudType () const
void	setCloudType (const CloudLayerCloudType &cloudType)
double	coverFraction () const
void	setCoverFraction (double coverFraction)
double	visibility () const
void	setVisibility (double visibility)
double	bottomAltitude () const
void	setBottomAltitude (double bottomAltitude)
double	topAltitude () const
void	setTopAltitude (double topAltitude)
DtVector	startPosition () const
void	setStartPosition (const DtVector &startPosition)
double	distance () const
void	setDistance (double distance)

Private Attributes
CloudLayerCloudType	myCloudType
double	myCoverFraction
double	myVisibility
double	myBottomAltitude
double	myTopAltitude
DtVector	myStartPosition
double	myDistance

Constructor & Destructor Documentation

CloudStateSegment::CloudStateSegment ( )

inline

References DtCloudLayerUndefined, myBottomAltitude, myCloudType, myCoverFraction, myDistance, myStartPosition, myTopAltitude, and myVisibility.

Member Function Documentation

CloudLayerCloudType CloudStateSegment::cloudType ( ) const

inline

References myCloudType.

Referenced by setCloudType().

void CloudStateSegment::setCloudType ( const CloudLayerCloudType &  cloudType )

inline

References cloudType(), and myCloudType.

double CloudStateSegment::coverFraction ( ) const

inline

References myCoverFraction.

Referenced by setCoverFraction().

void CloudStateSegment::setCoverFraction ( double  coverFraction )

inline

References coverFraction(), and myCoverFraction.

double CloudStateSegment::visibility ( ) const

inline

References myVisibility.

Referenced by setVisibility().

void CloudStateSegment::setVisibility ( double  visibility )

inline

References myVisibility, and visibility().

double CloudStateSegment::bottomAltitude ( ) const

inline

References myBottomAltitude.

Referenced by setBottomAltitude().

void CloudStateSegment::setBottomAltitude ( double  bottomAltitude )

inline

References bottomAltitude(), and myBottomAltitude.

double CloudStateSegment::topAltitude ( ) const

inline

References myTopAltitude.

Referenced by setTopAltitude().

void CloudStateSegment::setTopAltitude ( double  topAltitude )

inline

References myTopAltitude, and topAltitude().

DtVector CloudStateSegment::startPosition ( ) const

inline

References myStartPosition.

Referenced by setStartPosition().

void CloudStateSegment::setStartPosition ( const DtVector &  startPosition )

inline

References myStartPosition, and startPosition().

double CloudStateSegment::distance ( ) const

inline

References myDistance.

Referenced by setDistance().

void CloudStateSegment::setDistance ( double  distance )

inline

References distance(), and myDistance.

Member Data Documentation

CloudLayerCloudType CloudStateSegment::myCloudType

private

the cloud state data is a copy of cloudLayerDescription could be refactored to reference the cloudLayerDescription

Referenced by CloudStateSegment(), cloudType(), and setCloudType().

double CloudStateSegment::myCoverFraction

private

Referenced by CloudStateSegment(), coverFraction(), and setCoverFraction().

double CloudStateSegment::myVisibility

private

                      0-1, portion of sky covered.

By default, coverFraction is multiplied by defaultCloudVisibility to get visibility in the cloud layer.

Referenced by CloudStateSegment(), setVisibility(), and visibility().

double CloudStateSegment::myBottomAltitude

private

Meters.

Referenced by bottomAltitude(), CloudStateSegment(), and setBottomAltitude().

double CloudStateSegment::myTopAltitude

private

MSL of bottom of layer.

Referenced by CloudStateSegment(), setTopAltitude(), and topAltitude().

DtVector CloudStateSegment::myStartPosition

private

MSL of top of layer.

Referenced by CloudStateSegment(), setStartPosition(), and startPosition().

double CloudStateSegment::myDistance

private

Referenced by CloudStateSegment(), distance(), and setDistance().

---

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

• /data/exports/nrhent7-1/nightly/docs/vrForces.vrf5-1-branch/include/vrfobjcore/weatherStateProvider.h