SAGA C++ API 1.5.3

saga::rpc::parameter Class Reference

The parameter class inherits the saga::buffer class. More...

#include <parameter.hpp>

Inheritance diagram for saga::rpc::parameter:

List of all members.

Public Member Functions

 parameter (void *data=0, saga::ssize_t size=-1, io_mode mode=In, buffer_deleter cb=default_buffer_deleter)
 Creates a parameter instance.
 ~parameter ()
 Destroys a parameter instance.
io_mode get_mode () const
 FIXME: spec says: should be set_io_mode.

Protected Member Functions

TR1::shared_ptr
< saga::impl::parameter > 
get_impl_sp (void) const
 @ /** These methods are not within API scope */
saga::impl::parameter * get_impl (void) const

Detailed Description

The parameter class inherits the saga::buffer class.

It also adds one additional state attribute: io mode, which is read-only. With that addition, the new class can conveniently be used to define input, inout and output parameters for RPC calls.


Constructor & Destructor Documentation

saga::rpc::parameter::parameter ( void *  data = 0,
saga::ssize_t  size = -1,
io_mode  mode = In,
buffer_deleter  cb = default_buffer_deleter 
)

Creates a parameter instance.

Returns:
The newly created parameter.
saga::rpc::parameter::~parameter ( )

Destroys a parameter instance.


Member Function Documentation

TR1::shared_ptr< saga::impl::parameter > saga::rpc::parameter::get_impl_sp ( void  ) const [protected]

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

Reimplemented from saga::mutable_buffer.

saga::impl::parameter * saga::rpc::parameter::get_impl ( void  ) const [protected]

Reimplemented from saga::mutable_buffer.

Referenced by get_mode().

saga::rpc::io_mode saga::rpc::parameter::get_mode ( ) const

FIXME: spec says: should be set_io_mode.

References get_impl().


The documentation for this class was generated from the following files:
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Defines