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

Classes

struct  structChannelData

Public Member Functions

 ciChannel ()
 ciChannel (ciChannel &obj)
virtual ~ciChannel ()
ciChannel operator= (ciChannel &obj)
ciChannel & operator[] (int idx)
bool add (ciChannel channel)
bool insert (ciChannel channel, int placeBeforeIdx)
bool remove (int channelIdx)
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 getNumChannels ()
void setNumChannels (int count)
char * getName (int index=0)
void setName (const char *name, int index=0)
char * getIp (int index=0)
void setIp (char *ipAddr, int index=0)
int getSocket (int index=0)
void setSocket (int socket, int index=0)
int getPortChannel (int index=0)
void setPortChannel (int socket, int index=0)
char * getDIUIp (int index=0)
void setDIUIp (char *ipAddr, int index=0)
int getDIUPort (int index=0)
void setDIUPort (int socket, int index=0)
char * getFGUIp (int index=0)
void setFGUIp (char *ipAddr, int index=0)
int getFGUPort (int index=0)
void setFGUPort (int port, int index=0)
int getEntity (int index=0)
void setEntity (int entity, int index=0)
int getSensor (int index=0)
void setSensor (int sensor, int index=0)
int getViewportX (int index=0)
void setViewportX (int x, int index=0)
int getViewportY (int index=0)
void setViewportY (int y, int index=0)
int getViewportWidth (int index=0)
void setViewportWidth (int width, int index=0)
int getViewportHeight (int index=0)
void setViewportHeight (int width, int index=0)
int getWindowX (int index=0)
void setWindowX (int x, int index=0)
int getWindowY (int index=0)
void setWindowY (int y, int index=0)
int getWindowWidth (int index=0)
void setWindowWidth (int width, int index=0)
int getWindowHeight (int index=0)
void setWindowHeight (int width, int index=0)
int getDisplay (int index=0)
void setDisplay (int display, int index=0)
int getDisplayWidth (int index=0)
void setDisplayWidth (int display, int index=0)
int getDisplayHeight (int index=0)
void setDisplayHeight (int display, int index=0)
int getDisplayRate (int index=0)
void setDisplayRate (int display, int index=0)
int getRestoreDisplayWidth (int index=0)
void setRestoreDisplayWidth (int display, int index=0)
int getRestoreDisplayHeight (int index=0)
void setRestoreDisplayHeight (int display, int index=0)
int getRestoreDisplayRate (int index=0)
void setRestoreDisplayRate (int display, int index=0)
int getDisplayState (int index=0)
void setDisplayState (int display, int index=0)
char * getDIUCommand (int index=0)
void setDIUCommand (char *cmd, int index=0)
char * getSGUCommand (int index=0)
void setSGUCommand (char *cmd, int index=0)
char * getFGUCommand (int index=0)
void setFGUCommand (char *cmd, int index=0)
char * getTrackfile (int index=0)
void setTrackfile (char *cmd, int index=0)
int getRTSCCommunicationEnable (int index=0)
void setRTSCCommunicationEnable (int enable, int index=0)
int getConnectionType (int index=0)
void setConnectionType (int type, int index=0)
int getAsyncUpdateEnable (int index=0)
void setAsyncUpdateEnable (int enable, int index=0)
double getAsyncUpdateTime (int index=0)
void setAsyncUpdateTime (double time, int index=0)
char * getClientIPAddress (int index=0)
void setClientIPAddress (char *ip, int index=0)
int getClientPort (int index=0)
void setClientPort (int port, int index=0)

Private Attributes

struct
ciChannel::structChannelData * 		m_channelList
int m_nChannels
clXML m_xml
clXMLNode * m_parentNode

Detailed Description

ciChannel class declaration

Constructor & Destructor Documentation

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

Member Function Documentation

