include/vrvCore/DtVisualizerSchema.h

Go to the documentation of this file.

/******************************************************************************
** Copyright (c) 2011 MAK Technologies, Inc.
** All rights reserved.
******************************************************************************/
/******************************************************************************
** $RCSfile:  $ $Revision:  $ $State:  $
******************************************************************************/


#pragma once
#include <vrvCore/vrvCore.h>
#include <vrvUtil/DtUnicode.h>
#include <vector>
#include <boost/unordered_map.hpp>

namespace makVrv
{
   class DT_DLL_VRVCORE DtVisualizerSchema
   {
   public:

      struct DT_DLL_VRVCORE Parameter
      {
         Parameter();

         Parameter(const std::string& typeInfoName,
            const std::string& name,
            const DtUnicode& screenName, 
            const DtUnicode& desc, 
            bool required);

         std::string myVisualizerAttributeTypeInfoName;
         std::string myName;
         DtUnicode myScreenName;
         DtUnicode myDescription;
         bool myRequired;
         std::vector<DtUnicode> myEnumerationValues;
      };


      typedef boost::unordered_map<std::string,
         Parameter> SchemaParameters;

      DtVisualizerSchema(const std::string& name, 
         const DtUnicode& humanReadableText, bool empty = false);

      DtVisualizerSchema(const DtVisualizerSchema& rhs);

      ~DtVisualizerSchema();

      const std::string& name() const;

      const DtUnicode& screenName() const;

      void addParameter(const Parameter& param);

      void removeParameter(const std::string& name);

      Parameter* findParameter(const std::string& name);

      const Parameter* findParameter(const std::string& name) const;

      const SchemaParameters& parameters() const;

   protected:
      std::string myName;
      DtUnicode myScreenName;
      SchemaParameters myParameters;
   };
}