Public Types
enum	enumAtmModel { TROPICAL_ATMOSPHERE = 1, MIDLAT_SUMMER = 2, MIDLAT_WINTER = 3, SUBARC_SUMMER = 4, SUBARC_WINTER = 5, US_STANDARD_1976 = 6, USER_SPEC }
enum	enumHazeModel { noAerosolAttenuation = -1, noCloudOrAerosolAtten = 0, ruralVis_23km = 1, ruralVis_5km = 2, navyMaritime = 3, maritime = 4, urban = 5, tropospheric = 6, userDef_cards2Dx = 7, fog1_200m = 8, fog2_500m = 9, desert = 10 }

Public Member Functions
void	setDate (int month, int day, int year)
void	getDate (int &month, int &day, int &year)
void	setNightSkyTableFilepath (char *nightSkyTableFilepath)
char *	getNightSkyTableFilepath ()
void	setStarThreshold (double threshold)
double	getStarThreshold ()
void	setAtmModel (int atmModel)
int	getAtmModel ()
void	setHazeModel (int hazeModel)
int	getHazeModel ()
void	setWindVelocity (double windVelocity)
double	getWindVelocity ()
void	setVisibility (double visibility)
double	getVisibility ()
bool	archive (std::ofstream &outf)
bool	serialize (char *filepath)
bool	loadXML (clXMLNode *environmentNode)
bool	parseXML (clXML &xmlDocument)
bool	loadXMLNode (std::string tag, char *nodeString)
bool	loadXMLNode (std::string tag, bool *nodeBool)
bool	loadXMLNode (std::string tag, int *nodeBool)
bool	loadXMLNode (std::string tag, double *nodeBool)
void	saveXML (clXML *xmlDocument, bool saveTod)
	ciEnvironment (void)
	~ciEnvironment (void)
	ciEnvironment (ciEnvironment &obj)
ciEnvironment	operator= (ciEnvironment &obj)
void	setUseAtmosphericAttenuation (bool useAtmosphericAttenuation)
bool	getUseAtmosphericAttenuation ()
void	setUseAtmosphericScattering (bool useAtmosphericScattering)
bool	getUseAtmosphericScattering ()
void	setUseRoundEarth (bool useRoundEarth)
bool	getUseRoundEarth ()
void	setUseAtmosphericMultiScattering (bool useAtmosphericMultiScattering)
bool	getUseAtmosphericMultiScattering ()
void	setUseThermalEmission (bool useThermalEmission)
bool	getUseThermalEmission ()
void	setEnableLighting (bool enableLighting)
bool	getEnableLighting ()
void	setUserSpecifiedAtmFilepath (char *userSpecifiedAtmFilepath)
char *	getUserSpecifiedAtmFilepath ()
void	setUserSpecifiedTaMin (double tempMin)
void	setUserSpecifiedTaMax (double tempMax)
double	getUserSpecifiedTaMin ()
double	getUserSpecifiedTaMax ()
void	setSkyDomeRadius (double radius)
double	getSkyDomeRadius ()
void	setAtmExtinction (double extinction)
double	getAtmExtinction ()
double	getRainRate ()
void	setRainRate (double rate)
double	getRainTemp ()
void	setRainTemp (double temp)
double	getRelativeHumidityRatio ()
void	setRelativeHumidityRatio (double ratio)
void	setLogScale (bool flag)
bool	getLogScale ()
void	setMouseVel (double vel)
double	getMouseVel ()
void	setTime (float time)
float	getTime ()

Private Attributes
int	m_dateMonth
int	m_dateDay
int	m_dateYear
float	m_timeOfDay
char	m_nightSkyTableFilepath [512]
int	m_atmModel
int	m_hazeModel
double	m_windVelocity
double	m_visibility
bool	m_useAtmosphericAttenuation
bool	m_useAtmosphericScattering
bool	m_useThermalEmission
bool	m_enableLighting
char	m_userSpecifiedAtmFilepath [512]
float	m_tempMin
float	m_tempMax
double	m_skydomeRadius
bool	m_logScale
double	m_mouseVel
bool	m_useAtmosphericMultiScattering
bool	m_useRoundEarth
double	m_starThreshold
double	m_atmOffset
double	m_atmExtinction
double	m_rainRate
double	m_rainTemp
double	m_humidityRatio
clXMLNode *	m_parentNode

