Template class used to store collection of objects indexed by plan. More...

#include <PlanIndexedColl.h>

Inheritance diagram for ipsdk::PlanIndexedColl< T >:

Public Types
typedef T	ValueType

typedef boost::shared_ptr< T >	StorageType

typedef boost::shared_ptr< const T >	ConstStorageType

Public Types inherited from ipsdk::BasePlanIndexedColl
typedef std::map< PlanIndex, SerializationObjectPtr >	PlanIndexedColl
	collection of plan indexed serializable object shared pointers

typedef std::map< PlanIndex, SerializationObjectConstPtr >	PlanIndexedConstColl
	collection of plan indexed serializable object shared pointers

Public Member Functions
const std::string &	getElementsClassName () const
	retrieve class name associated to concrete elements into collection

bool	haveSkeleton () const

void	insert (const ipsdk::PlanIndex &planIndex, const StorageType &pObject)

void	insert (const ipsdk::ipUInt64 zPlanIdx, const ipsdk::ipUInt64 cPlanIdx, const ipsdk::ipUInt64 tPlanIdx, const StorageType &pObject)

void	assign (const T &object, const ipUInt64 sizeZ, const ipUInt64 sizeC, const ipUInt64 sizeT)
	assign a given value to all data of collection More...

ConstStorageType	getStorage (const ipsdk::PlanIndex &planIndex) const
	retrieve an element associated to a given plan index More...

ConstStorageType	getStorage (const ipsdk::ipUInt64 zPlanIdx, const ipsdk::ipUInt64 cPlanIdx, const ipsdk::ipUInt64 tPlanIdx) const
	retrieve an element associated to a given plan index More...

StorageType	getStorage (const ipsdk::PlanIndex &planIndex)
	retrieve an element associated to a given plan index More...

StorageType	getStorage (const ipsdk::ipUInt64 zPlanIdx, const ipsdk::ipUInt64 cPlanIdx, const ipsdk::ipUInt64 tPlanIdx)
	retrieve an element associated to a given plan index More...

const ValueType &	getValue (const ipsdk::PlanIndex &planIndex) const
	retrieve an element associated to a given plan index More...

const ValueType &	getValue (const ipsdk::ipUInt64 zPlanIdx, const ipsdk::ipUInt64 cPlanIdx, const ipsdk::ipUInt64 tPlanIdx) const
	retrieve an element associated to a given plan offset More...

const ValueType &	getValue (const ipsdk::ipUInt64 planOffset) const
	retrieve an element associated to a given plan index More...

ValueType &	getValue (const ipsdk::PlanIndex &planIndex)
	retrieve an element associated to a given plan index More...

ValueType &	getValue (const ipsdk::ipUInt64 zPlanIdx, const ipsdk::ipUInt64 cPlanIdx, const ipsdk::ipUInt64 tPlanIdx)
	retrieve an element associated to a given plan index More...

ValueType &	getValue (const ipsdk::ipUInt64 planOffset)
	retrieve an element associated to a given plan index More...

Constructors and destructor
	PlanIndexedColl ()

	~PlanIndexedColl ()

Public Member Functions inherited from ipsdk::BasePlanIndexedColl
const PlanIndexedConstColl &	getBaseColl () const
	retrieve base object collection

ipUInt64	getNbPlans () const
	retrieve number of plan indexes

bool	isComplete () const
	check whether collection is complete for maximum size along each direction

bool	isComplete (const ipUInt64 sizeZ, const ipUInt64 sizeC, const ipUInt64 sizeT) const
	check whether collection is complete given a number of plans

const PlanIndex &	getPlanIndex (const ipUInt64 planOffset) const
	retrieve plan index associated to a given plan offset More...

void	clear ()
	clear object data

	BasePlanIndexedColl ()

virtual	~BasePlanIndexedColl ()=0

ipUInt64	getMaxSizeZ () const
	retrieve maximum size of collection along each directions

ipUInt64	getMaxSizeC () const
	retrieve maximum size of collection along each directions

