ciInterface Class Reference

Public Member Functions
	ciInterface ()
virtual	~ciInterface ()
void	setSensor (ciSensor &sensor)
ciSensor &	getSensor ()
ciSensor &	getSensor (int index)
void	setSensorList (ciSensorList &sensorList)
ciSensorList &	getSensorList ()
void	setEntity (ciEntity &entity)
ciEntity &	getEntity ()
ciEntity &	getEntity (int index)
void	setTerrain (ciTerrain &terrain)
ciTerrain &	getTerrain ()
void	setEnvironment (ciEnvironment &environment)
ciEnvironment &	getEnvironment ()
void	setSystemTest (ciSystemTest &systemTest)
ciSystemTest &	getSystemTest ()
void	setScenario (ciScenario &scenario)
ciScenario &	getScenario ()
void	setMovieMerge (ciMovieMerge &movieMerge)
ciMovieMerge &	getMovieMerge ()
void	setOcean (ciOcean &ocean)
ciOcean &	getOcean ()
void	setTrack (ciTrack &track)
ciTrack &	getTrack ()
void	setSensorEffects (ciSenSim &senSimData)
ciSenSim &	getSensorEffects ()
void	setOptics (ciOptics &opticsData)
ciOptics &	getOptics ()
void	setDetector (ciDetector &detectorData)
ciDetector &	getDetector ()
void	setElectronics (ciElectronics &electronicsData)
ciElectronics &	getElectronics ()
ciMoviePlayer &	getMoviePlayer ()
void	setMoviePlayer (ciMoviePlayer movieplayer)
ciServerClient &	getNetwork ()
ciSettings &	getSettings ()
void	setSettings (ciSettings &settingsData)
bool	loadConfig (char *configFile)
bool	loadConfigFromString (const char *configString)
bool	saveConfig (char *configFile)
char *	getConfigAsString ()
void	parseConfig (clXML &xmlDocument)
bool	ParseXMLDocument (clXML &xmlDocument)
bool	saveXMLDocument (clXML *xmlDocument)
char *	getMovieMergeTestLocation ()
bool	restoreDefaults (char *configFile)
bool	ParseXMLRestoreDefaults (clXML &xmlDocument)
ciInterface *	getCiInterface ()

Public Attributes
bool	m_use_terrain
bool	m_use_environment
bool	m_use_track
bool	m_use_network
bool	m_use_scenario
bool	m_use_senSim
bool	m_use_sensor_list_panel
bool	m_use_movie_merge
bool	m_use_movie_player
bool	m_use_ocean
bool	m_use_settings
int	m_use_entity_list
int	m_use_sensor_list
int	m_use_detector
int	m_use_electronics
int	m_use_optics
bool	m_use_systemtest

Protected Attributes
ciSensor	m_sensorData
ciSensorList	m_sensorListData
ciEntity	m_entityData
ciTerrain	m_terrainData
ciEnvironment	m_environmentData
ciTrack	m_trackData
ciSystemTest	m_systemTestData
ciServerClient	m_network
ciScenario	m_scenarioData
ciMovieMerge	m_movieMergeData
ciMoviePlayer	m_moviePlayer
ciOcean	m_oceanData
ciOptics	m_opticsData
ciDetector	m_detectorData
ciElectronics	m_electronicsData
ciSenSim	m_senSimData
ciSettings	m_settingsData
char	m_movieMergeTestLocation [512]
std::string	m_XMLstring

Constructor & Destructor Documentation

ciInterface::ciInterface

(

)

Default constructor.

virtual ciInterface::~ciInterface ( )

virtual

Default destructor.

Member Function Documentation

void ciInterface::setSensor ( ciSensor &  sensor )

inline

Sets the sensor data object in the interface.

Parameters

sensor

- ciSensor pointer to set locally

ciSensor& ciInterface::getSensor ( )

inline

Gets the sensor data object in the interface.

Returns

pointer to the ciSensor data object

ciSensor& ciInterface::getSensor ( int  index )

inline

Parameters

int

index

Returns

ciSensor

void ciInterface::setSensorList ( ciSensorList &  sensorList )

inline

Sets the sensor data object in the interface.

Parameters

sensor

- ciSensor pointer to set locally

ciSensorList& ciInterface::getSensorList ( )

inline

Gets the sensor data object in the interface.

Returns

pointer to the ciSensor data object

void ciInterface::setEntity ( ciEntity &  entity )

inline

Sets the entity data object in the interface.

Parameters

entity

- ciEntity pointer to set locally

ciEntity& ciInterface::getEntity ( )

inline

Gets the entity data object in the interface.

Returns

pointer to the ciEntity data object

ciEntity& ciInterface::getEntity ( int  index )

inline

void ciInterface::setTerrain ( ciTerrain &  terrain )

inline

Sets the terrain data object in the interface.

Parameters

terrain

- ciTerrain pointer to set locally

ciTerrain& ciInterface::getTerrain ( )

inline

Gets the terrain data object in the interface.

Returns

pointer to the ciTerrain data object

void ciInterface::setEnvironment ( ciEnvironment &  environment )

inline

Sets the environment data object in the interface.

Parameters

environment

- ciEnvironment pointer to set locally

ciEnvironment& ciInterface::getEnvironment ( )

inline

Gets the environment data object in the interface.

Returns

pointer to the ciEnvironment data object

void ciInterface::setSystemTest ( ciSystemTest &  systemTest )

inline

Sets the environment data object in the interface.

Parameters

environment

- ciEnvironment pointer to set locally

