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

Interface for serializing samples. More...

#include <sample_serialization_intf.h>

Inheritance diagram for ISampleSerialization:
[legend]

Public Member Functions

 ADTF_IID (ISampleSerialization, "sample_serialization.ant.streaming.adtf.iid")
 definition of interface id
 
virtual tResult SetStreamType (const ucom::ant::iobject_ptr< const IStreamType > &pType)=0
 Set the stream type information.
 
virtual tResult Serialize (const ISample &pSample, ucom::ant::IOutputStream &oStream)=0
 Serializes a given sample into the given stream.
 
virtual tResult Deserialize (const ucom::ant::IInputStream &oStream, ISample &pSample)=0
 Deserializes a sample from a stream.
 
- Public Member Functions inherited from IObject
 ADTF_IID (IObject, "object.ant.ucom.adtf.iid")
 Marks the IObject to be castable with the ucom_cast()
 

Additional Inherited Members

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

Detailed Description

Interface for serializing samples.

Definition at line 21 of file sample_serialization_intf.h.

Member Function Documentation

◆ Deserialize()

virtual tResult Deserialize ( const ucom::ant::IInputStream & oStream,
ISample & pSample )
pure virtual

Deserializes a sample from a stream.

Parameters
[in]oStreamThe input stream.
[out]pSampleThe sample to deserialize the data to.
Returns
Standard result.

◆ Serialize()

virtual tResult Serialize ( const ISample & pSample,
ucom::ant::IOutputStream & oStream )
pure virtual

Serializes a given sample into the given stream.

Parameters
[in]pSampleThe sample to serialize.
[out]oStreamThe output stream.
Returns
Standard result.

◆ SetStreamType()

virtual tResult SetStreamType ( const ucom::ant::iobject_ptr< const IStreamType > & pType)
pure virtual

Set the stream type information.

Parameters
[in]pTypeThe type.
Returns
Standard result.