CapeModel.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: CapeModel.hpp 8160 2009-03-16 18:36:30Z miha $
 * -----------------------------------------------------------------------------
 *  Description:
 */

#ifndef CAPE_MODEL_HPP
#define CAPE_MODEL_HPP

#include "CapeTypes.hpp"
#include "CapeException.hpp"
#include "CapeMatrix.hpp"
#include "CapeESO.hpp"

namespace Numeric{

  namespace  Solvers {

    namespace Model {

      enum CapeModelType{
        CAPE_CONTINUOUS,
        CAPE_HIERARCHICAL,
        CAPE_AGGREGATE
      };

      enum CapeEventType{
        CAPE_BASIC,
        CAPE_COMPOSITE,
        CAPE_BINARY,
        CAPE_UNARY
      };

      enum CapeEventInfoKind{
        CAPE_EXTERNAL,
        CAPE_INTERNAL
      };

      enum CapeLogicalRelation{
        CAPE_GEQ,
        CAPE_LEQ,
        CAPE_GT,
        CAPE_LT
      };
      
      enum CapeLogicalOperator{
        CAPE_AND,
        CAPE_OR,
        CAPE_NOT
      };

      typedef std::vector<CapeModelType> CapeArrayModelType;
      typedef std::vector<CapeEventType> CapeArrayEventType;
      typedef std::vector<CapeEventInfoKind> CapeArrayEventInfoKind;
      typedef std::vector<CapeLogicalRelation> CapeArrayLogicalRelation;
      typedef std::vector<CapeLogicalOperator> CapeArrayLogicalOperator;

      // Foward declaration of interfaces
      class ICapeNumericModelManager;
      class ICapeNumericModel;
      class ICapeNumericContinuousModel;
      class ICapeNumericHierarchicalModel;
      class ICapeNumericAggregateModel;
      class ICapeNumericSTN;
      class ICapeNumericEvent;
      class ICapeNumericBasicEvent;
      class ICapeNumericCompositeEvent;
      class ICapeNumericBinaryEvent;
      class ICapeNumericUnaryEvent;
      class ICapeNumericEventInfo;
      class ICapeNumericExternalEventInfo;
      class ICapeNumericInternalEventInfo;

      // Interface sequence
      typedef std::vector<ICapeNumericModel*> CapeArrayNumericModel;
      typedef std::vector<ICapeNumericContinuousModel*> CapeArrayNumericContinuousModel;
      typedef std::vector<ICapeNumericHierarchicalModel*> CapeArrayNumericHierarchicalModel;
      typedef std::vector<ICapeNumericAggregateModel*> CapeArrayNumericAggregateModel;
      typedef std::vector<ICapeNumericSTN*> CapeArrayNumericSTN;
      typedef std::vector<ICapeNumericEvent*> CapeArrayNumericEvent;
      typedef std::vector<ICapeNumericBasicEvent*> CapeArrayNumericBasicEvent;
      typedef std::vector<ICapeNumericCompositeEvent*> CapeArrayNumericCompositeEvent;
      typedef std::vector<ICapeNumericBinaryEvent*> CapeArrayNumericBinaryEvent;
      typedef std::vector<ICapeNumericUnaryEvent*> CapeArrayNumericUnaryEvent;
      typedef std::vector<ICapeNumericEventInfo*> CapeArrayNumericEventInfo;
      typedef std::vector<ICapeNumericExternalEventInfo*> CapeArrayNumericExternalEventInfo;
      typedef std::vector<ICapeNumericInternalEventInfo*> CapeArrayNumericInternalEventInfo;

      
      class ICapeNumericModelManager {
      public:
        virtual ICapeNumericModel* CreateModel(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) = 0;
      };


      class ICapeNumericModel : public Common::Identification::ICapeIdentification,
                                public Common::Utilities::ICapeUtilities {
#ifndef SWIG

        friend std::ostream& operator<<(std::ostream& out_file, const ICapeNumericModel& model);
#endif
      public:
#ifndef SWIG        
        virtual ~ICapeNumericModel(){};
#endif

        virtual Common::Types::CapeLong SetVariablesIndex(Common::Types::CapeArrayLong varIndices)
          throw (Common::Error::ECapeUnknown, Common::Error::ECapeInvalidArgument,
                 Common::Error::ECapeOutOfBounds, Common::Error::ECapeNoImpl) = 0;
        virtual void SetActiveESO(Eso::ICapeNumericESO* theActiveESO)
          throw (Common::Error::ECapeUnknown, Common::Error::ECapeInvalidArgument,
                 Common::Error::ECapeSolvingError, Common::Error::ECapeBadInvOrder) = 0;

        virtual Eso::ICapeNumericESO* GetActiveESO()
          throw (Common::Error::ECapeUnknown, Common::Error::ECapeBadInvOrder) = 0;

        virtual void SetCommonESO(Eso::ICapeNumericESO* anESO)
          throw (Common::Error::ECapeUnknown, Common::Error::ECapeInvalidArgument,
                 Common::Error::ECapeNoImpl) = 0;

        virtual Eso::ICapeNumericESO* GetCommonESO()
          throw (Common::Error::ECapeUnknown, Common::Error::ECapeBadInvOrder,
                 Common::Error::ECapeNoImpl) = 0;

        virtual ICapeNumericExternalEventInfo* AddExternalEvent(ICapeNumericEvent* anEvent)
          throw (Common::Error::ECapeUnknown, Common::Error::ECapeInvalidArgument,
                 Common::Error::ECapeBadInvOrder, Common::Error::ECapeNoImpl) = 0;

      };

      class ICapeNumericContinuousModel : public ICapeNumericModel {
#ifndef SWIG

