Base class for image fragments. More...

#include <BaseImageFragment.h>

Inheritance diagram for ipsdk::image::BaseImageFragment:

Public Member Functions
virtual eImageFragmentType	getImageFragmentType () const =0
	retrieve image fragment type

virtual bool	isInput () const =0
	retrieve fragment input state More...

virtual bool	isOutput () const =0
	retrieve fragment output state More...

bool	isInOut () const
	retrieve fragment in/out state

bool	isInit () const
	retrieve object initialization flag

eDataAccessMode	getDataAccessMode () const
	retrieve flag indicating access mode for an image fragment data More...

bool	hasLocalDataAccess () const
	retrieve flag indicating whether fragment data can locally be accessed More...

bool	isBufferInit () const
	check whether strip buffer has been initialized More...

BoolResult	initBuffer ()
	method allowing to initialize strip buffer More...

void	clearBuffer ()
	method allowing to clear strip buffer More...

bool	isBufferSyncInput () const
	retrieve flag indicating whether buffer has been synchronised from image (read from image storage) More...

bool	isBufferSyncOutput () const
	retrieve flag indicating whether buffer has been synchronised to image (write to image storage) More...

void	clear ()
	clear object initialization data

Constructors and destructors
	BaseImageFragment ()

virtual	~BaseImageFragment ()=0

Image identifier
const Guid &	getGuid () const
	access to image guid More...

const std::string &	getName () const
	access to image name More...

Image header
bool	existsHeaderKey (const std::string &key) const
	check whether a given key exists into header More...

ItemNames	getHeaderKeys () const
	retrieve header key list More...

const BaseDataItem &	getHeaderItem (const std::string &key) const
	retrieve a header item given associated key 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::BaseIOData
virtual eIOStatus	getIOStatus () const =0
	retrieve data input/output status

	BaseIOData ()

virtual	~BaseIOData ()=0

Protected Member Functions
void	initBase (const DataIdentifierConstPtr &pImageIdentifier, const DataItemMapConstPtr &pImageHeader)
	base class initialization method

virtual eDataAccessMode	retrieveAccessMode () const =0
	method allowing to retrieve data access mode associated to fragment

virtual void	clearDerived ()=0
	clear function defined in derived class

virtual bool	isBufferInitDerived () const =0
	check whether strip buffer has been initialized in derived class

virtual BoolResult	initBufferDerived ()=0
	method allowing to initialize strip buffer in derived class

virtual void	clearBufferDerived ()=0
	method allowing to clear strip buffer in derived class

Strip read and write access
BoolResult	readData () const
	read image strip data from image storage More...

virtual BoolResult	readDataDerived () const =0
	read image strip data from image storage in derived class More...

BoolResult	writeData ()
	write image strip data to image storage More...

virtual BoolResult	writeDataDerived ()=0
	write image strip data to image storage in derived class More...

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

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

Detailed Description

Base class for image fragments.

Author: E. Noirfalise

Date: 2014/06/10

Copyright: 2014 Reactiv'IP, all right reserved.

Member Function Documentation

◆ isInput()

virtual bool ipsdk::image::BaseImageFragment::isInput ( ) const

pure virtual

retrieve fragment input state

Note: return true for in/out fragments

Implements ipsdk::BaseIOData.

◆ isOutput()

virtual bool ipsdk::image::BaseImageFragment::isOutput ( ) const

pure virtual

retrieve fragment output state

Note: return true for in/out fragments

Implements ipsdk::BaseIOData.

◆ getGuid()

const Guid& ipsdk::image::BaseImageFragment::getGuid ( ) const

access to image guid

Exceptions

ipsdk::image::IPSDKImageException if isInit() == false

◆ getName()

const std::string& ipsdk::image::BaseImageFragment::getName ( ) const

access to image name

Exceptions

ipsdk::image::IPSDKImageException if isInit() == false

◆ existsHeaderKey()

bool ipsdk::image::BaseImageFragment::existsHeaderKey ( const std::string & key ) const

check whether a given key exists into header

Exceptions

ipsdk::image::IPSDKImageException if isInit() == false

◆ getHeaderKeys()

ItemNames ipsdk::image::BaseImageFragment::getHeaderKeys ( ) const

retrieve header key list

Exceptions

ipsdk::image::IPSDKImageException if isInit() == false

◆ getHeaderItem()

const BaseDataItem& ipsdk::image::BaseImageFragment::getHeaderItem ( const std::string & key ) const

retrieve a header item given associated key

Exceptions

ipsdk::image::IPSDKImageException	if isInit() == false
ipsdk::IPSDKBaseDataException	if existsHeaderKey(key) == false

◆ getDataAccessMode()

eDataAccessMode ipsdk::image::BaseImageFragment::getDataAccessMode ( ) const

