#include <FileComparison.hpp>

Inheritance diagram for FileComparison:

Collaboration diagram for FileComparison:

Public Member Functions
	FileComparison (std::string fileName1, std::string fileName2, bool calledCollectively=true, bool suppressOutput=false)
	FileComparison (const FileFinder &rFileName1, const FileFinder &rFileName2, bool calledCollectively=true, bool suppressOutput=false)
void	SetupCommentLines ()
void	SetIgnoreCommentLines (bool ignore=true)
void	SetIgnoreLinesBeginningWith (std::string lineStart)
bool	CompareFiles (unsigned ignoreFirstFewLines=0, bool doTsAssert=true)
Private Attributes
bool	mIgnoreCommentLines
std::vector< std::string >	mCommentLineStarts

Detailed Description

Compare files to check for any differences (in numeric and/or string values).

By Default this class ignores all lines which (in both files) start with '#'.

Definition at line 45 of file FileComparison.hpp.

Constructor & Destructor Documentation

FileComparison::FileComparison	(	std::string	fileName1,
		std::string	fileName2,
		bool	calledCollectively = `true`,
		bool	suppressOutput = `false`
	)		`[inline]`

Specify two files to compare, and open them for reading. Actual comparison is done by calling CompareFiles.

Parameters:

fileName1	first file
fileName2	second file
calledCollectively	If true there will be a barrier before opening files, and only master compares contents.
suppressOutput	If true then no errors will go to TS_TRACE(). Should only be set for the test of this class.

Definition at line 68 of file FileComparison.hpp.

References SetupCommentLines().

FileComparison::FileComparison	(	const FileFinder &	rFileName1,
		const FileFinder &	rFileName2,
		bool	calledCollectively = `true`,
		bool	suppressOutput = `false`
	)		`[inline]`

Specify two files to compare, and open them for reading. Actual comparison is done by calling CompareFiles.

Parameters:

rFileName1	first file finder
rFileName2	second file finder
calledCollectively	If true there will be a barrier before opening files, and only master compares contents.
suppressOutput	If true then no errors will go to TS_TRACE(). Should only be set for the test of this class.

Definition at line 84 of file FileComparison.hpp.

References SetupCommentLines().

Member Function Documentation

bool FileComparison::CompareFiles	(	unsigned	ignoreFirstFewLines = `0`,
		bool	doTsAssert = `true`
	)		`[inline]`

Compare the files under both relative and absolute tolerances. The comparison only fails if neither tolerance holds. The default settings effectively require numbers to match exactly.

Parameters: