Base class used to store data item nodes collection. More...

Inheritance diagram for ipsdk::BaseDataItemNodeColl:

Public Types
typedef std::vector< DataItemNodePtr >	BaseCollType
	collection of nodes shared pointers

Public Member Functions
eDataItemType	getDataItemType () const
	retrieve data item type

bool	isEmpty () const
	check whether collection is empty

ipUInt32	getSize () const
	retrieve collection size

const BaseCollType &	getBaseColl () const
	retrieve base collection

void	clear ()
	remove all items from collection

Constructors and destructors
	BaseDataItemNodeColl ()

	~BaseDataItemNodeColl ()

Public Member Functions inherited from ipsdk::BaseDataItem
	BaseDataItem ()

virtual	~BaseDataItem ()=0

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

Static Public Attributes

static const bool	g_bIsColl = true
	flags indicating item type

static const bool	g_bNode = true
	flags indicating item type

static const bool	g_bLeaf = false
	flags indicating item type

static const eDataItemType::domain	g_itemType = eDataItemType::eDIT_NodeColl
	flags indicating item type

Protected Member Functions
void	push_back (const DataItemNodePtr &pItemNode)
	push back a new element into collection More...


const BaseDataItemNode &	getNodeBase (const ipUInt32 nodeIdx) const
	retrieve node associated to given index More...

BaseDataItemNode &	getNodeBase (const ipUInt32 nodeIdx)
	retrieve node associated to given 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
BaseCollType	_coll
	collection of nodes associated to 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

Detailed Description

Base class used to store data item nodes collection.

Member Function Documentation

const BaseDataItemNode& ipsdk::BaseDataItemNodeColl::getNodeBase ( const ipUInt32 nodeIdx ) const

protected

retrieve node associated to given index

Exceptions

ipsdk::IPSDKBaseDataException if nodeIdx >= getSize()

BaseDataItemNode& ipsdk::BaseDataItemNodeColl::getNodeBase ( const ipUInt32 nodeIdx )

protected

retrieve node associated to given index

Exceptions

ipsdk::IPSDKBaseDataException if nodeIdx >= getSize()

void ipsdk::BaseDataItemNodeColl::push_back ( const DataItemNodePtr & pItemNode )

protected

push back a new element into collection

Exceptions

ipsdk::IPSDKBaseDataException if pItem->get() == 0

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

/media/reactivipdev/Nightly/IPSDK_Patch/IPSDK_4_1/IPSDK_Nightly/include/public/IPSDKBaseData/DataItem/NodeColl/BaseDataItemNodeColl.h