scriptedTaskVariable.h

Go to the documentation of this file.

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


#pragma once

#include "vrfutil/vrfutilDefines.h"
#include "vrfutil/rwUUID.h"
#include "vrfutil/vrfScriptedTasksConstants.h"

#include <boost/serialization/access.hpp>
#include <boost/serialization/nvp.hpp>
#include <boost/serialization/list.hpp>
#include <boost/serialization/map.hpp>
#include <boost/serialization/vector.hpp>
#include <boost/serialization/string.hpp>
#include <readerWriter/readerWriter.h>
#include <matrix/vlVector.h>

#include <map>

class DtScriptedTaskVariableConverter;
class DtScriptedTaskVariableConverterFactory;

class DT_DLL_vrfutil DtScriptedTaskVariable
{
public:
   DtScriptedTaskVariable();

   virtual ~DtScriptedTaskVariable();

   DtScriptedTaskVariable(const DtScriptedTaskVariable& orig);

   DtScriptedTaskVariable& operator=(const DtScriptedTaskVariable& orig);

   virtual bool load(const std::string&);

   virtual bool save(std::string&) const;

   virtual void setVariableName(const std::string&);
   virtual const std::string& variableName() const;

   virtual void setScriptedTaskVariableName(const std::string&);
   virtual const std::string& scriptedTaskVariableName() const;

   virtual std::string buttonGroup() const;

   virtual void setType(const std::string&);
   virtual const std::string& type() const;

   virtual void setLabel(const std::string&);
   virtual const std::string& label() const;

   virtual void setToolTip(const std::string&);
   virtual const std::string& toolTip() const;

   virtual void setDefaultValue(const std::string&);
   virtual const std::string& defaultValue() const;

   virtual int indexOfDefaultInVariableData() const;

   virtual void setIndent(int);
   virtual int indent() const;

   virtual void setVariableRange(double bottom, double top);
   virtual void setVariableRangeTop(double r);
   virtual void setVariableRangeBottom(double r);
   virtual void variableRange(double& bottom, double& top) const;

   virtual void setInternal(bool);
   virtual bool isInternal() const;

   virtual void setVariableData(const std::string&);
   virtual const std::string& variableData() const;

   virtual void setVisible(bool);
   virtual bool visible() const;

   virtual void setAssociatedStateProperty(const std::string&);
   virtual const std::string& associatedStateProperty() const;

   virtual DtReaderWriter* toRwPtr() const;

   virtual void fromRwPtr(const DtReaderWriter*);

   virtual bool upgradeFromVariable(DtReaderWriter* toUpgradeTo, const DtReaderWriter* originalValue) const;

   static void addConverter(const std::string& variableType, DtScriptedTaskVariableConverter*);
   static DtScriptedTaskVariableConverter* converterFor(const std::string& variableType);
   static DtScriptedTaskVariableConverterFactory* converterFactory();
   static void cleanupConverterFactory();

   static DtString stringRep(const DtString& dataType, const DtReaderWriter*);

protected:
   friend class boost::serialization::access;

   template<class Archive>
      void serialize(Archive & ar, const unsigned int version)
   {
      ar & BOOST_SERIALIZATION_NVP(myVariableName);
      ar & BOOST_SERIALIZATION_NVP(myType);
      ar & BOOST_SERIALIZATION_NVP(myLabel);
      ar & BOOST_SERIALIZATION_NVP(myToolTip);
      ar & BOOST_SERIALIZATION_NVP(myDefaultValue);
      ar & BOOST_SERIALIZATION_NVP(myRangeBottom);
      ar & BOOST_SERIALIZATION_NVP(myRangeTop);
      ar & BOOST_SERIALIZATION_NVP(myVariableData);
      ar & BOOST_SERIALIZATION_NVP(myVisible);

      if (version >= 2)
      {
         ar & BOOST_SERIALIZATION_NVP(myIndent);

         if (version >= 3)
         {
            ar & BOOST_SERIALIZATION_NVP(myInternal);

            if (version >= 4)
            {
               ar & BOOST_SERIALIZATION_NVP(myScriptedTaskVariableName);

               if (version >= 5)
               {
                  ar & BOOST_SERIALIZATION_NVP(myAssociatedStateProperty);
               }
            }
         }
      }

      if (Archive::is_loading::value)
      {
         if ((myType == DtScriptedTaskSeparatorItem) && !myVariableName.length())
         {
            myVariableName = DtUUID().uuidString().c_str();
         }
      }
   }

protected:
   std::string myVariableName;
   std::string myType;
   std::string myLabel;
   std::string myToolTip;
   std::string myDefaultValue;
   double myRangeBottom;
   double myRangeTop;
   std::string myVariableData;
   std::string myScriptedTaskVariableName;
   std::string myAssociatedStateProperty;

   bool myVisible;
   bool myInternal;
   int myIndent;

   static DtScriptedTaskVariableConverterFactory* theScriptedTaskVariableConverterFactory;
};

BOOST_CLASS_VERSION(DtScriptedTaskVariable, 5)