IPSDK  4_1_0_2
IPSDK : Image Processing Software Development Kit
Public Member Functions | Static Public Attributes | Protected Member Functions | Protected Attributes | List of all members
ipsdk::imaproc::RuleMatchImageVolumeType Class Reference

Rule allowing to check image volume geometry. More...

#include <RuleMatchImageVolumeType.h>

Inheritance diagram for ipsdk::imaproc::RuleMatchImageVolumeType:
ipsdk::imaproc::BaseImagePropertyRule ipsdk::imaproc::BaseImageRule ipsdk::imaproc::BaseImageProcessingRule ipsdk::processor::BaseAttributeRule ipsdk::processor::BaseRule

Public Member Functions

eImagePropertyRuleType getImagePropertyRuleType () const
 get image property rule type
 
void init (const ImageAttributeConstWeakPtr &pAttribute, const image::eVolumeGeometryType &volumeGeometryType)
 initialization of object More...
 
const image::eVolumeGeometryTypegetVolumeGeometry () const
 retrieve volume geometry used for check More...
 
Constructors and destructors
 RuleMatchImageVolumeType ()
 
 ~RuleMatchImageVolumeType ()
 
- Public Member Functions inherited from ipsdk::imaproc::BaseImagePropertyRule
eImageRuleType getImageRuleType () const
 retrieve image rule operation type
 
 BaseImagePropertyRule ()
 
virtual ~BaseImagePropertyRule ()=0
 
- Public Member Functions inherited from ipsdk::imaproc::BaseImageRule
eImageProcessingRuleType getImageProcessingRuleType () const
 retrieve image processing rule operation type
 
 BaseImageRule ()
 
virtual ~BaseImageRule ()=0
 
- Public Member Functions inherited from ipsdk::imaproc::BaseImageProcessingRule
processor::eAttributeRuleType getAttributeRuleType () const
 retrieve attribute rule operation type
 
 BaseImageProcessingRule ()
 
virtual ~BaseImageProcessingRule ()=0
 
- Public Member Functions inherited from ipsdk::processor::BaseAttributeRule
eRuleType getRuleType () const
 retrieve rule type
 
bool hasSecondAttribute () const
 check whether a second attribute is associated to rule More...
 
const BaseAttributegetAttribute1 () const
 retrieve first attribute associated to object More...
 
const BaseAttributegetAttribute2 () const
 retrieve second attribute associated to object More...
 
 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 eImagePropertyRuleType::domain g_imagePropertyRuleType = eImagePropertyRuleType::eIPRT_MatchImageVolumeType
 image processing rule type associated to rule
 
- Static Public Attributes inherited from ipsdk::imaproc::BaseImagePropertyRule
static const eImageRuleType::domain g_imageRuleType = eImageRuleType::eIRT_ImageProperty
 image rule type associated to rule
 
- Static Public Attributes inherited from ipsdk::imaproc::BaseImageRule
static const eImageProcessingRuleType::domain g_imageProcessingRuleType = eImageProcessingRuleType::eIPRT_Image
 image processing rule type associated to rule
 
- Static Public Attributes inherited from ipsdk::imaproc::BaseImageProcessingRule
static const processor::eAttributeRuleType::domain g_attributeRuleType = processor::eAttributeRuleType::eART_ImageProcessing
 attribute rule type associated to rule
 
- Static Public Attributes inherited from ipsdk::processor::BaseAttributeRule
static const eRuleType::domain g_ruleType = eRuleType::eRT_Attribute
 rule type associated to rule
 

Protected Member Functions

bool testRule () const
 test whether rule is satisfied
 
std::string createRuleFormalString () const
 retrieve string expliciting rule content
 
std::string createRuleEvaluatedString (const ipUInt32 increment) const
 retrieve rule evaluation string
 
- Protected Member Functions inherited from ipsdk::processor::BaseAttributeRule
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
 

Protected Attributes

image::eVolumeGeometryType _volumeGeometryType
 volume geometry used for check
 

Detailed Description

Rule allowing to check image volume geometry.

Author
E. Noirfalise
Date
2014/2/11

Member Function Documentation

◆ init()

void ipsdk::imaproc::RuleMatchImageVolumeType::init ( const ImageAttributeConstWeakPtr pAttribute,
const image::eVolumeGeometryType volumeGeometryType 
)

initialization of object

Parameters
pAttributeimage attribute to be checked
volumeGeometryTypevolume geometry used for check
Exceptions
ipsdk::processor::IPSDKBaseProcessingExceptionif pAttribute.get() == 0

◆ getVolumeGeometry()

const image::eVolumeGeometryType& ipsdk::imaproc::RuleMatchImageVolumeType::getVolumeGeometry ( ) const

retrieve volume geometry used for check

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

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