RulePlanIndexedMatchImagePlans.h

// RulePlanIndexedMatchImagePlans.h:
// ---------------------------------
//

#ifndef __IPSDKIMAGEPROCESSING_RULEPLANINDEXEDMATCHIMAGEPLANS_H__
#define __IPSDKIMAGEPROCESSING_RULEPLANINDEXEDMATCHIMAGEPLANS_H__

// suppression warnings
// warning C4251: 'ipsdk::imaproc::RulePlanIndexedMatchImagePlans::_imagePlansMatchPolicy' : class 'ipsdk::imaproc::eImagePlansMatchPolicy' needs to have dll-interface to be used by clients of class 'ipsdk::imaproc::RulePlanIndexedMatchImagePlans'
#pragma warning (push)
#pragma warning (disable : 4251)

#include <IPSDKImageProcessing/Rule/PlanIndexed/BasePlanIndexedRule.h>
#include <IPSDKImageProcessing/Attribute/Image/ImageAttributeTypes.h>

namespace ipsdk {
namespace imaproc {


class IPSDKIMAGEPROCESSING_API RulePlanIndexedMatchImagePlans : public BasePlanIndexedRule
{
// predefined public types
public:
    // plan indexed rule type
    static const ePlanIndexedRuleType::domain g_planIndexedRuleType = ePlanIndexedRuleType::ePIRT_MatchImagePlans;

public:
    RulePlanIndexedMatchImagePlans();
    ~RulePlanIndexedMatchImagePlans();

// methods
public:
    ePlanIndexedRuleType            getPlanIndexedRuleType() const;

    void                            init(const PlanIndexedAttributeConstWeakPtr& pPlanIndexedAttribute,
                                         const ImageAttributeConstWeakPtr& pImageAttribute,
                                         const eImagePlansMatchPolicy& imagePlansMatchPolicy);

    const eImagePlansMatchPolicy&   getImagePlansMatchPolicy() const;

protected:
    bool            testRule() const;

    std::string     createRuleFormalString() const;

    std::string     createRuleEvaluatedString(const ipUInt32 increment) const;

// attributes
protected:
    eImagePlansMatchPolicy  _imagePlansMatchPolicy;
};


inline ePlanIndexedRuleType
RulePlanIndexedMatchImagePlans::getPlanIndexedRuleType() const
{
    return g_planIndexedRuleType;
}


} // end of namespace imaproc
} // end of namespace ipsdk

#pragma warning (pop)

#endif // __IPSDKIMAGEPROCESSING_RULEPLANINDEXEDMATCHIMAGEPLANS_H__