Parameter.h

Go to the documentation of this file.

/*
 * Copyright (C) 2006-2011, SRI International (R)
 *
 * This program is free software: you can redistribute it and/or modify
 * it under the terms of the GNU Lesser General Public License as published by
 * the Free Software Foundation, either version 3 of the License, or
 * (at your option) any later version.
 *
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU Lesser General Public License for more details.
 *
 * You should have received a copy of the GNU Lesser General Public License
 * along with this program.  If not, see <http://www.gnu.org/licenses/>.
 */

#pragma once

#ifndef __OpenKarto_Parameter_h__
#define __OpenKarto_Parameter_h__

#include <OpenKarto/String.h>
#include <OpenKarto/Geometry.h>
#include <OpenKarto/Event.h>
#include <OpenKarto/SmartPointer.h>
#include <OpenKarto/Meta.h>

namespace karto
{




  enum ParameterFlags
  {
    ParameterFlag_Read = 0x01,
    ParameterFlag_Write = 0x02,
    ParameterFlag_Hidden = 0x08,
    ParameterFlag_System = 0x10
  };


  class KARTO_EXPORT ParameterDescription : public Referenced
  {
  public:
    ParameterDescription(const karto::String& rName, const karto::String& rDisplayName = "", const karto::String& rDescription = "");
    virtual ~ParameterDescription();

  public:
    inline const karto::String& GetName() const
    {
      return m_Name;
    }

    inline const karto::String& GetDisplayName() const
    {
      return m_DisplayName;
    }

    inline const karto::String& GetDescription() const
    {
      return m_Description;
    }

    inline kt_int32s GetFlags() const
    {
      return m_Flags;
    }

    inline void SetFlags(kt_int32s flags)
    {
      m_Flags = flags;
    }

    const karto::String& GetFieldName(kt_int32u index) const
    {
      if (index >= 4)
      {
        assert(index < 4);
        throw karto::Exception("ParameterDescription::GetFieldName() - Invalid argument, index must be [0;3]");
      }

      return m_FieldNames[index]; 
    }

    void SetFieldNames(const karto::String& rX = "X", const karto::String& rY = "Y", const karto::String& rZ = "Z", const karto::String& rW = "W") 
    { 
      m_FieldNames[0] = rX; 
      m_FieldNames[1] = rY; 
      m_FieldNames[2] = rZ; 
      m_FieldNames[3] = rW; 
    }

    kt_int32s GetNumberOfDecimalPlaces() const
    {
      return m_nDecimalPlaces;
    }

    void SetNumberOfDecimalPlaces(kt_int32s decimalPlaces)
    {
      m_nDecimalPlaces = decimalPlaces;
    }

  private:
    karto::String m_Name;
    
    karto::String m_DisplayName;

    karto::String m_Description;

    karto::String m_FieldNames[4];

    kt_int32s m_Flags;

    kt_int32s m_nDecimalPlaces;
  };


  class ParameterSet;

  class KARTO_EXPORT AbstractParameter : public Referenced
  {
    KARTO_RTTI();

  public:
    AbstractParameter(ParameterDescription* pDescription, ParameterSet* pParameterSet = NULL);

  protected:
    //@cond EXCLUDE
    virtual ~AbstractParameter();
    //@endcond

  public:
    BasicEvent<EventArguments> Changed;

  public:
    inline const karto::String& GetName() const
    {
      return m_pDescription->GetName();
    }

    inline const karto::String& GetDisplayName() const
    {
      return m_pDescription->GetDisplayName();
    }

    inline const karto::String& GetDescription() const
    {
      return m_pDescription->GetDescription();
    }

    inline kt_int32s GetFlags() const
    {
      return m_pDescription->GetFlags();
    }

    inline const ParameterDescription* GetParameterDescription() const 
    {
      return m_pDescription;
    }

    inline ParameterDescription* GetParameterDescription() 
    {
      return m_pDescription;
    }

    virtual const karto::String GetValueAsString() const = 0;

    virtual void SetValueFromString(const karto::String& rStringValue) = 0;

    virtual void SetToDefaultValue() = 0;

  protected:
    virtual void InitializeParameters();

  private:
    // restrict the following functions
    AbstractParameter(const AbstractParameter&);
    const AbstractParameter& operator=(const AbstractParameter&);

  private:
    karto::SmartPointer<ParameterDescription> m_pDescription;
    ParameterSet* m_pParameterSet;
  };

  KARTO_TYPE(AbstractParameter);

  typedef List<SmartPointer<AbstractParameter> > ParameterList;


  struct ParameterSetPrivate;

  class KARTO_EXPORT ParameterSet : public Referenced
  {
  public:
    ParameterSet();

  protected:
    //@cond EXCLUDE
    virtual ~ParameterSet();
    //@endcond

  public:
    void AddParameter(AbstractParameter* pParameter);

    void RemoveParameter(AbstractParameter* pParameter);

    AbstractParameter* GetParameter(const karto::String& rParameterName) const;

    AbstractParameter* GetParameter(const karto::String& rParameterName);

    void Clear();

    const ParameterList& GetParameters() const;

    ParameterList& GetParameters();

  private:
    // restrict the following functions
    ParameterSet(const ParameterSet&);
    const ParameterSet& operator=(const ParameterSet&);

  private:
    ParameterSetPrivate* m_pPrivate;
  }; // class ParameterSet

  typedef SmartPointer<ParameterSet> ParameterSetPtr;


  template<typename T>
  class Parameter : public AbstractParameter
  {
    KARTO_RTTI();

  public:
    Parameter(ParameterDescription* pDescription, const T& rValue)
      : AbstractParameter(pDescription)
      , m_Value(rValue)
    {
      InitializeParameters();
    }

    Parameter(ParameterSet* pParameterSet, const karto::String& rName, const karto::String& rDisplayName, const karto::String& rDescription, const T& rValue)
      : AbstractParameter(new ParameterDescription(rName, rDisplayName, rDescription), pParameterSet)
      , m_Value(rValue)
    {
      InitializeParameters();
    }

  protected:
    //@cond EXCLUDE
    virtual ~Parameter()
    {
    }
    //@endcond

  public:
    virtual const T& GetValue() const
    {
      return m_Value;
    }

    virtual void SetValue(const T& rValue)
    {
      kt_bool changed = !CompareValue(rValue);

      if (changed)
      {
        m_Value = rValue;

        Changed.Notify(this, EventArguments::Empty());
      }
    }

    virtual T& GetDefaultValue()
    {
      return m_DefaultValue;
    }

    virtual void SetDefaultValue(const T& rValue)
    {
      m_DefaultValue = rValue;
    }

    virtual const karto::String GetValueAsString() const
    {
      return karto::StringHelper::ToString(m_Value);
    }

    virtual void SetValueFromString(const karto::String& rStringValue)
    {
      T value;
      if (karto::StringHelper::FromString(rStringValue, value))
      {
        SetValue(value);
      }
    }

    virtual void SetToDefaultValue()
    {
      SetValue(m_DefaultValue);
    }

  protected:
    virtual void InitializeParameters()
    {
      SetDefaultValue(GetValue());
    }

    kt_bool CompareValue(const T& rValue)
    {
      return m_Value == rValue;
    }

  private:
    // restrict the following functions
    Parameter(const Parameter&);
    const Parameter& operator=(const Parameter&);

  protected:
    T m_Value;

  private:
    T m_DefaultValue;
  };

  KARTO_TYPE(Parameter<kt_bool>);

  KARTO_TYPE(Parameter<kt_char>);

  KARTO_TYPE(Parameter<kt_int8s>);

  KARTO_TYPE(Parameter<kt_int8u>);

  KARTO_TYPE(Parameter<kt_int16s>);

  KARTO_TYPE(Parameter<kt_int16u>);

  KARTO_TYPE(Parameter<kt_int32s>);

  KARTO_TYPE(Parameter<kt_int32u>);

  KARTO_TYPE(Parameter<kt_int64s>);

  KARTO_TYPE(Parameter<kt_int64u>);

  KARTO_TYPE(Parameter<kt_float>);

  KARTO_TYPE(Parameter<kt_double>);

  KARTO_TYPE(Parameter<karto::String>);

  KARTO_TYPE(Parameter<karto::Size2<kt_int32s> >);

  KARTO_TYPE(Parameter<karto::Size2<kt_int32u> >);

  KARTO_TYPE(Parameter<karto::Size2<kt_double> >);

  KARTO_TYPE(Parameter<karto::Vector2i>);

  KARTO_TYPE(Parameter<karto::Vector3i>);

  KARTO_TYPE(Parameter<karto::Vector4i>);

  KARTO_TYPE(Parameter<karto::Vector2<kt_int32u> >);

  KARTO_TYPE(Parameter<karto::Vector3iu>);

  KARTO_TYPE(Parameter<karto::Vector4iu>);

  KARTO_TYPE(Parameter<karto::Vector2<kt_double> >);

  KARTO_TYPE(Parameter<karto::Vector3d>);

  KARTO_TYPE(Parameter<karto::Vector4d>);

  KARTO_TYPE(Parameter<karto::Quaternion>);

  KARTO_TYPE(Parameter<karto::Color>);

  KARTO_TYPE(Parameter<karto::Pose2>);

  KARTO_TYPE(Parameter<karto::Pose3>);

  KARTO_TYPE(Parameter<karto::gps::PointGps>);


  struct ParameterEnumPrivate;

  class KARTO_EXPORT ParameterEnum : public Parameter<kt_int64s>
  {
    KARTO_RTTI();

  public:
    ParameterEnum(ParameterSet* pParameterSet, const karto::String& rName, const karto::String& rDisplayName, const karto::String& rDescription, kt_int64s value);

  protected:
    //@cond EXCLUDE
    virtual ~ParameterEnum();
    //@endcond

  public:
    virtual const karto::String GetValueAsString() const;

    virtual void SetValueFromString(const karto::String& rStringValue);

  public:
    void DefineEnumValue(const String& rName, kt_int64s value);

    const EnumPairList GetEnumValues() const;

  private:
    ParameterEnumPrivate* m_pPrivate;
  }; // class ParameterEnum

  KARTO_TYPE(ParameterEnum);

}

#endif // __OpenKarto_Parameter_h__