CapeParameter.hpp

/* -----------------------------------------------------------------------------
 *  Diana process modelling, simulation and analysis software
 *  Copyright (c) 2005, Michael Krasnyk
 *  All rights reserved.
 *
 *  This file is a part of Diana process modelling, simulation and analysis software
 *
 *  Diana is free software; you can redistribute it and/or modify it
 *  under the terms of the GNU General Public License as published
 *  by the Free Software Foundation (see accompanying file LICENSE)
 * -----------------------------------------------------------------------------
 *  $Id: CapeParameter.hpp 8160 2009-03-16 18:36:30Z miha $
 * -----------------------------------------------------------------------------
 *  Description:
 */

#ifndef CAPE_PARAMETER_HPP
#define CAPE_PARAMETER_HPP

#include "CapeTypes.hpp"
#include "CapeBasic.hpp"
#include "DianaArray.hpp"

namespace Common{

  namespace Parameter{
    
    typedef enum eCapeParamType{
      CAPE_NONE,
      CAPE_REAL,                      
      CAPE_INT,                       
      CAPE_OPTION,                    
      CAPE_BOOLEAN,                   
      CAPE_ARRAY,                     
      CAPE_ARRAY_STRING,              
      CAPE_POINTER,                   
      DIANA_ARRAY_PARAMETERS,         
      DIANA_ARRAY_REAL,               
    } CapeParamType;

    typedef enum eCapeParamMode{
      CAPE_INPUT,        
      CAPE_OUTPUT,       
      CAPE_INPUT_OUTPUT  
    } CapeParamMode;


    class ICapeParameter;
    class ICapeParameterSpec;

    typedef std::vector<ICapeParameter*> CapeArrayParameter;         
    typedef std::vector<ICapeParameterSpec*> CapeArrayParameterSpec; 
    
    class ICapeParameterSpec : public Identification::ICapeIdentification{
    public:
      virtual CapeParamType Type() const
        throw(Common::Error::ECapeUnknown) = 0;

      virtual Common::Types::CapeVariant Dimensionality() const
        throw (Common::Error::ECapeUnknown, Common::Error::ECapeNoImpl) = 0;
    };


    class ICapeRealParameterSpec : public ICapeParameterSpec{
#ifndef SWIG

      friend std::ostream& operator<<(std::ostream& os, const ICapeRealParameterSpec& pspec);
#endif
    public:
      virtual Common::Types::CapeDouble DefaultValue() const
        throw (Common::Error::ECapeUnknown) = 0;
      
      virtual Common::Types::CapeDouble LowerBound() const
        throw (Common::Error::ECapeUnknown) = 0;
      
      virtual Common::Types::CapeDouble UpperBound() const
        throw (Common::Error::ECapeUnknown) = 0;

      virtual Common::Types::CapeBoolean Validate(Common::Types::CapeDouble value,
                                          Common::Types::CapeString& message)
        throw (Common::Error::ECapeUnknown,
               Common::Error::ECapeInvalidArgument,
               Common::Error::ECapeNoImpl) = 0;
    };


    class ICapeIntegerParameterSpec : public ICapeParameterSpec{
#ifndef SWIG

      friend std::ostream& operator<<(std::ostream& os, const ICapeIntegerParameterSpec& pspec);
#endif
    public:
      virtual Common::Types::CapeLong DefaultValue() const
        throw (Common::Error::ECapeUnknown) = 0;
      
      virtual Common::Types::CapeLong LowerBound() const
        throw (Common::Error::ECapeUnknown) = 0;

      virtual Common::Types::CapeLong UpperBound() const
        throw (Common::Error::ECapeUnknown) = 0;

      virtual Common::Types::CapeBoolean Validate(Common::Types::CapeLong value,
                                          Common::Types::CapeString& message)
        throw (Common::Error::ECapeUnknown,
               Common::Error::ECapeInvalidArgument,
               Common::Error::ECapeNoImpl) = 0;
    };


    class ICapeBooleanParameterSpec : public ICapeParameterSpec{
#ifndef SWIG

      friend std::ostream& operator<<(std::ostream& os, const ICapeBooleanParameterSpec& pspec);
#endif
    public:
      virtual Common::Types::CapeBoolean DefaultValue() const
        throw (Common::Error::ECapeUnknown) = 0;

      virtual Common::Types::CapeBoolean Validate(Common::Types::CapeBoolean value,
                                          Common::Types::CapeString& message)
        throw (Common::Error::ECapeUnknown,
               Common::Error::ECapeInvalidArgument,
               Common::Error::ECapeNoImpl) = 0;
    };

    class ICapePointerParameterSpec : public ICapeParameterSpec{
#ifndef SWIG

      friend std::ostream& operator<<(std::ostream& os, const ICapePointerParameterSpec& pspec);
#endif
    public:
      virtual Common::Types::CapePointer DefaultValue()  const
        throw (Common::Error::ECapeUnknown) = 0;

      virtual Common::Types::CapeBoolean Validate(Common::Types::CapePointer value,
                                          Common::Types::CapeString& message)
        throw (Common::Error::ECapeUnknown,
               Common::Error::ECapeInvalidArgument,
               Common::Error::ECapeNoImpl) = 0;
    };

    class ICapeOptionParameterSpec : public ICapeParameterSpec{
#ifndef SWIG

      friend std::ostream& operator<<(std::ostream& os, const ICapeOptionParameterSpec& pspec);
#endif
    public:
      virtual const Common::Types::CapeString& DefaultValue() const
        throw (Common::Error::ECapeUnknown) = 0;

      virtual const Common::Types::CapeArrayString& OptionList() const
        throw (Common::Error::ECapeUnknown) = 0;

      virtual Common::Types::CapeBoolean RestrictedToList() const
        throw (Common::Error::ECapeUnknown) = 0;

      virtual Common::Types::CapeBoolean Validate(Common::Types::CapeString value, Common::Types::CapeString& message)
        throw (Common::Error::ECapeUnknown,
               Common::Error::ECapeInvalidArgument,
               Common::Error::ECapeNoImpl) = 0;
    };

    class ICapeParameter : public Identification::ICapeIdentification {
#ifndef SWIG

      friend std::ostream& operator<<(std::ostream& os, ICapeParameter& param);
#endif
    public:
      virtual Common::Types::CapeVariant GetValue()
        throw (Common::Error::ECapeUnknown) = 0;

      virtual void SetValue(const Common::Types::CapeVariant& _value)
        throw (Common::Error::ECapeUnknown, Common::Error::ECapeInvalidArgument) = 0;

      virtual Common::Types::CapeValidationStatus ValStatus()  const
        throw (Common::Error::ECapeUnknown, Common::Error::ECapeNoImpl) = 0;

      virtual CapeParamMode GetMode()  const
        throw (Common::Error::ECapeUnknown) = 0;

      virtual void SetMode(CapeParamMode _mode)
        throw (Common::Error::ECapeUnknown, Common::Error::ECapeInvalidArgument) = 0;

      virtual ICapeParameterSpec* Specification() const
        throw (Common::Error::ECapeUnknown) = 0;

      virtual Common::Types::CapeBoolean Validate(Common::Types::CapeString& message)
        throw (Common::Error::ECapeUnknown,
               Common::Error::ECapeNoImpl) = 0;

      virtual void Reset()
        throw (Common::Error::ECapeUnknown) = 0;
    };
  };
};

#endif // CAPE_PARAMETER_HPP