[Output] plan indexed collection of properties of circles detected by Hough algorithm More...

#include <OutPIHoughCircles2dPpties.h>

Inheritance diagram for ipsdk::imaproc::attr::OutPIHoughCircles2dPpties:

Public Types
typedef ipsdk::imaproc::attr::PlanIndexedHoughCircles2dPpties	ValueType
	Value type associated to attribute.

typedef boost::shared_ptr< const ValueType >	StorageType
	Storage type associated to attribute.

typedef boost::shared_ptr< const ValueType >	ConstStorageType
	Const storage type associated to attribute.

typedef ipsdk::imaproc::attr::PlanIndexedHoughCircles2dPpties::ValueType	PlanValueType
	Plan value type associated to attribute.

typedef ipsdk::imaproc::attr::PlanIndexedHoughCircles2dPpties::StorageType	PlanStorageType
	Plan storage type associated to attribute.

typedef ipsdk::imaproc::attr::PlanIndexedHoughCircles2dPpties::ConstStorageType	PlanConstStorageType
	Plan const storage type associated to attribute.

Public Member Functions
	~OutPIHoughCircles2dPpties ()
	destructor

bool	isOptional () const
	retrieve attribute optional state for processing

ipsdk::eIOStatus	getIOStatus () const

bool	isInOut () const
	retrieve attribute in/out state for processing

bool	isInput () const
	retrieve attribute input state for processing

bool	isOutput () const
	retrieve attribute output state for processing

const std::string &	getObjectName () const
	method allowing to retrieve object name

const std::string &	getToolTip () const
	method allowing to retrieve object tooltip

const boost::filesystem::path	getHeaderPath () const
	retrieve relative header path associated to attribute

const std::string	getLibraryName () const
	retrieve library name associated attribute

void	init (const StorageType &pPlanIndexedColl)
	retrieve plan indexed collection More...


const ValueType &	getColl () const
	retrieve plan indexed collection More...

ConstStorageType	getStorage () const
	retrieve plan indexed collection More...


const PlanValueType &	getPlanValue (const ipsdk::PlanIndex &planIndex) const
	access to plan indexed element More...

const PlanValueType &	getPlanValue (const ipsdk::ipUInt32 zPlanIdx, const ipsdk::ipUInt32 cPlanIdx, const ipsdk::ipUInt32 tPlanIdx) const
	access to plan indexed element More...

PlanConstStorageType	getPlanStorage (const ipsdk::PlanIndex &planIndex) const
	access to plan indexed element More...

PlanConstStorageType	getPlanStorage (const ipsdk::ipUInt32 zPlanIdx, const ipsdk::ipUInt32 cPlanIdx, const ipsdk::ipUInt32 tPlanIdx) const
	access to plan indexed element More...


void	insert (const ipsdk::PlanIndex &planIndex, const PlanStorageType &pObject)
	insert a new element for a given plan index More...

void	insert (const ipsdk::ipUInt32 zPlanIdx, const ipsdk::ipUInt32 cPlanIdx, const ipsdk::ipUInt32 tPlanIdx, const PlanStorageType &pObject)
	insert a new element for a given plan index More...

Public Member Functions inherited from ipsdk::imaproc::BasePlanIndexedAttribute
eImageProcessingAttributeType	getImageProcessingAttributeType () const

const BasePlanIndexedColl &	getBaseColl () const

ipUInt64	getNbPlans () const

bool	isComplete () const

bool	isComplete (const ipUInt64 sizeZ, const ipUInt64 sizeC, const ipUInt64 sizeT) const

ipUInt64	getMaxSizeZ () const

ipUInt64	getMaxSizeC () const

ipUInt64	getMaxSizeT () const

bool	exists (const PlanIndex &planIndex) const

bool	exists (const ipUInt64 zPlanIdx, const ipUInt64 cPlanIdx, const ipUInt64 tPlanIdx) const

ipUInt64	getMaxSizeZ () const

ipUInt64	getMaxSizeC () const

ipUInt64	getMaxSizeT () const

bool	exists (const PlanIndex &planIndex) const

bool	exists (const ipUInt64 zPlanIdx, const ipUInt64 cPlanIdx, const ipUInt64 tPlanIdx) const

Public Member Functions inherited from ipsdk::imaproc::BaseImageProcessingAttribute
processor::eAttributeType	getAttributeType () const

