connectionSettings.h

Go to the documentation of this file.

/*******************************************************************************
 * Copyright (c) 2013 MAK Technologies, Inc.
 * All rights reserved.
 ******************************************************************************/


#pragma once

#include <makSettingsManager/settingsObject.h>

#include <connectionFileRecord.h>

#include <boost/archive/xml_iarchive.hpp>
#include <boost/archive/xml_oarchive.hpp>
#include <boost/serialization/nvp.hpp>
#include <boost/unordered_map.hpp>

#include <QtCore/QStringList>

#include <vlutil/vlString.h>
#include <vlutil/vlPrint.h>
#include <vlutil/vlRtiCompilerCheck.h>

#include <string>
#include <vector>
#include <map>


// Stores two strings - first is the command-line flag, second is a descriptive (?) string
typedef std::pair<const char*,const char*> ArgFlagDescriptorPair;
typedef boost::unordered_map<unsigned int,ArgFlagDescriptorPair> ArgIndexDescriptionMap;
typedef ArgIndexDescriptionMap::iterator ArgIndexDescriptionEntry;

//Mapping  between argument int and command-line value DtString
typedef std::map< unsigned int, QString > ConnectionArgValues;
typedef ConnectionArgValues::iterator ConnectionArgValuesEntry;

typedef std::map<std::string,std::string> DriverRecordArgValues;
typedef DriverRecordArgValues::iterator DriverRecordArgValuesEntry;

enum DtProtocolTypes
{
   DtDISProtocol     ,
   DtHLA13Protocol   ,
   DtHLA1516Protocol ,
   DtHLAEVOProtocol  ,
   DtLegionProtocol
};

enum DtConnectionSettingsCommonArguments
{
   AdditionalFrontEndCommandLineArguments = 1000,
   AdditionalBackEndCommandLineArguments = 1001
};

class DtConnectionSettings : public DtSettingsObject
{
public:

   // Default constructor, required for deserialization
   DtConnectionSettings();

   // Constructor
   DtConnectionSettings( std::string name );

   // Constructor
   DtConnectionSettings( std::string name,  DtProtocolTypes protocol );

   // Copy constructor
   DtConnectionSettings( const DtConnectionSettings& orig );

   virtual ~DtConnectionSettings();

   // Equality operator
   virtual bool operator == ( const DtConnectionSettings & orig ) const;

   // Inequality operator
   virtual bool operator != ( const DtConnectionSettings& orig ) const;

   // Reset this object based on another, used by DtSettingsManager::setSetting
   virtual bool setFrom( const DtConnectionSettings* other );
   virtual bool setFrom( const DtConnectionFileRecord& rec );

   // Returns true if the connection will be valid. Checks the connection settings.
   virtual bool connectionWillBeValid() const;
   //returns true if the connection is valid. Checks the supplied argument.
   virtual bool connectionWillBeValid(const QString deviceAddress) const;

#ifdef _WIN32
   // Call to VR-Link routine to check to make sure RTI version is compatible.  If not give an error and return false
   virtual bool checkRtiVersion(DtHLALib, bool showError = true) const;
#endif

   virtual bool setToFileRecord( DtConnectionFileRecord * rec );

   virtual void setName( std::string name );
   virtual std::string name();

   // What protocol is this connection
   virtual DtProtocolTypes protocolType() const;
   virtual void setProtocolType( DtProtocolTypes type );

   //Is this settings object the connect we should automatically connect with
   virtual bool autoConnection() const ;
   virtual void setAutoConnection( bool conn );

   // accessor to myArgsMap
   virtual ConnectionArgValues* argValues();

   //overload this class so as to take whatever data type comes out of the dialog
   virtual void updateStringArgValue( unsigned int type, QString qstringValue );
   virtual void updateBoolArgValue( unsigned int type, bool boolValue );
   virtual void updateIntArgValue( unsigned int type, int intValue, bool negativeOneOk = false );

   //returns "false" if the entry does not exist
   virtual bool getArgValue( unsigned int argType, QString & argValue ) const;

   virtual void removeArgValueEntry( unsigned int type );
   virtual bool findArgDescriptor( unsigned int type, ArgFlagDescriptorPair& mappingStorage );

   virtual QStringList frontEndFlags();
   virtual QStringList backEndFlags();

   static DtConnectionSettings* createFromDriverRecord( DtConnectionFileRecord & driverRecord, QString connName = "");
   static DtConnectionSettings* createFromProtocol( DtProtocolTypes protocol, QString connName = "" );

protected:

   // Stores the available command line args for this connection. Override to add new args
   virtual void initialize();

private:

   friend class boost::serialization::access;

   // Serialization support. Derived classes must call 
   // BOOST_SERIALIZATION_BASE_OBJECT_NVP(DtSettingsObject) in their
   // implementation of serialize.
   template<class Archive>
   void serialize(Archive & ar, const unsigned int version)
   {
      // Serialize the base class
      ar & BOOST_SERIALIZATION_BASE_OBJECT_NVP(DtSettingsObject);

      // Serialize our values
      ar & BOOST_SERIALIZATION_NVP(myAmAutoConnection);
      ar & BOOST_SERIALIZATION_NVP(myProtocolType);
      //ar & BOOST_SERIALIZATION_NVP(myArgsListSetting);
   }
   
protected:


   ArgIndexDescriptionMap myArgDescriptors;

   bool                 myAmAutoConnection;
   DtProtocolTypes      myProtocolType;
   std::string          mySettingsType;

   // Holds all the cmd args that have been set for this connection
   ConnectionArgValues  myArgValues;

};

// Setup this class as abstract in boost
BOOST_SERIALIZATION_ASSUME_ABSTRACT( DtConnectionSettings )