Classes | Public Member Functions | Protected Types | Protected Attributes | List of all members
variant_topic_tools::Serializer Class Reference

Data type. More...

#include <Serializer.h>

Inheritance diagram for variant_topic_tools::Serializer:
Inheritance graph
[legend]

Classes

class  Impl
 Serializer implementation. More...
 

Public Member Functions

void advance (ros::serialization::Stream &stream, const Variant &value)
 Advance a stream by the length of a serialized value. More...
 
void clear ()
 Clear the serializer. More...
 
void deserialize (ros::serialization::IStream &stream, Variant &value)
 Deserialize a variant value from an input stream. More...
 
size_t getSerializedLength (const Variant &value) const
 Retrieve the serialized length of a variant value. More...
 
bool isValid () const
 True, if this serializer is valid. More...
 
 operator void * () const
 Void pointer conversion. More...
 
void serialize (ros::serialization::OStream &stream, const Variant &value)
 Serialize a variant value to an output stream. More...
 
 Serializer ()
 Default constructor. More...
 
 Serializer (const DataType &dataType)
 Constructor (overloaded version taking a data type) More...
 
 Serializer (const Serializer &src)
 Copy constructor. More...
 
 ~Serializer ()
 Destructor. More...
 

Protected Types

typedef boost::shared_ptr< ImplImplPtr
 Declaration of the serializer implementation pointer type. More...
 
typedef boost::weak_ptr< ImplImplWPtr
 Declaration of the serializer implementation weak pointer type. More...
 

Protected Attributes

ImplPtr impl
 The serializer's implementation. More...
 

Detailed Description

Data type.

Definition at line 34 of file Serializer.h.

Member Typedef Documentation

Declaration of the serializer implementation pointer type.

Definition at line 120 of file Serializer.h.

typedef boost::weak_ptr<Impl> variant_topic_tools::Serializer::ImplWPtr
protected

Declaration of the serializer implementation weak pointer type.

Definition at line 124 of file Serializer.h.

Constructor & Destructor Documentation

variant_topic_tools::Serializer::Serializer ( )

Default constructor.

Definition at line 29 of file Serializer.cpp.

variant_topic_tools::Serializer::Serializer ( const DataType dataType)

Constructor (overloaded version taking a data type)

Note
If the data type specified data type cannot be found in the data type registry, the instantiated serializer will be invalid.

Definition at line 32 of file Serializer.cpp.

variant_topic_tools::Serializer::Serializer ( const Serializer src)

Copy constructor.

Definition at line 37 of file Serializer.cpp.

variant_topic_tools::Serializer::~Serializer ( )

Destructor.

Definition at line 41 of file Serializer.cpp.

Member Function Documentation

void variant_topic_tools::Serializer::advance ( ros::serialization::Stream stream,
const Variant value 
)

Advance a stream by the length of a serialized value.

Definition at line 89 of file Serializer.cpp.

void variant_topic_tools::Serializer::clear ( )

Clear the serializer.

Definition at line 69 of file Serializer.cpp.

void variant_topic_tools::Serializer::deserialize ( ros::serialization::IStream stream,
Variant value 
)

Deserialize a variant value from an input stream.

Definition at line 81 of file Serializer.cpp.

size_t variant_topic_tools::Serializer::getSerializedLength ( const Variant value) const

Retrieve the serialized length of a variant value.

Definition at line 54 of file Serializer.cpp.

bool variant_topic_tools::Serializer::isValid ( ) const

True, if this serializer is valid.

Definition at line 61 of file Serializer.cpp.

variant_topic_tools::Serializer::operator void * ( ) const
inline

Void pointer conversion.

Definition at line 81 of file Serializer.h.

void variant_topic_tools::Serializer::serialize ( ros::serialization::OStream stream,
const Variant value 
)

Serialize a variant value to an output stream.

Definition at line 73 of file Serializer.cpp.

Member Data Documentation

ImplPtr variant_topic_tools::Serializer::impl
protected

The serializer's implementation.

Definition at line 128 of file Serializer.h.


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


variant_topic_tools
Author(s): Ralf Kaestner
autogenerated on Sat Jan 9 2021 03:56:50