ciChannel.h

Go to the documentation of this file.

// Copyright JRM Enterprises, Inc. 2004 - 2012
// All rights reserved.
//
// This code is the intellectual property of JRM Enterprises, Inc.
// It may not be used or released as source or compiled binary form
// without the prior written consent of JRM Enterprises, Inc.
//
// Original Author:  Michael Ortalano
// Date:       Oct 2004
//
//
//
//

#if !defined(AFX_CICHANNEL_H__DE81EF86_CAA9_471E_AE7A_9087CD4CB282__INCLUDED_)
#define AFX_CICHANNEL_H__DE81EF86_CAA9_471E_AE7A_9087CD4CB282__INCLUDED_

#if _MSC_VER > 1000
#pragma once
#endif // _MSC_VER > 1000

#include "ciApi.h"
#include "clXML.h"
#include <stdio.h>
#include <string.h>
#include <iostream>
#include <fstream>
#include <memory.h>
#include <malloc.h>
#include <assert.h>
#include "clXMLNode.h"
class CI_API ciChannel  
{
public:     // enumerations


public:     // contructors, destructors and assignment operators

    // ciChannel
    ciChannel();

    // ciChannel
    ciChannel(ciChannel &obj);

    // ~ciChannel
    virtual ~ciChannel();

    // operator =
    ciChannel operator =(ciChannel &obj);

    // operator []
    ciChannel &operator [] (int idx);

public:     // methods

    // Add
    bool add(ciChannel channel);

    // Insert
    bool insert(ciChannel channel, int placeBeforeIdx);

    // Remove
    bool remove(int channelIdx);

    // Print
    void print();

    // archive
    bool archive(std::ofstream &outf);

    // serialize
    int serialize(char *filepath);

    //
    // loadXML
    //
    // \par Description:
    // Loads attributes from an XML node
    //
    // \param clXMLNode* childNode
    // \return bool
    //
    bool loadXML(clXMLNode* childNode);

    //
    // parseXML
    //
    // \par Description:
    // Parses an XML document for specific tags
    //
    // \param clXML xmlDocument
    // \return bool
    //
    bool parseXML(clXML& xmlDocument);

    //loadXMLNode
    bool loadXMLNode(std::string tag, char *nodeString);
    //loadXMLNode
    bool loadXMLNode(std::string tag, bool *nodeBool);
    //loadXMLNode
    bool loadXMLNode(std::string tag, int *nodeBool);
    //loadXMLNode
    bool loadXMLNode(std::string tag, double *nodeBool);

    //
    // saveXML
    //
    // \par Description:
    // Saves XML nodes to an XML document
    //
    // \param clXML* xmlDocument
    //
    void saveXML(clXML* xmlDocument);

    //serializeCheck
    int   serializeCheck(char *filepath);

    // setIndex
    void setIndex(int index) 
   {
      if(!m_channelList) return;
      m_channelList[0].index = index;
   }

    // getIndex
    int getIndex() 
   {
      if(!m_channelList)   return(0);
      return m_channelList[0].index;
   }

    // getNumChannels
    int getNumChannels() {return m_nChannels;}
    //setNumChannels
    void setNumChannels(int count) {m_nChannels = count;}

    // Getters and Setters 

    // GetName
    char *getName(int index=0);


    // SetName
    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);

protected:  // methods

private: // methods

private: // variables

    // structChannelData
    struct structChannelData
    {
        int index; 
        char   channelName[128];
        int     channelType;
      char  ip[128];
      int      port;
      int      portChannel;
        char   DIUip[128];
      int      DIUport;
        char   FGUip[128];
      int      FGUport;
      int      sensorID;
      int      entityID;
      int      viewportX;
      int     viewportY;
      int      viewportWidth;
      int      viewportHeight;
      int      windowX;
      int      windowY;
      int      windowWidth;
      int      windowHeight;
      int      display;
      int      displayWidth;
      int      displayHeight;
      int      displayRate;
      int      displayState;
        int    restoreDisplayWidth;
      int      restoreDisplayHeight;
      int      restoreDisplayRate;
      char  diuCommand[1024];
        char    sguCommand[1024];
        char    fguCommand[1024];
      char  trackfile[1024];
        int     enableRTSC_Communication;
        int     connectionType;
        int     asynchronousUpdates;
        double  asyncUpdateTime;
        char    ipAddress[64];
        int     clientPort;
    } *m_channelList;               
    int     m_nChannels;            
    clXML m_xml;
    clXMLNode* m_parentNode;
    //   ciChannel   *m_ciChannelList;    /*!< contiguous array of active ciChannel objects */

};

#endif // !defined(AFX_CICHANNEL_H__DE81EF86_CAA9_471E_AE7A_9087CD4CB282__INCLUDED_)