IPSDK: ipsdk::processor::BaseDataParser Class Reference

IPSDK 4_1_0_2

IPSDK : Image Processing Software Development Kit

Base class for objects allowing to parse attribute data. More...

#include <BaseDataParser.h>

Inheritance diagram for ipsdk::processor::BaseDataParser:

Public Member Functions
bool	isInit () const
	retrieve object initialization flag

virtual eDataParserType	getDataParserType () const =0
	retrieve data parser type

bool	areDataInit () const
	retrieve data initialization flag More...

ipUInt64	getNbInitData () const
	retrieve number of initial data More...

ipUInt64	getNbMainData () const
	retrieve number of main data More...

ipUInt64	getNbFinalData () const
	retrieve number of final data More...

ipUInt64	getNbRealFinalData () const
	retrieve number of real final data (not virtual for alignment purpose only) More...

void	clear ()
	clear object data

Constructors and destructors
	BaseDataParser ()

virtual	~BaseDataParser ()=0

Data preparator main informations
const eIOStatus &	getAttributeIO () const
	retrieve associated attribute input/output status More...

ipUInt64	getNbElements () const
	retrieve number of elements associated to object More...

ipUInt64	getNbDataByElement () const
	retrieve total number of data by element More...

ipUInt64	getNbMinInitData () const
	retrieve minimum number of initial data to be processed More...

ipUInt64	getNbMinFinalData () const
	retrieve minimum number of final data to be processed More...

ipUInt64	getCurElementIdx () const
	retrieve current element index for iteration process More...

Management of unaligned data values
ipReal64	getUnAlignedValue () const
	retrieve used value for unaligned data More...

void	setUnAlignedValue (const ipReal64 unAlignedValue)
	set used value for unaligned data More...

Protected Member Functions
void	initBase (const eIOStatus &attributeIO, const ipUInt64 nbElements, const ipUInt64 nbDataByElement, const ipUInt64 nbMinInitData, const ipUInt64 nbMinFinalData, const ipReal64 unAlignedDefaultValue)
	base class initialization method More...

virtual void	clearDerived ()
	clear object data in derived class

virtual void	initDataDerived (const ipUInt64 nbInitData, const ipUInt64 nbMainData, const ipUInt64 nbFinalData, const ipUInt64 nbRealFinalData, const ipReal64 unAlignedValue)=0
	initialize data for processing in derived class

virtual void	prepareDataDerived (const ipUInt64 elementIdx)=0

virtual void	updateToInitDataDerived ()=0
	update processed data to initial data in derived class

virtual void	updateToMainDataDerived ()=0
	update processed data to main data in derived class

virtual void	updateToFinalDataDerived ()=0
	update processed data to final data in derived class

virtual void	syncOutFinalDataDerived ()
	synchronize final output data after processing

void	initData (const ipUInt64 nbInitData, const ipUInt64 nbMainData, const ipUInt64 nbFinalData, const ipUInt64 nbRealFinalData)
	prepare data for processing for a given element index More...

void	prepareData (const ipUInt64 elementIdx)
	prepare data for processing for a given element index More...

Friends
class	BaseProcessingAlgorithm

Detailed Description

Base class for objects allowing to parse attribute data.

Author: E.Noirfalise

Date: 2015/01/16

Copyright: 2015 Reactiv'IP, all right reserved.

Member Function Documentation

◆ getAttributeIO()

const eIOStatus& ipsdk::processor::BaseDataParser::getAttributeIO ( ) const

retrieve associated attribute input/output status

Exceptions

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

◆ getNbElements()

ipUInt64 ipsdk::processor::BaseDataParser::getNbElements ( ) const

retrieve number of elements associated to object

Exceptions

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

◆ getNbDataByElement()

ipUInt64 ipsdk::processor::BaseDataParser::getNbDataByElement ( ) const

retrieve total number of data by element

Exceptions

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

◆ getNbMinInitData()

ipUInt64 ipsdk::processor::BaseDataParser::getNbMinInitData ( ) const

retrieve minimum number of initial data to be processed

Exceptions

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

◆ getNbMinFinalData()

