Base class for processing attributes. More...

#include <BaseAttribute.h>

Inheritance diagram for ipsdk::processor::BaseAttribute:

Public Member Functions
virtual	~BaseAttribute ()=0
	destructor

bool	isInit () const
	retrieve object initialization flag

virtual eAttributeType	getAttributeType () const =0
	retrieve attribute type

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

Protected Member Functions
	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

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

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

Friends
class	BaseProcessor

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

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

Detailed Description

Base class for processing attributes.

Author: E. Noirfalise

Date: 2013/7/30

Copyright: 2013 Reactiv'IP, all right reserved.

Member Function Documentation

◆ isValid()

BoolResult ipsdk::processor::BaseAttribute::isValid ( ) const

test whether rule is valid for current attribute

Exceptions

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

◆ isOutOptionalInitForced()

bool ipsdk::processor::BaseAttribute::isOutOptionalInitForced ( ) const

access to flag allowing to force output optional attribute initialization during processing initialization

This flag can be used to force use of output initializer on output optional attributes

Exceptions

ipsdk::processor::IPSDKBaseProcessingException	if isOptional() == false
ipsdk::processor::IPSDKBaseProcessingException	if isInput() == true

◆ setOutOptionalInitForced()

void ipsdk::processor::BaseAttribute::setOutOptionalInitForced ( bool bOutOptionalInitForced ) const

access to flag allowing to force output optional attribute initialization during processing initialization

This flag can be used to force use of output initializer on output optional attributes

Exceptions

ipsdk::processor::IPSDKBaseProcessingException	if isOptional() == false
ipsdk::processor::IPSDKBaseProcessingException	if isInput() == true

◆ syncInputDerived()

virtual BoolResult ipsdk::processor::BaseAttribute::syncInputDerived ( const Guid & processingSocketGuid )

inlineprotectedvirtual

method allowing to synchronize input attribute data in derived class

Returns: false in case of failure

◆ syncOutputDerived()

virtual BoolResult ipsdk::processor::BaseAttribute::syncOutputDerived ( const Guid & processingSocketGuid )

inlineprotectedvirtual

method allowing to synchronize output attribute data in derived class

Returns: false in case of failure

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

/media/reactivipdev/Nightly/IPSDK_Patch/IPSDK_4_1/IPSDK_Nightly/include/public/IPSDKBaseProcessing/Attribute/Base/BaseAttribute.h

Public Member Functions

Protected Member Functions

Friends

Additional Inherited Members

Detailed Description

Member Function Documentation

◆ isValid()

◆ isOutOptionalInitForced()

◆ setOutOptionalInitForced()

◆ syncInputDerived()

◆ syncOutputDerived()