InfoGroup Class Reference

#include <info_group.hh>

Public Member Functions
InfoGroup	GetParent () const
void	SetName (const String &name)
String	GetName () const
InfoPath	GetPath () const
InfoGroup	GetGroup (const InfoPath &path, bool use_defaults=true) const
InfoGroupList	GetGroups (const InfoPath &path) const
InfoItemList	GetItems (const InfoPath &path) const
InfoGroup	CreateGroup (const String &name)
bool	HasGroup (const InfoPath &name, bool use_defaults=true) const
InfoGroup	RetrieveGroup (const InfoPath &path, bool use_defaults=true)
InfoItem	GetItem (const InfoPath &path, bool use_defaults=true) const
InfoItem	CreateItem (const String &name, const String &value)
InfoItem	CreateItem (const String &name, Real value)
InfoItem	CreateItem (const String &name, bool value)
InfoItem	CreateItem (const String &name, int value)
InfoItem	CreateItem (const String &name, const geom::Vec3 &vector)
bool	HasItem (const InfoPath &path, bool use_defaults=true) const
InfoItem	RetrieveItem (const InfoPath &path, bool use_defaults=true)
void	Remove (const InfoPath &path, bool use_defaults=false)
void	Remove (const InfoGroup &group)
String	GetAttribute (const String &name) const
void	SetAttribute (const String &name, const String &value)
bool	HasAttribute (const String &name) const
void	RemoveAttribute (const String &name)
std::vector< String >	GetAttributeList () const
String	GetTextData () const
void	SetTextData (const String &td)
String	GetComment () const
void	Apply (InfoVisitor &v, bool visit_this=true)
void	Apply (InfoConstVisitor &v, bool visit_this=true) const
bool	operator== (const InfoGroup &ref) const
bool	operator!= (const InfoGroup &ref) const
Friends
class	InfoHandle
class	InfoItem

---

Detailed Description

Definition at line 40 of file info_group.hh.

---

Member Function Documentation

void Apply	(	InfoConstVisitor &	v,
		bool	visit_this = true
	)			const

void Apply	(	InfoVisitor &	v,
		bool	visit_this = true
	)

Apply visitor.

descends through all items and subgroups

InfoGroup CreateGroup

(

const String &

name

)

InfoItem CreateItem	(	const String &	name,
		const geom::Vec3 &	vector
	)

InfoItem CreateItem	(	const String &	name,
		int	value
	)

InfoItem CreateItem	(	const String &	name,
		bool	value
	)

InfoItem CreateItem	(	const String &	name,
		Real	value
	)

InfoItem CreateItem	(	const String &	name,
		const String &	value
	)

String GetAttribute

(

const String &

name

)

const

return attribute of given name

std::vector<String> GetAttributeList

(

)

const

String GetComment

(

)

const

get comment just above item

InfoGroup GetGroup	(	const InfoPath &	path,
		bool	use_defaults = true
	)			const

InfoGroupList GetGroups

(

const InfoPath &

path

)

const

InfoItem GetItem	(	const InfoPath &	path,
		bool	use_defaults = true
	)			const

InfoItemList GetItems

(

const InfoPath &

path

)

const

String GetName

(

)

const

retrieve name

InfoGroup GetParent

(

)

const

retrieve parent group

InfoPath GetPath

(

)

const

retrieve path

String GetTextData

(

)

const

bool HasAttribute

(

const String &

name

)

const

returns true if attribute of this names exists

bool HasGroup	(	const InfoPath &	name,
		bool	use_defaults = true
	)			const

bool HasItem	(	const InfoPath &	path,
		bool	use_defaults = true
	)			const

bool operator!=

(

const InfoGroup &

ref

)

const

bool operator==

(

const InfoGroup &

ref

)

const

void Remove

(

const InfoGroup &

group

)

void Remove	(	const InfoPath &	path,
		bool	use_defaults = false
	)

void RemoveAttribute

(

const String &

name

)

remove attribute of given name

InfoGroup RetrieveGroup	(	const InfoPath &	path,
		bool	use_defaults = true
	)

InfoItem RetrieveItem	(	const InfoPath &	path,
		bool	use_defaults = true
	)

void SetAttribute	(	const String &	name,
		const String &	value
	)

set attribute of given name, will be created if it does not yet exist

void SetName

(

const String &

name

)

set name

void SetTextData

(

const String &

td

)

---

Friends And Related Function Documentation

friend class InfoHandle [friend]

Definition at line 41 of file info_group.hh.

friend class InfoItem [friend]

Definition at line 42 of file info_group.hh.

---

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

• stage/include/ost/info/info_group.hh