ciSystemTest& ciInterface::getSystemTest ( )

inline

Gets the environment data object in the interface.

Returns

pointer to the ciEnvironment data object

void ciInterface::setScenario ( ciScenario &  scenario )

inline

Sets the scenario data object in the interface.

Parameters

scenario

- ciScenario pointer to set locally

ciScenario& ciInterface::getScenario ( )

inline

Gets the scenario data object in the interface.

Returns

pointer to the ciScenario data object

void ciInterface::setMovieMerge ( ciMovieMerge &  movieMerge )

inline

Parameters

ciMovieMerge

&movieMerge

ciMovieMerge& ciInterface::getMovieMerge ( )

inline

Returns

ciMovieMerge

void ciInterface::setOcean ( ciOcean &  ocean )

inline

Parameters

ciOcean

&ocean

ciOcean& ciInterface::getOcean ( )

inline

Returns

ciOcean

void ciInterface::setTrack ( ciTrack &  track )

inline

Sets the track data object in the interface.

Parameters

track

- ciTrack pointer to set locally

ciTrack& ciInterface::getTrack ( )

inline

Gets the track data object in the interface.

Returns

pointer to the ciTrack data object

void ciInterface::setSensorEffects ( ciSenSim &  senSimData )

inline

Parameters

ciSenSim

&senSimData

ciSenSim& ciInterface::getSensorEffects ( )

inline

Returns

ciSenSim

void ciInterface::setOptics ( ciOptics &  opticsData )

inline

Sets the optics data object in the interface.

Parameters

opticsData

- ciOptics data to be assigned

ciOptics& ciInterface::getOptics ( )

inline

Gets the optics data object in the interface.

Returns

reference to the ciOptics data object

void ciInterface::setDetector ( ciDetector &  detectorData )

inline

Sets the detector data object in the interface.

Parameters

detectorData

- ciDetector data to be assigned

ciDetector& ciInterface::getDetector ( )

inline

Gets the detector data object in the interface.

Returns

reference to the ciDetector data object

void ciInterface::setElectronics ( ciElectronics &  electronicsData )

inline

Sets the electronics data object in the interface.

Parameters

electronicsData

- ciElectronics data to be assigned

ciElectronics& ciInterface::getElectronics ( )

inline

Gets the electronics data object in the interface.

Returns

reference to the ciElectronics data object

ciMoviePlayer& ciInterface::getMoviePlayer ( )

inline

void ciInterface::setMoviePlayer ( ciMoviePlayer  movieplayer )

inline

ciServerClient& ciInterface::getNetwork ( )

inline

Gets the Network data object in the interface.

Returns

pointer to the ciSensor data object

ciServerClient

ciSettings& ciInterface::getSettings ( )

inline

void ciInterface::setSettings ( ciSettings &  settingsData )

inline

bool ciInterface::loadConfig

(

char *

configFile

)

bool ciInterface::loadConfigFromString

(

const char *

configString

)

bool ciInterface::saveConfig

(

char *

configFile

)

char* ciInterface::getConfigAsString

(

)

void ciInterface::parseConfig

(

clXML &

xmlDocument

)

bool ciInterface::ParseXMLDocument

(

clXML &

xmlDocument

)

bool ciInterface::saveXMLDocument

(

clXML *

xmlDocument

)

char* ciInterface::getMovieMergeTestLocation ( )

inline

bool ciInterface::restoreDefaults

(

char *

configFile

)

bool ciInterface::ParseXMLRestoreDefaults

(

clXML &

xmlDocument

)

ciInterface* ciInterface::getCiInterface ( )

inline

Returns

ciInterface

Member Data Documentation

bool ciInterface::m_use_terrain

bool ciInterface::m_use_environment

bool ciInterface::m_use_track

bool ciInterface::m_use_network

bool ciInterface::m_use_scenario

bool ciInterface::m_use_senSim

bool ciInterface::m_use_sensor_list_panel

bool ciInterface::m_use_movie_merge

bool ciInterface::m_use_movie_player

bool ciInterface::m_use_ocean

bool ciInterface::m_use_settings

int ciInterface::m_use_entity_list

int ciInterface::m_use_sensor_list

int ciInterface::m_use_detector

int ciInterface::m_use_electronics

int ciInterface::m_use_optics

bool ciInterface::m_use_systemtest

ciSensor ciInterface::m_sensorData

protected

sensor data from panel

ciSensorList ciInterface::m_sensorListData

protected

sensor data from panel

ciEntity ciInterface::m_entityData

protected

entity data from panel

ciTerrain ciInterface::m_terrainData

protected

terrain data from panel

ciEnvironment ciInterface::m_environmentData

protected

environment data from panel

ciTrack ciInterface::m_trackData

protected

track data from panel

ciSystemTest ciInterface::m_systemTestData

protected

ciServerClient ciInterface::m_network

protected

ciScenario ciInterface::m_scenarioData

protected

ciMovieMerge ciInterface::m_movieMergeData

protected

ciMoviePlayer ciInterface::m_moviePlayer

protected

ciOcean ciInterface::m_oceanData

protected

ciOptics ciInterface::m_opticsData

protected

CI optics data from panel

ciDetector ciInterface::m_detectorData

protected

CI detector data from panel

ciElectronics ciInterface::m_electronicsData

protected

CI electronics data from panel

ciSenSim ciInterface::m_senSimData

protected

ciSettings ciInterface::m_settingsData

protected

char ciInterface::m_movieMergeTestLocation[512]

protected

std::string ciInterface::m_XMLstring

protected

---

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

• ciInterface.h