Parameter object for measure Roughness2d. More...

#include <Roughness2dMsrParams.h>

Inheritance diagram for ipsdk::imaproc::shape::analysis::Roughness2dMsrParams:

Public Member Functions
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 data item node

const std::string	getLibraryName () const
	retrieve library name associated data item node

const ipsdk::ItemNames &	getItemIds () const
	retrieve item associated to a given id More...

	~Roughness2dMsrParams ()
	public destructor

Methods associated to sub node ProcessHoles
template<>
const ipsdk::DataItemLeaf< ipsdk::ipBool > &	getNode () const
	access to sub node ProcessHoles

template<>
ipsdk::DataItemLeaf< ipsdk::ipBool > &	get ()
	access to sub node ProcessHoles

template<>
const ipsdk::ipBool &	getValue () const
	access to value for sub node ProcessHoles

template<>
void	setValue (const ipsdk::ipBool &value)
	access to value for sub node ProcessHoles

Methods associated to sub node PolygApproxMaxDist
template<>
const ipsdk::DataItemLeaf< ipsdk::ipReal64 > &	getNode () const
	access to sub node PolygApproxMaxDist

template<>
ipsdk::DataItemLeaf< ipsdk::ipReal64 > &	get ()
	access to sub node PolygApproxMaxDist

template<>
const ipsdk::ipReal64 &	getValue () const
	access to value for sub node PolygApproxMaxDist

template<>
void	setValue (const ipsdk::ipReal64 &value)
	access to value for sub node PolygApproxMaxDist

Methods associated to sub node Neighborhood2dType
template<>
const ipsdk::DataItemLeaf< ipsdk::eNeighborhood2dType > &	getNode () const
	access to sub node Neighborhood2dType

template<>
ipsdk::DataItemLeaf< ipsdk::eNeighborhood2dType > &	get ()
	access to sub node Neighborhood2dType

template<>
const ipsdk::eNeighborhood2dType &	getValue () const
	access to value for sub node Neighborhood2dType

template<>
void	setValue (const ipsdk::eNeighborhood2dType &value)
	access to value for sub node Neighborhood2dType

Methods associated to sub node NbMinPointForPolygApprox
template<>
const ipsdk::DataItemLeaf< ipsdk::ipUInt32 > &	getNode () const
	access to sub node NbMinPointForPolygApprox

template<>
ipsdk::DataItemLeaf< ipsdk::ipUInt32 > &	get ()
	access to sub node NbMinPointForPolygApprox

template<>
const ipsdk::ipUInt32 &	getValue () const
	access to value for sub node NbMinPointForPolygApprox

template<>
void	setValue (const ipsdk::ipUInt32 &value)
	access to value for sub node NbMinPointForPolygApprox

Public Member Functions inherited from ipsdk::BaseDataItemNode
eDataItemType	getDataItemType () const

bool	existsItem (const std::string &itemId) const

const BaseDataItem &	getItem (const std::string &itemId) const

const std::string &	getItemName (const std::string &itemId) const

const std::string &	getItemToolTip (const std::string &itemId) 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

Static Public Member Functions
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 data item node

static const std::string	getLibraryNameStr ()
	retrieve library name associated data item node

static boost::shared_ptr< Roughness2dMsrParams >	createNode ()
	node creation function

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 ipsdk::ipUInt32	g_nbChildNodes
	number of child nodes associated to object

Static Public Attributes inherited from ipsdk::BaseDataItemNode
static const bool	g_bIsColl

static const bool	g_bNode

static const bool	g_bLeaf

static const eDataItemType::domain	g_itemType

Protected Member Functions
	Roughness2dMsrParams ()
	protected constructor

Protected Member Functions inherited from ipsdk::BaseDataItemNode
virtual ItemInfoPtr	getItemInfo (const std::string &itemId) 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 Types inherited from ipsdk::BaseDataItemNode
typedef boost::shared_ptr< ItemInfo >	ItemInfoPtr

Detailed Description

Parameter object for measure Roughness2d.

Author: R. Abbal

Date: 2017/08/02

Copyright: 2017 Reactiv'IP, all right reserved.

measure the roughness

Node associated library :

IPSDKIPLShapeAnalysis

SubNodes description

Name	ToolTip	Associated Class	Default Value
ProcessHoles	Flag indicating whether holes should be processed.	ipsdk::DataItemLeaf<ipsdk::ipBool>	false
PolygApproxMaxDist	Maximum distance for the second approximated shape used in the roughness calculation.	ipsdk::DataItemLeaf<ipsdk::ipReal64>	0.
Neighborhood2dType	Neighborhood 2d type for operation.	ipsdk::DataItemEnumLeaf<ipsdk::eNeighborhood2dType>	ipsdk::eNeighborhood2dType::eN2T_8Connexity
NbMinPointForPolygApprox	Minimum number of points needed to trigger polygon approximation.	ipsdk::DataItemLeaf<ipsdk::ipUInt32>	10

Member Function Documentation

◆ getItemIds()

const ipsdk::ItemNames& ipsdk::imaproc::shape::analysis::Roughness2dMsrParams::getItemIds ( ) const

virtual

retrieve item associated to a given id

Exceptions

ipsdk::IPSDKBaseDataException if existsItem(itemName) == false

Implements ipsdk::BaseDataItemNode.

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

/media/reactivipdev/Nightly/IPSDK_Patch/IPSDK_4_1/IPSDK_Nightly/include/public/IPSDKIPL/IPSDKIPLShapeAnalysis/Measure/Geometry/FormFactor/Roughness2d/Roughness2dMsrParams.h

Public Member Functions

Static Public Member Functions

Static Public Attributes

Protected Member Functions

Additional Inherited Members

Detailed Description

Node associated library :

SubNodes description

Member Function Documentation

◆ getItemIds()