ipsdk::processor::BaseAttributeRule Class Reference

Base class for rules applied on attributes. More...

#include <BaseAttributeRule.h>

Inheritance diagram for ipsdk::processor::BaseAttributeRule:

Public Member Functions
eRuleType	getRuleType () const
	retrieve rule type
virtual eAttributeRuleType	getAttributeRuleType () const =0
	retrieve attribute rule operation type
bool	hasSecondAttribute () const
	check whether a second attribute is associated to rule More...
const BaseAttribute &	getAttribute1 () const
	retrieve first attribute associated to object More...
const BaseAttribute &	getAttribute2 () const
	retrieve second attribute associated to object More...
Constructors and destructor
	BaseAttributeRule ()
virtual	~BaseAttributeRule ()=0
Public Member Functions inherited from ipsdk::processor::BaseRule
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...
	BaseRule ()
virtual	~BaseRule ()=0

Static Public Attributes
static const eRuleType::domain	g_ruleType = eRuleType::eRT_Attribute
	rule type associated to rule

Protected Member Functions
void	initBase (const AttributeConstWeakPtr &pAttribute)
	base class initialization More...
void	initBase (const AttributeConstWeakPtr &pAttribute1, const AttributeConstWeakPtr &pAttribute2)
	base class initialization More...
Protected Member Functions inherited from ipsdk::processor::BaseRule
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

Detailed Description

Base class for rules applied on attributes.

Author

E. Noirfalise

Date

2016/03/15

Copyright

2016 Reactiv'IP, all right reserved.

Member Function Documentation

hasSecondAttribute()

bool ipsdk::processor::BaseAttributeRule::hasSecondAttribute

(

)

const

check whether a second attribute is associated to rule

Exceptions

ipsdk::processor::IPSDKBaseProcessingException

if isInit() == false

getAttribute1()

const BaseAttribute& ipsdk::processor::BaseAttributeRule::getAttribute1

(

)

const

retrieve first attribute associated to object

Exceptions

ipsdk::processor::IPSDKBaseProcessingException

if isInit() == false

getAttribute2()

const BaseAttribute& ipsdk::processor::BaseAttributeRule::getAttribute2

(

)

const

retrieve second attribute associated to object

Exceptions

ipsdk::processor::IPSDKBaseProcessingException

if hasSecondAttribute() == false

initBase() [1/2]

void ipsdk::processor::BaseAttributeRule::initBase ( const AttributeConstWeakPtr &  pAttribute )

protected

base class initialization

Exceptions

ipsdk::processor::IPSDKBaseProcessingException

if pAttribute.get() == 0

initBase() [2/2]

void ipsdk::processor::BaseAttributeRule::initBase ( const AttributeConstWeakPtr &  pAttribute1, const AttributeConstWeakPtr &  pAttribute2  )

protected

base class initialization

Exceptions

ipsdk::processor::IPSDKBaseProcessingException	if pAttribute1.get() == 0
ipsdk::processor::IPSDKBaseProcessingException	if pAttribute2.get() == 0

---

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

• /media/reactivipdev/Nightly/IPSDK_Patch/IPSDK_4_1/IPSDK_Nightly/include/public/IPSDKBaseProcessing/Rule/Attribute/BaseAttributeRule.h