|
SAGA C++ API 1.5.3
|
The advert class represents an entry in a saga::advert::directory. An advert directory is a meta data directory with a hierarchical namespace attached. This class inherits all methods from saga::name_space::namespace_entry and provides additional methods to publish new and query existing adverts. More...
#include <advert.hpp>

Public Member Functions | |
| entry (saga::session const &s, saga::url url, int mode=Read) | |
| Constructs an advert object that points to url, opens it in mode and associates it with the session s. | |
| entry (saga::url url, int mode=Read) | |
| Constructs an advert object that points to url and opens it in mode. | |
| entry (saga::object const &other) | |
| Constructs a copy of other. | |
| entry (void) | |
| Constructs a default advert object. | |
| ~entry (void) | |
| Destroys the advert object and frees all allocated resources. | |
| void | store_object (saga::object object) |
| Stores a saga object in this advert. | |
| template<typename T > | |
| boost::disable_if < detail::has_sync_tag< T > >::type | store_object (T const &object) |
| boost::enable_if < detail::has_sync_tag< Tag > , saga::task >::type | store_object (T const &object) |
| @ template <typename Tag, typename T> | |
| saga::object | retrieve_object () |
| Retrieves the saga object stored in this advert. | |
| template<typename Tag > | |
| boost::enable_if < detail::has_sync_tag< Tag > , saga::task >::type | retrieve_object () |
| @// SAGA_CALL_PUB_0_DEF_0(retrieve_object) | |
| template<typename T > | |
| T & | retrieve_object (typename boost::disable_if< detail::has_sync_tag< T > >::type *=0) |
| boost::disable_if < detail::has_sync_tag< T > , saga::task >::type | retrieve_object () |
| @ template <typename T, typename Tag> | |
| saga::object | retrieve_object (saga::session const &s) |
| Retrieves the saga object stored in this advert and associates it with the session s. | |
| boost::enable_if < detail::has_sync_tag< Tag > , saga::task >::type | retrieve_object (saga::session const &s) |
| @ template <typename tag>=""> | |
| void | store_string (std::string str) |
| Stores a string in this advert. | |
| saga::task | store_string (std::string str) |
| @ template <typename tag>=""> | |
| std::string | retrieve_string (void) |
| Retrieves the string stored in this advert. | |
| saga::task | retrieve_string () |
| @ template <typename tag>=""> | |
Static Public Member Functions | |
| static entry | create (session const &s, saga::url const &url, int mode=Read) |
| Factory function resembling entry(session, url, int) constructor. | |
| static entry | create (saga::url const &url, int mode=Read) |
| Factory function resembling entry(url, int) constructor. | |
| template<typename Tag > | |
| static saga::task | create (saga::url const &url, int mode=Read) |
Protected Types | |
| typedef saga::detail::attribute< entry > | attribute_base |
| typedef saga::name_space::entry::monitorable_base | monitorable_base |
Protected Member Functions | |
| TR1::shared_ptr < saga::impl::advert > | get_impl_sp (void) const |
| @ /** These methods are not within API scope */ | |
| saga::impl::advert * | get_impl (void) const |
| entry (saga::impl::advert *impl) | |
The advert class represents an entry in a saga::advert::directory. An advert directory is a meta data directory with a hierarchical namespace attached. This class inherits all methods from saga::name_space::namespace_entry and provides additional methods to publish new and query existing adverts.
typedef saga::detail::attribute<entry> saga::advert::entry::attribute_base [protected] |
typedef saga::name_space::entry::monitorable_base saga::advert::entry::monitorable_base [protected] |
Reimplemented from saga::name_space::entry.
| saga::advert::entry::entry | ( | saga::impl::advert * | impl | ) | [explicit, protected] |
| saga::advert::entry::entry | ( | saga::session const & | s, |
| saga::url | url, | ||
| int | mode = Read |
||
| ) |
Constructs an advert object that points to url, opens it in mode and associates it with the session s.
| saga::advert::entry::entry | ( | saga::url | url, |
| int | mode = Read |
||
| ) | [explicit] |
Constructs an advert object that points to url and opens it in mode.
References saga::metrics::init_data::description, get_impl(), saga::detail::attribute< Derived >::init(), saga::metrics::init_data::mode, saga::metrics::init_data::name, saga::metrics::init_data::type, saga::metrics::init_data::unit, and saga::metrics::init_data::value.
| saga::advert::entry::entry | ( | saga::object const & | other | ) | [explicit] |
Constructs a copy of other.
Reimplemented from saga::name_space::entry.
References saga::object::Advert, saga::BadParameter, and saga::object::get_type().
| saga::advert::entry::entry | ( | void | ) |
Constructs a default advert object.
Reimplemented from saga::name_space::entry.
| saga::advert::entry::~entry | ( | void | ) |
Destroys the advert object and frees all allocated resources.
Reimplemented from saga::name_space::entry.
| TR1::shared_ptr< saga::impl::advert > saga::advert::entry::get_impl_sp | ( | void | ) | const [protected] |
@ /** These methods are not within API scope */
Reimplemented from saga::name_space::entry.
| saga::impl::advert * saga::advert::entry::get_impl | ( | void | ) | const [protected] |
Reimplemented from saga::name_space::entry.
Referenced by entry().
| static entry saga::advert::entry::create | ( | session const & | s, |
| saga::url const & | url, | ||
| int | mode = Read |
||
| ) | [inline, static] |
Factory function resembling entry(session, url, int) constructor.
| static entry saga::advert::entry::create | ( | saga::url const & | url, |
| int | mode = Read |
||
| ) | [inline, static] |
Factory function resembling entry(url, int) constructor.
@ SAGA_CALL_CREATE_3_DEF_1(session const&, saga::url const&, int, Read)
| static saga::task saga::advert::entry::create | ( | saga::url const & | url, |
| int | mode = Read |
||
| ) | [inline, static] |
| void saga::advert::entry::store_object | ( | saga::object | object | ) | [inline] |
Stores a saga object in this advert.
@ entry &operator= (saga::object const& object);
| object | The object to store |
| boost::disable_if<detail::has_sync_tag<T> >::type saga::advert::entry::store_object | ( | T const & | object | ) | [inline] |
| boost::enable_if<detail::has_sync_tag<Tag>, saga::task>::type saga::advert::entry::store_object | ( | T const & | object | ) | [inline] |
@ template <typename Tag, typename T>
| saga::object saga::advert::entry::retrieve_object | ( | ) | [inline] |
Retrieves the saga object stored in this advert.
| boost::enable_if<detail::has_sync_tag<Tag>, saga::task>::type saga::advert::entry::retrieve_object | ( | ) | [inline] |
@// SAGA_CALL_PUB_0_DEF_0(retrieve_object)
| T& saga::advert::entry::retrieve_object | ( | typename boost::disable_if< detail::has_sync_tag< T > >::type * | = 0 | ) | [inline] |
| boost::disable_if<detail::has_sync_tag<T>, saga::task>::type saga::advert::entry::retrieve_object | ( | ) | [inline] |
@ template <typename T, typename Tag>
| saga::object saga::advert::entry::retrieve_object | ( | saga::session const & | s | ) | [inline] |
Retrieves the saga object stored in this advert and associates it with the session s.
| s | a session object |
| boost::enable_if<detail::has_sync_tag<Tag>, saga::task>::type saga::advert::entry::retrieve_object | ( | saga::session const & | s | ) | [inline] |
@ template <typename tag>="">
| void saga::advert::entry::store_string | ( | std::string | str | ) | [inline] |
Stores a string in this advert.
obsolete API below, don't use this anymore
| str | The string to store |
| saga::task saga::advert::entry::store_string | ( | std::string | str | ) | [inline] |
@ template <typename tag>="">
| std::string saga::advert::entry::retrieve_string | ( | void | ) | [inline] |
Retrieves the string stored in this advert.
| saga::task saga::advert::entry::retrieve_string | ( | void | ) | [inline] |
@ template <typename tag>="">