ipsdk::DataItemNodeColl< TNodeType > Class Template Reference

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

#include <DataItemNodeColl.h>

Inheritance diagram for ipsdk::DataItemNodeColl< TNodeType >:

Public Types
typedef TNodeType	NodeType
	node type associated to object
typedef boost::shared_ptr< NodeType >	NodePtrType
	node shared pointer type associated to object
typedef std::vector< NodePtrType >	CollType
	collection type associated to object
Public Types inherited from ipsdk::BaseDataItemNodeColl
typedef std::vector< DataItemNodePtr >	BaseCollType
	collection of nodes shared pointers

Public Member Functions
const CollType &	getColl () const
	get data item node collection associated to object
CollType &	getColl ()
	get data item node collection associated to object
void	push_back (const NodePtrType &pItemNode)
	push back a new element into collection More...
Constructors and destructors
	DataItemNodeColl ()
	~DataItemNodeColl ()
const NodeType &	getNode (const ipUInt32 nodeIdx) const
	retrieve node associated to given index More...
NodeType &	getNode (const ipUInt32 nodeIdx)
	retrieve node associated to given index More...
Public Member Functions inherited from ipsdk::BaseDataItemNodeColl
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
	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

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
Static Public Attributes inherited from ipsdk::BaseDataItemNodeColl
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 inherited from ipsdk::BaseDataItemNodeColl
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 inherited from ipsdk::BaseDataItemNodeColl
BaseCollType	_coll
	collection of nodes associated to object

Detailed Description

template<typename TNodeType>
class ipsdk::DataItemNodeColl< TNodeType >

Template class used to store data item nodes collection.

Author

E. Noirfalise

Date

2014/03/10

Copyright

2014 Reactiv'IP, all right reserved.

Member Function Documentation

getNode() [1/2]

template<typename TNodeType >

const DataItemNodeColl< TNodeType >::NodeType & ipsdk::DataItemNodeColl< TNodeType >::getNode

(

const ipUInt32

nodeIdx

)

const

retrieve node associated to given index

Exceptions

ipsdk::IPSDKBaseDataException

if nodeIdx >= getSize()

getNode() [2/2]

template<typename TNodeType >

DataItemNodeColl< TNodeType >::NodeType & ipsdk::DataItemNodeColl< TNodeType >::getNode

(

const ipUInt32

nodeIdx

)

retrieve node associated to given index

Exceptions

ipsdk::IPSDKBaseDataException

if nodeIdx >= getSize()

push_back()

template<typename TNodeType >

void ipsdk::DataItemNodeColl< TNodeType >::push_back ( const NodePtrType &  pItemNode )

inline

push back a new element into collection

Exceptions

ipsdk::IPSDKBaseDataException

if pItemNode->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/DataItemNodeColl.h