ipUInt64 ipsdk::processor::BaseDataParser::getNbMinFinalData ( ) const

retrieve minimum number of final data to be processed

Exceptions

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

◆ getCurElementIdx()

ipUInt64 ipsdk::processor::BaseDataParser::getCurElementIdx ( ) const

retrieve current element index for iteration process

Exceptions

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

Returns: -1 if prepareData has not been called

◆ getUnAlignedValue()

ipReal64 ipsdk::processor::BaseDataParser::getUnAlignedValue ( ) const

retrieve used value for unaligned data

Exceptions

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

◆ setUnAlignedValue()

void ipsdk::processor::BaseDataParser::setUnAlignedValue ( const ipReal64 unAlignedValue )

set used value for unaligned data

Exceptions

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

◆ areDataInit()

bool ipsdk::processor::BaseDataParser::areDataInit ( ) const

retrieve data initialization flag

Exceptions

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

◆ getNbInitData()

ipUInt64 ipsdk::processor::BaseDataParser::getNbInitData ( ) const

retrieve number of initial data

Exceptions

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

◆ getNbMainData()

ipUInt64 ipsdk::processor::BaseDataParser::getNbMainData ( ) const

retrieve number of main data

Exceptions

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

◆ getNbFinalData()

ipUInt64 ipsdk::processor::BaseDataParser::getNbFinalData ( ) const

retrieve number of final data

Exceptions

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

◆ getNbRealFinalData()

ipUInt64 ipsdk::processor::BaseDataParser::getNbRealFinalData ( ) const

retrieve number of real final data (not virtual for alignment purpose only)

Exceptions

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

◆ initBase()

void ipsdk::processor::BaseDataParser::initBase	(	const eIOStatus &	attributeIO,
		const ipUInt64	nbElements,
		const ipUInt64	nbDataByElement,
		const ipUInt64	nbMinInitData,
		const ipUInt64	nbMinFinalData,
		const ipReal64	unAlignedDefaultValue
	)

protected

base class initialization method

Parameters

attributeIO	Attribute input/output flag
nbElements	number of elements to be processed
nbDataByElement	total number of data by element
nbMinInitData	number of minimum initial data (example : kernel case with starting virtual data)
nbMinFinalData	number of minimum final data (example : kernel case with ending virtual data)
unAlignedDefaultValue	default value used for alignement data (virtual data used only for alignement purpose)

Exceptions

ipsdk::processor::IPSDKBaseProcessingException if nbDataByElement < nbMinInitData + nbMinFinalData

◆ prepareDataDerived()

virtual void ipsdk::processor::BaseDataParser::prepareDataDerived ( const ipUInt64 elementIdx )

protectedpure virtual

prepare data for processing for a given element index in derived class

◆ initData()

void ipsdk::processor::BaseDataParser::initData	(	const ipUInt64	nbInitData,
		const ipUInt64	nbMainData,
		const ipUInt64	nbFinalData,
		const ipUInt64	nbRealFinalData
	)

protected

prepare data for processing for a given element index

Exceptions

ipsdk::processor::IPSDKBaseProcessingException	if nbInitData < getNbMinInitData()
ipsdk::processor::IPSDKBaseProcessingException	if nbFinalData < getNbMinFinalData()
ipsdk::processor::IPSDKBaseProcessingException	if nbInitData + nbMainData + getNbMinFinalData() > getNbDataByElement()
ipsdk::processor::IPSDKBaseProcessingException	if nbInitData + nbMainData + nbFinalData < getNbDataByElement()
ipsdk::processor::IPSDKBaseProcessingException	if nbRealFinalData > nbFinalData

◆ prepareData()

void ipsdk::processor::BaseDataParser::prepareData ( const ipUInt64 elementIdx )

protected

prepare data for processing for a given element index

Exceptions

ipsdk::processor::IPSDKBaseProcessingException	if elementIdx >= getNbElements()
ipsdk::processor::IPSDKBaseProcessingException	if areDataInit() == false

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

/media/reactivipdev/Nightly/IPSDK_Patch/IPSDK_4_1/IPSDK_Nightly/include/public/IPSDKBaseProcessing/Algorithm/Parser/BaseDataParser.h