igor::iItem Class Reference

Item holding generic data and other items. More...

#include <iItem.h>

Public Member Functions
	iItem ()=default
template<typename T >
void	setValue (const iaString &key, const T &value)
template<typename T >
T	getValue (const iaString &key) const
bool	hasValue (const iaString &key) const
const iaString	getID () const
iItemPtr	addItem (const iaString &id)
void	removeItem (iItemPtr item)
const std::vector< iItemPtr >	getItems () const
iItemPtr	getParent () const
void	clear ()
bool	operator== (const iItem &other) const
bool	operator!= (const iItem &other) const
bool	hasData () const
template<>
void	setValue (const iaString &key, const iaString &value)
template<>
iaString	getValue (const iaString &key) const
template<>
void	setValue (const iaString &key, const iaUUID &value)
template<>
iaUUID	getValue (const iaString &key) const
template<>
void	setValue (const iaString &key, const bool &value)
template<>
bool	getValue (const iaString &key) const
template<>
void	setValue (const iaString &key, const uint64 &value)
template<>
uint64	getValue (const iaString &key) const

Detailed Description

Item holding generic data and other items.

Useful for small hierarchies since all data is copied a lot

Constructor & Destructor Documentation

iItem()

igor::iItem::iItem ( )

default

nothing to do

Member Function Documentation

addItem()

iItemPtr igor::iItem::addItem

(

const iaString &

id

)

adds item to this item

this item retains ownership

Returns

newly added item

Parameters

id	if of the item (must be unique between siblings)

clear()

void igor::iItem::clear

(

)

clear item and it's children

getID()

const iaString igor::iItem::getID

(

)

const

Returns

id of item

it's a unique id amongst siblings

getItems()

const std::vector< iItemPtr > igor::iItem::getItems

(

)

const

Returns

items of this item

getParent()

iItemPtr igor::iItem::getParent

(

)

const

Returns

parent item. nullptr if root

getValue() [1/5]

template<typename T >

T igor::iItem::getValue

(

const iaString &

key

)

const

Returns

value for given key

key "name" is a reserved key. Every item has a name

Parameters

key	the given key

getValue() [2/5]

template<>

iaString igor::iItem::getValue ( const iaString &  key ) const

inline

getValue() [3/5]

template<>

iaUUID igor::iItem::getValue ( const iaString &  key ) const

inline

getValue() [4/5]

template<>

bool igor::iItem::getValue ( const iaString &  key ) const

inline

getValue() [5/5]

template<>

uint64 igor::iItem::getValue ( const iaString &  key ) const

inline

hasData()

bool igor::iItem::hasData

(

)

const

Returns

true if this item has any data

hasValue()

bool igor::iItem::hasValue

(

const iaString &

key

)

const

Returns

true if there is a value for given key

operator!=()

bool igor::iItem::operator!=

(

const iItem &

other

)

const

compare two items recursively for being not equal

Returns

true if not equal

Parameters

other

the other item

operator==()

bool igor::iItem::operator==

(

const iItem &

other

)

const

compare two items recursively for being equal

Returns

true if equal

Parameters

other

the other item

removeItem()

void igor::iItem::removeItem

(

iItemPtr

item

)

removes given item from this item

Parameters

item	the item to remove

setValue() [1/5]

template<>

void igor::iItem::setValue ( const iaString &  key, const bool &  value  )

inline

setValue() [2/5]

template<>

void igor::iItem::setValue ( const iaString &  key, const iaString &  value  )

inline

setValue() [3/5]

template<>

void igor::iItem::setValue ( const iaString &  key, const iaUUID &  value  )

inline

setValue() [4/5]

template<typename T >

void igor::iItem::setValue	(	const iaString &	key,
		const T &	value
	)

set value for given key

key "name" is a reserved key. Every item has a name

Parameters

key	to set
value	to set

setValue() [5/5]

template<>

void igor::iItem::setValue ( const iaString &  key, const uint64 &  value  )

inline

---

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

• /home/martin/dev/Igor/src/igor/igor/data/iItem.h
• /home/martin/dev/Igor/src/igor/igor/data/iItem.cpp
• /home/martin/dev/Igor/src/igor/igor/data/iItem.inl