ADTF
All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Modules Pages
ISerializableabstract

The ISerializable interface provides a generic way to implement object serialization. More...

#include <serializable_intf.h>

Inheritance diagram for ISerializable:
[legend]

Public Types

using tSerializerVersion = uint8_t
 Defintion of Serializer Version Type.
 

Public Member Functions

 ADTF_IID (ISerializable, "serializable.ant.ucom.adtf.iid")
 Marks the ISerializable to be castable with the ucom_cast<>
 
virtual tResult Serialize (IStream &pOutputStream) const =0
 Serialize object to stream.
 
virtual tResult Deserialize (const IStream &pInputStream)=0
 Deserialize object from stream.
 
virtual tSerializerVersion GetCurrentSerializerVersion () const =0
 
- Public Member Functions inherited from IClassInfo
 ADTF_IID (IClassInfo, "class_info.ant.ucom.adtf.iid")
 Marks the IClassInfo to be castable with the ucom_cast<>
 
virtual const char * GetCID () const =0
 Get class identifier.
 
virtual const char * GetCLabel () const =0
 
virtual iterator_adapter< const tDependencyDescription, pointer_iteratorGetCDependencies () const =0
 
virtual iterator_adapter< const tNamedVersion, pointer_iteratorGetCVersions () const =0
 
- Public Member Functions inherited from IObject
 ADTF_IID (IObject, "object.ant.ucom.adtf.iid")
 Marks the IObject to be castable with the ucom_cast()
 

Protected Member Functions

 ~ISerializable ()=default
 Protected destructor --> Only the final implementation can be destroyed!
 
- Protected Member Functions inherited from IClassInfo
 ~IClassInfo ()=default
 Protected destructor --> Only the final implementation can be destroyed!
 
- Protected Member Functions inherited from IObject
 ~IObject ()=default
 Protected destructor --> Only the final implementation can be destroyed!
 

Detailed Description

The ISerializable interface provides a generic way to implement object serialization.

Definition at line 39 of file serializable_intf.h.

Member Typedef Documentation

◆ tSerializerVersion

using tSerializerVersion = uint8_t

Defintion of Serializer Version Type.

Definition at line 43 of file serializable_intf.h.

Member Function Documentation

◆ ADTF_IID()

ADTF_IID ( ISerializable ,
"serializable.ant.ucom.adtf.iid"  )

Marks the ISerializable to be castable with the ucom_cast<>

See also
ADTF_IID(_interface, _striid)

◆ Deserialize()

virtual tResult Deserialize ( const IStream & pInputStream)
pure virtual

Deserialize object from stream.

The Deserialize method reads all object instance data from a stream.

Parameters
pInputStream[in] Pointer to a input stream interface.
Returns
Returns a standard result code.

◆ Serialize()

virtual tResult Serialize ( IStream & pOutputStream) const
pure virtual

Serialize object to stream.

The Serialize method writes all object instance data to a stream.

Parameters
pOutputStream[in] Pointer to a output stream interface.
Returns
Returns a standard result code.