HDK
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Pages
SIM_CacheOptions Class Reference

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

#include <SIM_CacheOptions.h>

Public Member Functions

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

Detailed Description

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

Definition at line 16 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.

int SIM_CacheOptions::getCheckpointSpacing ( ) const
inline

Definition at line 66 of file SIM_CacheOptions.h.

UT_CompressionType SIM_CacheOptions::getCompressSims ( ) const
inline

Definition at line 48 of file SIM_CacheOptions.h.

const UT_String& SIM_CacheOptions::getExplicitFname ( ) const
inline

Definition at line 64 of file SIM_CacheOptions.h.

int SIM_CacheOptions::getExplicitHistory ( ) const
inline

Definition at line 65 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 60 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 ( UT_CompressionType  type)
inline

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

Definition at line 47 of file SIM_CacheOptions.h.

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

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 and checkpoint spacing This is also used when we are a player. When we are a player history is set to 0 and the cache files are never deleted.

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: