SAGA C++ API 1.5.3

saga Namespace Reference

@/** These methods are not within API scope */ More...

Namespaces

namespace  detail
namespace  attributes
namespace  adaptors
 

@ /** These methods are not within API scope */


namespace  name_space
 

The Name Space API package.


namespace  advert
 

The Advert Service API package.


namespace  filesystem
 

The File Management API package.


namespace  replica
 

The Replica Management API package.


namespace  rpc
 

The Remote Procedure Call API package.


namespace  stream
 

The Streams API package.


namespace  job
 

The Job Management API package.


namespace  sd
namespace  cpr
 

The Checkpoint and Recovery (CPR) API package.


namespace  ini
namespace  metrics
 

@ /////////////////////////////////////////////////////////////////////////////


namespace  isn

Classes

protocol  SAGA_PACKAGE_EXPORT
 @ /** These methods are not within API scope */ More...
class  attribute
 Brief description starts here. More...
class  const_buffer
 Encapsulates I/O operations. More...
class  mutable_buffer
 Brief description starts here. More...
class  context
 The saga::context class provides the functionality of a security information container. More...
class  exception
class  not_implemented
class  parameter_exception
class  incorrect_url
class  bad_parameter
class  state_exception
class  already_exists
class  does_not_exist
class  incorrect_state
class  security_exception
class  permission_denied
class  authorization_failed
class  authentication_failed
class  timeout
class  no_success
class  metric
 Brief description starts here. More...
class  monitorable
 The monitorable interface is implemented by those SAGA objects which can be monitored, i.e. which have one or more associated metrics. More...
class  steerable
 The steerable interface is implemented by saga objects which can be steered, i.e. which have writable metrics, and which might allow to add new metrics. More...
class  object
 Brief description starts here. More...
class  permissions
 The SAGA permission interface. More...
struct  task_base
 Brief description starts here. More...
class  task_container
 Handles a large number of asynchronous operations. More...
class  url
 SAGA's implementation of an RFC 1630 compliant URL Class. More...
class  uuid
 Brief description starts here. More...

Typedefs

typedef std::vector< saga::metricmetric_list_type
 @ /** These methods are not within API scope */
typedef bool callback_function_type (saga::object, saga::metric, saga::context)
 @ /** These methods are not within API scope */
typedef TR1::function
< callback_function_type
callback
typedef char char_t
typedef boost::int8_t int8_t
typedef boost::uint8_t uint8_t
typedef boost::int16_t int16_t
typedef boost::uint16_t uint16_t
typedef boost::int32_t int32_t
typedef boost::uint32_t uint32_t
typedef boost::int64_t int64_t
typedef boost::uint64_t uint64_t
typedef boost::intmax_t intmax_t
typedef boost::uintmax_t uintmax_t
typedef boost::long_long_type long_long_t
typedef std::size_t size_t
typedef ::ssize_t ssize_t
typedef ::off_t off_t

Enumerations

enum  error {
  NotImplemented = 1,
  IncorrectURL = 2,
  BadParameter = 3,
  AlreadyExists = 4,
  DoesNotExist = 5,
  IncorrectState = 6,
  PermissionDenied = 7,
  AuthorizationFailed = 8,
  AuthenticationFailed = 9,
  Timeout = 10,
  NoSuccess = 11
}
 

Brief description starts here.

More...

Functions

mutable_buffer buffer (void *data, saga::size_t size)
const_buffer buffer (void const *data, saga::size_t size)
template<typename PodType , std::size_t N>
mutable_buffer buffer (PodType(&data)[N])
template<typename PodType , std::size_t N>
const_buffer buffer (PodType const (&data)[N])
template<typename PodType , std::size_t N>
mutable_buffer buffer (PodType(&data)[N], saga::size_t max_size)
template<typename PodType , std::size_t N>
const_buffer buffer (PodType const (&data)[N], saga::size_t max_size)
template<typename PodType , typename Allocator >
mutable_buffer buffer (std::vector< PodType, Allocator > &data)
template<typename PodType , typename Allocator >
const_buffer buffer (std::vector< PodType, Allocator > const &data)
template<typename PodType , typename Allocator >
mutable_buffer buffer (std::vector< PodType, Allocator > &data, saga::size_t max_size)
template<typename PodType , typename Allocator >
const_buffer buffer (std::vector< PodType, Allocator > const &data, saga::size_t max_size)
template<typename Char , typename Traits , typename Allocator >
const_buffer buffer (std::basic_string< Char, Traits, Allocator > const &data)
template<typename Char , typename Traits , typename Allocator >
const_buffer buffer (std::basic_string< Char, Traits, Allocator > const &data, saga::size_t max_size)
bool operator== (context const &lhs, context const &rhs)
 @ /** Doxygen generates namespace function from friend impls... */
