ipsdk::image::ImagePlanGeometry Class Reference

Class encapsulating image plan geometry. More...

#include <ImagePlanGeometry.h>

Inheritance diagram for ipsdk::image::ImagePlanGeometry:

Public Member Functions
bool	isInit () const
	retrieve object initialisation flag
void	init (const ipUInt64 sizeX, const ipUInt64 sizeY, const eImageBufferType &imageBufferType)
	initialization of object More...
ipUInt64	getSizeX () const
	retrieve plan x size for geometry More...
ipUInt64	getSizeY () const
	retrieve plan y size for geometry More...
ipUInt64	getNbPixels () const
	retrieve number of pixels for plan geometry More...
bool	isInside (const ipUInt64 x, const ipUInt64 y) const
	check whether a pixel coordinate is inside geometry More...
const eImageBufferType &	getBufferType () const
	retrieve image data type More...
ipUInt64	getFullMemorySize () const
	retrieve image plan full memory size More...
void	resize (const ipUInt64 sizeX, const ipUInt64 sizeY)
	change geometry dimensions More...
void	resize (const ipUInt64 sizeX, const ipUInt64 sizeY, const eImageBufferType &imageBufferType)
	change geometry dimensions and image buffer type More...
void	setImageBufferType (const eImageBufferType &imageBufferType)
	change image buffer type associated to plan More...
void	clear ()
	clear object data
Constructors and destructors
	ImagePlanGeometry ()
	~ImagePlanGeometry ()
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

Protected Attributes
ipUInt64	_sizeX
	x size for image plan
ipUInt64	_sizeY
	y size for image plan
eImageBufferType	_imageBufferType
	image data type
bool	_bInit
	object initialization flag

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 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

Detailed Description

Class encapsulating image plan geometry.

Author

E. Noirfalise

Date

2014/06/06

Copyright

2014 Reactiv'IP, all right reserved.

Member Function Documentation

init()

void ipsdk::image::ImagePlanGeometry::init	(	const ipUInt64	sizeX,
		const ipUInt64	sizeY,
		const eImageBufferType &	imageBufferType
	)

initialization of object

Exceptions

ipsdk::image::IPSDKImageException

if imageBufferType == eImageBufferType::eIBT_None

getSizeX()

ipUInt64 ipsdk::image::ImagePlanGeometry::getSizeX

(

)

const

retrieve plan x size for geometry

Exceptions

ipsdk::image::IPSDKImageException

if isInit() == false

getSizeY()

ipUInt64 ipsdk::image::ImagePlanGeometry::getSizeY

(

)

const

retrieve plan y size for geometry

Exceptions

ipsdk::image::IPSDKImageException

if isInit() == false

getNbPixels()

ipUInt64 ipsdk::image::ImagePlanGeometry::getNbPixels

(

)

const

retrieve number of pixels for plan geometry

Exceptions

ipsdk::image::IPSDKImageException

if isInit() == false

isInside()

bool ipsdk::image::ImagePlanGeometry::isInside	(	const ipUInt64	x,
		const ipUInt64	y
	)		const

check whether a pixel coordinate is inside geometry

Exceptions

ipsdk::image::IPSDKImageException

if isInit() == false

getBufferType()

const eImageBufferType& ipsdk::image::ImagePlanGeometry::getBufferType

(

)

const

retrieve image data type

Exceptions

ipsdk::image::IPSDKImageException

if isInit() == false

getFullMemorySize()

ipUInt64 ipsdk::image::ImagePlanGeometry::getFullMemorySize

(

)

const

retrieve image plan full memory size

Exceptions

ipsdk::image::IPSDKImageException

if isInit() == false

resize() [1/2]

void ipsdk::image::ImagePlanGeometry::resize	(	const ipUInt64	sizeX,
		const ipUInt64	sizeY
	)

change geometry dimensions

Exceptions

ipsdk::image::IPSDKImageException

if isInit() == false

resize() [2/2]

void ipsdk::image::ImagePlanGeometry::resize	(	const ipUInt64	sizeX,
		const ipUInt64	sizeY,
		const eImageBufferType &	imageBufferType
	)

change geometry dimensions and image buffer type

Exceptions

ipsdk::image::IPSDKImageException	if isInit() == false
ipsdk::image::IPSDKImageException	if imageBufferType == eImageBufferType::eIBT_None

setImageBufferType()

void ipsdk::image::ImagePlanGeometry::setImageBufferType

(

const eImageBufferType &

imageBufferType

)

change image buffer type associated to plan

Exceptions

ipsdk::image::IPSDKImageException

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/IPSDKImage/Geometry/Plan/ImagePlanGeometry.h