DianaReporting.hpp

/* -----------------------------------------------------------------------------
 *  Diana process modelling, simulation and analysis software
 *  Copyright (c) 2005, Michael Krasnyk, Alexey Milokhov
 *  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: DianaReporting.hpp 8909 2009-10-29 13:01:45Z miha $
 * -----------------------------------------------------------------------------
 *  Description:
 */

#ifndef DIANA_REPORTING_H
#define DIANA_REPORTING_H

#include <CapeOpen.hpp>
#include <Diana/IDianaReporting.hpp>

#include <map>
#include <stdio.h>

namespace Diana {

  
  typedef std::vector<Common::Types::CapeArrayDouble> ReportDataEntryValues;

  class ReportDataEntry {
  public:
    ReportDataEntry(Common::Parameter::ICapeParameter *referencedParameter);
    ReportDataEntry(Common::Parameter::ICapeParameter *referencedParameter, const ReportDataEntry& templ);
    void StoreValue();
    void StartNewChunk();
    ReportDataEntryValues* GetValues();
    const Common::Types::CapeArrayDouble& operator[](const Common::Types::CapeLong index);
    Common::Types::CapeLong size() const;
    Common::Types::CapeString name() const;
    Common::Parameter::CapeParamType type() const;
    void clear();
  private:
    ReportDataEntryValues values;
    Common::Parameter::ICapeParameter *parameter;
  };
  

  // defines internal communication between reporting interface and solver
  class MemoryReportingInterface : virtual public IDianaReporting {
  protected:
    std::map<Common::Parameter::ICapeParameter*, Common::Types::CapeLong> pmap; 
    std::vector<ReportDataEntry> values;
    
    Diana::IDianaNumericSolver* solver;
    Common::Types::CapeString name;
    Common::Types::CapeString description;

    Diana::DianaCollection                       collParameters; 
  public:
    MemoryReportingInterface();
    ~MemoryReportingInterface();

    const Common::Types::CapeString& GetComponentName() const
      throw (Common::Error::ECapeUnknown);

    void SetComponentName(const Common::Types::CapeString& _name)
      throw (Common::Error::ECapeUnknown, Common::Error::ECapeInvalidArgument);

    const Common::Types::CapeString& GetComponentDescription() const
      throw (Common::Error::ECapeUnknown);

    void SetComponentDescription(const Common::Types::CapeString& _description)
      throw (Common::Error::ECapeUnknown, Common::Error::ECapeInvalidArgument);
    
    void Add(Common::Parameter::ICapeParameter *_parameter)
      throw (Common::Error::ECapeUnknown);

    Common::Types::CapeLong getIndexByItem(Common::Parameter::ICapeParameter *_parameter)
      throw (Common::Error::ECapeUnknown);

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

    void Remove(Common::Types::CapeLong index)
      throw (Common::Error::ECapeUnknown);

    void ClearData()
            throw (Common::Error::ECapeUnknown);

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

    void WriteDataPlain(const Common::Types::CapeString& filename)
            throw (Common::Error::ECapeUnknown);

    void WriteDataCSV(const Common::Types::CapeString& filename)
            throw (Common::Error::ECapeUnknown);

    Common::Collection::ICapeCollection* GetParameters()
      throw (Common::Error::ECapeUnknown, Common::Error::ECapeFailedInitialisation,
             Common::Error::ECapeNoImpl);
      
    void SetSimulationContext(Common::Identification::ICapeIdentification* simContextManager)
      throw (Common::Error::ECapeUnknown, Common::Error::ECapeInvalidArgument,
             Common::Error::ECapeFailedInitialisation, Common::Error::ECapeNoImpl);

    void Initialize()
      throw (Common::Error::ECapeUnknown, Common::Error::ECapeFailedInitialisation,
             Common::Error::ECapeOutOfResources, Common::Error::ECapeLicenceError,
             Common::Error::ECapeBadInvOrder);

    void Terminate()
      throw (Common::Error::ECapeUnknown, Common::Error::ECapeOutOfResources,
             Common::Error::ECapeBadInvOrder);

  protected:
    ReportDataEntry* getItem(Common::Types::CapeLong index)
      throw (Common::Error::ECapeUnknown);
    
    ReportDataEntry* getItem(Common::Parameter::ICapeParameter *_parameter)
      throw (Common::Error::ECapeUnknown);
       
    void shutdownReportingInterface();
      
    void setSolver(Diana::IDianaNumericSolver *_solver)
      throw (Common::Error::ECapeUnknown);

    void addDimension()
      throw (Common::Error::ECapeUnknown);
    
  protected:
     virtual void solverStart();
     virtual void solverStep();
     virtual void solverStop();
     virtual void updateValues();
     virtual void solverError();
    
  public:
    void onSolverEvent(SolverEvents event, IDianaNumericSolver* _solver)
      throw (Common::Error::ECapeUnknown, Common::Error::ECapeInvalidArgument, Common::Error::ECapeFailedInitialisation);
  };

  

  class Plot2D {
    public:
      Plot2D(Common::Parameter::ICapeParameter *_x,
             Common::Parameter::ICapeParameter *_y,
             Common::Types::CapeString _name);
      Common::Parameter::ICapeParameter* GetX();
      Common::Parameter::ICapeParameter* GetY();
      Common::Types::CapeString GetName();
    private:
      Common::Parameter::ICapeParameter *x;
      Common::Parameter::ICapeParameter *y;
      Common::Types::CapeString name;
  };
  
  class GraphicalReportingInterface : public MemoryReportingInterface, virtual public IDianaGraphicReporting2 {
  public:
    virtual void Add2DPlot(Common::Parameter::ICapeParameter *_x,
                           Common::Parameter::ICapeParameter *_y,
                           Common::Types::CapeString name = Common::Types::CapeStringUNDEFINED);
    virtual void Add2DPlot(Plot2D plot);
    virtual void AddSurface(Common::Parameter::ICapeParameter *_x,
                            Common::Parameter::ICapeParameter *_y,
                            Common::Parameter::ICapeParameter *_z,
                            Common::Types::CapeString name = Common::Types::CapeStringUNDEFINED);
    virtual void ClearAll2DPlots();
    virtual void Show2DPlots() = 0;

    virtual void SetMaxPoints(Common::Types::CapeLong _maxPoints);
    virtual void SetUpdateInterval(Common::Types::CapeDouble _period);
    virtual void Update() = 0;
  protected:
    std::vector<Plot2D> plots;
    Common::Types::CapeLong maxPoints;
    Common::Types::CapeDouble period;
  };

  class GNUPlotReportingInterface : virtual public GraphicalReportingInterface {
  public:
    GNUPlotReportingInterface();
    virtual ~GNUPlotReportingInterface();
    virtual void Show2DPlots();
    virtual void Update();
  private:
    FILE* plotPipe;
    void StartPlot();
    void StopPlot();
    void SendCommand(Common::Types::CapeString cmd);
  protected:
    void solverStop();
  
  };

}

#endif // DIANA_REPORTING_H