connectionSettings.h

Go to the documentation of this file.

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


#pragma once

#include <vrfLauncherQt/vrfLauncherQtDefines.h>

#include <makSettingsManager/settingsObject.h>

#include <vrfLauncherQt/connectionFileRecord.h>

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

#include <QtCore/QStringList>

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

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


typedef std::pair<const char*,const char*> ArgFlagDescriptorPair;
typedef std::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 ConnectionArgValues::const_iterator ConnectionArgValuesConstEntry;

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

enum DtProtocolTypes
{
   DtNoProtocol = -1,
   DtDISProtocol = 0,
   DtHLAEVOProtocol = 1,
   DtHLA4Protocol = 2
};

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

class DT_DLL_vrfLauncherQt DtConnectionSettings : public DtSettingsObject
{
public:

   DtConnectionSettings();

   DtConnectionSettings( std::string name );

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

   DtConnectionSettings( const DtConnectionSettings& orig );

   virtual ~DtConnectionSettings() override;

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

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

   virtual bool setFrom( const DtConnectionSettings* other );
   virtual bool setFrom( const DtConnectionFileRecord& rec );

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

#ifdef _WIN32
   virtual bool checkRtiVersion(DtHLALib, bool showError = true) const;
#endif

   virtual bool setToFileRecord( DtConnectionFileRecord * rec );

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

   virtual void setDescription(const std::string&);
   virtual std::string description() const
   {
      return myDescription;
   }

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

   //Whether or not this item is the last selected one, so it can be brought up when the app is selected, if there is no auto connect
   virtual bool selectAtStart() const;
   virtual void setSelectAtStart(bool);

   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 ) const;

   virtual QStringList flagsFromLinkConfigFile() const;

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

   virtual std::string summary() const;

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

   void setAutoConnect(bool b) { myAmAutoConnection = b; };
   bool autoConnect() const { return myAmAutoConnection; };

protected:

   virtual void initialize();

private:

   friend class boost::serialization::access;

   template<class Archive>
   void serialize(Archive & ar, const unsigned int version)
   {
      ar & BOOST_SERIALIZATION_BASE_OBJECT_NVP(DtSettingsObject);

      ar & BOOST_SERIALIZATION_NVP(myAmAutoConnection);
      ar & BOOST_SERIALIZATION_NVP(myProtocolType);
      //ar & BOOST_SERIALIZATION_NVP(myArgsListSetting);

      if (version >= 2)
      {
         ar & BOOST_SERIALIZATION_NVP(mySelectAtStart);
         if (version >= 3)
         {
            ar & BOOST_SERIALIZATION_NVP(myDescription);
         }
      }
   }
   
protected:


   ArgIndexDescriptionMap myArgDescriptors;

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

   ConnectionArgValues  myArgValues;
   bool mySelectAtStart = false;

   std::string          myDescription;

};

BOOST_SERIALIZATION_ASSUME_ABSTRACT( DtConnectionSettings )
BOOST_CLASS_VERSION(DtConnectionSettings,3)