Public Member Functions inherited from ipsdk::processor::BaseAttribute
bool	isInit () const

const BaseRule &	getRule () const

BoolResult	isValid () const

void	clear ()

bool	isOutOptionalInitForced () const

void	setOutOptionalInitForced (bool bOutOptionalInitForced) const

bool	isOutOptionalInitForced () const

void	setOutOptionalInitForced (bool bOutOptionalInitForced) const

Public Member Functions inherited from ipsdk::BaseObjectWithSkeleton
const eSklSrzMode &	getSerializationMode () const

void	setSerializationMode (const eSklSrzMode &sklSrzMode) const

Public Member Functions inherited from ipsdk::BaseDynamicObject
virtual const std::string &	getClassName () const

virtual BaseDynamicObject *	createNew () const=0

virtual DynamicObjectPtr	createShared () const=0

virtual bool	hasCopySupport () const=0

virtual BaseDynamicObject *	duplicate () const=0

virtual DynamicObjectPtr	duplicateShared () const=0

Public Member Functions inherited from ipsdk::BaseOptData
virtual eOptStatus	getOptStatus () const=0

virtual bool	isMandatory () const=0

Static Public Member Functions
static boost::shared_ptr< OutPIHoughCircles2dPpties >	createAttribute ()
	attribute creation function

static const std::string &	getObjectNameStr ()
	method allowing to retrieve object name

static const std::string &	getToolTipStr ()
	method allowing to retrieve object tooltip

static const boost::filesystem::path	getHeaderPathStr ()
	retrieve relative header path associated to attribute

static const std::string	getLibraryNameStr ()
	retrieve library name associated attribute

Static Public Member Functions inherited from ipsdk::BaseSerializationObject
static ipUInt32	getVersion ()

Static Public Member Functions inherited from ipsdk::BaseDynamicObject
static const std::string &	getTypeName ()

Static Public Attributes
static const bool	g_bOptionalAttribute = false
	attribute optional status


static const ipsdk::eIOStatus::domain	g_dataIOStatus = ipsdk::eIOStatus::eIOS_Output
	attribute input and output state for processing

Static Public Attributes inherited from ipsdk::imaproc::BasePlanIndexedAttribute
static const eImageProcessingAttributeType::domain	g_imageProcessingAttributeType

Static Public Attributes inherited from ipsdk::imaproc::BaseImageProcessingAttribute
static const processor::eAttributeType::domain	g_attributeType

Protected Member Functions
	OutPIHoughCircles2dPpties ()
	constructor

Protected Member Functions inherited from ipsdk::imaproc::BasePlanIndexedAttribute
void	initBase (const PlanIndexedCollPtr &pPlanIndexedColl)

void	clearDerived ()

PlanIndexedCollConstPtr	accessStorage () const

const PlanIndexedCollPtr &	accessStorage ()

PlanIndexedCollConstPtr	accessStorage () const

const PlanIndexedCollPtr &	accessStorage ()

Protected Member Functions inherited from ipsdk::processor::BaseAttribute
void	initBase ()

virtual BoolResult	syncInputDerived (const Guid &processingSocketGuid)

virtual BoolResult	syncOutputDerived (const Guid &processingSocketGuid)

virtual RulePtr	createRule (const AttributePtr &pBaseThis) const=0

Protected Member Functions inherited from ipsdk::BaseSerializationObject
virtual BoolResult	write (BaseOArchive &ar) const

virtual BoolResult	read (BaseIArchive &ar)

Protected Member Functions inherited from ipsdk::BaseDynamicObject
virtual void	initCtorCopy (const BaseDynamicObject &object)

virtual void	copy (const BaseDynamicObject &object)

Additional Inherited Members
Protected Attributes inherited from ipsdk::imaproc::BasePlanIndexedAttribute
PlanIndexedCollPtr	_pPlanIndexedColl

Protected Attributes inherited from ipsdk::BaseObjectWithSkeleton
eSklSrzMode	_sklSrzMode

Detailed Description

[Output] plan indexed collection of properties of circles detected by Hough algorithm

Author: H. Delestre

Date: 2015/06/25

Copyright: 2015 Reactiv'IP, all right reserved.

Attribute associated library :

IPSDKIPLAttributes

Attribute rule :

