ipsdk::DataItemMap Class Reference

Class used to store a variable collection of heterogeneous nodes. More...

#include <DataItemMap.h>

Inheritance diagram for ipsdk::DataItemMap:

Public Types
typedef std::map< std::string, DataItemPtr >	MapType
	map type associated to object

Public Member Functions
eDataItemType	getDataItemType () const
	retrieve data item type
const MapType &	getMap () const
	retrieve map associated to object
ItemNames	getItemNames () const
	retrieve item names associated to object
bool	isEmpty () const
	check whether collection is empty
ipUInt32	getSize () const
	retrieve collection size associated to object
bool	existsItem (const std::string &itemName) const
	check whether an item exists given its name
void	insertItem (const std::string &itemName, const DataItemPtr &pItem)
	insert a new item into map More...
void	removeItem (const std::string &itemName)
	remove an item from map More...
void	clear ()
	remove all items from collection
Constructors and destructors
	DataItemMap ()
	~DataItemMap ()
const BaseDataItem &	getItem (const std::string &itemName) const
	retrieve item associated to a given name More...
BaseDataItem &	getItem (const std::string &itemName)
	retrieve item associated to a given name More...
DataItemConstPtr	getItemPtr (const std::string &itemName) const
	retrieve item shared pointer associated to a given name More...
DataItemPtr	getItemPtr (const std::string &itemName)
	retrieve item shared pointer associated to a given name More...
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 = false
	flags indicating item type
static const bool	g_bNode = true
	flags indicating item type
static const bool	g_bLeaf = true
	flags indicating item type
static const eDataItemType::domain	g_itemType = eDataItemType::eDIT_Map
	flags indicating item type

Protected Attributes
MapType	_itemMap
	collection of named data items 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
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 used to store a variable collection of heterogeneous nodes.

Author

E. Noirfalise

Date

2014/03/13

Copyright

2014 Reactiv'IP, all right reserved.

Member Function Documentation

getItem() [1/2]

const BaseDataItem& ipsdk::DataItemMap::getItem

(

const std::string &

itemName

)

const

retrieve item associated to a given name

Exceptions

ipsdk::IPSDKBaseDataException

if existsItem(itemName) == false

getItem() [2/2]

BaseDataItem& ipsdk::DataItemMap::getItem

(

const std::string &

itemName

)

retrieve item associated to a given name

Exceptions

ipsdk::IPSDKBaseDataException

if existsItem(itemName) == false

getItemPtr() [1/2]

DataItemConstPtr ipsdk::DataItemMap::getItemPtr

(

const std::string &

itemName

)

const

retrieve item shared pointer associated to a given name

Exceptions

ipsdk::IPSDKBaseDataException

if existsItem(itemName) == false

getItemPtr() [2/2]

DataItemPtr ipsdk::DataItemMap::getItemPtr

(

const std::string &

itemName

)

retrieve item shared pointer associated to a given name

Exceptions

ipsdk::IPSDKBaseDataException

if existsItem(itemName) == false

insertItem()

void ipsdk::DataItemMap::insertItem	(	const std::string &	itemName,
		const DataItemPtr &	pItem
	)

insert a new item into map

Exceptions

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

removeItem()

void ipsdk::DataItemMap::removeItem

(

const std::string &

itemName

)

remove an item from map

Exceptions

ipsdk::IPSDKBaseDataException

if existsItem(itemName) == false

---

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/Map/DataItemMap.h