DtSmsChecksum Class Reference

Public Member Functions
	DtSmsChecksum ()
	Constructor.
virtual	~DtSmsChecksum ()
	Destructor.
virtual bool	loadSms (const DtFilename &sms)
	Loads an SMS and calculates its checksums. If an SMS was already loaded, unloads it first.
virtual bool	loadSmsChecksum (const DtFilename &checksumFile)
	Load a previously written SMS checksum file.
virtual bool	setSms (const DtSimulationModelSet &sms)
	Sets the SMS to perform checksums on.
virtual void	clearChecksums ()
	Clears the calculated checksums.
virtual bool	saveToFile (const DtFilename &checksumFile)
	Saves checksums to a file.
virtual const DtChecksumMap &	checksums () const
	Returns a map of filenames to checksums.
virtual bool	compare (const DtSmsChecksum &other, std::set< DtFilename > &changed, std::set< DtFilename > &added, std::set< DtFilename > &removed) const
	Compares this checksum to another.
virtual void	addExtensionToIgnore (const DtString &ext)
	Adds a file extension to be ignored when calculating checksums.
virtual void	removeExtensionToIgnore (const DtString &ext)
	Removes a file extension to be ignored when calculating checksums.
virtual void	addFileToIgnore (const DtFilename &fn)
	Adds a file to be ignored when calculating checksums.
virtual void	removeFileToIgnore (const DtFilename &fn)
	Removes a file to be ignored when calculating checksums.
virtual void	addDirectoryToIgnore (const DtFilename &dir)
	Adds a directory to be ignored when calculating checksums.
virtual void	removeDirectoryToIgnore (const DtFilename &dir)
	Removes a directory to be ignored when calculating checksums.

Protected Member Functions
virtual bool	calculateChecksums ()
	Performs checksums on all files in the loaded SMS.
virtual bool	calculateDirectoryChecksums (const std::string &smsDirectory)
	Performs checksums on all files in the directory.
virtual bool	ignoreDirectory (const DtFilename &dir) const
	Determines if directory should be ignored.
virtual bool	ignoreFile (const DtFilename &fn) const
	Determines if files should be ignored.
void	addDefaultFilesToIgnore ()
	Adds default files, extensions, and directories to ignore when calculating checksums.

Static Protected Member Functions
static const DtString &	separator ()
	Returns the directory separator to be used on this platform.

Protected Attributes
DtSimulationModelSet	mySMS
DtChecksumMap	myChecksums
std::set< DtString >	myIgnoredFileExtensions
std::set< DtString >	myIgnoredFiles
std::set< DtString >	myIgnoredDirectories

Constructor & Destructor Documentation

DtSmsChecksum::DtSmsChecksum

(

)

Constructor.

virtual DtSmsChecksum::~DtSmsChecksum ( )

virtual

Destructor.

Member Function Documentation

virtual bool DtSmsChecksum::loadSms ( const DtFilename &  sms )

virtual

Loads an SMS and calculates its checksums. If an SMS was already loaded, unloads it first.

virtual bool DtSmsChecksum::loadSmsChecksum ( const DtFilename &  checksumFile )

virtual

Load a previously written SMS checksum file.

virtual bool DtSmsChecksum::setSms ( const DtSimulationModelSet &  sms )

virtual

Sets the SMS to perform checksums on.

virtual void DtSmsChecksum::clearChecksums ( )

virtual

Clears the calculated checksums.

virtual bool DtSmsChecksum::saveToFile ( const DtFilename &  checksumFile )

virtual

Saves checksums to a file.

virtual const DtChecksumMap& DtSmsChecksum::checksums ( ) const

virtual

Returns a map of filenames to checksums.

virtual bool DtSmsChecksum::compare ( const DtSmsChecksum &  other, std::set< DtFilename > &  changed, std::set< DtFilename > &  added, std::set< DtFilename > &  removed  ) const

virtual

Compares this checksum to another.

Returns lists of files that have changed from the other, have been added since the other, and have been removed since the other. Returns false if the comparison could not be performed for some reason.

virtual void DtSmsChecksum::addExtensionToIgnore ( const DtString &  ext )

virtual

Adds a file extension to be ignored when calculating checksums.

virtual void DtSmsChecksum::removeExtensionToIgnore ( const DtString &  ext )

virtual

Removes a file extension to be ignored when calculating checksums.

virtual void DtSmsChecksum::addFileToIgnore ( const DtFilename &  fn )

virtual

Adds a file to be ignored when calculating checksums.

virtual void DtSmsChecksum::removeFileToIgnore ( const DtFilename &  fn )

virtual

Removes a file to be ignored when calculating checksums.

virtual void DtSmsChecksum::addDirectoryToIgnore ( const DtFilename &  dir )

virtual

Adds a directory to be ignored when calculating checksums.

virtual void DtSmsChecksum::removeDirectoryToIgnore ( const DtFilename &  dir )

virtual

Removes a directory to be ignored when calculating checksums.

virtual bool DtSmsChecksum::calculateChecksums ( )

protectedvirtual

Performs checksums on all files in the loaded SMS.

virtual bool DtSmsChecksum::calculateDirectoryChecksums ( const std::string &  smsDirectory )

protectedvirtual

Performs checksums on all files in the directory.

virtual bool DtSmsChecksum::ignoreDirectory ( const DtFilename &  dir ) const

protectedvirtual

Determines if directory should be ignored.

virtual bool DtSmsChecksum::ignoreFile ( const DtFilename &  fn ) const

protectedvirtual

Determines if files should be ignored.

void DtSmsChecksum::addDefaultFilesToIgnore ( )

protected

Adds default files, extensions, and directories to ignore when calculating checksums.

Called by constructor.

static const DtString& DtSmsChecksum::separator ( )

staticprotected

Returns the directory separator to be used on this platform.

Member Data Documentation

DtSimulationModelSet DtSmsChecksum::mySMS

protected

DtChecksumMap DtSmsChecksum::myChecksums

protected

std::set<DtString> DtSmsChecksum::myIgnoredFileExtensions

protected

std::set<DtString> DtSmsChecksum::myIgnoredFiles

protected

std::set<DtString> DtSmsChecksum::myIgnoredDirectories

protected

---

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

• /exports/nfedora7-1/nightly/docs/vrforcesDevelopment.tot/include/smsChecksum/smsChecksum.h