[Input] collection of distances between successive z-plans of the image More...

#include <InZSteps.h>

Inheritance diagram for ipsdk::imaproc::attr::InZSteps:

Public Types
typedef ipsdk::imaproc::attr::ZSteps	ValueType
	Type of node associated to attribute.

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

Public Member Functions
	~InZSteps ()
	destructor

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

const std::string &	getNodeType () const
	Retrieve node type associated to attribute.

void	init (const ValueType &dataItemNode)
	By value attribute initialization.

void	init (const StorageType &pDataItemNode)
	By reference attribute initialization.

const ValueType &	getNode () const
	Retrieve node associated to attribute.

StorageType	getStorage ()
	access to storage associated to attribute

Public Member Functions inherited from ipsdk::processor::BaseInputMandatoryDataItemAttribute
const BaseDataItemNode &	getDataItemNode () const

Public Member Functions inherited from ipsdk::processor::BaseDataItemAttribute
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::BaseIOData
virtual eIOStatus	getIOStatus () const=0

virtual bool	isInput () const=0

virtual bool	isOutput () const=0

virtual bool	isInOut () const=0

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

virtual bool	isMandatory () const=0

virtual bool	isOptional () const=0

Static Public Member Functions
static boost::shared_ptr< InZSteps >	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 const std::string &	getNodeTypeStr ()
	Retrieve node type associated to 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 ()

Protected Member Functions
	InZSteps ()
	constructor

Protected Member Functions inherited from ipsdk::processor::BaseDataItemAttribute
void	initBase (const DataItemNodePtr &pDataItemNode)

bool	isDataItemNodePtrSet () const

void	clearDerived ()

DataItemNodeConstPtr	accessDataItemNodePtr () const

DataItemNodePtr	accessDataItemNodePtr ()

DataItemNodeConstPtr	accessDataItemNodePtr () const

DataItemNodePtr	accessDataItemNodePtr ()

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
Static Public Attributes inherited from ipsdk::processor::BaseDataItemAttribute
static const eAttributeType::domain	g_attributeType

Protected Attributes inherited from ipsdk::BaseObjectWithSkeleton
eSklSrzMode	_sklSrzMode

Detailed Description

[Input] collection of distances between successive z-plans of the image

Author: H. Delestre

Date: 2016/11/25

Copyright: 2016 Reactiv'IP, all right reserved.

Associated node :

This attribute is associated to node ipsdk::imaproc::attr::ZSteps

Attribute associated library :

IPSDKIPLAttributes

Attribute rule :

Rule on attribute is given by
((ipsdk::processor::isGreater<ZSteps::StepsColl>(attribute,0)) && (ipsdk::processor::isNotEmpty<ZSteps::StepsColl>(attribute)))

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/InZSteps.h

Public Types

Public Member Functions

Static Public Member Functions

Protected Member Functions

Additional Inherited Members

Detailed Description

Associated node :

Attribute associated library :

Attribute rule :