VR-Vantage 2.7 API Documentation
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Groups Pages
List of all members | Classes | Public Types | Public Member Functions | Private Attributes
ciEntity Class Reference

Classes

struct  structEntityData

Public Types

enum  EntityType { SigSim, SPIRITS, MUSES, EMat }
enum  ClampingMode { NONE = 0, TERRAIN_CLAMP, TUNNEL_CLAMP }
enum  enumTextureType { MCM, EMAT }

Public Member Functions

 ciEntity ()
 ciEntity (ciEntity &obj)
virtual ~ciEntity ()
ciEntity operator= (ciEntity &obj)
ciEntity & operator[] (int idx)
bool add (ciEntity entity)
bool insert (ciEntity entity, int placeBeforeIdx)
bool remove (int entityIdx)
void print ()
bool archive (std::ofstream &outf)
int serialize (char *filepath)
bool loadXML (clXMLNode *childNode)
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)
int serializeCheck (char *filepath)
 Checks the saved configuration file for whether it has more than one panel saved.
void setIndex (int index)
int getIndex ()
int getNumEntities ()
void setNumEntities (int count)
char * getName (int index=0)
void setName (const char *name, int index=0)
double getVelocity (int index=0)
void setVelocity (double velocity, int index=0)
char * getGeomFileName (int index=0)
void setGeomFileName (char *name, int index=0)
char * getMatSysFileName (int index=0)
void setMatSysFileName (char *name, int index=0)
int getTextureType (int idx=0)
void setTextureType (int textureType, int idx=0)
char * getTrackFileName (int index=0)
void setTrackFileName (char *name, int index=0)
int getEntityType (int index=0)
void setEntityType (int type, int index=0)
double getThermalSpinUpPeriod (int index=0)
void setThermalSpinUpPeriod (double period, int index=0)
void setVisibility (bool visibility, int index=0)
bool getVisibility (int index=0)
void setClampMode (int clampMode, int index=0)
int getClampMode (int index=0)
void setUseTrackfile (bool useTrackfile, int idx=0)
bool getUseTrackfile (int idx=0)
void setWorldPosition (double x, double y, double z, int i=0)
void getWorldPosition (double &x, double &y, double &z, int i=0)
void setGeodeticPosition (double latitude, double longitude, double altitude, int idx=0)
void getGeodeticPosition (double &latitude, double &longitude, double &altitude, int idx=0)
void setNEDOrientation (double heading, double pitch, double roll, int idx=0)
void getNEDOrientation (double &heading, double &pitch, double &roll, int idx=0)
char * getRCSfilename (int idx=0)
void setRCSfilename (char *filename, int idx=0)
char * getSCfilename (int idx=0)
void setSCfilename (char *filename, int idx=0)
char * getPIPfilename (int idx=0)
void setPIPfilename (char *filename, int idx=0)
void setClampHeightOffset (double offset, int idx=0)
double getClampHeightOffset (int idx=0)
int getBrdf (int idx=0)
void setBrdf (int brdf, int idx=0)
double getRoughness (int idx=0)
void setRoughness (double roughness, int idx=0)
bool getMmlsReflect (int idx=0)
void setMmlsReflect (bool mmlsReflect, int idx=0)
bool getThermalReflect (int idx=0)
void setThermalReflect (bool thermalReflect, int idx=0)
double getThermalReflectTemp (int idx=0)
void setThermalReflectTemp (double thermalReflectTemp, int idx=0)
void getThermalReflectExtent (double &x, double &y, int idx=0)
void setThermalReflectExtent (double x, double y, int idx=0)
void getThermalReflectOffset (double &x, double &y, int idx=0)
void setThermalReflectOffset (double x, double y, int idx=0)

Private Attributes

struct ciEntity::structEntityData * m_entityList
int m_nEntities
clXML m_xml
clXMLNode * m_parentNode

Detailed Description

ciEntity class declaration

Member Enumeration Documentation

enum ciEntity::EntityType
Description
Enumerates the possible entity types.
Enumerator:
SigSim 
SPIRITS 
MUSES 
EMat 
enum ciEntity::ClampingMode
Description:
Enumerates the possible clamping modes.
Enumerator:
NONE 

0

TERRAIN_CLAMP 

1

TUNNEL_CLAMP 

2

enum ciEntity::enumTextureType
Description
Enumerates the defined terrain texture types
Enumerator:
MCM 

0

EMAT 

1

Constructor & Destructor Documentation

ciEntity::ciEntity ( )
Description:
Default constructor.
ciEntity::ciEntity ( ciEntity &  obj)
Description:
Copy constructor.
Parameters
obj- ciEntity object that is to be copied.
virtual ciEntity::~ciEntity ( )
virtual
Description:
Default destructor.

Member Function Documentation

ciEntity ciEntity::operator= ( ciEntity &  obj)
Description:
Assignment operator.
Parameters
obj- ciEntity object that is to be assigned.
See Also
ciEntity(ciEntity &obj)
ciEntity& ciEntity::operator[] ( int  idx)
Description:
Get operator.
Parameters
obj- ciEntity object that is to be getted.
bool ciEntity::add ( ciEntity  entity)
Description:
Adds a entity to the tail of the entity list.
Parameters
entity- ciEntity object that is will be added to the current list of entitys.
Returns
true if successfull.
See Also
Insert()
bool ciEntity::insert ( ciEntity  entity,
int  placeBeforeIdx 
)
Description:
Inserts a entity to prior to the indicated index.
Parameters
entity- ciEntity entity object to be added
placeBeforeIdx- the entity index to insert the new entity. 0 will place it at the head of the list, -1 will place it at the tail of the list.
Returns
true if successful.
bool ciEntity::remove ( int  entityIdx)
Description:
Removes a entity from the entity list.
Parameters
entityIdx- index in the entity list of the entity to remove
Returns
true if successful.
void ciEntity::print ( )
Description:
Prints the entities list to screen (i.e stdout).
Parameters
none
Returns
void
bool ciEntity::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
int ciEntity::serialize ( char *  filepath)
Description:
Loads the panel storage object from file.
Parameters
filepath- complete path and filename to the file
Returns
int - the style of the saved panel(s) (0 = no panels saved)(1 = one panel saved)(2 = one or more panels saved)
bool ciEntity::loadXML ( clXMLNode *  childNode)
bool ciEntity::parseXML ( clXML &  xmlDocument)
bool ciEntity::loadXMLNode ( std::string  tag,
char *  nodeString 
)
Parameters
std::stringtag
char*nodeString
Returns
bool
bool ciEntity::loadXMLNode ( std::string  tag,
bool *  nodeBool 
)
Parameters
std::stringtag
bool*nodeBool
Returns
bool
bool ciEntity::loadXMLNode ( std::string  tag,
int *  nodeBool 
)
Parameters
std::stringtag
int*nodeBool
Returns
bool
bool ciEntity::loadXMLNode ( std::string  tag,
double *  nodeBool 
)
Parameters
std::stringtag
double*nodeBool
Returns
bool
void ciEntity::saveXML ( clXML *  xmlDocument)
int ciEntity::serializeCheck ( char *  filepath)

Checks the saved configuration file for whether it has more than one panel saved.

