OpenDaVINCI  4.16.0
odcore::data::SerializableData Class Referenceabstract

#include <SerializableData.h>

Inheritance diagram for odcore::data::SerializableData:
Inheritance graph

Public Member Functions

 SerializableData ()
 
virtual ~SerializableData ()
 
virtual int32_t getID () const =0
 
virtual const string getShortName () const =0
 
virtual const string getLongName () const =0
 
virtual const string toString () const =0
 
virtual ostream & operator<< (ostream &out) const =0
 
virtual istream & operator>> (istream &in)=0
 

Detailed Description

This class is the superclass for all data.

Constructor & Destructor Documentation

odcore::data::SerializableData::SerializableData ( )
odcore::data::SerializableData::~SerializableData ( )
virtual

Member Function Documentation

virtual int32_t odcore::data::SerializableData::getID ( ) const
pure virtual

This method returns the message ID.

Returns
Message identifier.

Implemented in odcore::data::image::CompressedImage, odcore::base::KeyValueConfiguration, and odcore::reflection::Message.

virtual const string odcore::data::SerializableData::getLongName ( ) const
pure virtual

This method returns the message name including namespace.

Returns
Message name including namespace.

Implemented in odcore::data::image::CompressedImage, odcore::base::KeyValueConfiguration, and odcore::reflection::Message.

virtual const string odcore::data::SerializableData::getShortName ( ) const
pure virtual

This method returns the message name.

Returns
Message name.

Implemented in odcore::data::image::CompressedImage, odcore::base::KeyValueConfiguration, and odcore::reflection::Message.

virtual ostream& odcore::serialization::Serializable::operator<< ( ostream &  out) const
pure virtualinherited

This method needs to be used to serialize data.

Parameters
outostream to serialize data to.
Returns
The ostream.

Implemented in odcore::data::image::CompressedImage, odcore::data::Container, and odcore::base::KeyValueConfiguration.

virtual istream& odcore::serialization::Serializable::operator>> ( istream &  in)
pure virtualinherited

This method needs to be used to deserialize data.

Parameters
inistream to deserialize data from.
Returns
The istream.

Implemented in odcore::data::image::CompressedImage, odcore::data::Container, and odcore::base::KeyValueConfiguration.

virtual const string odcore::data::SerializableData::toString ( ) const
pure virtual

This method returns a human readable format of the contained data.

Returns
Human readable representation.

Implemented in odcore::data::image::CompressedImage, odcore::base::KeyValueConfiguration, and odcore::reflection::Message.