Public Member Functions
	ciOcean ()
	ciOcean (ciOcean &obj)
virtual	~ciOcean ()
ciOcean	operator= (ciOcean &obj)
bool	archive (std::ofstream &outf)
bool	serialize (char *filepath)
bool	loadXML (clXMLNode *oceanNode)
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)
char *	getGeomFileName ()
void	setGeomFileName (char *name)
char *	getMatSysFileName ()
void	setMatSysFileName (char *name)
double	getThermalSpinUpPeriod ()
void	setThermalSpinUpPeriod (double period)
void	setVisibility (bool visibility)
bool	getVisibility ()
void	setGeodeticPosition (double latitude, double longitude, double altitude)
void	getGeodeticPosition (double &latitude, double &longitude, double &altitude)
void	setNEDOrientation (double heading, double pitch, double roll)
void	getNEDOrientation (double &heading, double &pitch, double &roll)
void	setUseOcean (bool flag)
	*sets whether or not to use the ocean panel
bool	getUseOcean ()
	*gets the current status on whether or not to use the ocean panel
double	getWindSpeed ()
	*returns the windspeed being applied to the ocean
void	setWindSpeed (double windSpeed)
	*sets the windspeed being applied to the ocean
double	getWindDirection ()
	*gets the direction of the wind on the ocean
void	setWindDirection (double windDirection)
	*sets the direction of the wind on the ocean
double	getWaveHeight ()
	*gets the height of the waves on the ocean
void	setWaveHeight (double waveHeight)
	*sets the height of the waves on the ocean

Private Attributes
char	m_geomFileName [512]
char	m_matSysFileName [512]
double	m_thermalSpinUp
bool	m_visibility
double	m_latitude
double	m_longitude
double	m_altitude
double	m_heading
double	m_pitch
double	m_roll
bool	m_useOcean
double	m_windSpeed
double	m_windDirection
double	m_waveHeight
clXMLNode *	m_parentNode

Detailed Description

ciOcean class declaration

Constructor & Destructor Documentation

ciOcean::ciOcean ( )

Description:: Default constructor.

ciOcean::ciOcean ( ciOcean & obj )

Description:: Copy constructor.

Parameters

obj	- ciOcean object that is to be copied.

virtual ciOcean::~ciOcean ( )

virtual

Description:: Default destructor.

Member Function Documentation

ciOcean ciOcean::operator= ( ciOcean & obj )

Description:: Assignment operator.

Parameters

obj	- ciOcean object that is to be assigned.

See Also: ciOcean(ciOcean &obj)

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

Description:: Saves the ciSensor object to file.

Parameters

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

Returns: true if sucessful

bool ciOcean::serialize ( char * filepath )

Description:: Loads the panel storage object from file.

Parameters

filepath - complete path and filename to the file

Returns: true if sucessful

bool ciOcean::loadXML ( clXMLNode * oceanNode )

bool ciOcean::parseXML ( clXML & xmlDocument )

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

Parameters

std::string	tag
char	*nodeString

Returns: bool

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

Parameters

std::string	tag
bool	*nodeBool

Returns: bool

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

Parameters

std::string	tag
int	*nodeBool

Returns: bool

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

Parameters

std::string	tag
double	*nodeBool

Returns: bool

void ciOcean::saveXML ( clXML * xmlDocument )

char* ciOcean::getGeomFileName ( )

: Gets the geometry filename associated with the Ocean at the input index .

Returns: The geometry filename associated with the Ocean at input index.

void ciOcean::setGeomFileName ( char * name )

: Sets the geometry filename associated with the Ocean at input index.

Parameters

name	- The geometry filename to be associated with the Ocean at input index .

Returns: void.

char* ciOcean::getMatSysFileName ( )

: Gets the material system filename associated with the Ocean at the input index .

Returns: The material system filename associated with the Ocean at input index.

void ciOcean::setMatSysFileName ( char * name )

: Sets the material system filename associated with the Ocean at input index.

Parameters

name	- The material system filename to be associated with the Ocean at input index .

Returns: void.

double ciOcean::getThermalSpinUpPeriod ( )

: Gets the thermal spin up period associated with the Ocean at the input index .

Returns: The thermal spin up period associated with the Ocean at input index.

void ciOcean::setThermalSpinUpPeriod ( double period )

: Sets the thermal spin up period associated with the Ocean at input index.

Parameters

name	- The thermal spin up period to be associated with the Ocean at input index.

Returns: void.

void ciOcean::setVisibility ( bool visibility )

Description:: Sets the visibility state flag.

Parameters

visibility - New state for the visibility flag.

Returns: void.

bool ciOcean::getVisibility ( )

Description:: Gets the visibility state flag.

Returns: The current state of the visibility flag.

void ciOcean::setGeodeticPosition	(	double	latitude,
		double	longitude,
		double	altitude
	)

Description:: Sets geodetic postion of the ocean object.

Parameters

latitude	- geodetic latitude [deg].
longitude	- geodetic longitude [deg].
altitude	- geodetic altitude [m].

Returns: void.

void ciOcean::getGeodeticPosition	(	double &	latitude,
		double &	longitude,
		double &	altitude
	)

Description:: Gets geodetic postion of the ocean object.

Parameters

latitude	- geodetic latitude [deg].
longitude	- geodetic longitude [deg].
altitude	- geodetic altitude [m].

Returns: void.

void ciOcean::setNEDOrientation	(	double	heading,
		double	pitch,
		double	roll
	)

Description:: Sets NED orientation of the ocean object.

Parameters

heading	- NED heading [deg].
pitch	- NED pitch [deg].
roll	- NED roll [deg].

Returns: void.

void ciOcean::getNEDOrientation	(	double &	heading,
		double &	pitch,
		double &	roll
	)

Description:: Gets NED orientation of the ocean object.

Parameters

heading	- NED heading [deg].
pitch	- NED pitch [deg].
roll	- NED roll [deg].

Returns: void.

void ciOcean::setUseOcean ( bool flag )

inline

*sets whether or not to use the ocean panel

Parameters

bool flag

bool ciOcean::getUseOcean ( )

inline

*gets the current status on whether or not to use the ocean panel

Returns: bool

double ciOcean::getWindSpeed ( )

inline

*returns the windspeed being applied to the ocean

Returns: double

void ciOcean::setWindSpeed ( double windSpeed )

inline

*sets the windspeed being applied to the ocean

Parameters

double windSpeed

double ciOcean::getWindDirection ( )

inline

*gets the direction of the wind on the ocean

Returns: double

void ciOcean::setWindDirection ( double windDirection )

inline

*sets the direction of the wind on the ocean

Parameters

double windDirection

double ciOcean::getWaveHeight ( )

inline

*gets the height of the waves on the ocean

Returns: double

void ciOcean::setWaveHeight ( double waveHeight )

inline

*sets the height of the waves on the ocean

Parameters

double waveHeight

Member Data Documentation

char ciOcean::m_geomFileName[512]

private

char ciOcean::m_matSysFileName[512]

private

double ciOcean::m_thermalSpinUp

private

bool ciOcean::m_visibility

private

visibility flag

double ciOcean::m_latitude

private

geodetic position [deg]

double ciOcean::m_longitude

private

geodetic position [deg]

double ciOcean::m_altitude

private

geodetic position [m]

double ciOcean::m_heading

private

NED orientation [deg]

double ciOcean::m_pitch

private

NED orientation [deg]

double ciOcean::m_roll

private

NED orientation [deg]

bool ciOcean::m_useOcean

private

double ciOcean::m_windSpeed

private

double ciOcean::m_windDirection

private

double ciOcean::m_waveHeight

private

clXMLNode* ciOcean::m_parentNode

private

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

ciOcean.h

Public Member Functions

Private Attributes

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation