include/makArchives/DtSchemaParameter.h

Go to the documentation of this file.

/******************************************************************************
** Copyright (c) 2009 MAK Technologies, Inc.
** All rights reserved.
******************************************************************************/
/******************************************************************************
** $RCSfile: DtSchemaParameter.h,v $ $Revision: 1.10 $ $State: Exp $
******************************************************************************/


#ifndef DtSchemaParameter_H_
#define DtSchemaParameter_H_

#include <makArchives/makArchives.h>

#include <string>
#include <vector>

namespace makArchives
{
   class DT_DLL_MAKARCHIVES DtSchemaParameter
   {
   public:

      enum ParameterType
      {
         Enumeration = 0, //The string value must be one of a list of possible values.
         FileName = 1, //The string must be a filename.
         FloatingPoint = 2, //The string must be a floating point number.
         Integer = 3, //The string must be an integer.
         Any = 4, //Any string is allowed.
         StringVector = 5, //A comma delimited list of strings
         String = 6,//Item is a string
         Boolean = 7, //Boolean
         Vector = 8, //x, y, z
         Double = 9,
         Color = 10,  //r, g, b, a where each component is 0-1
         FontGlyph = 11, // A Glyph
         SymbolSelector = 12, // A mapping between an integer and a model definition
      };      

      DtSchemaParameter();

      DtSchemaParameter(const DtSchemaParameter&);

      virtual ~DtSchemaParameter();

      virtual DtSchemaParameter& operator=(const DtSchemaParameter&);

   public:

      void setName(const std::string& name)
      {
         myName = name;
      }

      const std::string& name() const
      {
         return myName;
      }

      void setRequired(bool b)
      {
         myRequiredFlag = b;
      }

      bool required() const
      {
         return myRequiredFlag;
      }

      void setEnumerationValues(const std::vector<std::string>& val)
      {
         myEnumerationValues = val;
      }

      const std::vector<std::string>& enumerationValues() const
      {
         return myEnumerationValues;
      }

      void setDescription(const std::string& d)
      {
         myDescription = d;
      }

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

      void setType(ParameterType t)
      {
         myType = t;
      }

      ParameterType type() const
      {
         return myType;
      }

   protected:

      friend class boost::serialization::access;


      template <typename Archive>
      void serialize(Archive& ar,unsigned int version)
      {
         ar & BOOST_SERIALIZATION_NVP(myName);
         ar & BOOST_SERIALIZATION_NVP(myType);
         ar & BOOST_SERIALIZATION_NVP(myRequiredFlag);
         ar & BOOST_SERIALIZATION_NVP(myEnumerationValues);

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

   protected:
      std::string myName;
      ParameterType myType;
      bool myRequiredFlag;
      std::vector<std::string> myEnumerationValues;
      std::string myDescription;
   };
};

BOOST_CLASS_VERSION(makArchives::DtSchemaParameter, 2)

#endif