Member Enumeration Documentation

enum ciEnvironment::enumAtmModel

Description: Enumerates the available atmospheric models.

Enumerator:

TROPICAL_ATMOSPHERE	1
MIDLAT_SUMMER	2
MIDLAT_WINTER	3
SUBARC_SUMMER	4
SUBARC_WINTER	5
US_STANDARD_1976	6
USER_SPEC

enum ciEnvironment::enumHazeModel

Description: Enumerates the available haze models.

Enumerator:

noAerosolAttenuation	-1
noCloudOrAerosolAtten	0
ruralVis_23km	1
ruralVis_5km	2
navyMaritime	3
maritime	4
urban	5
tropospheric	6
userDef_cards2Dx	7
fog1_200m	8
fog2_500m	9
desert	10

Constructor & Destructor Documentation

ciEnvironment::ciEnvironment ( void )

Description:: Default constructor.

ciEnvironment::~ciEnvironment ( void )

Description:: Default destructor.

ciEnvironment::ciEnvironment ( ciEnvironment & obj )

Description:: Copy constructor.

Parameters

obj	- the object being copied.

Member Function Documentation

void ciEnvironment::setDate	(	int	month,
		int	day,
		int	year
	)

inline

Description:: Sets the scenario date.

Parameters

month	- the scenario month [1 - 12].
day	- the scenario month [1 - 31].
year	- the scenario year [yyyy].

Returns: void

void ciEnvironment::getDate	(	int &	month,
		int &	day,
		int &	year
	)

inline

Description:: Gets the scenario date.

Parameters

month	- the scenario month [1 - 12].
day	- the scenario month [1 - 31].
year	- the scenario year [yyyy].

Returns: void

void ciEnvironment::setNightSkyTableFilepath ( char * nightSkyTableFilepath )

inline

Description:: Sets the scenario night sky table file path.

Parameters

nightSkyTableFilepath - the complete path and name of the file.

Returns: void.

char* ciEnvironment::getNightSkyTableFilepath ( )

inline

Description:: Gets the scenario night sky table file path.

Parameters

nightSkyTableFilepath - the complete path and name of the file.

Returns: void.

void ciEnvironment::setStarThreshold ( double threshold )

inline

Parameters

double threshold

double ciEnvironment::getStarThreshold ( )

inline

Returns: double

void ciEnvironment::setAtmModel ( int atmModel )

inline

Description:: Sets the scenario atmospheric model.

Parameters

atmModel - the enumerated atmospheric model.

Returns: void.

See Also: enumAtmModel

int ciEnvironment::getAtmModel ( )

inline

Description:: Gets the scenario atmospheric model.

Returns: the enumerated atmospheric model.

See Also: enumAtmModel

void ciEnvironment::setHazeModel ( int hazeModel )

inline

Description:: Sets the scenario haze model.

Parameters

hazeModel - the enumerated haze model.

Returns: void.

See Also: enumHazeModel

int ciEnvironment::getHazeModel ( )

inline

Description:: Gets the scenario haze model.

Returns: the enumerated haze model.

See Also: enumHazeModel

void ciEnvironment::setWindVelocity ( double windVelocity )

inline

Description:: Sets the scenario wind velocity.

Parameters

windVelocity - the current scenario wind velocity [m/s].

Returns: void.

double ciEnvironment::getWindVelocity ( )

inline

Description:: Gets the scenario wind velocity.

Returns: the current scenario wind velocity [m/s].

void ciEnvironment::setVisibility ( double visibility )

inline

Description:: Sets the scenario visibility.

Parameters

visibility - the current scenario visibility [m].

Returns: void.

double ciEnvironment::getVisibility ( )

inline

Description:: Gets the scenario visibility.

Returns: the current scenario visibility [m].

bool ciEnvironment::archive ( std::ofstream & outf )

Description:: Saves the ciEnvironment object to file.

Parameters

filepath	- complete path and filename to the file
flags	- file io flags to be set.

