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

#ifndef CAPE_BASIC_HPP
#define CAPE_BASIC_HPP

#include "CapeTypes.hpp"
#include "CapeException.hpp"


namespace Common{


  namespace Identification{

    class ICapeIdentification   {
#ifndef SWIG

      friend std::ostream& operator<<(std::ostream& out_file, const ICapeIdentification& identification);
#endif
    public:
      virtual ~ICapeIdentification(){}
      
      virtual const Common::Types::CapeString& GetComponentName() const
        throw (Common::Error::ECapeUnknown) = 0;

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

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

      virtual void SetComponentDescription(const Common::Types::CapeString& _description)
        throw (Common::Error::ECapeUnknown, Common::Error::ECapeInvalidArgument) = 0;

#ifndef SWIG

      virtual ICapeIdentification* clone()
        throw (Common::Error::ECapeUnknown, Common::Error::ECapeNoImpl);
#endif
    };

#ifndef SWIG

      std::ostream& operator<<(std::ostream& out_file, const ICapeIdentification& identification);
#endif
  }; 


  namespace Collection{

    class ICapeCollection : public Common::Identification::ICapeIdentification{
#ifndef SWIG

      friend std::ostream& operator<<(std::ostream& out_file, ICapeCollection& coll);
#endif
    public:
      virtual ~ICapeCollection(){}
      
      virtual Common::Types::CapeLong Count() const  
        throw (Common::Error::ECapeUnknown, Common::Error::ECapeFailedInitialisation) = 0;
      
      virtual Common::Identification::ICapeIdentification* ItemByIndex(Common::Types::CapeLong index) const
        throw (Common::Error::ECapeUnknown, Common::Error::ECapeInvalidArgument,
               Common::Error::ECapeFailedInitialisation, Common::Error::ECapeOutOfBounds) = 0;

      virtual Common::Identification::ICapeIdentification* ItemByName(const Common::Types::CapeString& name) const
        throw (Common::Error::ECapeUnknown, Common::Error::ECapeInvalidArgument,
               Common::Error::ECapeFailedInitialisation, Common::Error::ECapeOutOfBounds) = 0;
    };
#ifndef SWIG

    std::ostream& operator<<(std::ostream& out_file, ICapeCollection& coll);
#endif
  };


  namespace Utilities{

    class ICapeUtilities{
    public:
      virtual ~ICapeUtilities(){};
      
      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;
    };
  };
};

#endif // CAPE_BASIC_HPP