ipsdk::image::VolumeGeometry Class Reference

Class encapsulating volume geometryThis class allows to define geometry volume size and type (2d or 3d) More...

#include <VolumeGeometry.h>

Inheritance diagram for ipsdk::image::VolumeGeometry:

Public Member Functions
bool	isInit () const
	retrieve object initialisation flag
void	init2d ()
	initialize object with 2d volume geometry
void	init3d (ipUInt64 sizeZ)
	initialize object with 3d volume geometry More...
const eVolumeGeometryType &	getVolumeGeometryType () const
	retrieve volume geometry type More...
bool	is2d () const
	test whether object is associated to a 2d volume geometry More...
bool	is3d () const
	test whether object is associated to a 3d volume geometry More...
ipUInt64	getSizeZ () const
	retrieve z size associated to object More...
void	setVolumeGeometryType (const eVolumeGeometryType &vType)
	Setter of geometry type : More...
void	clear ()
	clear object data
Constructors and destructors
	VolumeGeometry ()
	~VolumeGeometry ()
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
eVolumeGeometryType	_volumeGeometryType
	volume geometry type associated to object
ipUInt64	_sizeZ
	z size associated to object
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 volume geometry

This class allows to define geometry volume size and type (2d or 3d)

Author

E. Noirfalise

Date

2013/8/21

Copyright

2013 Reactiv'IP, all right reserved.

Member Function Documentation

init3d()

void ipsdk::image::VolumeGeometry::init3d

(

ipUInt64

sizeZ

)

initialize object with 3d volume geometry

Exceptions

ipsdk::image::IPSDKImageException

if sizeZ == 0

getVolumeGeometryType()

const eVolumeGeometryType& ipsdk::image::VolumeGeometry::getVolumeGeometryType

(

)

const

retrieve volume geometry type

Exceptions

ipsdk::image::IPSDKImageException

if isInit() == false

is2d()

bool ipsdk::image::VolumeGeometry::is2d

(

)

const

test whether object is associated to a 2d volume geometry

Exceptions

ipsdk::image::IPSDKImageException

if isInit() == false

is3d()

bool ipsdk::image::VolumeGeometry::is3d

(

)

const

test whether object is associated to a 3d volume geometry

Exceptions

ipsdk::image::IPSDKImageException

if isInit() == false

getSizeZ()

ipUInt64 ipsdk::image::VolumeGeometry::getSizeZ

(

)

const

retrieve z size associated to object

Exceptions

ipsdk::image::IPSDKImageException

if isInit() == false

setVolumeGeometryType()

void ipsdk::image::VolumeGeometry::setVolumeGeometryType

(

const eVolumeGeometryType &

vType

)

Setter of geometry type :

• allow to switch from 3D to 2D if sizeZ == 1 or from 2D to 3D regardless of sizeZ

  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/Component/VolumeGeometry.h