PARTONS::ComparisonReport Class Reference

Comparison report. More...

Public Member Functions
	ComparisonReport (const NumA::Tolerances &tolerances)
	Constructor. More...
	ComparisonReport (const std::string &environmentSetting, const std::string &objectClassNameTested, const std::string &referenceObjectClassName)
	Constructor. More...
	ComparisonReport (const ComparisonReport &other)
	Copy constructor. More...
virtual	~ComparisonReport ()
	Destructor. More...
void	addComparisonData (const ComparisonData &comparisonData)
	Add comparison data for a single comparison point. More...
std::string	toString () const
	Return a pre-formatted characters string for output visualization of class member's values. More...
std::string	showComparedDataFailed () const
	Return a pre-formatted characters string for data that have failed the comparison. More...
std::string	showComparisonStats () const
	Return a pre-formatted characters string containing general information on the comparison. More...
void	clearComparedData ()
	Clear vectors containing comparison data (ComparisonData objects) for single points. More...
bool	isPassed () const
	Check if the comparison is passed. More...
const NumA::Tolerances &	getTolerances () const
	Get tolerance assumed in this test. More...
void	setTolerances (const NumA::Tolerances &tolerances)
	Set tolerance assumed in this test. More...
size_t	sizeOfComparedDataFailed () const
	Number of data points that have failed the comparison. More...

Private Attributes
std::string	m_environmentSetting
	String of characters indicating the environment settings. More...
std::string	m_objectClassNameTested
	Name of class to be examined. More...
std::string	m_referenceObjectClassName
	Name of reference class. More...
std::vector< ComparisonData >	m_comparedDataPassed
	Vector containing comparison data for single points that have passed the comparison. More...
std::vector< ComparisonData >	m_comparedDataFailed
	Vector containing comparison data for single points that have failed the comparison. More...
NumA::Tolerances	m_tolerances
	Tolerance assumed in this test. More...
unsigned int	m_numberOfComparedDataPassed
	Number of points that have passed the comparison. More...
unsigned int	m_numberOfComparedDataFailed
	Number of points that have failed the comparison. More...

Detailed Description

Comparison report.

This class stores a comparison result for a set of data.

Constructor & Destructor Documentation

ComparisonReport() [1/3]

PARTONS::ComparisonReport::ComparisonReport

(

const NumA::Tolerances &

tolerances

)

Constructor.

Parameters

tolerances

Tolerance.

ComparisonReport() [2/3]

PARTONS::ComparisonReport::ComparisonReport	(	const std::string &	environmentSetting,
		const std::string &	objectClassNameTested,
		const std::string &	referenceObjectClassName
	)

Constructor.

Parameters

environmentSetting	String of characters indicating the environment settings.
objectClassNameTested	Name of class to be examined.
referenceObjectClassName	Name of reference class.

ComparisonReport() [3/3]

PARTONS::ComparisonReport::ComparisonReport

(

const ComparisonReport &

other

)

Copy constructor.

Parameters

other

Object to be copied.

~ComparisonReport()

PARTONS::ComparisonReport::~ComparisonReport ( )

virtual

Destructor.

Member Function Documentation

addComparisonData()

void PARTONS::ComparisonReport::addComparisonData

(

const ComparisonData &

comparisonData

)

Add comparison data for a single comparison point.

Parameters

comparisonData

ComparisonData object containing comparison information for a single point.

clearComparedData()

void PARTONS::ComparisonReport::clearComparedData

(

)

Clear vectors containing comparison data (ComparisonData objects) for single points.

getTolerances()

const NumA::Tolerances & PARTONS::ComparisonReport::getTolerances

(

)

const

Get tolerance assumed in this test.

isPassed()

bool PARTONS::ComparisonReport::isPassed

(

)

const

Check if the comparison is passed.

setTolerances()

void PARTONS::ComparisonReport::setTolerances

(

const NumA::Tolerances &

tolerances

)

Set tolerance assumed in this test.

showComparedDataFailed()

std::string PARTONS::ComparisonReport::showComparedDataFailed

(

)

const

Return a pre-formatted characters string for data that have failed the comparison.

Returns

Pre-formatted characters string.

showComparisonStats()

std::string PARTONS::ComparisonReport::showComparisonStats

(

)

const

Return a pre-formatted characters string containing general information on the comparison.

Returns

Pre-formatted characters string.

sizeOfComparedDataFailed()

size_t PARTONS::ComparisonReport::sizeOfComparedDataFailed

(

)

const

Number of data points that have failed the comparison.

toString()

std::string PARTONS::ComparisonReport::toString

(

)

const

Return a pre-formatted characters string for output visualization of class member's values.

Returns

Pre-formatted characters string.

Member Data Documentation

m_comparedDataFailed

std::vector<ComparisonData> PARTONS::ComparisonReport::m_comparedDataFailed

private

Vector containing comparison data for single points that have failed the comparison.

m_comparedDataPassed

std::vector<ComparisonData> PARTONS::ComparisonReport::m_comparedDataPassed

private

Vector containing comparison data for single points that have passed the comparison.

m_environmentSetting

std::string PARTONS::ComparisonReport::m_environmentSetting

private

String of characters indicating the environment settings.

m_numberOfComparedDataFailed

unsigned int PARTONS::ComparisonReport::m_numberOfComparedDataFailed

private

Number of points that have failed the comparison.

m_numberOfComparedDataPassed

unsigned int PARTONS::ComparisonReport::m_numberOfComparedDataPassed

private

Number of points that have passed the comparison.

m_objectClassNameTested

std::string PARTONS::ComparisonReport::m_objectClassNameTested

private

Name of class to be examined.

m_referenceObjectClassName

std::string PARTONS::ComparisonReport::m_referenceObjectClassName

private

Name of reference class.

m_tolerances

NumA::Tolerances PARTONS::ComparisonReport::m_tolerances

private

Tolerance assumed in this test.

---

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

• include/partons/utils/compare/ComparisonReport.h
• src/partons/utils/compare/ComparisonReport.cpp