SIM_CacheOptions Class Reference

This class stores all the caching options used by the SIM_Cache. More...

#include <SIM_CacheOptions.h>

List of all members.

Public Member Functions
	SIM_CacheOptions ()
	Constructor sets up default caching options.
	~SIM_CacheOptions ()
	Destructor for cache options.
const UT_String &	getInitialState () const
	Returns the name of the initial state file.
void	setInitialState (const char *filename)
	Sets the initial state file name.
bool	getIsCacheEnabled () const
	Returns whether or not caching is enabled.
void	setIsCacheEnabled (bool enabled)
	Sets the enable state of the cache.
bool	getAllowSaveToDisk () const
	Returns whether or not cache entries can be sent to disk.
void	setAllowSaveToDisk (bool allow)
	Sets whether or not cache entries can be saved to disk.
bool	getAllowSaveSubsteps () const
	Returns whether or not cache should save substep data.
void	setAllowSaveSubsteps (bool allow)
	Sets whether or not cache should save substep data.
int64	getMaxCacheMemSize () const
	Returns the maximum memory footprint for all cached data.
void	setMaxCacheMemSize (int64 maxsize)
	Sets the maximum allowed memory footprint of the cache (in bytes).
void	setCompressSims (bool docompress)
bool	getCompressSims () const
void	setExplicitCache (bool useexplicit, const char *explicitfname, int history)
bool	getUseExplicit () const
const UT_String &	getExplicitFname () const
int	getExplicitHistory () const
const SIM_CacheOptions &	operator= (const SIM_CacheOptions &src)
	Assignment operator copies options from one instance to another.

---

Detailed Description

This class stores all the caching options used by the SIM_Cache.

Definition at line 21 of file SIM_CacheOptions.h.

---

Constructor & Destructor Documentation

SIM_CacheOptions::SIM_CacheOptions

(

)

Constructor sets up default caching options.

SIM_CacheOptions::~SIM_CacheOptions

(

)

Destructor for cache options.

---

Member Function Documentation

bool SIM_CacheOptions::getAllowSaveSubsteps

(

)

const

Returns whether or not cache should save substep data.

bool SIM_CacheOptions::getAllowSaveToDisk

(

)

const

Returns whether or not cache entries can be sent to disk.

bool SIM_CacheOptions::getCompressSims

(

)

const [inline]

Definition at line 53 of file SIM_CacheOptions.h.

const UT_String& SIM_CacheOptions::getExplicitFname

(

)

const [inline]

Definition at line 63 of file SIM_CacheOptions.h.

int SIM_CacheOptions::getExplicitHistory

(

)

const [inline]

Definition at line 64 of file SIM_CacheOptions.h.

const UT_String& SIM_CacheOptions::getInitialState

(

)

const

Returns the name of the initial state file.

bool SIM_CacheOptions::getIsCacheEnabled

(

)

const

Returns whether or not caching is enabled.

int64 SIM_CacheOptions::getMaxCacheMemSize

(

)

const

Returns the maximum memory footprint for all cached data.

bool SIM_CacheOptions::getUseExplicit

(

)

const [inline]

Definition at line 59 of file SIM_CacheOptions.h.

const SIM_CacheOptions& SIM_CacheOptions::operator=

(

const SIM_CacheOptions &

src

)

Assignment operator copies options from one instance to another.

void SIM_CacheOptions::setAllowSaveSubsteps

(

bool

allow

)

Sets whether or not cache should save substep data.

void SIM_CacheOptions::setAllowSaveToDisk

(

bool

allow

)

Sets whether or not cache entries can be saved to disk.

void SIM_CacheOptions::setCompressSims

(

bool

docompress

)

[inline]

Determines if we compress our .sim files. Compression can be very slow.

Definition at line 52 of file SIM_CacheOptions.h.

void SIM_CacheOptions::setExplicitCache	(	bool	useexplicit,
		const char *	explicitfname,
		int	history
	)

Determines if we are overriding the cache files with an explicit list of cache files. These will always be saved when added and only deleted according to history.

void SIM_CacheOptions::setInitialState

(

const char *

filename

)

Sets the initial state file name.

void SIM_CacheOptions::setIsCacheEnabled

(

bool

enabled

)

Sets the enable state of the cache.

void SIM_CacheOptions::setMaxCacheMemSize

(

int64

maxsize

)

Sets the maximum allowed memory footprint of the cache (in bytes).

---

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

• SIM/SIM_CacheOptions.h