Abstract class for serializable objects. More...

#include <Serializable.h>

Inheritance diagram for Util::Serializable:

Public Types
typedef BinaryFileOArchive	OArchive
	Type of output archive used by save method. More...

typedef BinaryFileIArchive	IArchive
	Type of input archive used by load method. More...

Public Member Functions
virtual	~Serializable ()
	Destructor. More...

virtual void	save (OArchive &ar)=0
	Save to an archive. More...

virtual void	load (IArchive &ar)=0
	Load from an archive. More...

Detailed Description

Abstract class for serializable objects.

This class defines an interface for serialization of objects. The save() method saves the internal state of an object to an archive, and the load() method loads the state from an archive.

The type of archive to be used is specified by the OArchive and IArchive typedefs. The two concrete classes that are referred to by these typedefs should be forward declared in this file, and the header files for these two classes must be included in the file Serializable_includes.h. The file Serializable_includes.h should be included in source files that implement that load and save methods for subclasses.

Definition at line 34 of file Serializable.h.

Member Typedef Documentation

◆ OArchive

typedef BinaryFileOArchive Util::Serializable::OArchive

Type of output archive used by save method.

Definition at line 42 of file Serializable.h.

◆ IArchive

typedef BinaryFileIArchive Util::Serializable::IArchive

Type of input archive used by load method.

Definition at line 47 of file Serializable.h.

Constructor & Destructor Documentation

◆ ~Serializable()

virtual Util::Serializable::~Serializable ( )

inlinevirtual

Destructor.

Definition at line 52 of file Serializable.h.

Member Function Documentation

◆ save()

virtual void Util::Serializable::save ( OArchive & ar )

pure virtual

Save to an archive.

Parameters

ar	binary saving (output) archive.

Implemented in Util::AutoCorr< Data, Product >, Util::AutoCorrArray< Data, Product >, Util::AutoCorrelation< Data, Product >, Util::Average, Util::Distribution, Util::IntDistribution, Util::MeanSqDispArray< Data >, Util::RadialDistribution, Util::SymmTensorAverage, Util::TensorAverage, Util::FileMaster, Util::ArrayParam< Type >, Util::Manager< Data >, Util::MatrixParam< Type >, Util::ParamComponent, Util::ParamComposite, Util::Parameter, and Util::Random.

◆ load()

virtual void Util::Serializable::load ( IArchive & ar )

pure virtual

Load from an archive.