bool operator== (metric const &lhs, metric const &rhs)
 @ /** Doxygen generates namespace function from friend impls... */
std::string get_object_type_name (saga::object::type t)
 @ /** These methods are not within API scope TODO wrong namespace?!? */
template saga::advert::entrytask::get_result< saga::advert::entry > ()
template saga::advert::directorytask::get_result< saga::advert::directory > ()
template saga::objecttask::get_result< saga::object > ()
unsigned long get_advert_package_version (void)
unsigned long get_advert_package_api_version (void)
template saga::cpr::jobtask::get_result< saga::cpr::job > ()
template saga::cpr::checkpointtask::get_result< saga::cpr::checkpoint > ()
template saga::cpr::directorytask::get_result< saga::cpr::directory > ()
template saga::cpr::descriptiontask::get_result< saga::cpr::description > ()
template saga::cpr::selftask::get_result< saga::cpr::self > ()
template saga::cpr::servicetask::get_result< saga::cpr::service > ()
unsigned long get_cpr_package_version (void)
unsigned long get_cpr_package_api_version (void)
template saga::filesystem::filetask::get_result< saga::filesystem::file > ()
template
saga::filesystem::directory
task::get_result< saga::filesystem::directory > ()
unsigned long get_filesystem_package_version (void)
unsigned long get_filesystem_package_api_version (void)
template saga::isn::navigator & task::get_result< saga::isn::navigator > ()
template std::vector
< saga::isn::entity_data > & 
task::get_result< std::vector< saga::isn::entity_data > > ()
unsigned long get_isn_package_version ()
unsigned long get_isn_package_api_version ()
template saga::job::job & task::get_result< saga::job::job > ()
template saga::job::statetask::get_result< saga::job::state > ()
template saga::job::ostreamtask::get_result< saga::job::ostream > ()
template saga::job::istreamtask::get_result< saga::job::istream > ()
template saga::job::selftask::get_result< saga::job::self > ()
template saga::job::descriptiontask::get_result< saga::job::description > ()
template saga::job::servicetask::get_result< saga::job::service > ()
unsigned long get_job_package_version (void)
unsigned long get_job_package_api_version (void)
template
saga::name_space::directory
task::get_result< saga::name_space::directory > ()
template saga::name_space::entrytask::get_result< saga::name_space::entry > ()
unsigned long get_namespace_package_version ()
unsigned long get_namespace_package_api_version ()
template
saga::replica::logical_file
task::get_result< saga::replica::logical_file > ()
template
saga::replica::logical_directory
task::get_result< saga::replica::logical_directory > ()
unsigned long get_replica_package_version (void)
unsigned long get_replica_package_api_version (void)
template saga::rpc::rpctask::get_result< saga::rpc::rpc > ()
unsigned long get_rpc_package_version ()
unsigned long get_rpc_package_api_version ()
template std::vector
< saga::sd::service_description > & 
task::get_result< std::vector< saga::sd::service_description > > ()
template saga::sd::discoverertask::get_result< saga::sd::discoverer > ()
unsigned long get_sd_package_version ()
unsigned long get_sd_package_api_version ()
template saga::stream::streamtask::get_result< saga::stream::stream > ()
template saga::stream::servertask::get_result< saga::stream::server > ()
template saga::stream::activitytask::get_result< saga::stream::activity > ()
unsigned long get_stream_package_version ()
unsigned long get_stream_package_api_version ()
saga::session get_default_session ()
 @ namespace detail
