ipsdk::shape::analysis::FormulaManager Class Reference

Object allowing to manage shape analysis formula. More...

#include <FormulaManager.h>

Inheritance diagram for ipsdk::shape::analysis::FormulaManager:

Public Member Functions
bool	isInit () const
	retrieve object initialization flag
BoolResult	init (const std::string &formulaStr, const bool bDebugMode=false)
	initialization of object More...
const std::string &	getFormulaStr () const
	retrieve string associated to formula More...
const eMsrFormulaResultType &	getResultType () const
	retrieve result type associated to formula More...
const ConstantMap &	getConstantMap () const
	retrieve image constants associated to formula More...
const VariableMap &	getVariableMap () const
	retrieve variables associated to formula More...
EvalStatus	evaluate (ipBool &result)
	evaluate logic formula More...
EvalStatus	evaluate (ipReal64 &result)
	evaluate arithmetic formula More...
void	clear ()
	clear of object data
Constructors and destructors
	FormulaManager ()
	~FormulaManager ()

Protected Attributes
bool	_bInit
	object initialization flag
std::string	_formulaStr
	formula string associated to object$
FormulaItemColl	_itemsColl
	items collection associated to formula
ConstantMap	_csteMap
	image constant collection associated to formula
VariableMap	_varMap
	variable collection associated to formula
eMsrFormulaResultType	_resultType
	result type associated to formula

Detailed Description

Object allowing to manage shape analysis formula.

Author

E. Noirfalise

Date

2015/07/27

Copyright

2015 Reactiv'IP, all right reserved.

Member Function Documentation

init()

BoolResult ipsdk::shape::analysis::FormulaManager::init	(	const std::string &	formulaStr,
		const bool	bDebugMode = false
	)

initialization of object

Returns

false in case of failure

getFormulaStr()

const std::string& ipsdk::shape::analysis::FormulaManager::getFormulaStr

(

)

const

retrieve string associated to formula

Exceptions

ipsdk::shape::analysis::IPSDKBaseShapeAnalysisException

if isInit() == false

getResultType()

const eMsrFormulaResultType& ipsdk::shape::analysis::FormulaManager::getResultType

(

)

const

retrieve result type associated to formula

Exceptions

ipsdk::shape::analysis::IPSDKBaseShapeAnalysisException

if isInit() == false

getConstantMap()

const ConstantMap& ipsdk::shape::analysis::FormulaManager::getConstantMap

(

)

const

retrieve image constants associated to formula

Exceptions

ipsdk::shape::analysis::IPSDKBaseShapeAnalysisException

if isInit() == false

getVariableMap()

const VariableMap& ipsdk::shape::analysis::FormulaManager::getVariableMap

(

)

const

retrieve variables associated to formula

Exceptions

ipsdk::shape::analysis::IPSDKBaseShapeAnalysisException

if isInit() == false

evaluate() [1/2]

EvalStatus ipsdk::shape::analysis::FormulaManager::evaluate

(

ipBool &

result

)

evaluate logic formula

Note

image constants retrieved via getConstantMap() must have been previously set

variable values retrieved via getVariableMap() must have been previously set

Exceptions

ipsdk::shape::analysis::IPSDKBaseShapeAnalysisException

if getResultType() != eMsrFormulaResultType::eMFRT_Logic

Returns

evaluation status

evaluate() [2/2]

EvalStatus ipsdk::shape::analysis::FormulaManager::evaluate

(

ipReal64 &

result

)

evaluate arithmetic formula

Note

image constants retrieved via getConstantMap() must have been previously set

variable values retrieved via getVariableMap() must have been previously set

Exceptions

ipsdk::shape::analysis::IPSDKBaseShapeAnalysisException

if getResultType() != eMsrFormulaResultType::eMFRT_Arithmetic

Returns

evaluation status

---

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

• /media/reactivipdev/Nightly/IPSDK_Patch/IPSDK_4_1/IPSDK_Nightly/include/public/IPSDKBaseShapeAnalysis/Measure/Formula/FormulaManager.h