Base class for data item nodes. More...

#include <BaseDataItemNode.h>

Inheritance diagram for ipsdk::BaseDataItemNode:

Classes
struct	ItemInfo
	structure used to retrieve item informations More...

struct	ItemInfoStr
	structure used to retrieve item string informations More...

struct	NodeAccessor
	structure used to access to node data More...

Public Member Functions
virtual	~BaseDataItemNode ()=0
	public destructor

eDataItemType	getDataItemType () const
	retrieve data item type

virtual const boost::filesystem::path	getHeaderPath () const =0
	retrieve relative header path associated to derived data item node

virtual const std::string	getLibraryName () const =0
	retrieve library name associated to derived data item node

virtual const ItemNames &	getItemIds () const =0
	retrieve item ids associated to object

bool	existsItem (const std::string &itemId) const
	check whether an item exists given its id

const BaseDataItem &	getItem (const std::string &itemId) const
	retrieve item associated to a given id More...

const std::string &	getItemName (const std::string &itemId) const
	retrieve item name associated to a given id More...

const std::string &	getItemToolTip (const std::string &itemId) const
	retrieve item tooltip associated to a given id 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

Public Member Functions inherited from ipsdk::BaseToolTip
virtual const std::string &	getObjectName () const =0
	retrieve object name

virtual const std::string &	getToolTip () const =0
	retrieve object tool tip

	BaseToolTip ()

virtual	~BaseToolTip ()=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 = false
	flags indicating item type

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

Protected Types
typedef boost::shared_ptr< ItemInfo >	ItemInfoPtr
	shared pointer to item informations

Protected Member Functions
	BaseDataItemNode ()
	protected constructor

virtual ItemInfoPtr	getItemInfo (const std::string &itemId) const =0
	retrieve item informations associated to a given id 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

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 for data item nodes.

Author: E. Noirfalise

Date: 2014/03/10

Copyright: 2014 Reactiv'IP, all right reserved.

Member Function Documentation

◆ getItem()

const BaseDataItem& ipsdk::BaseDataItemNode::getItem ( const std::string & itemId ) const

retrieve item associated to a given id

Exceptions

ipsdk::IPSDKBaseDataException if existsItem(itemName) == false

◆ getItemName()

const std::string& ipsdk::BaseDataItemNode::getItemName ( const std::string & itemId ) const

retrieve item name associated to a given id

Exceptions

ipsdk::IPSDKBaseDataException if existsItem(itemName) == false

◆ getItemToolTip()

const std::string& ipsdk::BaseDataItemNode::getItemToolTip ( const std::string & itemId ) const

retrieve item tooltip associated to a given id

Exceptions

ipsdk::IPSDKBaseDataException if existsItem(itemName) == false

◆ getItemInfo()

virtual ItemInfoPtr ipsdk::BaseDataItemNode::getItemInfo ( const std::string & itemId ) const

protectedpure virtual

retrieve item informations associated to a given id

Note: a null returned value stands for error case

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/Node/BaseDataItemNode.h

Classes

Public Member Functions

Static Public Attributes

Protected Types

Protected Member Functions

Additional Inherited Members

Detailed Description

Member Function Documentation

◆ getItem()

◆ getItemName()

◆ getItemToolTip()

◆ getItemInfo()