retrieve flag indicating access mode for an image fragment data

Exceptions

ipsdk::image::IPSDKImageException if isInit() == false

◆ hasLocalDataAccess()

bool ipsdk::image::BaseImageFragment::hasLocalDataAccess ( ) const

retrieve flag indicating whether fragment data can locally be accessed

Exceptions

ipsdk::image::IPSDKImageException if isInit() == false

◆ isBufferInit()

bool ipsdk::image::BaseImageFragment::isBufferInit ( ) const

check whether strip buffer has been initialized

Exceptions

ipsdk::image::IPSDKImageException if isInit() == false

◆ initBuffer()

BoolResult ipsdk::image::BaseImageFragment::initBuffer ( )

method allowing to initialize strip buffer

Exceptions

ipsdk::image::IPSDKImageException if isInit() == false

◆ clearBuffer()

void ipsdk::image::BaseImageFragment::clearBuffer ( )

method allowing to clear strip buffer

Exceptions

ipsdk::image::IPSDKImageException if isBufferInit() == false

◆ isBufferSyncInput()

bool ipsdk::image::BaseImageFragment::isBufferSyncInput ( ) const

retrieve flag indicating whether buffer has been synchronised from image (read from image storage)

Exceptions

ipsdk::image::IPSDKImageException if isBufferInit() == false

◆ isBufferSyncOutput()

bool ipsdk::image::BaseImageFragment::isBufferSyncOutput ( ) const

retrieve flag indicating whether buffer has been synchronised to image (write to image storage)

Exceptions

ipsdk::image::IPSDKImageException if isBufferInit() == false

◆ readData()

BoolResult ipsdk::image::BaseImageFragment::readData ( ) const

protected

read image strip data from image storage

Exceptions

ipsdk::image::IPSDKImageException	if isBufferInit() == false
ipsdk::image::IPSDKImageException	if hasLocalDataAccess() == false

Returns: false in case of failure

◆ readDataDerived()

virtual BoolResult ipsdk::image::BaseImageFragment::readDataDerived ( ) const

protectedpure virtual

read image strip data from image storage in derived class

Returns: false in case of failure

Implemented in ipsdk::image::BaseImageZStrip3dWithKernel, ipsdk::image::BaseImageXStrip2dWithKernel, ipsdk::image::BaseImageYStrip2dWithKernel, ipsdk::image::BaseImageTile2d, ipsdk::image::BaseImageZStripColor3d, ipsdk::image::BaseImageYStrip2d, ipsdk::image::BaseImageZStrip3d, ipsdk::image::BaseImageYStripColor2d, ipsdk::image::BaseImageTile3d, ipsdk::image::BaseImageYStripSeq2d, ipsdk::image::BaseImageXStrip2d, and ipsdk::image::BaseImageYStrip3d.

◆ writeData()

BoolResult ipsdk::image::BaseImageFragment::writeData ( )

protected

write image strip data to image storage

Exceptions

ipsdk::image::IPSDKImageException	if isBufferInit() == false
ipsdk::image::IPSDKImageException	if hasLocalDataAccess() == false

Returns: false in case of failure

◆ writeDataDerived()

virtual BoolResult ipsdk::image::BaseImageFragment::writeDataDerived ( )

protectedpure virtual

write image strip data to image storage in derived class

Returns: false in case of failure

Implemented in ipsdk::image::BaseImageZStrip3dWithKernel, ipsdk::image::BaseImageXStrip2dWithKernel, ipsdk::image::BaseImageYStrip2dWithKernel, ipsdk::image::BaseImageTile2d, ipsdk::image::BaseImageZStripColor3d, ipsdk::image::BaseImageYStrip2d, ipsdk::image::BaseImageZStrip3d, ipsdk::image::BaseImageYStripColor2d, ipsdk::image::BaseImageTile3d, ipsdk::image::BaseImageYStripSeq2d, ipsdk::image::BaseImageXStrip2d, and ipsdk::image::BaseImageYStrip3d.

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

/media/reactivipdev/Nightly/IPSDK_Patch/IPSDK_4_1/IPSDK_Nightly/include/public/IPSDKImage/Fragment/BaseImageFragment.h

Public Member Functions

Protected Member Functions

Additional Inherited Members

Detailed Description

Member Function Documentation

◆ isInput()

◆ isOutput()

◆ getGuid()

◆ getName()

◆ existsHeaderKey()

◆ getHeaderKeys()

◆ getHeaderItem()

◆ getDataAccessMode()

◆ hasLocalDataAccess()

◆ isBufferInit()

◆ initBuffer()

◆ clearBuffer()

◆ isBufferSyncInput()

◆ isBufferSyncOutput()

◆ readData()

◆ readDataDerived()

◆ writeData()

◆ writeDataDerived()