DianaModel.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: DianaModel.hpp 9717 2013-09-03 13:16:29Z soldatov $
 * -----------------------------------------------------------------------------
 *  Description:
 */

#ifndef DIANA_MODEL_H
#define DIANA_MODEL_H

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

extern "C" {
  typedef Numeric::Solvers::Model::ICapeNumericModel* (*fCreateModel)(Numeric::Solvers::Model::CapeModelType typeOfTheModel);
}

namespace Diana{

  using Common::Types::CapeArrayString;
  using Common::Types::CapeArrayLong;
  using Common::Error::ECapeUnknown;
  using Common::Error::ECapeBadInvOrder;
  using Common::Error::ECapeNoImpl;
  class DianaModelManager : public Numeric::Solvers::Model::ICapeNumericModelManager {
  public:
    Numeric::Solvers::Model::ICapeNumericModel* CreateModel(Numeric::Solvers::Model::CapeModelType typeOfTheModel,
                                                            Common::Types::CapeString strLibraryName=Common::Types::CapeStringUNDEFINED)
            throw (Common::Error::ECapeUnknown, Common::Error::ECapeInvalidArgument,
             Common::Error::ECapeOutOfBounds, Common::Error::ECapeOutOfResources,
             Common::Error::ECapeFailedInitialisation);
  };

  class DianaContinuousModel : public IDianaContinuousModel {
  public:
    DianaContinuousModel(Numeric::Solvers::Eso::ICapeNumericESO* pESO=NULL);

    virtual ~DianaContinuousModel();

    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);
    
    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);
    
    Common::Types::CapeLong SetVariablesIndex(Common::Types::CapeArrayLong varIndices)
            throw (Common::Error::ECapeUnknown, Common::Error::ECapeInvalidArgument,
             Common::Error::ECapeOutOfBounds, Common::Error::ECapeNoImpl);

    void SetActiveESO(Numeric::Solvers::Eso::ICapeNumericESO* theActiveESO)
      throw (Common::Error::ECapeUnknown, Common::Error::ECapeInvalidArgument,
             Common::Error::ECapeSolvingError, Common::Error::ECapeBadInvOrder);

    Numeric::Solvers::Eso::ICapeNumericESO* GetActiveESO()
      throw (Common::Error::ECapeUnknown, Common::Error::ECapeBadInvOrder);

    void SetCommonESO(Numeric::Solvers::Eso::ICapeNumericESO* anESO)
      throw (Common::Error::ECapeUnknown, Common::Error::ECapeInvalidArgument,
             Common::Error::ECapeNoImpl);

    Numeric::Solvers::Eso::ICapeNumericESO* GetCommonESO()
      throw (Common::Error::ECapeUnknown, Common::Error::ECapeBadInvOrder,
             Common::Error::ECapeNoImpl);

    Diana::IDianaSensDAESO* GetSensESO() 
      throw (Common::Error::ECapeUnknown, Common::Error::ECapeBadInvOrder, Common::Error::ECapeNoImpl);

    IDianaContinuousModel* GetSensitivityModelByIndex(const Common::Types::CapeArrayLong& _sensParIndices,
                                               const Common::Types::CapeArrayLong& _sensInitStateIndices)
      throw (Common::Error::ECapeUnknown, Common::Error::ECapeBadInvOrder,
             Common::Error::ECapeNoImpl);

    IDianaContinuousModel* GetSensitivityModel(const Common::Types::CapeArrayString& _sensParNames,
                                               const Common::Types::CapeArrayString& _sensInitStateNames)
      throw (Common::Error::ECapeUnknown, Common::Error::ECapeBadInvOrder,
             Common::Error::ECapeNoImpl);

    Numeric::Solvers::Model::ICapeNumericExternalEventInfo* AddExternalEvent(Numeric::Solvers::Model::ICapeNumericEvent* anEvent)
            throw (Common::Error::ECapeUnknown, Common::Error::ECapeInvalidArgument,
             Common::Error::ECapeBadInvOrder, Common::Error::ECapeNoImpl);

  protected:
    Common::Types::CapeString   name;                  
    Common::Types::CapeString   description;           
        
    Numeric::Solvers::Eso::ICapeNumericESO* pActiveESO;
  };
};

#endif // DIANA_MODEL_H