Base class for plan indexed split operations for data dispatch. More...

#include <BasePlanIndexedSplit.h>

Inheritance diagram for ipsdk::imaproc::BasePlanIndexedSplit:

Public Member Functions
processor::eSplitStaticType	getSplitStaticType () const
	retrieve static split operation type

eImageSplitType	getImageSplitType () const
	retrieve image split operation type

const BasePlanIndexedColl &	getPlanIndexedColl () const
	retrieve plan indexed collection to be splitted More...

Constructors and destructors
	BasePlanIndexedSplit ()

virtual	~BasePlanIndexedSplit ()=0

Public Member Functions inherited from ipsdk::processor::BaseStaticSplit
eSplitBaseType	getSplitBaseType () const
	retrieve split operation base type

BoolResult	initAttribute (BaseProcessor &processor, const ipUInt32 elementIdx, const core::BaseRequestOrigin &requestOrigin)
	initialize processor attribute associate to split operation for a starting element index and a number of elements More...

	BaseStaticSplit ()

virtual	~BaseStaticSplit ()=0

Public Member Functions inherited from ipsdk::processor::BaseDataSplit
virtual const std::string &	getAttributeName () const =0
	retrieve attribute name associated to split operation

virtual const std::string &	getAttributeToolTip () const =0
	retrieve attribute tooltip associated to split operation

bool	isInit () const
	retrieve object initialization flag

bool	isSplitted () const
	check whether object will be associated to split operation More...

const ElementsLocationInfo &	getElementsLocationInfo () const
	retrieve data location informations More...

ipUInt64	getFullMemorySize () const
	retrieve full memory data size for elements More...

bool	areDataLocalized () const
	check whether data are localized More...

bool	hasLocalData () const
	check whether some data are local data More...

bool	hasRemoteData () const
	check whether some data are remote data More...

void	disableDataLocalization ()
	method allowing to disable data localization More...

	BaseDataSplit ()

virtual	~BaseDataSplit ()=0

ipUInt64	getNbElements () const
	retrieve total number of elements associated to input data More...

ipUInt64	getDataMemorySize (const ipUInt64 elementIdx) const
	retrieve memory size of data for a given element More...

ipUInt64	getDataMemorySize () const
	retrieve memory size of data for a given element More...

Protected Member Functions
void	initBase (const PlanIndexedCollPtr &pPlanIndexedColl, const ipUInt64 sizeZ, const ipUInt64 sizeC, const ipUInt64 sizeT, const bool bCanBeSingle)
	base class initialization method More...

Protected Member Functions inherited from ipsdk::processor::BaseStaticSplit
virtual BoolResult	processAttribute (BaseProcessor &processor, const ipUInt32 elementIdx, const core::BaseRequestOrigin &requestOrigin)=0
	initialize processor attribute associate to split operation for a given element index More...

Protected Member Functions inherited from ipsdk::processor::BaseDataSplit
void	initBaseSplitted (const ElementsLocationInfo &elementsLocationInfo)
	base class initialization method for splitted elements More...

void	initBaseUnSplitted (const ElementsLocationInfo &elementsLocationInfo)
	base class initialization method for un splitted elements More...

virtual bool	checkProcessorType (const processor::BaseProcessor &processor)=0
	check processor type in derived class

void	throwNullInputSharedPtr ()

Protected Attributes
PlanIndexedCollPtr	_pPlanIndexedColl
	pointer to plan indexed collection to be splitted

bool	_bCanBeSingle


ipUInt64	_sizeZ
	image size associated to operation

ipUInt64	_sizeC
	image size associated to operation

ipUInt64	_sizeT
	image size associated to operation

Additional Inherited Members
Static Public Attributes inherited from ipsdk::processor::BaseStaticSplit
static const eSplitBaseType::domain	g_splitBaseType = eSplitBaseType::eSBT_Static
	data split type associated to object

Detailed Description

Base class for plan indexed split operations for data dispatch.

Author: E. Noirfalise

Date: 2015/06/19

Copyright: 2015 Reactiv'IP, all right reserved.

Member Function Documentation

◆ getPlanIndexedColl()

const BasePlanIndexedColl& ipsdk::imaproc::BasePlanIndexedSplit::getPlanIndexedColl ( ) const

retrieve plan indexed collection to be splitted

Exceptions

ipsdk::processor::IPSDKBaseProcessingException if isInit() == false

◆ initBase()

void ipsdk::imaproc::BasePlanIndexedSplit::initBase	(	const PlanIndexedCollPtr &	pPlanIndexedColl,
		const ipUInt64	sizeZ,
		const ipUInt64	sizeC,
		const ipUInt64	sizeT,
		const bool	bCanBeSingle
	)

protected

base class initialization method

Exceptions

ipsdk::imaproc::IPSDKImageProcessingException	if pPlanIndexedColl.get() == 0
ipsdk::imaproc::IPSDKImageProcessingException	if provided sizes and indexed plan coll components mismatch

Member Data Documentation

◆ _bCanBeSingle

bool ipsdk::imaproc::BasePlanIndexedSplit::_bCanBeSingle

protected

flag indicating whether input plan indexed collection can be composed of a single element (case where we want to use a same element for each proceeded plans)

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

/media/reactivipdev/Nightly/IPSDK_Patch/IPSDK_4_1/IPSDK_Nightly/include/public/IPSDKImageProcessing/DataSplit/PlanIndexed/BasePlanIndexedSplit.h

Public Member Functions

Protected Member Functions