session.hpp

Go to the documentation of this file.

//  Copyright (c) 2005-2007 Andre Merzky (andre@merzky.net)
//  Copyright (c) 2005-2009 Hartmut Kaiser
//  Copyright (c) 2007 Ole Weidner (oweidner@cct.lsu.edu)
// 
//  Distributed under the Boost Software License, Version 1.0. (See accompanying 
//  file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt)

#ifndef SAGA_SESSION_HPP
#define SAGA_SESSION_HPP

// include stl
#include <list>
#include <set>

// include dependent spec sections
#include <saga/saga/util.hpp>
#include <saga/saga/base.hpp>
#include <saga/saga/object.hpp>
#include <saga/saga/detail/preferences.hpp>

// suppress warnings about dependent classes not being exported from the dll
#if defined(BOOST_MSVC)
#pragma warning(push)
#pragma warning(disable: 4251 4231 4275 4660)
#endif

namespace saga
{
    namespace detail 
    {
        // the default session as singleton, and the no-session singleton
        SAGA_EXPORT session& get_the_session();
        #define SAGA_DEFAULT_SESSION detail::get_the_session()

        // helper function to create exactly one instance of a default session
        session& get_instance();
    }

  class SAGA_EXPORT session
    : public saga::object
  {
    protected: 

      TR1::shared_ptr<saga::impl::session> get_impl_sp (void) const;
      saga::impl::session* get_impl (void) const;

      friend class  saga::object; // needs to get impl
      friend struct impl::runtime;
      friend session& detail::get_instance();

      // this is protected now to avoid abuse
      explicit session(bool default_session);

    public:
      explicit session();

      explicit session(saga::object const& obj);

     ~session (void);

      session &operator= (saga::object const& o);

      void add_context(saga::context const& c);

      void remove_context(saga::context const& c);

      std::vector <saga::context> list_contexts() const;
      
      friend SAGA_EXPORT 
      bool operator== (session const& lhs, session const& rhs);

      void close (double timeout = 0.0);
  };

  saga::session SAGA_EXPORT get_default_session();

} // namespace saga

// re-enable warnings about dependent classes not being exported from the dll
#if defined(BOOST_MSVC)
#pragma warning(pop)
#endif

#endif // SAGA_SESSION_HPP