template std::string const & task::get_result< std::string > () const
 @ saga::impl::task_base* task::get_impl (void) const
template std::vector
< std::string > & 
task::get_result< std::vector< std::string > > ()
template saga::size_ttask::get_result< saga::size_t > ()
template saga::ssize_ttask::get_result< saga::ssize_t > ()
template saga::off_ttask::get_result< saga::off_t > ()
template saga::contexttask::get_result< saga::context > ()
template saga::urltask::get_result< saga::url > ()
template std::vector< saga::url > & task::get_result< std::vector< saga::url > > ()
std::ostream & operator<< (std::ostream &os, url const &u)
 Brief description starts here.
std::istream & operator>> (std::istream &is, url &u)
 Brief description starts here.
bool operator== (saga::url const &lhs, saga::url const &rhs)
 Brief description starts here.
bool operator!= (saga::url const &lhs, saga::url const &rhs)
 Brief description starts here.
bool operator< (saga::url const &lhs, saga::url const &rhs)
 Brief description starts here.
bool operator== (uuid const &lhs, uuid const &rhs)
 @ /** Doxygen generates namespace function from friend impls... */
bool operator!= (uuid const &lhs, uuid const &rhs)
bool operator< (uuid const &lhs, uuid const &rhs)
bool operator> (uuid const &lhs, uuid const &rhs)
bool operator<= (uuid const &lhs, uuid const &rhs)
bool operator>= (uuid const &lhs, uuid const &rhs)
std::ostream & operator<< (std::ostream &ostrm, uuid const &rhs)
std::istream & operator>> (std::istream &istrm, uuid &rhs)
unsigned long get_engine_version (void)
 Brief description starts here.
unsigned long get_saga_version (void)
 Brief description starts here.

Variables

char const *const error_names []
 @ /** These methods are not within API scope */
char const SAGA_CHECK_VERSION [] = BOOST_PP_STRINGIZE(SAGA_CHECK_VERSION)
 Brief description starts here.

Detailed Description

@/** These methods are not within API scope */

The SAGA root namespace.

@/** Hide from Doxygen */

@/** Hide from Doxygen


Typedef Documentation

typedef std::vector<saga::metric> saga::metric_list_type

@ /** These methods are not within API scope */

@ /** These methods are not within API scope */

typedef TR1::function<callback_function_type> saga::callback
typedef char saga::char_t
typedef boost::int8_t saga::int8_t
typedef boost::uint8_t saga::uint8_t
typedef boost::int16_t saga::int16_t
typedef boost::uint16_t saga::uint16_t
typedef boost::int32_t saga::int32_t
typedef boost::uint32_t saga::uint32_t
typedef boost::int64_t saga::int64_t
typedef boost::uint64_t saga::uint64_t
typedef boost::intmax_t saga::intmax_t
typedef boost::uintmax_t saga::uintmax_t
typedef boost::long_long_type saga::long_long_t
typedef std::size_t saga::size_t
typedef ::off_t saga::off_t

Enumeration Type Documentation

Brief description starts here.

Enumerator:
NotImplemented 
IncorrectURL 
BadParameter 
AlreadyExists 
DoesNotExist 
IncorrectState 
PermissionDenied 
AuthorizationFailed 
AuthenticationFailed 
Timeout 
NoSuccess 

Function Documentation