Returns: true if sucessful

bool ciEnvironment::serialize ( char * filepath )

Description:: Loads the ciEnvironment object from file.

Parameters

filepath - complete path and filename to the file

Returns: true if sucessful

bool ciEnvironment::loadXML ( clXMLNode * environmentNode )

bool ciEnvironment::parseXML ( clXML & xmlDocument )

bool ciEnvironment::loadXMLNode	(	std::string	tag,
		char *	nodeString
	)

Parameters

std::string	tag
char	*nodeString

Returns: bool

bool ciEnvironment::loadXMLNode	(	std::string	tag,
		bool *	nodeBool
	)

Parameters

std::string	tag
bool	*nodeBool

Returns: bool

bool ciEnvironment::loadXMLNode	(	std::string	tag,
		int *	nodeBool
	)

Parameters

std::string	tag
int	*nodeBool

Returns: bool

bool ciEnvironment::loadXMLNode	(	std::string	tag,
		double *	nodeBool
	)

Parameters

std::string	tag
double	*nodeBool

Returns: bool

void ciEnvironment::saveXML	(	clXML *	xmlDocument,
		bool	saveTod
	)

ciEnvironment ciEnvironment::operator= ( ciEnvironment & obj )

Description:: Assignment operator.

Parameters

obj	- the object being assigned.

void ciEnvironment::setUseAtmosphericAttenuation ( bool useAtmosphericAttenuation )

inline

Description:: Sets the atmospheric attenuation flag.

Parameters

useAtmosphericAttenuation - the new state for the atmospheric attenuation flag.

Returns: void.

bool ciEnvironment::getUseAtmosphericAttenuation ( )

inline

Description:: Gets the atmospheric attenuation flag.

Returns: The current state of the atmospheric attenuation flag.

void ciEnvironment::setUseAtmosphericScattering ( bool useAtmosphericScattering )

inline

Description:: Sets the atmospheric scattering flag.

Parameters

useAtmosphericScattering - the new state for the atmospheric scattering flag.

Returns: void.

bool ciEnvironment::getUseAtmosphericScattering ( )

inline

Description:: Gets the atmospheric scattering flag.

Returns: The current state of the atmospheric scattering flag.

void ciEnvironment::setUseRoundEarth ( bool useRoundEarth )

inline

Description:: Sets the Round Earth flag.

Parameters

useRoundEarth - the new state for the Round Earth flag.

Returns: void.

bool ciEnvironment::getUseRoundEarth ( )

inline

Description:: Gets the Round Earth flag.

Returns: The current state of the Round Earth flag.

void ciEnvironment::setUseAtmosphericMultiScattering ( bool useAtmosphericMultiScattering )

inline

Description:: Sets the atmospheric Multi scattering flag.

Parameters

useAtmosphericMultiScattering - the new state for the atmospheric scattering flag.

Returns: void.

bool ciEnvironment::getUseAtmosphericMultiScattering ( )

inline

Description:: Gets the atmospheric Multi scattering flag.

Returns: The current state of the atmospheric Multi scattering flag.

void ciEnvironment::setUseThermalEmission ( bool useThermalEmission )

inline

Description:: Sets the thermal emission flag.

Parameters

useThermalEmission - the new state for the thermal emission flag.

Returns: void.

bool ciEnvironment::getUseThermalEmission ( )

inline

Description:: Gets the thermal emission flag.

Returns: The current state of the thermal emission flag.

void ciEnvironment::setEnableLighting ( bool enableLighting )

inline

Description:: Sets the enable lighting flag.

Parameters

enableLighting - the new state for the enable lighting flag.

Returns: void.

bool ciEnvironment::getEnableLighting ( )

inline

Description:: Gets the enable lighting flag.

Returns: The current state of the enable lighting flag.

void ciEnvironment::setUserSpecifiedAtmFilepath ( char * userSpecifiedAtmFilepath )

inline

Description:: Sets the scenario night sky table file path.

Parameters

nightSkyTableFilepath - the complete path and name of the file.

Returns: void.

char* ciEnvironment::getUserSpecifiedAtmFilepath ( )

inline

Description:: Gets the scenario night sky table file path.

