E:/dev/eLynx/include/elx/core/CoreParameters.h

//============================================================================
//  CoreParameters.h                                    Core.Component package
//============================================================================
//  Usage : definitions of modeler parameters for UI.
//----------------------------------------------------------------------------
//  Copyright (C) 2008 by eLynx project
//
//  This library is free software; you can redistribute it and/or
//  modify it under the terms of the GNU Library General Public
//  License as published by the Free Software Foundation; either
//  version 2 of the License, or (at your option) any later version.
//
//  This library 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 Library General Public License for more details.
//----------------------------------------------------------------------------
#ifndef __CoreParameters_h__
#define __CoreParameters_h__

#include "elx/core/CoreTypes.h"
#include <string>
#include <vector>

namespace eLynx {

enum EParameterType
{
  PT_Boolean,
  PT_Enum,
  PT_Integer,
  PT_Double,
  PT_String,
  PT_StringList
};

//----------------------------------------------------------------------------
class ExportedByCore AbstractParameter
{
public:
  AbstractParameter(EParameterType iType, const std::string& iName);
  virtual ~AbstractParameter();

  virtual void Reset() = 0;

  EParameterType GetType() const;
  std::string GetName() const;

protected:
  EParameterType _type;
  std::string    _name;
};

typedef std::vector<AbstractParameter*> ParameterList;
size_t ExportedByCore elxGetParameterIndex(const ParameterList& iList, const std::string& iName);

//----------------------------------------------------------------------------
struct ExportedByCore ParameterEnumItem 
{ 
  ParameterEnumItem(const std::string& iLabel, int32 iValue): _label(iLabel), _value(iValue) {}
  std::string GetLabel() const { return _label; }
  int32 GetValue() const { return _value; }

protected:
  std::string _label; 
  int32       _value; 
};
typedef std::vector<ParameterEnumItem> ParameterEnumItemList;


class ExportedByCore ParameterEnum : public AbstractParameter
{
public:
  ParameterEnum(const std::string& iName, int32 iIndex, const ParameterEnumItemList& iList);
  ParameterEnum();
  virtual ~ParameterEnum();

  virtual void Reset();

  size_t GetSize() const;

  int32 GetIndex() const;
  void SetIndex(int32 iIndex);
  
  int32 GetValue() const;
  int32 GetValue(int32 iIndex) const;

  std::string GetLabel() const;
  std::string GetLabel(int32 iIndex) const;

protected:
  int32 _index, _default;
  const ParameterEnumItemList& _list;
};

//----------------------------------------------------------------------------
class ExportedByCore ParameterInteger : public AbstractParameter
{
public:
  ParameterInteger(const std::string& iName, 
    int32 iMin, int32 iMax, int32 iValue, int32 iTick, int32 iDigits,
    const std::string& iFormat);
  virtual ~ParameterInteger();

  virtual void Reset();

  void SetValue(int32 iValue);

  int32 GetMin() const;
  int32 GetMax() const;
  int32 GetValue() const;
  int32 GetTick() const;
  int32 GetDigits() const;
  std::string GetFormat() const;

protected:
  int32 _min, _max, _value, _default;
  int32 _tick, _digits;
  std::string _format;
};

//----------------------------------------------------------------------------
class ExportedByCore ParameterDouble : public AbstractParameter
{
public:
  ParameterDouble(const std::string& iName, 
    double iMin, double iMax, double iValue, int32 iTick, int32 iDigits,
    const std::string& iFormat);
  virtual ~ParameterDouble();

  virtual void Reset();

  void SetValue(double iValue);

  double GetMin() const;
  double GetMax() const;
  double GetValue() const;
  int32 GetTick() const;
  int32 GetDigits() const;
  std::string GetFormat() const;

protected:
  double _min, _max, _value, _default;
  int32 _tick, _digits;
  std::string _format;
};

} // namespace eLynx

#endif // __CoreParameters_h__