PARTONS::ComparisonData Class Reference

Comparison report for single data point. More...

Public Member Functions
	ComparisonData (bool isPassed, const std::string &variableName, const std::string &variableValue, const std::string &variableValueReference, const NumA::Differences &differences, const std::string &objectInfo)
	Constructor. More...
virtual	~ComparisonData ()
	Destructor. More...
std::string	toString () const
	Return a pre-formatted characters string for output visualization of class member's values. More...
bool	isComparisonPassed () const
	Check if the comparison is passed. More...
void	setComparisonPassed (bool isComparisonPassed)
	Set if the comparison is passed. More...
const std::string &	getVariableName () const
	Get variable name. More...
void	setVariableName (const std::string &variableName)
	Set variable name. More...
const std::string &	getVariableValue () const
	Get variable value. More...
void	setVariableValue (const std::string &variableValue)
	Set variable value. More...
const std::string &	getVariableValueReference () const
	Get variable value reference. More...
void	setVariableValueReference (const std::string &variableValueReference)
	Set variable value reference. More...
const NumA::Differences &	getDifferences () const
	Get differences. More...
void	setDifferences (const NumA::Differences &differences)
	Set differences. More...
const std::string &	getObjectInfo () const
	Get object info. More...
void	setObjectInfo (const std::string &objectInfo)
	Set object info. More...

Private Attributes
bool	m_isComparisonPassed
	Boolean value indicating if the comparison is passed. More...
std::string	m_variableName
	Name of variable. More...
std::string	m_variableValue
	Value of variable. More...
std::string	m_variableValueReference
	Reference value of variable. More...
NumA::Differences	m_differences
	Difference. More...
std::string	m_objectInfo
	Information on object being compared. More...

Detailed Description

Comparison report for single data point.

This class stores a comparison result for a single data point.

Constructor & Destructor Documentation

ComparisonData()

PARTONS::ComparisonData::ComparisonData	(	bool	isPassed,
		const std::string &	variableName,
		const std::string &	variableValue,
		const std::string &	variableValueReference,
		const NumA::Differences &	differences,
		const std::string &	objectInfo
	)

Constructor.

Parameters

isPassed	Boolean value indicating if the comparison is passed.
variableName	Name of variable.
variableValue	Value of variable.
variableValueReference	Reference value of variable.
differences	Difference.
objectInfo	Information on object being compared.

~ComparisonData()

PARTONS::ComparisonData::~ComparisonData ( )

virtual

Destructor.

Member Function Documentation

getDifferences()

const NumA::Differences & PARTONS::ComparisonData::getDifferences

(

)

const

Get differences.

getObjectInfo()

const std::string & PARTONS::ComparisonData::getObjectInfo

(

)

const

Get object info.

getVariableName()

const std::string & PARTONS::ComparisonData::getVariableName

(

)

const

Get variable name.

getVariableValue()

const std::string & PARTONS::ComparisonData::getVariableValue

(

)

const

Get variable value.

getVariableValueReference()

const std::string & PARTONS::ComparisonData::getVariableValueReference

(

)

const

Get variable value reference.

isComparisonPassed()

bool PARTONS::ComparisonData::isComparisonPassed

(

)

const

Check if the comparison is passed.

setComparisonPassed()

void PARTONS::ComparisonData::setComparisonPassed

(

bool

isComparisonPassed

)

Set if the comparison is passed.

setDifferences()

void PARTONS::ComparisonData::setDifferences

(

const NumA::Differences &

differences

)

Set differences.

setObjectInfo()

void PARTONS::ComparisonData::setObjectInfo

(

const std::string &

objectInfo

)

Set object info.

setVariableName()

void PARTONS::ComparisonData::setVariableName

(

const std::string &

variableName

)

Set variable name.

setVariableValue()

void PARTONS::ComparisonData::setVariableValue

(

const std::string &

variableValue

)

Set variable value.

setVariableValueReference()

void PARTONS::ComparisonData::setVariableValueReference

(

const std::string &

variableValueReference

)

Set variable value reference.

toString()

std::string PARTONS::ComparisonData::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_differences

NumA::Differences PARTONS::ComparisonData::m_differences

private

Difference.

m_isComparisonPassed

bool PARTONS::ComparisonData::m_isComparisonPassed

private

Boolean value indicating if the comparison is passed.

m_objectInfo

std::string PARTONS::ComparisonData::m_objectInfo

private

Information on object being compared.

m_variableName

std::string PARTONS::ComparisonData::m_variableName

private

Name of variable.

m_variableValue

std::string PARTONS::ComparisonData::m_variableValue

private

Value of variable.

m_variableValueReference

std::string PARTONS::ComparisonData::m_variableValueReference

private

Reference value of variable.

---

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

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