Parameters

nightSkyTableFilepath - the complete path and name of the file.

Returns: void.

void ciEnvironment::setUserSpecifiedTaMin ( double tempMin )

inline

Description:: Sets the user specified TaMin.

Parameters

double tempMin minimal temperature

Returns: void.

void ciEnvironment::setUserSpecifiedTaMax ( double tempMax )

inline

Description:: Sets the user specified TaMax.

Parameters

double tempMin maximal temperature

Returns: void.

double ciEnvironment::getUserSpecifiedTaMin ( )

inline

Description:: Gets the user specified TaMin.

Returns: double m_tempMin.

double ciEnvironment::getUserSpecifiedTaMax ( )

inline

Description:: Gets the user specified TaMax.

Returns: double tempMax.

void ciEnvironment::setSkyDomeRadius ( double radius )

inline

Description:: Sets the skydome radius.

Parameters

double diameter of skydome

Returns: void.

double ciEnvironment::getSkyDomeRadius ( )

inline

Description:: Gets the skydome radius.

Returns: double.

void ciEnvironment::setAtmExtinction ( double extinction )

inline

Parameters

double extinction

double ciEnvironment::getAtmExtinction ( )

inline

Returns: double

double ciEnvironment::getRainRate ( )

inline

Returns: double

void ciEnvironment::setRainRate ( double rate )

inline

Parameters

double rate

double ciEnvironment::getRainTemp ( )

inline

Returns: double

void ciEnvironment::setRainTemp ( double temp )

inline

Parameters

double temp

double ciEnvironment::getRelativeHumidityRatio ( )

inline

Returns: double

void ciEnvironment::setRelativeHumidityRatio ( double ratio )

inline

Parameters

double rate

void ciEnvironment::setLogScale ( bool flag )

inline

bool ciEnvironment::getLogScale ( )

inline

void ciEnvironment::setMouseVel ( double vel )

inline

double ciEnvironment::getMouseVel ( )

inline

void ciEnvironment::setTime ( float time )

inline

float ciEnvironment::getTime ( )

inline

Member Data Documentation

int ciEnvironment::m_dateMonth

private

scenario month [1 - 12]

int ciEnvironment::m_dateDay

private

scenario day [1 - 31]

int ciEnvironment::m_dateYear

private

scenario year [yyyy]

float ciEnvironment::m_timeOfDay

private

scenario time of day [0.0 - 23.99]

char ciEnvironment::m_nightSkyTableFilepath[512]

private

complete path and file name to the night sky table

int ciEnvironment::m_atmModel

private

enumerated atmospheric model

int ciEnvironment::m_hazeModel

private

enumerated haze model

double ciEnvironment::m_windVelocity

private

wind velocity [m/s]

double ciEnvironment::m_visibility

private

visibility [m]

bool ciEnvironment::m_useAtmosphericAttenuation

private

toggles atmospheric attenuation and path radiance

bool ciEnvironment::m_useAtmosphericScattering

private

toggles atmospheric scattering

bool ciEnvironment::m_useThermalEmission

private

toggles thermal emission

bool ciEnvironment::m_enableLighting

private

toggles lighting

char ciEnvironment::m_userSpecifiedAtmFilepath[512]

private

complete path and file name modcard/atm state file

float ciEnvironment::m_tempMin

private

scenario Ta min

float ciEnvironment::m_tempMax

private

scenario Ta max

double ciEnvironment::m_skydomeRadius

private

skydome radius (m)

bool ciEnvironment::m_logScale

private

double ciEnvironment::m_mouseVel

private

bool ciEnvironment::m_useAtmosphericMultiScattering

private

bool ciEnvironment::m_useRoundEarth

private

double ciEnvironment::m_starThreshold

private

double ciEnvironment::m_atmOffset

private

double ciEnvironment::m_atmExtinction

private

double ciEnvironment::m_rainRate

private

double ciEnvironment::m_rainTemp

private

double ciEnvironment::m_humidityRatio

private

clXMLNode* ciEnvironment::m_parentNode

private

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

ciEnvironment.h

Public Types

Public Member Functions

Private Attributes

Member Enumeration Documentation

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation