Base class for image formula attributes. More...

#include <BaseImageFormulaAttribute.h>

Inheritance diagram for ipsdk::imaproc::BaseImageFormulaAttribute:

Public Types
typedef ipsdk::image::tools::ImageFormulaManagerConstPtr	StorageType
	storage type for attribute familly

Public Types inherited from ipsdk::imaproc::BaseFormulaAttribute
typedef std::string	ValueType
	value type for attribute familly

Public Member Functions
virtual	~BaseImageFormulaAttribute ()=0
	destructor

eFormulaAttributeType	getFormulaAttributeType () const
	retrieve formula attribute type

virtual ipsdk::image::tools::eImageFormulaImageType	getImageFormulaImageType () const =0
	retrieve image type associated to formula attribute

void	init (const std::string &formulaStr)
	initialization of object

void	init (const StorageType &pImageFormulaManager)
	object initialization from ImageFormulaManager object More...

StorageType	getStorage () const
	retrieve storage associated to object More...

bool	isValidated () const
	check whether formula associated to attribute has been validated More...

BoolResult	validateFormula () const
	validate formula associated to object More...

const ipsdk::image::tools::ImageFormulaManager &	getImageFormulaManager () const
	retrieve formula manager associated to object More...

Public Member Functions inherited from ipsdk::imaproc::BaseFormulaAttribute
virtual	~BaseFormulaAttribute ()=0
	destructor

eImageProcessingAttributeType	getImageProcessingAttributeType () const
	retrieve image attribute type

const ValueType &	getFormulaStr () const
	get formula string associated to attribute More...

void	initBase (const ValueType &formulaStr)
	base class initialization method

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

	BaseImageProcessingAttribute ()

virtual	~BaseImageProcessingAttribute ()=0

Public Member Functions inherited from ipsdk::processor::BaseAttribute
virtual	~BaseAttribute ()=0
	destructor

bool	isInit () const
	retrieve object initialization flag

virtual const boost::filesystem::path	getHeaderPath () const =0
	retrieve relative header path associated to derived attribute

virtual const std::string	getLibraryName () const =0
	retrieve library name associated to derived attribute

const BaseRule &	getRule () const
	retrieve rule associated to attribute

BoolResult	isValid () const
	test whether rule is valid for current attribute More...

void	clear ()
	reset object intialization flag

bool	isOutOptionalInitForced () const
	access to flag allowing to force output optional attribute initialization during processing initialization More...

void	setOutOptionalInitForced (bool bOutOptionalInitForced) const
	access to flag allowing to force output optional attribute initialization during processing initialization More...

Public Member Functions inherited from ipsdk::BaseObjectWithSkeleton
const eSklSrzMode &	getSerializationMode () const
	retrieve serialization flag for object More...

void	setSerializationMode (const eSklSrzMode &sklSrzMode) const
	set serialization flag for object

	BaseObjectWithSkeleton ()

	~BaseObjectWithSkeleton ()

Public Member Functions inherited from ipsdk::BaseSerializationObject
	BaseSerializationObject ()
	Default constructor.

virtual	~BaseSerializationObject ()=0
	destructor

Public Member Functions inherited from ipsdk::BaseDynamicObject
virtual const std::string &	getClassName () const
	method allowing to retrieve object class name

virtual BaseDynamicObject *	createNew () const =0
	method allowing to create new instance of current object type

virtual DynamicObjectPtr	createShared () const =0
	method allowing to create new shared instance of current object type

virtual bool	hasCopySupport () const =0
	check whether objet has copy support

virtual BaseDynamicObject *	duplicate () const =0
	method allowing to duplicate current object More...

virtual DynamicObjectPtr	duplicateShared () const =0
	method allowing shared duplication of current object More...

	BaseDynamicObject ()

virtual	~BaseDynamicObject ()=0

Public Member Functions inherited from ipsdk::BaseToolTip
virtual const std::string &	getObjectName () const =0
	retrieve object name

virtual const std::string &	getToolTip () const =0
	retrieve object tool tip

	BaseToolTip ()

virtual	~BaseToolTip ()=0

Public Member Functions inherited from ipsdk::BaseIOData
virtual eIOStatus	getIOStatus () const =0
	retrieve data input/output status

virtual bool	isInput () const =0
	retrieve data input status More...

virtual bool	isOutput () const =0
	retrieve data output status More...

virtual bool	isInOut () const =0
	retrieve attribute in/out status

	BaseIOData ()

virtual	~BaseIOData ()=0

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

virtual bool	isMandatory () const =0
	check whether data is mandatory