mutable_buffer saga::buffer ( void *  data,
saga::size_t  size 
) [inline]
const_buffer saga::buffer ( void const *  data,
saga::size_t  size 
) [inline]
template<typename PodType , std::size_t N>
mutable_buffer saga::buffer ( PodType(&)  data[N]) [inline]
template<typename PodType , std::size_t N>
const_buffer saga::buffer ( PodType const (&)  data[N]) [inline]
template<typename PodType , std::size_t N>
mutable_buffer saga::buffer ( PodType(&)  data[N],
saga::size_t  max_size 
) [inline]
template<typename PodType , std::size_t N>
const_buffer saga::buffer ( PodType const (&)  data[N],
saga::size_t  max_size 
) [inline]
template<typename PodType , typename Allocator >
mutable_buffer saga::buffer ( std::vector< PodType, Allocator > &  data) [inline]
template<typename PodType , typename Allocator >
const_buffer saga::buffer ( std::vector< PodType, Allocator > const &  data) [inline]
template<typename PodType , typename Allocator >
mutable_buffer saga::buffer ( std::vector< PodType, Allocator > &  data,
saga::size_t  max_size 
) [inline]
template<typename PodType , typename Allocator >
const_buffer saga::buffer ( std::vector< PodType, Allocator > const &  data,
saga::size_t  max_size 
) [inline]
template<typename Char , typename Traits , typename Allocator >
const_buffer saga::buffer ( std::basic_string< Char, Traits, Allocator > const &  data) [inline]
template<typename Char , typename Traits , typename Allocator >
const_buffer saga::buffer ( std::basic_string< Char, Traits, Allocator > const &  data,
saga::size_t  max_size 
) [inline]
bool saga::operator== ( context const &  lhs,
context const &  rhs 
)

@ /** Doxygen generates namespace function from friend impls... */

Brief description starts here.

bool saga::operator== ( metric const &  lhs,
metric const &  rhs 
)

@ /** Doxygen generates namespace function from friend impls... */

Brief description starts here.

References saga::metric::get_impl().

std::string saga::get_object_type_name ( saga::object::type  t)

@ /** These methods are not within API scope TODO wrong namespace?!? */

template saga::advert::entry& saga::task::get_result< saga::advert::entry > ( )
template saga::advert::directory& saga::task::get_result< saga::advert::directory > ( )
template saga::object& saga::task::get_result< saga::object > ( )
unsigned long saga::get_advert_package_version ( void  )
unsigned long saga::get_advert_package_api_version ( void  )
template saga::cpr::job& saga::task::get_result< saga::cpr::job > ( )
template saga::cpr::checkpoint& saga::task::get_result< saga::cpr::checkpoint > ( )
template saga::cpr::directory& saga::task::get_result< saga::cpr::directory > ( )
template saga::cpr::description& saga::task::get_result< saga::cpr::description > ( )
template saga::cpr::self& saga::task::get_result< saga::cpr::self > ( )
template saga::cpr::service& saga::task::get_result< saga::cpr::service > ( )
unsigned long saga::get_cpr_package_version ( void  )
unsigned long saga::get_cpr_package_api_version ( void  )
template saga::filesystem::file& saga::task::get_result< saga::filesystem::file > ( )
template saga::filesystem::directory& saga::task::get_result< saga::filesystem::directory > ( )
unsigned long saga::get_filesystem_package_version ( void  )
unsigned long saga::get_filesystem_package_api_version ( void  )
template saga::isn::navigator& saga::task::get_result< saga::isn::navigator > ( )
template std::vector<saga::isn::entity_data>& saga::task::get_result< std::vector< saga::isn::entity_data > > ( )
unsigned long saga::get_isn_package_version ( )
unsigned long saga::get_isn_package_api_version ( )
template saga::job::job& saga::task::get_result< saga::job::job > ( )
template saga::job::state& saga::task::get_result< saga::job::state > ( )
template saga::job::ostream& saga::task::get_result< saga::job::ostream > ( )
template saga::job::istream& saga::task::get_result< saga::job::istream > ( )
template saga::job::self& saga::task::get_result< saga::job::self > ( )
template saga::job::description& saga::task::get_result< saga::job::description > ( )
template saga::job::service& saga::task::get_result< saga::job::service > ( )
unsigned long saga::get_job_package_version ( void  )
unsigned long saga::get_job_package_api_version ( void  )
template saga::name_space::directory& saga::task::get_result< saga::name_space::directory > ( )
template saga::name_space::entry& saga::task::get_result< saga::name_space::entry > ( )
unsigned long saga::get_namespace_package_version ( )
unsigned long saga::get_namespace_package_api_version ( )
template saga::replica::logical_file& saga::task::get_result< saga::replica::logical_file > ( )
template saga::replica::logical_directory& saga::task::get_result< saga::replica::logical_directory > ( )
unsigned long saga::get_replica_package_version ( void  )
unsigned long saga::get_replica_package_api_version ( void  )
template saga::rpc::rpc& saga::task::get_result< saga::rpc::rpc > ( )
unsigned long saga::get_rpc_package_version ( )
unsigned long saga::get_rpc_package_api_version ( )
template std::vector<saga::sd::service_description>& saga::task::get_result< std::vector< saga::sd::service_description > > ( )
template saga::sd::discoverer& saga::task::get_result< saga::sd::discoverer > ( )
unsigned long saga::get_sd_package_version ( )
unsigned long saga::get_sd_package_api_version ( )
template saga::stream::stream& saga::task::get_result< saga::stream::stream > ( )
template saga::stream::server& saga::task::get_result< saga::stream::server > ( )
template saga::stream::activity& saga::task::get_result< saga::stream::activity > ( )
unsigned long saga::get_stream_package_version ( )
unsigned long saga::get_stream_package_api_version ( )
saga::session saga::get_default_session ( )

