Public Types | Public Member Functions
orogen_transports::OpaqueTypelibMarshaller< TypelibType, OpaqueType, 0 > Struct Template Reference

#include <OpaqueTypelibMarshaller.hpp>

Inheritance diagram for orogen_transports::OpaqueTypelibMarshaller< TypelibType, OpaqueType, 0 >:
Inheritance graph
[legend]

List of all members.

Public Types

typedef
orogen_transports::TypelibMarshallerBase::Handle 
MarshallingHandle
typedef OpaqueType opaque_t
typedef TypelibType typelib_t

Public Member Functions

MarshallingHandlecreateSample ()
 OpaqueTypelibMarshaller (std::string const &typelib_name, std::string const &opaque_name, Typelib::Registry const &registry)
void refreshOrocosSample (MarshallingHandle *handle)
void refreshTypelibSample (MarshallingHandle *handle)
void setTypelibSample (MarshallingHandle *handle, uint8_t *typelib_data, bool refresh_orocos=true)

Detailed Description

template<typename TypelibType, typename OpaqueType>
struct orogen_transports::OpaqueTypelibMarshaller< TypelibType, OpaqueType, 0 >

Definition at line 117 of file OpaqueTypelibMarshaller.hpp.


Member Typedef Documentation

template<typename TypelibType , typename OpaqueType >
typedef orogen_transports::TypelibMarshallerBase::Handle orogen_transports::OpaqueTypelibMarshaller< TypelibType, OpaqueType, 0 >::MarshallingHandle
template<typename TypelibType , typename OpaqueType >
typedef OpaqueType orogen_transports::OpaqueTypelibMarshaller< TypelibType, OpaqueType, 0 >::opaque_t
template<typename TypelibType , typename OpaqueType >
typedef TypelibType orogen_transports::OpaqueTypelibMarshaller< TypelibType, OpaqueType, 0 >::typelib_t

Constructor & Destructor Documentation

template<typename TypelibType , typename OpaqueType >
orogen_transports::OpaqueTypelibMarshaller< TypelibType, OpaqueType, 0 >::OpaqueTypelibMarshaller ( std::string const &  typelib_name,
std::string const &  opaque_name,
Typelib::Registry const &  registry 
) [inline]

Definition at line 123 of file OpaqueTypelibMarshaller.hpp.


Member Function Documentation

template<typename TypelibType , typename OpaqueType >
MarshallingHandle* orogen_transports::OpaqueTypelibMarshaller< TypelibType, OpaqueType, 0 >::createSample ( ) [inline, virtual]

Creates a sample handler, which is an opaque type used to read/write/marshal data. Unlike createHandle(), the handle returned by this method already contains a preallocated data sample. It can therefore be used as-is for readPort.

Implements orogen_transports::TypelibMarshallerBase.

Definition at line 126 of file OpaqueTypelibMarshaller.hpp.

template<typename TypelibType , typename OpaqueType >
void orogen_transports::OpaqueTypelibMarshaller< TypelibType, OpaqueType, 0 >::refreshOrocosSample ( MarshallingHandle data) [inline, virtual]

Updates the value of data->orocos_sample based on the data in data->typelib_sample

Implements orogen_transports::TypelibMarshallerBase.

Definition at line 146 of file OpaqueTypelibMarshaller.hpp.

template<typename TypelibType , typename OpaqueType >
void orogen_transports::OpaqueTypelibMarshaller< TypelibType, OpaqueType, 0 >::refreshTypelibSample ( MarshallingHandle handle) [inline, virtual]

Updates the value of data->typelib_sample based on the data in data->orocos_sample

Implements orogen_transports::TypelibMarshallerBase.

Definition at line 131 of file OpaqueTypelibMarshaller.hpp.

template<typename TypelibType , typename OpaqueType >
void orogen_transports::OpaqueTypelibMarshaller< TypelibType, OpaqueType, 0 >::setTypelibSample ( MarshallingHandle data,
uint8_t *  typelib_data,
bool  refresh_orocos = true 
) [inline, virtual]

Updates the sample handler by using a data sample that Typelib understands. +typelib_data+ must be pointing to an object whose type is the one returned by getMarshallingType.

The handle will then point directly to the given data sample, i.e. calls to read might modify that sample directly.

The ownership of typelib_data is retained by the caller. I.e. it has to delete it.

Implements orogen_transports::TypelibMarshallerBase.

Definition at line 158 of file OpaqueTypelibMarshaller.hpp.


The documentation for this struct was generated from the following file:


rtt_typelib
Author(s): Sylvain Joyeux/sylvain.joyeux@m4x.org
autogenerated on Mon Sep 14 2015 14:56:37