ipUInt64	getMaxSizeT () const
	retrieve maximum size of collection along each directions

bool	exists (const PlanIndex &planIndex) const
	check whether an element is available for a given plan index

bool	exists (const ipUInt64 zPlanIdx, const ipUInt64 cPlanIdx, const ipUInt64 tPlanIdx) const
	check whether an element is available for a given plan index

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

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::BasePlanIndexedColl
void	insert (const PlanIndex &planIndex, const SerializationObjectPtr &pObject)
	insert a new element for a given plan index More...

void	assign (const BaseSerializationObject &object, const ipUInt64 sizeZ, const ipUInt64 sizeC, const ipUInt64 sizeT)
	assign a given value to all data of collection More...

SerializationObjectConstPtr	getStorage (const PlanIndex &planIndex) const
	retrieve an element associated to a given plan index More...

const SerializationObjectPtr &	getStorage (const PlanIndex &planIndex)
	retrieve an element associated to a given plan index 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

Protected Attributes inherited from ipsdk::BasePlanIndexedColl
PlanIndexedColl	_planIndexedColl
	collection of plan indexed elements associated to attribute

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

Detailed Description

template<typename T>
class ipsdk::PlanIndexedColl< T >

Template class used to store collection of objects indexed by plan.

Author: E. Noirfalise

Date: 2015/12/04

Copyright: 2015 Reactiv'IP, all right reserved.

Member Function Documentation

◆ haveSkeleton()

template<typename T >

bool ipsdk::PlanIndexedColl< T >::haveSkeleton ( ) const

inlinevirtual

method allowing to check whether type of collection elements is associated to a skeleton

Implements ipsdk::BasePlanIndexedColl.

◆ insert() [1/2]

template<typename T >

void ipsdk::PlanIndexedColl< T >::insert	(	const ipsdk::PlanIndex &	planIndex,
		const StorageType &	pObject
	)

inline

Exceptions

ipsdk::IPSDKBaseDataException	if pObject.get() == 0
ipsdk::IPSDKBaseDataException	if exists(planIndex) == true

◆ insert() [2/2]

template<typename T >

void ipsdk::PlanIndexedColl< T >::insert	(	const ipsdk::ipUInt64	zPlanIdx,
		const ipsdk::ipUInt64	cPlanIdx,
		const ipsdk::ipUInt64	tPlanIdx,
		const StorageType &	pObject
	)

inline

Exceptions

ipsdk::IPSDKBaseDataException	if pObject.get() == 0
ipsdk::IPSDKBaseDataException	if exists(zPlanIdx, cPlanIdx, tPlanIdx) == true

◆ assign()

template<typename T>

void ipsdk::PlanIndexedColl< T >::assign	(	const T &	object,
		const ipUInt64	sizeZ,
		const ipUInt64	sizeC,
		const ipUInt64	sizeT
	)

inline

assign a given value to all data of collection

Exceptions

ipsdk::eIPSDKUtilErrors if object.hasCopySupport() == false

◆ getStorage() [1/4]

template<typename T >

PlanIndexedColl< T >::ConstStorageType ipsdk::PlanIndexedColl< T >::getStorage ( const ipsdk::PlanIndex & planIndex ) const

inline

retrieve an element associated to a given plan index

Exceptions

ipsdk::IPSDKBaseDataException if exists(planIndex) == false

◆ getStorage() [2/4]

template<typename T >

PlanIndexedColl< T >::ConstStorageType ipsdk::PlanIndexedColl< T >::getStorage	(	const ipsdk::ipUInt64	zPlanIdx,
		const ipsdk::ipUInt64	cPlanIdx,
		const ipsdk::ipUInt64	tPlanIdx
	)		const

inline

retrieve an element associated to a given plan index

Exceptions

ipsdk::IPSDKBaseDataException if exists(zPlanIdx, cPlanIdx, tPlanIdx) == false

◆ getStorage() [3/4]

template<typename T >

PlanIndexedColl< T >::StorageType ipsdk::PlanIndexedColl< T >::getStorage ( const ipsdk::PlanIndex & planIndex )