@ namespace detail

template std::string const& saga::task::get_result< std::string > ( ) const

@ saga::impl::task_base* task::get_impl (void) const

@ namespace detail

template std::vector<std::string>& saga::task::get_result< std::vector< std::string > > ( )
template saga::size_t& saga::task::get_result< saga::size_t > ( )
template saga::ssize_t& saga::task::get_result< saga::ssize_t > ( )
template saga::off_t& saga::task::get_result< saga::off_t > ( )
template saga::context& saga::task::get_result< saga::context > ( )
template saga::url& saga::task::get_result< saga::url > ( )
template std::vector<saga::url>& saga::task::get_result< std::vector< saga::url > > ( )
std::ostream & saga::operator<< ( std::ostream &  os,
url const &  u 
)

Brief description starts here.

References saga::url::get_string().

std::istream & saga::operator>> ( std::istream &  is,
url &  u 
)

Brief description starts here.

bool saga::operator== ( saga::url const &  lhs,
saga::url const &  rhs 
)

Brief description starts here.

References saga::url::get_string().

bool saga::operator!= ( saga::url const &  lhs,
saga::url const &  rhs 
)

Brief description starts here.

References saga::url::get_string().

bool saga::operator< ( saga::url const &  lhs,
saga::url const &  rhs 
)

Brief description starts here.

References saga::url::get_string().

bool saga::operator== ( uuid const &  lhs,
uuid const &  rhs 
)

@ /** Doxygen generates namespace function from friend impls... */

Brief description starts here.

bool saga::operator!= ( uuid const &  lhs,
uuid const &  rhs 
)
bool saga::operator< ( uuid const &  lhs,
uuid const &  rhs 
)
bool saga::operator> ( uuid const &  lhs,
uuid const &  rhs 
)
bool saga::operator<= ( uuid const &  lhs,
uuid const &  rhs 
)
bool saga::operator>= ( uuid const &  lhs,
uuid const &  rhs 
)
std::ostream& saga::operator<< ( std::ostream &  ostrm,
uuid const &  rhs 
)

References saga::uuid::string().

std::istream& saga::operator>> ( std::istream &  istrm,
uuid &  rhs 
)
unsigned long saga::get_engine_version ( void  )

Brief description starts here.

unsigned long saga::get_saga_version ( void  )

Brief description starts here.

References SAGA_VERSION_API.


Variable Documentation

char const* const saga::error_names[]
Initial value:
 {
    "Success",
    "NotImplemented",
    "IncorrectURL",
    "BadParameter",
    "AlreadyExists",
    "DoesNotExist",
    "IncorrectState",
    "PermissionDenied",
    "AuthorizationFailed",
    "AuthenticationFailed",
    "Timeout",
    "NoSuccess",
    
    
    "NoSuccess", 
    "NoSuccess", 
    "NoSuccess", 
    "NoSuccess" 
  }

@ /** These methods are not within API scope */

char const saga::SAGA_CHECK_VERSION = BOOST_PP_STRINGIZE(SAGA_CHECK_VERSION)

Brief description starts here.

 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Defines