rsb::converter::RosettaConverter< Mechanism, DataType, WireSchema > Class Template Reference

#include <RosettaConverter.h>

Inheritance diagram for rsb::converter::RosettaConverter< Mechanism, DataType, WireSchema >:

Collaboration diagram for rsb::converter::RosettaConverter< Mechanism, DataType, WireSchema >:

Public Member Functions
	RosettaConverter ()
virtual	~RosettaConverter ()
std::string	serialize (const AnnotatedData &data, std::string &wire)
	Serialized the given domain object to the wire. More...
AnnotatedData	deserialize (const std::string &wireType, const std::string &wire)
	Deserializes a domain object from a wire type. More...
Public Member Functions inherited from rsb::converter::Converter< std::string >
virtual	~Converter ()
virtual std::string	getDataType () const
	Returns the name of the data type this converter is applicable for. More...
virtual std::string	getWireSchema () const
	Returns the name of the wire schema this converter can (de)serialize from/to. More...

Additional Inherited Members
Public Types inherited from rsb::converter::Converter< std::string >
typedef boost::shared_ptr < Converter< std::string > >	Ptr
Protected Member Functions inherited from rsb::converter::Converter< std::string >
	Converter (const std::string &dataType, const std::string &wireSchema, bool dummy=true)
	Creates a new instance of this class with automatic handling for types. More...
	Converter (const std::string &wireSchema, const DataType *=0)
	Creates a new instance of this class with a data type string that is inferred based on the template parameter DataType. More...

Detailed Description

template<typename Mechanism, typename DataType, typename WireSchema>
class rsb::converter::RosettaConverter< Mechanism, DataType, WireSchema >

Template Parameters

Mechanism
DataType
WireSchema

Author

jmoringe

Definition at line 51 of file RosettaConverter.h.

Constructor & Destructor Documentation

template<typename Mechanism , typename DataType , typename WireSchema >

rsb::converter::RosettaConverter< Mechanism, DataType, WireSchema >::RosettaConverter

(

)

Definition at line 66 of file RosettaConverter.h.

template<typename Mechanism , typename DataType , typename WireSchema >

rsb::converter::RosettaConverter< Mechanism, DataType, WireSchema >::~RosettaConverter ( )

virtual

Definition at line 76 of file RosettaConverter.h.

Member Function Documentation

template<typename Mechanism , typename DataType , typename WireSchema >

AnnotatedData rsb::converter::RosettaConverter< Mechanism, DataType, WireSchema >::deserialize ( const std::string &  wireSchema, const std::string &  wire  )

virtual

Deserializes a domain object from a wire type.

Parameters

wireSchema	type of the wire message
wire	the wire containing the data

Returns

the deserialized domain object annotated with its data type name

Exceptions

SerializationException

if deserializing the message fails

Implements rsb::converter::Converter< std::string >.

Definition at line 102 of file RosettaConverter.h.

template<typename Mechanism , typename DataType , typename WireSchema >

std::string rsb::converter::RosettaConverter< Mechanism, DataType, WireSchema >::serialize ( const AnnotatedData &  data, std::string &  wire  )

virtual

Serialized the given domain object to the wire.

Parameters

data	data to serialize
wire	the wire to serialize on

Returns

the wire schema the data is encoded with

Exceptions

SerializationException

if the serialization failed

Implements rsb::converter::Converter< std::string >.

Definition at line 82 of file RosettaConverter.h.

---

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

• rsb/converter/RosettaConverter.h