virtual bool	isOptional () const =0
	check whether data is optional

	BaseOptData ()

virtual	~BaseOptData ()=0

Static Public Attributes
static const eFormulaAttributeType::domain	g_formulaAttributeType = eFormulaAttributeType::eFAT_Image
	image processing attribute type

static const bool	g_hasValueInit = true
	flag indicating that this attribute has a by value initializer

Static Public Attributes inherited from ipsdk::imaproc::BaseFormulaAttribute
static const eImageProcessingAttributeType::domain	g_imageProcessingAttributeType = eImageProcessingAttributeType::eIPAT_Formula
	image processing attribute type

Static Public Attributes inherited from ipsdk::imaproc::BaseImageProcessingAttribute
static const processor::eAttributeType::domain	g_attributeType = processor::eAttributeType::eAT_ImageProcessing
	type associated to attribute

Protected Member Functions
	BaseImageFormulaAttribute ()
	constructor

void	clearDerived ()
	method allowing to clear data in derived class

Protected Member Functions inherited from ipsdk::imaproc::BaseFormulaAttribute
	BaseFormulaAttribute ()
	constructor

Protected Member Functions inherited from ipsdk::processor::BaseAttribute
	BaseAttribute ()
	constructor

void	initBase ()
	base class initialization method

virtual BoolResult	syncInputDerived (const Guid &processingSocketGuid)

virtual BoolResult	syncOutputDerived (const Guid &processingSocketGuid)

virtual RulePtr	createRule (const AttributePtr &pBaseThis) const =0
	method allowing to create rule associated to object

Protected Member Functions inherited from ipsdk::BaseSerializationObject
virtual BoolResult	write (BaseOArchive &ar) const
	method allowing to ensure serialization write part for object

virtual BoolResult	read (BaseIArchive &ar)
	method allowing to ensure serialization read part for object

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

virtual void	copy (const BaseDynamicObject &object)
	method allowing to copy data from another object

Protected Attributes
ipsdk::image::tools::ImageFormulaManagerPtr	_pImageFormulaManager
	shared pointer to formula data manager

Protected Attributes inherited from ipsdk::imaproc::BaseFormulaAttribute
ValueType	_formulaStr
	formula associated to attribute

Protected Attributes inherited from ipsdk::BaseObjectWithSkeleton
eSklSrzMode	_sklSrzMode
	serialization flag for object More...

Additional Inherited Members
Static Public Member Functions inherited from ipsdk::BaseSerializationObject
static ipUInt32	getVersion ()
	method allowing to retrieve class version information for serialization

Static Public Member Functions inherited from ipsdk::BaseDynamicObject
static const std::string &	getTypeName ()
	method allowing to retrieve name associated to class

Detailed Description

Base class for image formula attributes.

Author: E.Noirfalise

Date: 2017/03/17

Copyright: 2017 Reactiv'IP, all right reserved.

Member Function Documentation

◆ init()

void ipsdk::imaproc::BaseImageFormulaAttribute::init ( const StorageType & pImageFormulaManager )

object initialization from ImageFormulaManager object

Exceptions

ipsdk::processor::IPSDKBaseProcessingException	if pImageFormulaManager.get() == 0
ipsdk::imaproc::IPSDKImageProcessingException	if pImageFormulaManager->isInit() == false

◆ getStorage()

StorageType ipsdk::imaproc::BaseImageFormulaAttribute::getStorage ( ) const

retrieve storage associated to object

Exceptions

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

◆ isValidated()

bool ipsdk::imaproc::BaseImageFormulaAttribute::isValidated ( ) const

check whether formula associated to attribute has been validated

Exceptions

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

◆ validateFormula()

BoolResult ipsdk::imaproc::BaseImageFormulaAttribute::validateFormula ( ) const

validate formula associated to object

Returns: false in case of failure

Exceptions

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

◆ getImageFormulaManager()

const ipsdk::image::tools::ImageFormulaManager& ipsdk::imaproc::BaseImageFormulaAttribute::getImageFormulaManager ( ) const

retrieve formula manager associated to object

Exceptions

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

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

/media/reactivipdev/Nightly/IPSDK_Patch/IPSDK_4_1/IPSDK_Nightly/include/public/IPSDKImageProcessing/Attribute/Formula/BaseImageFormulaAttribute.h

Public Types

Public Member Functions

Static Public Attributes

Protected Member Functions

Protected Attributes

Additional Inherited Members

Detailed Description

Member Function Documentation

◆ init()

◆ getStorage()

◆ isValidated()

◆ validateFormula()

◆ getImageFormulaManager()