IDianaReporting.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: IDianaReporting.hpp 8909 2009-10-29 13:01:45Z miha $
 * -----------------------------------------------------------------------------
 *  Description:
 */

#ifndef IDIANA_REPORTING_H
#define IDIANA_REPORTING_H

#include <CapeOpen.hpp>

namespace Numeric {
  namespace Solvers {
    namespace NLPTasks {
      class DianaNLPTask;
    }
  }
}

namespace Diana {

#ifndef SWIG
  enum SolverEvents {
    eventNone = 0,
    eventSetReportingInterface,
    eventRemoveReportingInterface,
    eventStart,
    eventStop,
    eventOneStep,
    eventError,
    eventNewChunk,
    eventOneEval,
  };
  enum NLPTaskEvents {
    eventNLPNone = 0,
    eventNLPSetReportingInterface,
    eventNLPRemoveReportingInterface,
    eventNLPStartObjCalc,
    eventNLPStopObjCalc,
    eventNLPStepObjCalc,
    eventNLPErrorObjCalc,
    eventNLPInit,
    eventNLPAssing,
  };
#endif // SWIG

  // forward declaration
  class IDianaNumericSolver;
  
  class IDianaReporting : public Common::Identification::ICapeIdentification, public Common::Utilities::ICapeUtilities {
  public:
    virtual void Add(Common::Parameter::ICapeParameter *_parameter)
        throw (Common::Error::ECapeUnknown) = 0;

    virtual void Remove(Common::Parameter::ICapeParameter *_parameter)
        throw (Common::Error::ECapeUnknown) = 0;

    virtual void Remove(Common::Types::CapeLong index)
      throw (Common::Error::ECapeUnknown) = 0;
    
    virtual void ClearData()
            throw (Common::Error::ECapeUnknown) = 0;

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

    virtual void WriteData(const Common::Types::CapeString& filename, const Common::Types::CapeString& format="")
            throw (Common::Error::ECapeUnknown) = 0;
 
    virtual void WriteDataMatlab(const Common::Types::CapeString& filename)
            throw (Common::Error::ECapeUnknown) = 0;

#ifndef SWIG
public:
    virtual void onSolverEvent(SolverEvents event, IDianaNumericSolver* solver)
      throw (Common::Error::ECapeUnknown, Common::Error::ECapeInvalidArgument, Common::Error::ECapeFailedInitialisation) = 0;

    virtual void onNLPTaskEvent(NLPTaskEvents event, Numeric::Solvers::NLPTasks::DianaNLPTask* solver)
      throw (Common::Error::ECapeUnknown, Common::Error::ECapeInvalidArgument, Common::Error::ECapeFailedInitialisation) {}
#endif // SWIG
  };

  class IDianaGraphicReporting : virtual public IDianaReporting {
  public:
    virtual void ShowCurvePlot(Common::Types::CapeString strX, Common::Types::CapeString strY,
                               Common::Types::CapeString strZ=Common::Types::CapeStringUNDEFINED)
      throw (Common::Error::ECapeUnknown, Common::Error::ECapeInvalidArgument) = 0;
  };
  
  class IDianaGraphicReporting2 : virtual public IDianaReporting {
  public:
    virtual void Add2DPlot(Common::Parameter::ICapeParameter *_x,
                           Common::Parameter::ICapeParameter *_y,
                           Common::Types::CapeString name = Common::Types::CapeStringUNDEFINED) = 0;
    virtual void AddSurface(Common::Parameter::ICapeParameter *_x,
                            Common::Parameter::ICapeParameter *_y,
                            Common::Parameter::ICapeParameter *_z,
                            Common::Types::CapeString name = Common::Types::CapeStringUNDEFINED) = 0;
    virtual void Show2DPlots() = 0;
  };

};

#endif // IDIANA_REPORTING_H