REC RPC library
Public Member Functions | Static Public Attributes | Protected Member Functions | Friends | List of all members
rec::rpc::serialization::Serializable Class Reference

Base class for all serializable data. More...

#include <rec_rpc_serialization_Serializable.h>

Inheritance diagram for rec::rpc::serialization::Serializable:
Inheritance graph
[legend]
Collaboration diagram for rec::rpc::serialization::Serializable:
Collaboration graph
[legend]

Public Member Functions

 Serializable ()
 
virtual ~Serializable ()
 

Static Public Attributes

static SerializablePtr empty
 

Protected Member Functions

virtual void serialize (QDataStream &stream) const
 
virtual void deserialize (QDataStream &stream)
 

Friends

QDataStream & operator<< (QDataStream &, const Serializable &)
 Serialize the data and write it into a data stream. More...
 
QDataStream & operator>> (QDataStream &, Serializable &)
 Read data from a data stream and deserialize it. More...
 

Detailed Description

Base class for all serializable data.

This class is the base class for all serializable data container types. All function parameter, return value and topic data types must inherit this class.

Definition at line 54 of file rec_rpc_serialization_Serializable.h.

Constructor & Destructor Documentation

rec::rpc::serialization::Serializable::Serializable ( )
inline

Creates an empty container.

Definition at line 88 of file rec_rpc_serialization_Serializable.h.

rec::rpc::serialization::Serializable::~Serializable ( )
inlinevirtual

Destroys the container.

Definition at line 92 of file rec_rpc_serialization_Serializable.h.

Member Function Documentation

void rec::rpc::serialization::Serializable::deserialize ( QDataStream &  stream)
inlineprotectedvirtual

In a subclass, this function must be reimplemented to read data from the stream.

Parameters
streamData stream that contains and deserializes the data.
See also
serialize()

Definition at line 100 of file rec_rpc_serialization_Serializable.h.

Referenced by rec::rpc::serialization::operator>>().

void rec::rpc::serialization::Serializable::serialize ( QDataStream &  stream) const
inlineprotectedvirtual

In a subclass, this function must be reimplemented to write the data into the stream.

Parameters
streamData stream that serializes the data.
See also
deserialize()

Definition at line 96 of file rec_rpc_serialization_Serializable.h.

Referenced by rec::rpc::serialization::operator<<().

Friends And Related Function Documentation

QDataStream& operator<< ( QDataStream &  out,
const Serializable data 
)
friend

Serialize the data and write it into a data stream.

Parameters
outData stream.
dataData to be serialized. The serialize() method will be used.
See also
operator>>(), Serializable::serialize(), Serializable::deserialize()

Definition at line 112 of file rec_rpc_serialization_Serializable.h.

QDataStream& operator>> ( QDataStream &  in,
Serializable data 
)
friend

Read data from a data stream and deserialize it.

Parameters
inData stream.
dataObject that stores the deserialized data. The deserialize() method will be used.
See also
operator<<(), Serializable::serialize(), Serializable::deserialize()

Definition at line 126 of file rec_rpc_serialization_Serializable.h.

Member Data Documentation

SerializablePtr rec::rpc::serialization::Serializable::empty
static

Empty serializable.

Definition at line 61 of file rec_rpc_serialization_Serializable.h.


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