Base class for in/out attributes associated to collection of image 3d tile. More...

#include <BaseInOutTile3dCollAttribute.h>

Inheritance diagram for ipsdk::imaproc::BaseInOutTile3dCollAttribute:

Public Types
typedef image::InOutImageTile3d	TileType
	tile type associated to object

typedef std::vector< image::InOutImageTile3dPtr >	ValueType
	value type associated to object

typedef std::vector< image::InOutImageTile3dPtr >	StorageType
	storage type associated to object

typedef std::vector< image::InOutImageTile3dConstPtr >	ConstStorageType
	const storage type associated to object

Public Types inherited from ipsdk::imaproc::BaseTileCollAttribute
typedef std::vector< image::ImageTileConstPtr >	ImageTileConstColl
	collection of shared pointer to const base tile object

typedef std::vector< image::ImageTilePtr >	ImageTileColl
	collection of shared pointer to base tile object

Public Member Functions
virtual	~BaseInOutTile3dCollAttribute ()=0
	destructor

void	init (const StorageType &imageTileColl)
	initialize collection of image 3d tiles associated to attribute More...


const image::InOutImageTile3d &	getImageTile3d (const ipUInt32 tileIdx) const
	get image tile 3d associated to attribute More...

image::InOutImageTile3d &	getImageTile3d (const ipUInt32 tileIdx)
	get image tile 3d associated to attribute More...


const ConstStorageType &	getStorage () const
	access to storage associated to attribute More...

const StorageType &	getStorage ()
	access to storage associated to attribute More...

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

eTileCollAttributeType	getTileCollAttributeType () const
	retrieve tile attribute type

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

eImageProcessingAttributeType	getImageProcessingAttributeType () const
	retrieve image attribute type

ipUInt32	getNbTiles () const
	retrieve number of tiles into collection

const ImageTileConstColl &	getImageTileColl () const
	get collection of image tile associated to attribute More...

const image::BaseImageTile &	getImageTile (const ipUInt32 tileIdx) const
	retrieve image tile associated to a given index More...

bool	haveSameBufferType () const
	method allowing to check whether all tiles associated to attribute share same buffer type More...

image::eImageBufferType	getImageBufferType () const
	method allowing to buffer type associated to tiles associated to attribute More...

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

Protected Member Functions
	BaseInOutTile3dCollAttribute ()
	constructor

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

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

void	initBase (const ImageTileColl &imageTileColl)
	base class initialization method More...

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

const ImageTileConstColl &	accessImageTileColl () const
	retrieve collection of image tile associated to attribute More...

const ImageTileColl &	accessImageTileColl ()
	retrieve collection of image tile associated to attribute More...

const image::BaseImageTile &	accessImageTile (const ipUInt32 tileIdx) const
	access to image tile associated to a given index More...

image::BaseImageTile &	accessImageTile (const ipUInt32 tileIdx)
	access to image tile associated to a given index More...

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

void	initBase ()
	base class initialization method

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

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

Static Public Attributes inherited from ipsdk::imaproc::BaseTile3dCollAttribute
static const eTileCollAttributeType::domain	g_tileCollAttributeType = eTileCollAttributeType::eTCAT_3d
	tile attribute type

Static Public Attributes inherited from ipsdk::imaproc::BaseTileCollAttribute
static const eImageProcessingAttributeType::domain	g_imageProcessingAttributeType = eImageProcessingAttributeType::eIPAT_TileColl
	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 Attributes inherited from ipsdk::BaseObjectWithSkeleton
eSklSrzMode	_sklSrzMode
	serialization flag for object More...

Detailed Description

Base class for in/out attributes associated to collection of image 3d tile.

Author: E.Noirfalise

Date: 2017/04/11

Copyright: 2017 Reactiv'IP, all right reserved.

Member Function Documentation

◆ init()

void ipsdk::imaproc::BaseInOutTile3dCollAttribute::init ( const StorageType & imageTileColl )

initialize collection of image 3d tiles associated to attribute

Exceptions

ipsdk::imaproc::IPSDKImageProcessingException	if imageTileColl.empty() == true
ipsdk::imaproc::IPSDKImageProcessingException	if collection contains null shared pointers
ipsdk::imaproc::IPSDKImageProcessingException	if collection contains un initialized tiles

◆ getImageTile3d() [1/2]

const image::InOutImageTile3d& ipsdk::imaproc::BaseInOutTile3dCollAttribute::getImageTile3d ( const ipUInt32 tileIdx ) const

get image tile 3d associated to attribute

Exceptions

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

◆ getImageTile3d() [2/2]

image::InOutImageTile3d& ipsdk::imaproc::BaseInOutTile3dCollAttribute::getImageTile3d ( const ipUInt32 tileIdx )

get image tile 3d associated to attribute

Exceptions

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

◆ getStorage() [1/2]

const ConstStorageType& ipsdk::imaproc::BaseInOutTile3dCollAttribute::getStorage ( ) const

access to storage associated to attribute

Exceptions

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

◆ getStorage() [2/2]

const StorageType& ipsdk::imaproc::BaseInOutTile3dCollAttribute::getStorage ( )

access to storage associated to attribute

Exceptions

ipsdk::processor::IPSDKBaseProcessingException if isInit() == 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/TileColl/Tile3dColl/BaseInOutTile3dCollAttribute.h

Public Types

Public Member Functions

Protected Member Functions

Additional Inherited Members

Detailed Description

Member Function Documentation

◆ init()

◆ getImageTile3d() [1/2]

◆ getImageTile3d() [2/2]

◆ getStorage() [1/2]

◆ getStorage() [2/2]