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

#ifndef DIANA_XML_DAESO_H
#define DIANA_XML_DAESO_H
#include <CapeOpen.hpp>
#include <Diana.hpp>

namespace Diana{

  Common::Types::CapeBoolean ensureXercesInitialized();

    using Common::Types::CapeString;
  class DianaXmlDAESO : public DianaDAESO {

  protected:
      CapeString loadDirectory;
    Common::Types::CapeString strXmlDataFile; 

  public:

    DianaXmlDAESO(const Common::Types::CapeString& _strXmlDataFile,
                  const Common::Types::CapeString& _name,
                  Common::Types::CapeLong          _nVars,
                  Common::Types::CapeLong          _nEqns,
                  Common::Types::CapeLong          _nRealParams,
                  Common::Types::CapeLong          _nStructureParams,
                  Common::Types::CapeLong          _nIntegerParams,
                  Common::Types::CapeLong          _nHelpVariables,
                  Common::Types::CapeLong          _nPhi = 0,
                  Common::Types::CapeLong          _nPlaces = 0);
    DianaXmlDAESO(const DianaXmlDAESO& org);
    
    virtual ~DianaXmlDAESO();

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

      virtual const CapeString& getLoadDirectory();
      virtual void setLoadDirectory(const CapeString& _dir);


    virtual Common::Types::CapeBoolean initializeData(void *input)
            throw(Common::Error::ECapeFailedInitialisation);


    virtual Common::Types::CapeBoolean initializeData(const Common::Types::CapeString& fileName=
                                Common::Types::CapeStringUNDEFINED)
            throw(Common::Error::ECapeFailedInitialisation);
    
    virtual Common::Types::CapeBoolean initializeDataFromString(const Common::Types::CapeString& data)
            throw(Common::Error::ECapeFailedInitialisation);


    virtual void addSpar(const Common::Types::CapeString& _name,
                         const Common::Types::CapeString& descr=Common::Types::CapeStringUNDEFINED);

    virtual void addIpar(const Common::Types::CapeString& _name,
                         const Common::Types::CapeString& descr,
                         const Common::Types::CapeArrayLong& idxLower,
                         const Common::Types::CapeArrayLong& idxUpper
                         );

    virtual void addRpar(const Common::Types::CapeString& _name,
                         const Common::Types::CapeString& descr,
                         const Common::Types::CapeArrayLong& idxLower,
                         const Common::Types::CapeArrayLong& idxUpper
        );

    virtual void addHelp(const Common::Types::CapeString& _name,
                         const Common::Types::CapeString& descr,
                         const Common::Types::CapeArrayLong& idxLower,
                         const Common::Types::CapeArrayLong& idxUpper);

    virtual void addState(const Common::Types::CapeString& _name,
                          const Common::Types::CapeString& descr,
                         const Common::Types::CapeArrayLong& idxLower,
                         const Common::Types::CapeArrayLong& idxUpper);

    virtual void addPlace(const Common::Types::CapeString& _name,
                          const Common::Types::CapeString& descr,
                          const Common::Types::CapeArrayLong& idxLower,
                          const Common::Types::CapeArrayLong& idxUpper,
                          const Common::Types::CapeBoolean fork=false
        );
    virtual void addDirectTransition(const Common::Types::CapeString& _name,
                                       const Common::Types::CapeString& descr,
                                       const Common::Types::CapeArrayLong& idxLower,
                                       const Common::Types::CapeArrayLong& idxUpper
);
    virtual void addExplicitTransition(const Common::Types::CapeString& _name,
                                       const Common::Types::CapeString& descr,
                                       const Common::Types::CapeArrayLong& idxLower,
                                       const Common::Types::CapeArrayLong& idxUpper
);
    virtual void addImplicitTransition(const Common::Types::CapeString& _name,
                                       const Common::Types::CapeString& descr,
                                       const Common::Types::CapeArrayLong& idxLower,
                                       const Common::Types::CapeArrayLong& idxUpper
        );

    virtual void initParameter(const Common::Types::CapeString& name, 
                               const Common::Types::CapeArrayLong& value,
                               const Common::Types::CapeArrayLong& minValue, 
                               const Common::Types::CapeArrayLong& maxValue);
    virtual void initPlace(const Common::Types::CapeString& name, 
                           const Common::Types::CapeArrayBoolean& value);
    virtual void initParameter(const Common::Types::CapeString& name, 
                               const Common::Types::CapeArrayDouble& value, 
                               const Common::Types::CapeArrayDouble& minValue, 
                               const Common::Types::CapeArrayDouble& maxValue);
    virtual void initState(const Common::Types::CapeString& name,
                           const Common::Types::CapeArrayDouble&  dblValue,     
                           const Common::Types::CapeArrayDouble&  minValue,
                           const Common::Types::CapeArrayDouble&  maxValue,
                           const Common::Types::CapeArrayDouble&  absError);
      virtual void connectTransitionFrom(CapeLong transIndex, CapeLong placeIndex);
      virtual void connectTransitionTo(CapeLong transIndex, CapeLong placeIndex);

    virtual void addEquation(const Common::Types::CapeString& name, 
                             const Common::Types::CapeString& descr,
                             const Common::Types::CapeLong startRow);
    virtual void addDiffPattern(Common::Types::CapeLong rowIndex, 
                                Common::Types::CapeLong colIndex);
    virtual void addJacPattern(Common::Types::CapeLong rowIndex, 
                               Common::Types::CapeLong colIndex);
    virtual void finishPatterns();

  private:
    Common::Types::CapeBoolean                    bInitialized;

  private:
    Common::Types::CapeLong curSpar;           
    Common::Types::CapeLong curIpar;           
    Common::Types::CapeLong curRpar;           
    Common::Types::CapeLong curHelp;           
    Common::Types::CapeLong curState;          
    Common::Types::CapeLong curPlace;          
    Common::Types::CapeLong curExplicitTransition; 
    Common::Types::CapeLong curImplicitTransition; 
    Common::Types::CapeArrayLong iJRow;    
    Common::Types::CapeArrayLong iJCol;    
    Common::Types::CapeArrayLong iDRow;    
    Common::Types::CapeArrayLong iDCol;    
  };
}

#endif // DIANA_XML_DAESO_H