inline

retrieve an element associated to a given plan index

Exceptions

ipsdk::IPSDKBaseDataException if exists(planIndex) == false

◆ getStorage() [4/4]

template<typename T >

PlanIndexedColl< T >::StorageType ipsdk::PlanIndexedColl< T >::getStorage	(	const ipsdk::ipUInt64	zPlanIdx,
		const ipsdk::ipUInt64	cPlanIdx,
		const ipsdk::ipUInt64	tPlanIdx
	)

inline

retrieve an element associated to a given plan index

Exceptions

ipsdk::IPSDKBaseDataException if exists(zPlanIdx, cPlanIdx, tPlanIdx) == false

◆ getValue() [1/6]

template<typename T >

const PlanIndexedColl< T >::ValueType & ipsdk::PlanIndexedColl< T >::getValue ( const ipsdk::PlanIndex & planIndex ) const

inline

retrieve an element associated to a given plan index

Exceptions

ipsdk::IPSDKBaseDataException if exists(planIndex) == false

◆ getValue() [2/6]

template<typename T >

const PlanIndexedColl< T >::ValueType & ipsdk::PlanIndexedColl< T >::getValue	(	const ipsdk::ipUInt64	zPlanIdx,
		const ipsdk::ipUInt64	cPlanIdx,
		const ipsdk::ipUInt64	tPlanIdx
	)		const

inline

retrieve an element associated to a given plan offset

Exceptions

ipsdk::IPSDKBaseDataException if exists(zPlanIdx, cPlanIdx, tPlanIdx) == false

◆ getValue() [3/6]

template<typename T >

const PlanIndexedColl< T >::ValueType & ipsdk::PlanIndexedColl< T >::getValue ( const ipsdk::ipUInt64 planOffset ) const

inline

retrieve an element associated to a given plan index

Exceptions

ipsdk::IPSDKBaseDataException if planOffset >= getNbPlans()

◆ getValue() [4/6]

template<typename T >

PlanIndexedColl< T >::ValueType & ipsdk::PlanIndexedColl< T >::getValue ( const ipsdk::PlanIndex & planIndex )

inline

retrieve an element associated to a given plan index

Exceptions

ipsdk::IPSDKBaseDataException if exists(planIndex) == false

◆ getValue() [5/6]

template<typename T >

PlanIndexedColl< T >::ValueType & ipsdk::PlanIndexedColl< T >::getValue	(	const ipsdk::ipUInt64	zPlanIdx,
		const ipsdk::ipUInt64	cPlanIdx,
		const ipsdk::ipUInt64	tPlanIdx
	)

inline

retrieve an element associated to a given plan index

Exceptions

ipsdk::IPSDKBaseDataException if exists(zPlanIdx, cPlanIdx, tPlanIdx) == false

◆ getValue() [6/6]

template<typename T >

PlanIndexedColl< T >::ValueType & ipsdk::PlanIndexedColl< T >::getValue ( const ipsdk::ipUInt64 planOffset )

inline

retrieve an element associated to a given plan index

Exceptions

ipsdk::IPSDKBaseDataException if planOffset >= getNbPlans()

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

/media/reactivipdev/Nightly/IPSDK_Patch/IPSDK_4_1/IPSDK_Nightly/include/public/IPSDKBaseData/PlanIndex/PlanIndexedColl.h

Public Types

Public Member Functions

Additional Inherited Members

Detailed Description

template<typename T> class ipsdk::PlanIndexedColl< T >

Member Function Documentation

◆ haveSkeleton()

◆ insert() [1/2]

◆ insert() [2/2]

◆ assign()

◆ getStorage() [1/4]

◆ getStorage() [2/4]

◆ getStorage() [3/4]

◆ getStorage() [4/4]

◆ getValue() [1/6]

◆ getValue() [2/6]

◆ getValue() [3/6]

◆ getValue() [4/6]

◆ getValue() [5/6]

◆ getValue() [6/6]

template<typename T>
class ipsdk::PlanIndexedColl< T >