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::BaseFromOtherPlanIndexedInitializer Class Referenceabstract

Base class for initialization of a plan indexed collection from an other plan indexed collection. More...

#include <BaseFromOtherPlanIndexedInitializer.h>

Inheritance diagram for ipsdk::imaproc::BaseFromOtherPlanIndexedInitializer:
ipsdk::imaproc::BasePlanIndexedInitializer ipsdk::imaproc::BaseImageProcessingOutputInitializer ipsdk::processor::BaseOutputInitializer ipsdk::imaproc::FromOtherPlanIndexedInitializer< OutputAttributeType >

Public Member Functions

ePlanIndexedInitializerType getPlanIndexedInitializerType () const
 retrieve plan indexed initializer type
 
const BasePlanIndexedAttributegetInputAttribute () const
 retrieve input plan indexed attribute associated to object More...
 
Constructors and destructor
 BaseFromOtherPlanIndexedInitializer ()
 
virtual ~BaseFromOtherPlanIndexedInitializer ()
 
- Public Member Functions inherited from ipsdk::imaproc::BasePlanIndexedInitializer
eImageProcessingInitializerType getImageProcessingInitializerType () const
 retrieve image processing initializer type
 
 BasePlanIndexedInitializer ()
 
virtual ~BasePlanIndexedInitializer ()=0
 
- Public Member Functions inherited from ipsdk::imaproc::BaseImageProcessingOutputInitializer
processor::eOutputInitializerType getOutputInitializerType () const
 retrieve initializer type
 
 BaseImageProcessingOutputInitializer ()
 
 ~BaseImageProcessingOutputInitializer ()
 
- Public Member Functions inherited from ipsdk::processor::BaseOutputInitializer
bool isInit () const
 retrieve object initialization flag
 
const BaseAttributegetOutputAttribute () const
 retrieve output attribute to be initialized More...
 
BoolResult initOutputAttribute ()
 initialize ouput attribute More...
 
std::string getInitializerFormalString () const
 retrieve string expliciting initializer content More...
 
std::string getInitializerEvaluatedString () const
 retrieve initializer evaluation string More...
 
 BaseOutputInitializer ()
 
virtual ~BaseOutputInitializer ()=0
 

Static Public Attributes

static const ePlanIndexedInitializerType::domain g_planIndexedInitializerType = ePlanIndexedInitializerType::ePIIT_FromOther
 plan indexed output initializer type
 
- Static Public Attributes inherited from ipsdk::imaproc::BasePlanIndexedInitializer
static const eImageProcessingInitializerType::domain g_imageProcessingInitializerType = eImageProcessingInitializerType::eIPIT_PlanIndexed
 image processing output initializer type
 
- Static Public Attributes inherited from ipsdk::imaproc::BaseImageProcessingOutputInitializer
static const processor::eOutputInitializerType::domain g_outputInitializerType = processor::eOutputInitializerType::eOIT_ImageProcessing
 output initializer type
 

Protected Member Functions

void initBase (const PlanIndexedAttributeWeakPtr &pOutputAttribute, const PlanIndexedAttributeConstWeakPtr &pInputAttribute)
 base class initialization method More...
 
virtual BoolResult initAttribute (BasePlanIndexedAttribute &baseAttributeOut, const ipUInt64 sizeZ, const ipUInt64 sizeC, const ipUInt64 sizeT)=0
 initialize ouput attribute in derived class More...
 
- Protected Member Functions inherited from ipsdk::processor::BaseOutputInitializer
void initBase (const AttributeWeakPtr &pOutputAttribute)
 base class initialization method More...
 
BaseAttributegetOutputAttribute ()
 retrieve output attribute to be initialized More...
 

Protected Attributes

PlanIndexedAttributeConstWeakPtr _pInputAttribute
 pointer to input plan indexed attribute used by initializer
 

Detailed Description

Base class for initialization of a plan indexed collection from an other plan indexed collection.

Author
E. Noirfalise
Date
2017/09/28

Member Function Documentation

◆ getInputAttribute()

const BasePlanIndexedAttribute& ipsdk::imaproc::BaseFromOtherPlanIndexedInitializer::getInputAttribute ( ) const

retrieve input plan indexed attribute associated to object

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

◆ initBase()

void ipsdk::imaproc::BaseFromOtherPlanIndexedInitializer::initBase ( const PlanIndexedAttributeWeakPtr pOutputAttribute,
const PlanIndexedAttributeConstWeakPtr pInputAttribute 
)
protected

base class initialization method

Exceptions
ipsdk::processor::IPSDKBaseProcessingExceptionif pOutputAttribute.get() == 0
ipsdk::processor::IPSDKBaseProcessingExceptionif pOutputAttribute->getIOStatus() != eAttributeIO::eIOS_Output
ipsdk::processor::IPSDKBaseProcessingExceptionif pInputAttribute.get() == 0

◆ initAttribute()

virtual BoolResult ipsdk::imaproc::BaseFromOtherPlanIndexedInitializer::initAttribute ( BasePlanIndexedAttribute baseAttributeOut,
const ipUInt64  sizeZ,
const ipUInt64  sizeC,
const ipUInt64  sizeT 
)
protectedpure virtual

initialize ouput attribute in derived class

Returns
false in case of failure

Implemented in ipsdk::imaproc::FromOtherPlanIndexedInitializer< OutputAttributeType >.


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