ISerializable Class Reference

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

#include <peak_common/serialization/peak_common_iserializable.hpp>

Inheritance diagram for ISerializable:

Public Member Functions
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 IArchive, and restore it later from the same archive.

Since

ids_peak_common 1.0

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 IArchive and reconstructs the internal state of the object.

Parameters

archive

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

Implemented in AdvancedAutoFeatures, AdvancedAutoBrightness, AdvancedAutoFocus, AdvancedAutoWhiteBalance, AutoPercentile, AutoTarget, AutoTolerance, BrightnessAlgorithm, BrightnessLimit, FocusLimit, Hysteresis, Roi, SearchAlgorithm, SharpnessAlgorithm, SkipFrames, WeightedRois, and BasicAutoFeatures.

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 IArchive so that it can later be reconstructed using Deserialize().

Parameters

archive

The archive to which the object's data will be written.

Implemented in AdvancedAutoFeatures, AdvancedAutoBrightness, AdvancedAutoFocus, AdvancedAutoWhiteBalance, AutoPercentile, AutoTarget, AutoTolerance, BrightnessAlgorithm, BrightnessLimit, FocusLimit, Hysteresis, Roi, SearchAlgorithm, SharpnessAlgorithm, SkipFrames, WeightedRois, and BasicAutoFeatures.

---

The documentation for this class was generated from the following file:

• peak_common/serialization/peak_common_iserializable.hpp