ciChannel ciChannel::operator= ( ciChannel &  obj)
Description:
Assignment operator.
Parameters
obj- ciChannel object that is to be assigned.
See Also
ciChannel(ciChannel &obj)
ciChannel& ciChannel::operator[] ( int  idx)
Description:
Get operator.
Parameters
obj- ciChannel object that is to be getted.
bool ciChannel::add ( ciChannel  channel)
Description:
Adds a channel to the tail of the channel list.
Parameters
channel- ciChannel object that is will be added to the current list of channels.
Returns
true if successfull.
See Also
Insert()
bool ciChannel::insert ( ciChannel  channel,
int  placeBeforeIdx 
)
Description:
Inserts a channel to prior to the indicated index.
Parameters
channel- ciChannel channel object to be added
placeBeforeIdx- the channel index to insert the new channel. 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 ciChannel::remove ( int  channelIdx)
Description:
Removes a channel from the channel list.
Parameters
channelIdx- index in the channel list of the channel to remove
Returns
true if successful.
void ciChannel::print ( )
Description:
Prints the entities list to screen (i.e stdout).
Parameters
none
Returns
void
bool ciChannel::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 ciChannel::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 ciChannel::loadXML ( clXMLNode *  childNode)
bool ciChannel::parseXML ( clXML &  xmlDocument)
bool ciChannel::loadXMLNode ( std::string  tag,
char *  nodeString 
)
Parameters
std::stringtag
char*nodeString
Returns
bool
bool ciChannel::loadXMLNode ( std::string  tag,
bool *  nodeBool 
)
Parameters
std::stringtag
bool*nodeBool
Returns
bool
bool ciChannel::loadXMLNode ( std::string  tag,
int *  nodeBool 
)
Parameters
std::stringtag
int*nodeBool
Returns
bool
bool ciChannel::loadXMLNode ( std::string  tag,
double *  nodeBool 
)
Parameters
std::stringtag
double*nodeBool
Returns
bool
void ciChannel::saveXML ( clXML *  xmlDocument)
int ciChannel::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 ciChannel::setIndex ( int  index)
inline
Description:
Sets the index number in the channel list
Returns
int ciChannel::getIndex ( )
inline
Description:
Gets the index number in the channel list
Returns
int ciChannel::getNumChannels ( )
inline
Description:
Gets the number of sensors in the list.
Returns
number of sensors.
void ciChannel::setNumChannels ( int  count)
inline
Parameters
intcount
char* ciChannel::getName ( int  index = 0)
Gets the name associated with the channel at the input index .
Returns
The name associated with the channel at input index.
void ciChannel::setName ( const char *  name,
int  index = 0 
)
Sets the name associated with the channel at input index.
Parameters
name- The name to be associated with the channel at input index .
Returns
void.
char* ciChannel::getIp ( int  index = 0)
void ciChannel::setIp ( char *  ipAddr,
int  index = 0 
)
int ciChannel::getSocket ( int  index = 0)
void ciChannel::setSocket ( int  socket,
int  index = 0 
)
int ciChannel::getPortChannel ( int  index = 0)
void ciChannel::setPortChannel ( int  socket,
int  index = 0 
)
char* ciChannel::getDIUIp ( int  index = 0)
void ciChannel::setDIUIp ( char *  ipAddr,
int  index = 0 
)
int ciChannel::getDIUPort ( int  index = 0)
void ciChannel::setDIUPort ( int  socket,
int  index = 0 
)
char* ciChannel::getFGUIp ( int  index = 0)
void ciChannel::setFGUIp ( char *  ipAddr,
int  index = 0 
)
int ciChannel::getFGUPort ( int  index = 0)
void ciChannel::setFGUPort ( int  port,
int  index = 0 
)
int ciChannel::getEntity ( int  index = 0)
void ciChannel::setEntity ( int  entity,
int  index = 0 
)
int ciChannel::getSensor ( int  index = 0)
void ciChannel::setSensor ( int  sensor,
int  index = 0 
)
int ciChannel::getViewportX ( int  index = 0)
void ciChannel::setViewportX ( int  x,
int  index = 0 
)
int ciChannel::getViewportY ( int  index = 0)
void ciChannel::setViewportY ( int  y,
int  index = 0 
)
int ciChannel::getViewportWidth ( int  index = 0)
void ciChannel::setViewportWidth ( int  width,
int  index = 0 
)
int ciChannel::getViewportHeight ( int  index = 0)
void ciChannel::setViewportHeight ( int  width,
int  index = 0 
)
int ciChannel::getWindowX ( int  index = 0)
void ciChannel::setWindowX ( int  x,
int  index = 0 
)
int ciChannel::getWindowY ( int  index = 0)
void ciChannel::setWindowY ( int  y,
int  index = 0 
)
int ciChannel::getWindowWidth ( int  index = 0)
void ciChannel::setWindowWidth ( int  width,
int  index = 0 
)
int ciChannel::getWindowHeight ( int  index = 0)
void ciChannel::setWindowHeight ( int  width,
int  index = 0 
)
int ciChannel::getDisplay ( int  index = 0)
void ciChannel::setDisplay ( int  display,
int  index = 0 
)
int ciChannel::getDisplayWidth ( int  index = 0)
void ciChannel::setDisplayWidth ( int  display,
int  index = 0 
)
int ciChannel::getDisplayHeight ( int  index = 0)
void ciChannel::setDisplayHeight ( int  display,
int  index = 0 
)
int ciChannel::getDisplayRate ( int  index = 0)
void ciChannel::setDisplayRate ( int  display,
int  index = 0 
)
int ciChannel::getRestoreDisplayWidth ( int  index = 0)
void ciChannel::setRestoreDisplayWidth ( int  display,
int  index = 0 
)
int ciChannel::getRestoreDisplayHeight ( int  index = 0)
void ciChannel::setRestoreDisplayHeight ( int  display,
int  index = 0 
)
int ciChannel::getRestoreDisplayRate ( int  index = 0)
void ciChannel::setRestoreDisplayRate ( int  display,
int  index = 0 
)
int ciChannel::getDisplayState ( int  index = 0)
void ciChannel::setDisplayState ( int  display,
int  index = 0 
)
char* ciChannel::getDIUCommand ( int  index = 0)
void ciChannel::setDIUCommand ( char *  cmd,
int  index = 0 
)
char* ciChannel::getSGUCommand ( int  index = 0)
void ciChannel::setSGUCommand ( char *  cmd,
int  index = 0 
)
char* ciChannel::getFGUCommand ( int  index = 0)
void ciChannel::setFGUCommand ( char *  cmd,
int  index = 0 
)
char* ciChannel::getTrackfile ( int  index = 0)
void ciChannel::setTrackfile ( char *  cmd,
int  index = 0 
)
int ciChannel::getRTSCCommunicationEnable ( int  index = 0)
void ciChannel::setRTSCCommunicationEnable ( int  enable,
int  index = 0 
)
int ciChannel::getConnectionType ( int  index = 0)
void ciChannel::setConnectionType ( int  type,
int  index = 0 
)
int ciChannel::getAsyncUpdateEnable ( int  index = 0)
void ciChannel::setAsyncUpdateEnable ( int  enable,
int  index = 0 
)
double ciChannel::getAsyncUpdateTime ( int  index = 0)
void ciChannel::setAsyncUpdateTime ( double  time,
int  index = 0 
)
char* ciChannel::getClientIPAddress ( int  index = 0)
void ciChannel::setClientIPAddress ( char *  ip,
int  index = 0 
)
int ciChannel::getClientPort ( int  index = 0)
void ciChannel::setClientPort ( int  port,
int  index = 0 
)

Member Data Documentation

struct ciChannel::structChannelData * ciChannel::m_channelList
private

list of available entities

int ciChannel::m_nChannels
private

number of entities in the list

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

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