IPSDK  4_1_0_2
IPSDK : Image Processing Software Development Kit
Public Member Functions | Protected Member Functions | Friends | List of all members
ipsdk::processor::BaseRule Class Referenceabstract

Base class for processing attributes rules. More...

#include <BaseRule.h>

Inheritance diagram for ipsdk::processor::BaseRule:
ipsdk::processor::BaseAttributeRule ipsdk::processor::BaseCombinationRule ipsdk::processor::RuleNone ipsdk::imaproc::BaseImageProcessingRule ipsdk::processor::BaseDataItemRule ipsdk::processor::BaseOptionalRule ipsdk::processor::BaseValueRule ipsdk::processor::BaseBinaryCombinationRule ipsdk::processor::BaseTernaryCombinationRule ipsdk::processor::BaseUnaryCombinationRule ipsdk::imaproc::BaseFormulaRule ipsdk::imaproc::BaseImageBufferTypeRule ipsdk::imaproc::BaseImageRule ipsdk::imaproc::BaseIPEnumRule ipsdk::imaproc::BaseKernelPropertyRule ipsdk::imaproc::BasePlanIndexedRule ipsdk::imaproc::BaseShapeMeasureInfoSetRule ipsdk::imaproc::BaseShapeMeasureSetRule ipsdk::imaproc::BaseStripRule ipsdk::imaproc::BaseTileCollRule ipsdk::imaproc::BaseTileRule ipsdk::processor::BaseLeafCollRule ipsdk::processor::BaseLeafRule ipsdk::processor::BaseNodeCollRule ipsdk::processor::RuleOptionalIsSet ipsdk::processor::BaseAttributeComparisonRule ipsdk::processor::BaseValueComparisonRule ipsdk::processor::BaseValueCustomPropertyRule ipsdk::processor::BaseValuePropertyRule ipsdk::processor::RuleAnd ipsdk::processor::RuleOr ipsdk::processor::RuleIf ipsdk::processor::RuleNot

Public Member Functions

virtual eRuleType getRuleType () const =0
 retrieve rule type
 
bool isInit () const
 retrieve object initialization flag
 
BoolResult isSatisfied () const
 test whether rule is satisfied More...
 
std::string getRuleFormalString () const
 retrieve string expliciting rule content More...
 
std::string getRuleEvaluatedString () const
 retrieve rule evaluation string More...
 
Constructors and destructors
 BaseRule ()
 
virtual ~BaseRule ()=0
 

Protected Member Functions

void initBase ()
 base class initialization method
 
std::string createRuleEvaluatedStartString (const ipUInt32 increment) const
 method allowing to create a rule evaluation starting string
 
virtual bool testRule () const =0
 test whether rule is satisfied
 
virtual std::string createRuleFormalString () const =0
 retrieve string expliciting rule content
 
virtual std::string createRuleEvaluatedString (const ipUInt32 increment) const =0
 retrieve rule evaluation string
 

Friends

class RuleAnd
 
class RuleOr
 
class RuleNot
 
class RuleIf
 

Detailed Description

Base class for processing attributes rules.

Author
E. Noirfalise
Date
2013/7/30

Member Function Documentation

◆ isSatisfied()

BoolResult ipsdk::processor::BaseRule::isSatisfied ( ) const

test whether rule is satisfied

Exceptions
ipsdk::processor::IPSDKBaseProcessingExceptionif isInit() == false

◆ getRuleFormalString()

std::string ipsdk::processor::BaseRule::getRuleFormalString ( ) const

retrieve string expliciting rule content

Exceptions
ipsdk::processor::IPSDKBaseProcessingExceptionif isInit() == false

◆ getRuleEvaluatedString()

std::string ipsdk::processor::BaseRule::getRuleEvaluatedString ( ) const

retrieve rule evaluation string

Exceptions
ipsdk::processor::IPSDKBaseProcessingExceptionif isInit() == false
ipsdk::processor::IPSDKBaseProcessingExceptionif underlying attribute(s) has not been initialized

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