rsb::converter::StringConverter Class Reference

Converts any string into any string serializing content to a string. More...

#include <StringConverter.h>

Inheritance diagram for rsb::converter::StringConverter:

Collaboration diagram for rsb::converter::StringConverter:

Public Member Functions
	StringConverter ()
virtual	~StringConverter ()
std::string	serialize (const AnnotatedData &data, std::string &wire)
	Serialized the given domain object to the wire.
AnnotatedData	deserialize (const std::string &wireSchema, const std::string &wire)
	Deserializes a domain object from a wire type.
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.
virtual std::string	getWireSchema () const
	Returns the name of the wire schema this converter can (de)serialize from/to.

Static Private Attributes
static const std::string	WIRE_SCHEMA = "utf-8-string"

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.
	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.

Detailed Description

Converts any string into any string serializing content to a string.

Author

swrede

Definition at line 44 of file StringConverter.h.

Constructor & Destructor Documentation

rsb::converter::StringConverter::StringConverter

(

)

Definition at line 38 of file StringConverter.cpp.

rsb::converter::StringConverter::~StringConverter ( )

virtual

Definition at line 42 of file StringConverter.cpp.

Member Function Documentation

AnnotatedData rsb::converter::StringConverter::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 55 of file StringConverter.cpp.

References rsb::converter::Converter< std::string >::getDataType(), and WIRE_SCHEMA.

Here is the call graph for this function:

string rsb::converter::StringConverter::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 45 of file StringConverter.cpp.

References WIRE_SCHEMA.

Member Data Documentation

const string rsb::converter::StringConverter::WIRE_SCHEMA = "utf-8-string"

staticprivate

Definition at line 55 of file StringConverter.h.

Referenced by deserialize(), and serialize().

---

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

• rsb/converter/StringConverter.h
• rsb/converter/StringConverter.cpp