mpqc.Core.State

Classes/functions used for serialization/deserialization. More...

Classes
class	sc::SavableStateProxy
	Create a proxy for a SavableState object. More...
class	sc::SavableState
	Base class for objects that can save/restore state. More...
struct	sc::DummySavableState
	useful as a dummy template argument More...
class	sc::StateOutBin
	Save state to a binary file. More...
class	sc::StateInBin
	Read objects written with StateOutBin. More...
class	sc::StateOutFile
	Writes state information to files. More...
class	sc::StateInFile
	Reads state information from a file. More...
class	sc::StateOutText
	Writes out state information in an almost human readable format. More...
class	sc::StateInText
	Reads state information written with StateOutText. More...
class	sc::StateIn
	Restores fundamental and user-defined types from images created with StateOut. More...
class	sc::StateOut
	Serializes fundamental and user-defined types. More...

Functions
template<typename T >
void	sc::FromStateIn (T &t, StateIn &si, int &count)
	Helps to read user-defined types from StateIn.
template<typename T >
void	sc::FromStateIn (Ref< T > &t, StateIn &so, int &count)
	specialization for Ref<SavableState>
template<typename T >
void	sc::ToStateOut (const T &t, StateOut &so, int &count)
	Helps to write user-defined types to StateOut.
template<typename T >
void	sc::ToStateOut (const Ref< T > &t, StateOut &so, int &count)
	specialization for Ref<SavableState>

Detailed Description

Classes/functions used for serialization/deserialization.

helper class to save to StateOut

helper template to read from StateIn

Function Documentation

FromStateIn()

template<typename T >

void sc::FromStateIn	(	T &	t,
		StateIn &	si,
		int &	count )

Helps to read user-defined types from StateIn.

Overload/specialize this function for each user-defined type not derived from SavableState (if your class is derived from SavableState simply implement its "StateIn" constructor member).

Template Parameters

T	type of an object

Parameters

t	an object to deserialize from StateIn
si	the StateIn object
count	number of bytes read

References sc::StateIn::get().

ToStateOut()

template<typename T >

void sc::ToStateOut	(	const T &	t,
		StateOut &	so,
		int &	count )

Helps to write user-defined types to StateOut.

Overload/specialize this function for each user-defined type not derived from SavableState (if your class is derived from SavableState simply implement its save_data_state() member).

Template Parameters

T	type of an object

Parameters

t	an object to serialize to StateIn
so	the StateOut object
count	number of bytes written

References sc::StateOut::put().