Rule on attribute is given by
ipsdk::processor::none ()

Member Function Documentation

◆ getIOStatus()

ipsdk::eIOStatus ipsdk::imaproc::attr::OutPIHoughCircles2dPpties::getIOStatus ( ) const

inlinevirtual

retrieve attribute input/output state for processing

Implements ipsdk::BaseIOData.

◆ getColl()

const ValueType& ipsdk::imaproc::attr::OutPIHoughCircles2dPpties::getColl ( ) const

retrieve plan indexed collection

Exceptions

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

◆ getStorage()

ConstStorageType ipsdk::imaproc::attr::OutPIHoughCircles2dPpties::getStorage ( ) const

retrieve plan indexed collection

Exceptions

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

◆ init()

void ipsdk::imaproc::attr::OutPIHoughCircles2dPpties::init ( const StorageType & pPlanIndexedColl )

retrieve plan indexed collection

Exceptions

ipsdk::processor::IPSDKBaseProcessingException if pPlanIndexedColl.get() == 0

◆ getPlanValue() [1/2]

const PlanValueType& ipsdk::imaproc::attr::OutPIHoughCircles2dPpties::getPlanValue ( const ipsdk::PlanIndex & planIndex ) const

access to plan indexed element

Exceptions

ipsdk::IPSDKBaseDataException if exists(planIndex) == false

◆ getPlanValue() [2/2]

const PlanValueType& ipsdk::imaproc::attr::OutPIHoughCircles2dPpties::getPlanValue	(	const ipsdk::ipUInt32	zPlanIdx,
		const ipsdk::ipUInt32	cPlanIdx,
		const ipsdk::ipUInt32	tPlanIdx
	)		const

access to plan indexed element

Exceptions

ipsdk::IPSDKBaseDataException if exists(planIndex) == false

◆ getPlanStorage() [1/2]

PlanConstStorageType ipsdk::imaproc::attr::OutPIHoughCircles2dPpties::getPlanStorage ( const ipsdk::PlanIndex & planIndex ) const

access to plan indexed element

Exceptions

ipsdk::IPSDKBaseDataException if exists(planIndex) == false

◆ getPlanStorage() [2/2]

PlanConstStorageType ipsdk::imaproc::attr::OutPIHoughCircles2dPpties::getPlanStorage	(	const ipsdk::ipUInt32	zPlanIdx,
		const ipsdk::ipUInt32	cPlanIdx,
		const ipsdk::ipUInt32	tPlanIdx
	)		const

access to plan indexed element

Exceptions

ipsdk::IPSDKBaseDataException if exists(planIndex) == false

◆ insert() [1/2]

void ipsdk::imaproc::attr::OutPIHoughCircles2dPpties::insert	(	const ipsdk::PlanIndex &	planIndex,
		const PlanStorageType &	pObject
	)

insert a new element for a given plan index

Exceptions

ipsdk::IPSDKBaseDataException	if exists(planIndex) == true
ipsdk::IPSDKBaseDataException	if pObject.get() == 0

◆ insert() [2/2]

void ipsdk::imaproc::attr::OutPIHoughCircles2dPpties::insert	(	const ipsdk::ipUInt32	zPlanIdx,
		const ipsdk::ipUInt32	cPlanIdx,
		const ipsdk::ipUInt32	tPlanIdx,
		const PlanStorageType &	pObject
	)

insert a new element for a given plan index

Exceptions

ipsdk::IPSDKBaseDataException	if exists(planIndex) == true
ipsdk::IPSDKBaseDataException	if pObject.get() == 0

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

/media/reactivipdev/Nightly/IPSDK_Patch/IPSDK_4_1/IPSDK_Nightly/include/public/IPSDKIPL/IPSDKIPLAttributes/Attribute/DataItem/OutPIHoughCircles2dPpties.h

Public Types

Public Member Functions

Static Public Member Functions

Static Public Attributes

Protected Member Functions

Additional Inherited Members

Detailed Description

Attribute associated library :

Attribute rule :

Member Function Documentation

◆ getIOStatus()

◆ getColl()

◆ getStorage()

◆ init()

◆ getPlanValue() [1/2]

◆ getPlanValue() [2/2]

◆ getPlanStorage() [1/2]

◆ getPlanStorage() [2/2]

◆ insert() [1/2]

◆ insert() [2/2]