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

#ifndef IDIANA_MAIN_HPP
#define IDIANA_MAIN_HPP


#include <CapeOpen.hpp>
#include <Diana/IDianaReporting.hpp>
#include <Diana/IDianaNLPParalleling.hpp>
#include <Diana/parallel/IParallelEnv.hpp>

namespace Diana {

  class IDianaMain : public Common::Utilities::ICapeUtilities  {
  public:
    virtual ~IDianaMain(){};

  public:
    virtual Common::Collection::ICapeCollection* GetParameters()
      throw (Common::Error::ECapeUnknown, Common::Error::ECapeFailedInitialisation,
             Common::Error::ECapeNoImpl) = 0;

    virtual void SetSimulationContext(Common::Identification::ICapeIdentification* simContextManager)
      throw (Common::Error::ECapeUnknown, Common::Error::ECapeInvalidArgument,
             Common::Error::ECapeFailedInitialisation, Common::Error::ECapeNoImpl) = 0;

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

    virtual void Terminate()
      throw (Common::Error::ECapeUnknown, Common::Error::ECapeOutOfResources,
             Common::Error::ECapeBadInvOrder) = 0;
    virtual Numeric::Solvers::Model::ICapeNumericModelManager* GetModelManager()
      throw (Common::Error::ECapeUnknown, Common::Error::ECapeOutOfResources,
             Common::Error::ECapeFailedInitialisation) = 0;

    virtual Numeric::Solvers::Solver::ICapeNumericSolverFactory* GetSolverFactory()
      throw (Common::Error::ECapeUnknown, Common::Error::ECapeOutOfResources,
             Common::Error::ECapeFailedInitialisation) = 0;
    virtual Numeric::Solvers::NLPTasks::ICapeNumericNLPTaskFactory* GetNLPTaskFactory()
      throw (Common::Error::ECapeUnknown, Common::Error::ECapeOutOfResources,
             Common::Error::ECapeFailedInitialisation) = 0;


    virtual IParallelEnv* CreateParallelEnv()
        throw (Common::Error::ECapeUnknown, Common::Error::ECapeNoImpl) = 0;

    virtual Diana::IDianaReporting* CreateReportingInterface(const Common::Types::CapeString& strName)
      throw (Common::Error::ECapeUnknown, Common::Error::ECapeOutOfResources,
             Common::Error::ECapeFailedInitialisation) = 0;

    virtual Diana::IDianaNLPSolverParallelInterface* CreateNLPSolverParallelInterface(int argc, char *argv[], Common::Types::CapeString strLibraryName)
      throw (Common::Error::ECapeUnknown, Common::Error::ECapeInvalidArgument,
             Common::Error::ECapeOutOfBounds, Common::Error::ECapeOutOfResources,
             Common::Error::ECapeFailedInitialisation, Common::Error::ECapeUser) = 0;

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

    virtual void Beep(int percent=0)
      throw (Common::Error::ECapeUnknown) = 0;

#ifdef DEBUG
    virtual void DebuggerTrap()
      throw (Common::Error::ECapeUnknown) = 0;
#endif
  };

  extern IDianaMain* GetDianaMain(const Common::Types::CapeArrayString& args=Common::Types::CapeArrayString());
};

#endif // IDIANA_MAIN_HPP