#include <peak_common/serialization/peak_common_iserializable.hpp>

Inheritance diagram for ISerializable:

[legend]

Public Member Functions
virtual	~ISerializable ()=default

virtual void	Serialize (IArchive &archive) const =0
	Serializes the current object into the provided archive.

virtual void	Deserialize (const IArchive &archive)=0
	Deserializes the object's state from the provided archive.

Detailed Description

Interface for objects that can be serialized to and deserialized from an archive.

Classes implementing this interface provide mechanisms to convert their internal state into a portable form using an peak::common::serialization::IArchive, and restore it later from the same archive.

Since: ids_peak_common 1.0

Constructor & Destructor Documentation

◆ ~ISerializable()

virtual ~ISerializable ( )

virtualdefault

Member Function Documentation

◆ Deserialize()

virtual void Deserialize ( const IArchive & archive )

pure virtual

Deserializes the object's state from the provided archive.

This method reads data from the given peak::common::serialization::IArchive and reconstructs the internal state of the object.

Parameters

archive The archive from which to read the object's data.

Implemented in ColorCorrectionMatrix, ColorMatrixTransformationModule, DebayerModule, DownsamplingModule, GainModule, HotpixelCorrectionModule, MonoConversionModule, PixelFormatConversionModule, SharpeningModule, ToneCurveCorrectionModule, TransformationModule, and UnpackModule.

◆ Serialize()

virtual void Serialize ( IArchive & archive ) const

pure virtual

Serializes the current object into the provided archive.

This method writes the internal state of the object into the given peak::common::serialization::IArchive so that it can later be reconstructed using Deserialize().