        friend std::ostream& operator<<(std::ostream& out_file, const ICapeNumericContinuousModel& model);
#endif
      };

      class ICapeNumericHierarchicalModel : public ICapeNumericModel {
#ifndef SWIG

        friend std::ostream& operator<<(std::ostream& out_file, const ICapeNumericHierarchicalModel& model);
#endif
      public:
        virtual CapeArrayNumericSTN GetSTNList()
          throw (Common::Error::ECapeUnknown, Common::Error::ECapeBadInvOrder) = 0;
      };

      class ICapeNumericAggregateModel : public ICapeNumericModel {
#ifndef SWIG

        friend std::ostream& operator<<(std::ostream& out_file, const ICapeNumericAggregateModel& model);
#endif
      public:
        virtual CapeArrayNumericModel GetModelList()
          throw (Common::Error::ECapeUnknown, Common::Error::ECapeBadInvOrder) = 0;

        virtual void SetConnectionEquation(ICapeNumericModel* inputModel, Common::Types::CapeLong inputIndex,
                                           ICapeNumericModel* outputModel, Common::Types::CapeLong outputIndex)
          throw (Common::Error::ECapeUnknown, Common::Error::ECapeInvalidArgument,
                 Common::Error::ECapeBadInvOrder, Common::Error::ECapeOutOfBounds) = 0;
      };


      class ICapeNumericSTN {
      public:
        virtual void SetCurrentState(const Common::Types::CapeString& theStateName)
          throw (Common::Error::ECapeUnknown, Common::Error::ECapeInvalidArgument,
                 Common::Error::ECapeBadInvOrder, Common::Error::ECapeOutOfBounds) = 0;

        virtual Common::Types::CapeString GetCurrentState()
          throw (Common::Error::ECapeUnknown, Common::Error::ECapeBadInvOrder) = 0;

        virtual ICapeNumericModel* GetParentModel()
          throw (Common::Error::ECapeUnknown, Common::Error::ECapeBadInvOrder) = 0;

        virtual CapeArrayNumericInternalEventInfo GetPossibleTransitions()
          throw (Common::Error::ECapeUnknown,  Common::Error::ECapeBadInvOrder) = 0;

        virtual Common::Types::CapeDouble GetStateTransitions(const Common::Types::CapeString& fromState, CapeArrayNumericEventInfo& eventList,
                                                              Common::Types::CapeArrayString& stateList)
          throw (Common::Error::ECapeUnknown, Common::Error::ECapeInvalidArgument,
                 Common::Error::ECapeBadInvOrder, Common::Error::ECapeOutOfBounds) = 0;

        virtual Common::Types::CapeArrayString GetStateList()
          throw (Common::Error::ECapeUnknown, Common::Error::ECapeBadInvOrder) = 0;

        virtual ICapeNumericModel* GetStateModel(const Common::Types::CapeString& stateName)
          throw (Common::Error::ECapeUnknown, Common::Error::ECapeInvalidArgument,
                 Common::Error::ECapeBadInvOrder, Common::Error::ECapeOutOfBounds) = 0;

        virtual Common::Types::CapeString MoveToNextState(ICapeNumericEventInfo* firedEvent)
          throw (Common::Error::ECapeUnknown, Common::Error::ECapeInvalidArgument,
                 Common::Error::ECapeBadInvOrder, Common::Error::ECapeOutOfBounds) = 0;
      };

      class ICapeNumericEvent {
      public:
        virtual Common::Types::CapeBoolean Eval()
          throw (Common::Error::ECapeUnknown, Common::Error::ECapeBadInvOrder) = 0;

        virtual CapeEventType QueryType() throw (Common::Error::ECapeUnknown) = 0;
      };
      
      class ICapeNumericBasicEvent : public ICapeNumericEvent {
      public:
        virtual Common::Types::CapeLong GetVariable()
          throw (Common::Error::ECapeUnknown) = 0;

        virtual CapeLogicalRelation GetLogicalRelation()
          throw (Common::Error::ECapeUnknown) = 0;

        virtual Common::Types::CapeDouble GetValue()
          throw (Common::Error::ECapeUnknown) = 0;
      };

      class ICapeNumericCompositeEvent : public ICapeNumericEvent {
      public:
        virtual ICapeNumericEvent* GetRightOperand()
          throw (Common::Error::ECapeUnknown) = 0;
        virtual CapeLogicalOperator* GetLogicalOperator()
          throw (Common::Error::ECapeUnknown) = 0;
      };

      class ICapeNumericBinaryEvent : public ICapeNumericCompositeEvent {
      public:
        virtual ICapeNumericEvent* GetLeftOperand()
          throw (Common::Error::ECapeUnknown) = 0;
      };

      class ICapeNumericUnaryEvent : public ICapeNumericCompositeEvent {
      };

      class ICapeNumericEventInfo {
      public:
        virtual CapeEventInfoKind QueryKind()
          throw (Common::Error::ECapeUnknown) = 0;

        virtual ICapeNumericEvent* GetSubEvent()
          throw (Common::Error::ECapeUnknown) = 0;

        virtual ICapeNumericEvent* GetEvent()
          throw (Common::Error::ECapeUnknown) = 0;
      };

      class ICapeNumericExternalEventInfo : public ICapeNumericEventInfo {
      };

      class ICapeNumericInternalEventInfo : public ICapeNumericEventInfo {
      public:
        virtual ICapeNumericSTN* GetSTN()
          throw (Common::Error::ECapeUnknown) = 0;

        virtual Common::Types::CapeString GetToState()
          throw (Common::Error::ECapeUnknown) = 0;
      };
    };
  };
};

#endif // CAPE_MODEL_HPP