Parameters
char*filepath - path of the configuration file that is being checked.
Returns
int - the style of the saved panel(s) (0 = no panels saved)(1 = one panel saved)(2 = one or more panels saved)
void ciEntity::setIndex ( int  index)
inline
Description:
Sets the index number in the entity list
Returns
int ciEntity::getIndex ( )
inline
Description:
Gets the index number in the entity list
Returns
int ciEntity::getNumEntities ( )
inline
Description:
Gets the number of sensors in the list.
Returns
number of sensors.
void ciEntity::setNumEntities ( int  count)
inline
Parameters
intcount
char* ciEntity::getName ( int  index = 0)
Gets the name associated with the entity at the input index .
Returns
The name associated with the entity at input index.
void ciEntity::setName ( const char *  name,
int  index = 0 
)
Sets the name associated with the entity at input index.
Parameters
name- The name to be associated with the entity at input index .
Returns
void.
double ciEntity::getVelocity ( int  index = 0)
void ciEntity::setVelocity ( double  velocity,
int  index = 0 
)
char* ciEntity::getGeomFileName ( int  index = 0)
Gets the geometry filename associated with the entity at the input index .
Returns
The geometry filename associated with the entity at input index.
void ciEntity::setGeomFileName ( char *  name,
int  index = 0 
)
Sets the geometry filename associated with the entity at input index.
Parameters
name- The geometry filename to be associated with the entity at input index .
Returns
void.
char* ciEntity::getMatSysFileName ( int  index = 0)
Gets the material system filename associated with the entity at the input index .
Returns
The material system filename associated with the entity at input index.
void ciEntity::setMatSysFileName ( char *  name,
int  index = 0 
)
Sets the material system filename associated with the entity at input index.
Parameters
name- The material system filename to be associated with the entity at input index .
Returns
void.
int ciEntity::getTextureType ( int  idx = 0)
gets object Texture type.
Returns
The enumerated object Texture type.
void ciEntity::setTextureType ( int  textureType,
int  idx = 0 
)
sets object Texture type.
Parameters
textureType- The enumerated object Texture type.
Returns
void.
char* ciEntity::getTrackFileName ( int  index = 0)
Gets the track filename associated with the entity at the input index .
Returns
The track filename associated with the entity at input index.
void ciEntity::setTrackFileName ( char *  name,
int  index = 0 
)
Sets the track filename associated with the entity at input index.
Parameters
name- The track filename to be associated with the entity at input index .
Returns
void.
int ciEntity::getEntityType ( int  index = 0)
Gets the entity type associated with the entity at the input index .
Returns
The entity type associated with the entity at input index.
void ciEntity::setEntityType ( int  type,
int  index = 0 
)
Sets the entity type associated with the entity at input index.
Parameters
name- The entity type to be associated with the entity at input index .
Returns
void.
double ciEntity::getThermalSpinUpPeriod ( int  index = 0)
Gets the thermal spin up period associated with the entity at the input index .
Returns
The thermal spin up period associated with the entity at input index.
void ciEntity::setThermalSpinUpPeriod ( double  period,
int  index = 0 
)
Sets the thermal spin up period associated with the entity at input index.
Parameters
name- The thermal spin up period to be associated with the entity at input index.
index- index into the list of entities.
Returns
void.
void ciEntity::setVisibility ( bool  visibility,
int  index = 0 
)
Description:
Sets the visibility state flag.
Parameters
visibility- New state for the visibility flag.
index- index into the list of entities.
Returns
void.
bool ciEntity::getVisibility ( int  index = 0)
Description:
Gets the visibility state flag.
Parameters
index- index into the list of entities.
Returns
The current state of the visibility flag.
void ciEntity::setClampMode ( int  clampMode,
int  index = 0 
)
Description:
Sets the clamping mode.
Parameters
clampMode- enumerated clamping mode.
index- index into the list of entities.
Returns
void.
See Also
ClampingMode
int ciEntity::getClampMode ( int  index = 0)
Description:
Gets the clamping mode.
Parameters
index- index into the list of entities.
Returns
The current clamping mode.
See Also
ClampingMode
void ciEntity::setUseTrackfile ( bool  useTrackfile,
int  idx = 0 
)
Description:
Sets the use trackfile flag.
Parameters
useTrackfile- new value for the use trackfile flag.
idx- index into the list of entities.
Returns
void.
bool ciEntity::getUseTrackfile ( int  idx = 0)
Description:
Gets the use trackfile flag.
Parameters
idx- index into the list of entities.
Returns
the current value for the use trackfile flag.
void ciEntity::setWorldPosition ( double  x,
double  y,
double  z,
int  i = 0 
)
Description:
Sets the world position
Parameters
x,y,z- world position to set from
i- index of entity
void ciEntity::getWorldPosition ( double &  x,
double &  y,
double &  z,
int  i = 0 
)
Description:
Gets the world position
Parameters
x,y,z- return in these
i- index of entity
void ciEntity::setGeodeticPosition ( double  latitude,
double  longitude,
double  altitude,
int  idx = 0 
)
Description:
Sets geodetic postion of the sensor object.
Parameters
latitude- geodetic latitude [deg].
longitude- geodetic longitude [deg].
altitude- geodetic altitude [m].
idx- index into the list of entities.
Returns
void.
void ciEntity::getGeodeticPosition ( double &  latitude,
double &  longitude,
double &  altitude,
int  idx = 0 
)
Description:
Gets geodetic postion of the sensor object.
Parameters
latitude- geodetic latitude [deg].
longitude- geodetic longitude [deg].
altitude- geodetic altitude [m].
idx- index into the list of entities.
Returns
void.
void ciEntity::setNEDOrientation ( double  heading,
double  pitch,
double  roll,
int  idx = 0 
)
Description:
Sets NED orientation of the sensor object.
Parameters
heading- NED heading [deg].
pitch- NED pitch [deg].
roll- NED roll [deg].
idx- index into the list of entities.
Returns
void.
void ciEntity::getNEDOrientation ( double &  heading,
double &  pitch,
double &  roll,
int  idx = 0 
)
Description:
Gets NED orientation of the sensor object.
Parameters
heading- NED heading [deg].
pitch- NED pitch [deg].
roll- NED roll [deg].
idx- index into the list of entities.
Returns
void.
char* ciEntity::getRCSfilename ( int  idx = 0)
Description:
Gets the radar cross section filename.
Returns
char *.
void ciEntity::setRCSfilename ( char *  filename,
int  idx = 0 
)
Description:
sets the radar cross section filename.
Returns
void.
char* ciEntity::getSCfilename ( int  idx = 0)
Description:
Gets the radar cross section filename.
Returns
char *.
void ciEntity::setSCfilename ( char *  filename,
int  idx = 0 
)
Description:
sets the scatter center filename.
Returns
void.
char* ciEntity::getPIPfilename ( int  idx = 0)
Description:
Gets the special effects input filename.
Returns
char *.
void ciEntity::setPIPfilename ( char *  filename,
int  idx = 0 
)
Description:
sets the special effects input filename.
Returns
void.
void ciEntity::setClampHeightOffset ( double  offset,
int  idx = 0 
)
double ciEntity::getClampHeightOffset ( int  idx = 0)
int ciEntity::getBrdf ( int  idx = 0)
void ciEntity::setBrdf ( int  brdf,
int  idx = 0 
)
double ciEntity::getRoughness ( int  idx = 0)
void ciEntity::setRoughness ( double  roughness,
int  idx = 0 
)
bool ciEntity::getMmlsReflect ( int  idx = 0)
void ciEntity::setMmlsReflect ( bool  mmlsReflect,
int  idx = 0 
)
bool ciEntity::getThermalReflect ( int  idx = 0)
void ciEntity::setThermalReflect ( bool  thermalReflect,
int  idx = 0 
)
double ciEntity::getThermalReflectTemp ( int  idx = 0)
void ciEntity::setThermalReflectTemp ( double  thermalReflectTemp,
int  idx = 0 
)
void ciEntity::getThermalReflectExtent ( double &  x,
double &  y,
int  idx = 0 
)
void ciEntity::setThermalReflectExtent ( double  x,
double  y,
int  idx = 0 
)
void ciEntity::getThermalReflectOffset ( double &  x,
double &  y,
int  idx = 0 
)
void ciEntity::setThermalReflectOffset ( double  x,
double  y,
int  idx = 0 
)

Member Data Documentation

struct ciEntity::structEntityData * ciEntity::m_entityList
private

list of available entities

int ciEntity::m_nEntities
private

number of entities in the list

clXML ciEntity::m_xml
private
clXMLNode* ciEntity::m_parentNode
private
The documentation for this class was generated from the following file:

Copyright © 2005-2021 MAK Technologies. All Rights Reserved (www.mak.com)