include/vrvCigi/DtCigiConnectionInitializer.h

Go to the documentation of this file.

/****************************************************************************** 
** Copyright (c) 2007 MAK Technologies, Inc. 
** All rights reserved. 
******************************************************************************/ 
/****************************************************************************** 
** $RCSfile: DtCigiConnInit.h,v $ $Revision: 1.18 $ $State: Exp $ 
******************************************************************************/ 
 
 
#pragma once
#include <vrvCigi/vrvCigi.h> 
#include <string>

namespace makVrv 
{
   class DT_DLL_VRVCIGI DtCigiConnectionInitializer
   {
   public:
      enum TransportType
      {
         BestEffort = 0,
         Reliable_Client = 1,
         Reliable_Server = 2
      };

      DtCigiConnectionInitializer();

      DtCigiConnectionInitializer(const DtCigiConnectionInitializer& orig);

      virtual ~DtCigiConnectionInitializer();

      const DtCigiConnectionInitializer& operator=(const DtCigiConnectionInitializer& orig);

   public:

      std::string cigiVersion() const;
      
      virtual void setCigiVersion( const std::string& version );

      std::string cigiMappingsName() const;

      virtual void setCigiMappingsName(const std::string& name);

      std::string deviceAddress() const;

      virtual void setDeviceAddress( const std::string& address);

      std::string hostIpAddress() const;

      virtual void setHostIpAddress( const std::string& address);

      unsigned incomingBufferSize() const;

      virtual void setIncomingBufferSize(unsigned nSize);

      unsigned listenPort() const;

      virtual void setListenPort(unsigned port);

      unsigned incomingBuffers() const;

      virtual void setNumIncomingBuffers(unsigned nNum);

      unsigned outgoingBuffers() const;

      virtual void setNumOutgoingBuffers(unsigned nNum);

      unsigned outgoingBufferSize() const;

      virtual void setOutgoingBufferSize(unsigned nSize);

      unsigned packetBufferSize() const;

      virtual void setPacketBufferSize( unsigned nSize );

      unsigned sendPort() const;

      virtual void setSendPort(unsigned port);

      virtual const std::string& driverMode() const;

      virtual void setDriverMode(const std::string& mode);

      virtual TransportType transportType() const;

      virtual void setTransportType(TransportType tType);

      virtual bool useSynchronousMode() const;

      virtual void setDriverFrequency(unsigned int hertz);

      virtual unsigned int driverFrequency() const;

   protected:

      std::string myCigiVersion;
      std::string myDeviceAddress;
      std::string myHostIpAddress;
      std::string myEntityMappingName;
      unsigned myIncomingBufferSize;
      unsigned myListenPort;
      unsigned myNumIncomingBuffers;
      unsigned myNumOutgoingBuffers;
      unsigned myOutgoingBufferSize;
      unsigned myPacketBufferSize;
      unsigned mySendPort;
      std::string myDriverMode;
      TransportType myTransportType;
      unsigned int myDriverFrequency;

   };

   inline std::string DtCigiConnectionInitializer::cigiVersion() const
   {
      return (myCigiVersion);
   }

   inline std::string DtCigiConnectionInitializer::deviceAddress() const
   {
      return (myDeviceAddress);
   }

   inline std::string DtCigiConnectionInitializer::hostIpAddress() const
   {
      return (myHostIpAddress);
   }

   inline unsigned DtCigiConnectionInitializer::incomingBufferSize() const
   {
      return (myIncomingBufferSize);
   }

   inline unsigned DtCigiConnectionInitializer::listenPort() const
   {
      return (myListenPort);
   }

   inline unsigned DtCigiConnectionInitializer::incomingBuffers() const
   {
      return (myNumIncomingBuffers);
   }

   inline unsigned DtCigiConnectionInitializer::outgoingBuffers() const
   {
      return (myNumOutgoingBuffers);
   }

   inline unsigned DtCigiConnectionInitializer::outgoingBufferSize() const
   {
      return (myOutgoingBufferSize);
   }

   inline unsigned DtCigiConnectionInitializer::packetBufferSize() const
   {
      return (myPacketBufferSize);
   }

   inline unsigned DtCigiConnectionInitializer::sendPort() const
   {
      return (mySendPort);
   }
}