CIssue Class Reference

#include <CValidity.h>

Public Types
enum class	eKind {   Unknown , ExpressionInvalid , ExpressionEmpty , MissingInitialValue ,   CalculationIssue , EventMissingAssignment , EventAlreadyHasAssignment , EventMissingTriggerExpression ,   UnitUndefined , UnitConflict , UnitInvalid , NaNissue ,   ObjectNotFound , ValueNotFound , VariableNotfound , StructureInvalid ,   TooManyArguments , HasCircularDependency , ExpressionDataTypeInvalid , VariableInExpression ,   CExpressionNotFound , CFunctionNotFound , VariablesMismatch , ValueTypeMismatch ,   InitialExpressionWithAssignment , SettingFixedExpression , KineticsUndefined , __SIZE }
enum class	eSeverity {   Success , Information , Warning , Error ,   __SIZE }

Public Member Functions
	CIssue (const CIssue &src)
	CIssue (const eSeverity &severity=eSeverity::Success, const eKind &kind=eKind::Unknown)
const eKind &	getKind () const
const eSeverity &	getSeverity () const
bool	isError () const
bool	isSuccess () const
	operator bool () const
CIssue &	operator&= (const CIssue &rhs)
bool	operator== (const CIssue &rhs) const
	~CIssue ()

Static Public Attributes
static const CIssue	Error
static const CIssue	Information
static const CEnumAnnotation< std::string, CIssue::eKind >	kindDescriptions
static const CEnumAnnotation< std::string, CIssue::eKind >	kindNames
static const CEnumAnnotation< std::string, CIssue::eSeverity >	severityNames
static const CIssue	Success
static const CIssue	Warning

Private Attributes
eKind	mKind
eSeverity	mSeverity

Member Enumeration Documentation

eKind

enum CIssue::eKind

strong

Enumerator
Unknown
ExpressionInvalid
ExpressionEmpty
MissingInitialValue
CalculationIssue
EventMissingAssignment
EventAlreadyHasAssignment
EventMissingTriggerExpression
UnitUndefined
UnitConflict
UnitInvalid
NaNissue
ObjectNotFound
ValueNotFound
VariableNotfound
StructureInvalid
TooManyArguments
HasCircularDependency
ExpressionDataTypeInvalid
VariableInExpression
CExpressionNotFound
CFunctionNotFound
VariablesMismatch
ValueTypeMismatch
InitialExpressionWithAssignment
SettingFixedExpression
KineticsUndefined
__SIZE

eSeverity

enum CIssue::eSeverity

strong

Enumerator
Success
Information
Warning
Error
__SIZE

Constructor & Destructor Documentation

CIssue() [1/2]

CIssue::CIssue	(	const eSeverity &	severity = eSeverity::Success,
		const eKind &	kind = eKind::Unknown
	)

CIssue() [2/2]

CIssue::CIssue

(

const CIssue &

src

)

~CIssue()

CIssue::~CIssue

(

)

Member Function Documentation

getKind()

const CIssue::eKind & CIssue::getKind

(

)

const

References mKind.

Referenced by CValidity::add(), and CValidity::remove().

getSeverity()

const CIssue::eSeverity & CIssue::getSeverity

(

)

const

References mSeverity.

Referenced by CValidity::add(), and CValidity::remove().

isError()

bool CIssue::isError

(

)

const

Utility method for language bindings where the bool operator is not available. This method returns a flag indicating whether this issue represents an error

Returns

whether this issue represents an error or not

References isSuccess().

Referenced by CMathObject::compileExpression(), and CExpression::createInitialExpression().

isSuccess()

bool CIssue::isSuccess

(

)

const

Utility method for language bindings where the bool operator is not available. This method returns a flag indicating whether this issue represents a success

Returns

whether this issue represents a success or not

References Error, and mSeverity.

Referenced by CEvaluationTree::calculate(), CExpression::compile(), and isError().

operator bool()

CIssue::operator bool

(

)

const

References Error.

operator&=()

CIssue & CIssue::operator&=

(

const CIssue &

rhs

)

References mKind, and mSeverity.

operator==()

bool CIssue::operator==

(

const CIssue &

rhs

)

const

References mKind, and mSeverity.

Member Data Documentation

Error

const CIssue CIssue::Error

static

Referenced by CModel::compile(), CEvaluationNodeCall::compile(), and CEvaluationTree::setInfix().

Information

const CIssue CIssue::Information

static

kindDescriptions

const CEnumAnnotation< std::string, CIssue::eKind > CIssue::kindDescriptions

static

Referenced by CValidity::getIssueMessages().

kindNames

const CEnumAnnotation< std::string, CIssue::eKind > CIssue::kindNames

static

Referenced by CConfigurationFile::initializeParameter().

mKind

eKind CIssue::mKind

private

Referenced by getKind(), operator&=(), and operator==().

mSeverity

eSeverity CIssue::mSeverity

private

Referenced by getSeverity(), isSuccess(), operator&=(), and operator==().

severityNames

const CEnumAnnotation< std::string, CIssue::eSeverity > CIssue::severityNames

static

Referenced by CConfigurationFile::initializeParameter().

Success

const CIssue CIssue::Success

static

Referenced by CValidity::clear(), CEvaluationNode::compile(), CUnit::compile(), CEvaluationNodeCall::compile(), CEvaluationNodeChoice::compile(), CEvaluationNodeDelay::compile(), CEvaluationNodeFunction::compile(), CEvaluationNodeObject::compile(), CEvaluationNodeVariable::compile(), CMathExpression::compile(), CFunction::initVariables(), CEvaluationTree::parse(), CValidity::remove(), CUnit::setExpression(), CEvaluationTree::setInfix(), and CEvaluationNode::setValueType().

Warning

const CIssue CIssue::Warning

static

---

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

• CValidity.h
• CValidity.cpp