CapeNLPData.hpp

#ifndef CAPE_NLP_DATA_H
#define CAPE_NLP_DATA_H


namespace Numeric {
  namespace Solvers {
    namespace Model {
      class ICapeNumericContinuousModel;
    }
  }
}

namespace Common {

  namespace NLPData {

    // Forward declaration of interfaces
    class CapeMeasuredData;

    class CapeMeasuredValue { 
    public:
      CapeMeasuredValue(Common::Types::CapeDouble _measurement = 0.0, Common::Types::CapeDouble _variance = 1.0) 
        : dblMeasurement(_measurement) { this->setVariance(_variance); }

      inline void setMeasurement(Common::Types::CapeDouble _measurement) { dblMeasurement = _measurement; }

      inline Common::Types::CapeDouble getMeasurement() const { return dblMeasurement; }

      void setVariance(Common::Types::CapeDouble _variance) 
        throw(Common::Error::ECapeInvalidArgument);

      inline Common::Types::CapeDouble getVariance() const { return dblVariance; }

    private:
      inline static Common::Types::CapeBoolean isVarianceValid(Common::Types::CapeDouble _value) { return (_value > 0); }

      Common::Types::CapeDouble dblMeasurement; 
      Common::Types::CapeDouble dblVariance;    
    };


    typedef std::vector<CapeMeasuredValue> CapeMeasuredValues;

    class CapeMeasuredPoint {
    public:
      CapeMeasuredPoint(const Common::Types::CapeArrayLong& _indices);

      CapeMeasuredPoint(CapeMeasuredData& _ExpDat);

      inline void SetTime(Common::Types::CapeDouble _time) { dblTime = _time; }

      inline Common::Types::CapeDouble GetTime() const { return dblTime; }

      void SetValue(Common::Types::CapeLong _idx, CapeMeasuredValue _value)
        throw(Common::Error::ECapeInvalidArgument);

      void SetValueByIndex(Common::Types::CapeLong _idx, CapeMeasuredValue _value)
        throw(Common::Error::ECapeInvalidArgument);

      CapeMeasuredValue GetValue(Common::Types::CapeLong _idx) const
        throw(Common::Error::ECapeInvalidArgument);

      CapeMeasuredValue GetValueByIndex(Common::Types::CapeLong _idx) const
        throw(Common::Error::ECapeInvalidArgument);
    private:
      const Common::Types::CapeArrayLong* parrIndices;  

      Common::Types::CapeDouble dblTime;                
      CapeMeasuredValues arrValues;                     
    };

    typedef std::vector<CapeMeasuredPoint> CapeMeasuredPoints;

    class CapeMeasuredData {
    public:
      CapeMeasuredData() {}

      CapeMeasuredData(const Numeric::Solvers::Model::ICapeNumericContinuousModel* _model, const Common::Types::CapeArrayLong& _indices);

      const Common::Types::CapeArrayLong& GetVariablesIndices() const;

      const CapeMeasuredPoint& GetMeasuredPoint(Common::Types::CapeLong _idx) const
        throw (Common::Error::ECapeUnknown);

      Common::Types::CapeLong GetMeasuredPointsCount() const;

      inline Common::Types::CapeLong GetNumVars() const { return arrStateVarsIndices.size(); }

      void AddMeasuredPoint(Common::Types::CapeDouble _time, Common::Types::CapeDouble _variance, const Common::Types::CapeArrayDouble& _values)
        throw (Common::Error::ECapeInvalidArgument);

      void AddMeasuredPoint(Common::Types::CapeDouble _time, const CapeMeasuredValues& _values)
        throw (Common::Error::ECapeInvalidArgument);

      void load(const Common::Types::CapeURL& strFileName)
        throw (Common::Error::ECapeUnknown);

#ifndef SWIG

      friend std::istream& operator>>(std::istream& is, CapeMeasuredData& mdExpDat);
      friend std::ostream& operator<<(std::ostream& os, CapeMeasuredData& mdExpDat);
#endif

    protected:
      void AddMeasuredPoint(const CapeMeasuredPoint& mpValue)
        throw (Common::Error::ECapeInvalidArgument);

    protected:
      Common::Types::CapeArrayLong arrStateVarsIndices; 

    private:
      CapeMeasuredPoints arrMeasuredPoints;             
    };

#ifndef SWIG

    std::istream& operator>>(std::istream& is, CapeMeasuredData& mdExpDat);
    std::ostream& operator<<(std::ostream& os, CapeMeasuredData& mdExpDat);
#endif
  }
}

#endif //CAPE_NLP_DATA_H