ADTF
Loading...
Searching...
No Matches
Public Types | Public Member Functions | Protected Member Functions | List of all members
adtf::ucom::ant::ISerializable Class Referenceabstract

#include <serializable_intf.h>

Inherits adtf::ucom::ant::IClassInfo.

Public Types

using tSerializerVersion = uint8_t
 Defintion of Serializer Version Type.
 

Public Member Functions

 ADTF_IID (ISerializable, "serializable.ant.ucom.adtf.iid")
 
virtual tResult Serialize (IStream &pOutputStream) const =0
 
virtual tResult Deserialize (const IStream &pInputStream)=0
 
virtual tSerializerVersion GetCurrentSerializerVersion () const =0
 
- Public Member Functions inherited from adtf::ucom::ant::IClassInfo
 ADTF_IID (IClassInfo, "class_info.ant.ucom.adtf.iid")
 
virtual const char * GetCID () const =0
 
virtual const char * GetCLabel () const =0
 
virtual iterator_adapter< const tDependencyDescription, pointer_iterator > GetCDependencies () const =0
 
virtual iterator_adapter< const tNamedVersion, pointer_iterator > GetCVersions () const =0
 
- Public Member Functions inherited from adtf::ucom::ant::IObject
 ADTF_IID (IObject, "object.ant.ucom.adtf.iid")
 

Protected Member Functions

 ~ISerializable ()=default
 Protected destructor --> Only the final implementation can be destroyed!
 
- Protected Member Functions inherited from adtf::ucom::ant::IClassInfo
 ~IClassInfo ()=default
 Protected destructor --> Only the final implementation can be destroyed!
 
- Protected Member Functions inherited from adtf::ucom::ant::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.

Member Function Documentation

◆ ADTF_IID()

adtf::ucom::ant::ISerializable::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 adtf::ucom::ant::ISerializable::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 adtf::ucom::ant::ISerializable::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.
The documentation for this class was generated from the following file: