orogen_transports::MQTypelibMarshaller< T > Class Template Reference

#include <MQTypelibMarshaller.hpp>

Inheritance diagram for orogen_transports::MQTypelibMarshaller< T >:

[legend]

List of all members.

Public Member Functions
void *	createCookie () const
void	deleteCookie (void *cookie) const
std::pair< void const *, int >	fillBlob (RTT::base::DataSourceBase::shared_ptr source, void *blob, int size, void *cookie) const
unsigned int	getSampleSize (RTT::base::DataSourceBase::shared_ptr sample, void *cookie) const
	MQTypelibMarshaller (orogen_transports::TypelibMarshallerBase *marshaller)
bool	updateFromBlob (const void *blob, int size, RTT::base::DataSourceBase::shared_ptr target, void *cookie) const

---

Detailed Description

template<typename T>
class orogen_transports::MQTypelibMarshaller< T >

Definition at line 24 of file MQTypelibMarshaller.hpp.

---

Constructor & Destructor Documentation

template<typename T >

orogen_transports::MQTypelibMarshaller< T >::MQTypelibMarshaller

(

orogen_transports::TypelibMarshallerBase *

marshaller

)

[inline]

Definition at line 26 of file MQTypelibMarshaller.hpp.

---

Member Function Documentation

template<typename T >

void* orogen_transports::MQTypelibMarshaller< T >::createCookie

(

)

const [inline]

Reimplemented from orogen_transports::MQTypelibMarshallerBase.

Definition at line 29 of file MQTypelibMarshaller.hpp.

template<typename T >

void orogen_transports::MQTypelibMarshaller< T >::deleteCookie

(

void *

cookie

)

const [inline]

Reimplemented from orogen_transports::MQTypelibMarshallerBase.

Definition at line 31 of file MQTypelibMarshaller.hpp.

template<typename T >

std::pair<void const*,int> orogen_transports::MQTypelibMarshaller< T >::fillBlob	(	RTT::base::DataSourceBase::shared_ptr	source,
		void *	blob,
		int	size,
		void *	cookie
	)			const [inline, virtual]

Create an transportable object for a protocol which contains the value of source. This must be a real-time function which does not allocate memory

Parameters:

	source	The data to be read
	blob	Suggested target memory area to write to. In case the type marshaller does not need this, it will return an alternative as a first element in the returned std::pair.
	size	The size of the memory area pointed by blob

Returns:

Returns (0,0) if the filling failed, otherwise, points to the filled memory area and the effectively written size. The returned pointer may differ from blob, in case blob was not used. The returned size must be lower or equal than size

Reimplemented from RTT::mqueue::MQTemplateProtocol< T >.

Definition at line 33 of file MQTypelibMarshaller.hpp.

template<typename T >

unsigned int orogen_transports::MQTypelibMarshaller< T >::getSampleSize	(	RTT::base::DataSourceBase::shared_ptr	sample,
		void *	cookie
	)			const [inline, virtual]

Returns the size in bytes of a marshalled data element.

Returns:

the size.

Reimplemented from RTT::mqueue::MQTemplateProtocol< T >.

Definition at line 37 of file MQTypelibMarshaller.hpp.

template<typename T >

bool orogen_transports::MQTypelibMarshaller< T >::updateFromBlob	(	const void *	blob,
		int	size,
		RTT::base::DataSourceBase::shared_ptr	target,
		void *	cookie
	)			const [inline, virtual]

Update target with the contents of blob which is an object of a protocol. The given data source is guaranteed to be an AssignableDataSource

Reimplemented from RTT::mqueue::MQTemplateProtocol< T >.

Definition at line 35 of file MQTypelibMarshaller.hpp.

---

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

• MQTypelibMarshaller.hpp