RTT::mqueue::MQSerializationProtocol< T > Class Template Reference

#include <MQSerializationProtocol.hpp>

Inheritance diagram for RTT::mqueue::MQSerializationProtocol< T >:

[legend]

List of all members.

Public Member Functions
virtual std::pair< void const *, int >	fillBlob (base::DataSourceBase::shared_ptr source, void *blob, int size, void *cookie) const
virtual std::pair< void const *, int >	fillBlob (base::DataSourceBase::shared_ptr source, void *blob, int size, void *cookie) const
virtual unsigned int	getSampleSize (base::DataSourceBase::shared_ptr sample, void *cookie) const
virtual unsigned int	getSampleSize (base::DataSourceBase::shared_ptr sample, void *cookie) const
	MQSerializationProtocol ()
	MQSerializationProtocol ()
virtual bool	updateFromBlob (const void *blob, int size, base::DataSourceBase::shared_ptr target, void *cookie) const
virtual bool	updateFromBlob (const void *blob, int size, base::DataSourceBase::shared_ptr target, void *cookie) const

---

Detailed Description

template<class T>
class RTT::mqueue::MQSerializationProtocol< T >

Definition at line 54 of file install/include/rtt/transports/mqueue/MQSerializationProtocol.hpp.

---

Constructor & Destructor Documentation

template<class T >

RTT::mqueue::MQSerializationProtocol< T >::MQSerializationProtocol

(

)

[inline]

Definition at line 53 of file install/include/rtt/transports/mqueue/MQSerializationProtocol.hpp.

template<class T >

RTT::mqueue::MQSerializationProtocol< T >::MQSerializationProtocol

(

)

[inline]

Definition at line 65 of file rtt/transports/mqueue/MQSerializationProtocol.hpp.

---

Member Function Documentation

template<class T >

virtual std::pair<void const*,int> RTT::mqueue::MQSerializationProtocol< T >::fillBlob	(	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 68 of file rtt/transports/mqueue/MQSerializationProtocol.hpp.

template<class T >

virtual std::pair<void const*,int> RTT::mqueue::MQSerializationProtocol< T >::fillBlob	(	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 56 of file install/include/rtt/transports/mqueue/MQSerializationProtocol.hpp.

template<class T >

virtual unsigned int RTT::mqueue::MQSerializationProtocol< T >::getSampleSize	(	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 98 of file rtt/transports/mqueue/MQSerializationProtocol.hpp.

template<class T >

virtual unsigned int RTT::mqueue::MQSerializationProtocol< T >::getSampleSize	(	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 86 of file install/include/rtt/transports/mqueue/MQSerializationProtocol.hpp.

template<class T >

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

Update target with the contents of blob which is an object of a protocol.

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

Definition at line 86 of file rtt/transports/mqueue/MQSerializationProtocol.hpp.

template<class T >

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

Update target with the contents of blob which is an object of a protocol.

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

Definition at line 74 of file install/include/rtt/transports/mqueue/MQSerializationProtocol.hpp.

---

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

• install/include/rtt/transports/mqueue/MQSerializationProtocol.hpp
• rtt/transports/mqueue/MQSerializationProtocol.hpp