StateMetaInfo Class Reference

Abstract class for gathering and serializing metadata for the current session. More...

#include <StateMetaInfo.h>

Inheritance diagram for StateMetaInfo:

[legend]

Collaboration diagram for StateMetaInfo:

[legend]

List of all members.

Public Member Functions
	StateMetaInfo ()
	Constructor.
virtual	~StateMetaInfo ()
	Empty destructor.
virtual void	capture ()=0
	This captures the current meta information and stores it ready for archiving.
virtual void	restore ()=0
	Restore the metadata from the archive.
string	getHostName ()
	Returns the captuured hostname.
string	getUserName ()
	Returns the captured username of archiver.
string	getComment ()
	Returns the supplied comment.
void	setComment (const string &comment)
	Set a comment.
void	clearComment ()
	Clear the comment.
struct tm *	getCreationTime ()
	Returns the captured time of save information.
Protected Member Functions
template<class Archive>
void	post_serialize (Archive &ar, const unsigned int file_version)
	Called AFTER serializing a class.
Protected Attributes
struct tm	meta_tm
	This struct records the archive creation time.
string	meta_username
	Username of the person writing the state.
string	meta_hostname
	Hostname where the archive was created.
string	meta_comment
	Comment string.
Friends
class	boost::serialization::access

---

Detailed Description

Abstract class for gathering and serializing metadata for the current session.

---

Member Function Documentation

virtual void StateMetaInfo::capture

(

)

[pure virtual]

This captures the current meta information and stores it ready for archiving.

Implemented in StateMetaInfo_CLI, and StateMetaInfo_Test.

---

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

• /home/weinberg/src/BIE/persistence/StateMetaInfo.h