DtPeriodicSnapshotSettings Class Reference

Periodic snapshot settings are used to keep track of whether or not periodic snapshots are enabled and the simulation time to schedule the snapshots for. More...

Inheritance diagram for DtPeriodicSnapshotSettings:

Public Member Functions
	DtPeriodicSnapshotSettings ()
	Default constructor, required for deserialization.
	DtPeriodicSnapshotSettings (std::string name)
	Constructor.
	DtPeriodicSnapshotSettings (std::string name, bool enabled, double periodicSnapshotTime, int numberOfSnapshotsToKeep)
	Constructor.
	DtPeriodicSnapshotSettings (const DtPeriodicSnapshotSettings &orig)
	Copy constructor.
virtual bool	operator== (const DtSettingsObject &other) const
	Equality operator.
virtual bool	operator!= (const DtSettingsObject &other) const
	Inequality operator.
virtual DtSettingsObject *	clone () const
	Clone operator, returns a new settings which is a copy of this one.
virtual bool	setFrom (const DtSettingsObject *other)
bool	enabled () const
	Whether or not the periodic Snapshot system is enabled.
void	setEnabled (bool b)
	Whether or not the periodic Snapshot system is enabled.
double	periodicSnapshotTime () const
	Simulation time period between Snapshots. Default is 1 second.
void	setPeriodicSnapshotTime (double threshold)
	Simulation time period between Snapshots. Default is 1 second.
void	setNumberOfSnapshotsToKeep (int)
	Number of periodic Snapshots to keep around. 0 means keep all.
int	numberOfSnapshotsToKeep () const
	Number of periodic Snapshots to keep around. 0 means keep all.
Public Member Functions inherited from DtSettingsObject
	DtSettingsObject ()
	DtSettingsObject (std::string name)
	DtSettingsObject (const DtSettingsObject &orig)
virtual void	operator= (const DtSettingsObject &orig)
virtual std::string	name () const

Static Public Member Functions
static DtSettingsObject *	create (DtSettingsObjectCreationParams &params)
	Creator.

Protected Attributes
bool	myEnabled
double	myPeriodicSnapshotTime
int	myNumberOfSnapshotsToKeep
Protected Attributes inherited from DtSettingsObject
std::string	myName

Private Member Functions
template<class Archive >
void	serialize (Archive &ar, const unsigned int version)
	Serialization support.

Friends
class	boost::serialization::access

Detailed Description

Periodic snapshot settings are used to keep track of whether or not periodic snapshots are enabled and the simulation time to schedule the snapshots for.

Constructor & Destructor Documentation

DtPeriodicSnapshotSettings::DtPeriodicSnapshotSettings

(

)

Default constructor, required for deserialization.

DtPeriodicSnapshotSettings::DtPeriodicSnapshotSettings

(

std::string

name

)

Constructor.

DtPeriodicSnapshotSettings::DtPeriodicSnapshotSettings	(	std::string	name,
		bool	enabled,
		double	periodicSnapshotTime,
		int	numberOfSnapshotsToKeep
	)

Constructor.

DtPeriodicSnapshotSettings::DtPeriodicSnapshotSettings

(

const DtPeriodicSnapshotSettings &

orig

)

Copy constructor.

Member Function Documentation

virtual bool DtPeriodicSnapshotSettings::operator== ( const DtSettingsObject &  other ) const

virtual

Equality operator.

Reimplemented from DtSettingsObject.

virtual bool DtPeriodicSnapshotSettings::operator!= ( const DtSettingsObject &  other ) const

virtual

Inequality operator.

Reimplemented from DtSettingsObject.

virtual DtSettingsObject* DtPeriodicSnapshotSettings::clone ( ) const

virtual

Clone operator, returns a new settings which is a copy of this one.

Implements DtSettingsObject.

virtual bool DtPeriodicSnapshotSettings::setFrom ( const DtSettingsObject *  other )

virtual

Reimplemented from DtSettingsObject.

static DtSettingsObject* DtPeriodicSnapshotSettings::create ( DtSettingsObjectCreationParams &  params )

static

Creator.

bool DtPeriodicSnapshotSettings::enabled

(

)

const

Whether or not the periodic Snapshot system is enabled.

void DtPeriodicSnapshotSettings::setEnabled

(

bool

b

)

Whether or not the periodic Snapshot system is enabled.

double DtPeriodicSnapshotSettings::periodicSnapshotTime

(

)

const

Simulation time period between Snapshots. Default is 1 second.

void DtPeriodicSnapshotSettings::setPeriodicSnapshotTime

(

double

threshold

)

Simulation time period between Snapshots. Default is 1 second.

void DtPeriodicSnapshotSettings::setNumberOfSnapshotsToKeep

(

int

)

Number of periodic Snapshots to keep around. 0 means keep all.

int DtPeriodicSnapshotSettings::numberOfSnapshotsToKeep

(

)

const

Number of periodic Snapshots to keep around. 0 means keep all.

template<class Archive >

void DtPeriodicSnapshotSettings::serialize ( Archive &  ar, const unsigned int  version  )

inlineprivate

Serialization support.

Friends And Related Function Documentation

friend class boost::serialization::access

friend

Member Data Documentation

bool DtPeriodicSnapshotSettings::myEnabled

protected

double DtPeriodicSnapshotSettings::myPeriodicSnapshotTime

protected

int DtPeriodicSnapshotSettings::myNumberOfSnapshotsToKeep

protected

---

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

• /exports/nfedora7-1/nightly/docs/vrforcesDevelopment.vrf4-4-branch/include/vrfutil/periodicSnapshotSettings.h