[Home]	[About]
[Screenshots]	[Download]
[News]	[Community]
[Documentation]	[Manual]
[Bugs & Requests]	[Wiki]

VOS::VobjectState Class Reference
[libvos]

#include <vos/vos/vobjectstate.hh>

List of all members.

---

Detailed Description

This holds the actual state common to every Vobject: the type set, the child list, and the parent set.

Listeners are also stored here, although the methods of this class do not actually trigger the listener callbacks. The API for VobjectState is basically a subset of Vobject, for obvious reasons. You shouldn't ever access a Vobject's state object state directly unless you have a very good reason to bypass the extensions, access control checks and listener callbacks that are implemented by VobjectBase.

Definition at line 72 of file vobjectstate.hh.

Public Types

• typedef std::set< ParentChildRelation * > ParentSet
• typedef std::deque< ParentChildRelation * > ChildList
• typedef std::set< std::string > TypeSet

Public Member Functions

• VobjectState (VobjectBase *myvobject)
• ~VobjectState ()
• VUtil::vRef< VobjectBase > getBase ()
• void addType (const std::string &s)
• void removeType (const std::string &s)
• TypeSetIterator getTypes ()
• int numChildren ()
• void insertChild (int pos, const std::string &c, Vobject *vobj)
• void setChild (int pos, const std::string &c, Vobject *vobj)
• void removeChild (int pos)
• void fixPosition (int &pos, int forinsert=0)
• bool hasChild (const std::string &c)
• bool hasChild (int pos)
• VUtil::vRef< ParentChildRelation > findChild (int pos)
• VUtil::vRef< ParentChildRelation > findChild (const std::string &c)
• ChildListIterator getChildren (int start=0, int end=-1)
• void clearChildren ()
• ParentSetIterator getParents ()
• VUtil::vRef< ParentChildRelation > findParent (Vobject &parent)
• VUtil::vRef< ParentChildRelation > findParent (Vobject *parent)
• void addParent (ParentChildRelation *pcr)
• void removeParent (ParentChildRelation *pcr)

Public Attributes

• boost::recursive_mutex state_mutex
• VUtil::ListenerBase< TypeChangeListener,
  VobjectEvent > typeListeners
• VUtil::ListenerBase< ParentChangeListener,
  VobjectEvent > parentListeners
• VUtil::ListenerBase< ChildChangeListener,
  VobjectEvent > childListeners

---

Member Typedef Documentation

typedef std::deque<ParentChildRelation*> VOS::VobjectState::ChildList

Definition at line 76 of file vobjectstate.hh.

typedef std::set<ParentChildRelation*> VOS::VobjectState::ParentSet

Definition at line 75 of file vobjectstate.hh.

typedef std::set<std::string> VOS::VobjectState::TypeSet

Definition at line 77 of file vobjectstate.hh.

---

Constructor & Destructor Documentation

VOS::VobjectState::VobjectState

(

VobjectBase *

myvobject

)

VOS::VobjectState::~VobjectState

(

)

---

Member Function Documentation

void VOS::VobjectState::addParent

(

ParentChildRelation *

pcr

)

void VOS::VobjectState::addType

(

const std::string &

s

)

void VOS::VobjectState::clearChildren

(

)

VUtil::vRef<ParentChildRelation> VOS::VobjectState::findChild

(

const std::string &

c

)

VUtil::vRef<ParentChildRelation> VOS::VobjectState::findChild

(

int

pos

)

VUtil::vRef<ParentChildRelation> VOS::VobjectState::findParent

(

Vobject *

parent

)

VUtil::vRef<ParentChildRelation> VOS::VobjectState::findParent

(

Vobject &

parent

)

void VOS::VobjectState::fixPosition	(	int &	pos,
		int	forinsert = 0
	)

VUtil::vRef<VobjectBase> VOS::VobjectState::getBase

(

)

ChildListIterator VOS::VobjectState::getChildren	(	int	start = 0,
		int	end = -1
	)

ParentSetIterator VOS::VobjectState::getParents

(

)

TypeSetIterator VOS::VobjectState::getTypes

(

)

bool VOS::VobjectState::hasChild

(

int

pos

)

bool VOS::VobjectState::hasChild

(

const std::string &

c

)

void VOS::VobjectState::insertChild	(	int	pos,
		const std::string &	c,
		Vobject *	vobj
	)

int VOS::VobjectState::numChildren

(

)

void VOS::VobjectState::removeChild

(

int

pos

)

void VOS::VobjectState::removeParent

(

ParentChildRelation *

pcr

)

void VOS::VobjectState::removeType

(

const std::string &

s

)

void VOS::VobjectState::setChild	(	int	pos,
		const std::string &	c,
		Vobject *	vobj
	)

---

Member Data Documentation

VUtil::ListenerBase<ChildChangeListener, VobjectEvent> VOS::VobjectState::childListeners

Definition at line 94 of file vobjectstate.hh.

VUtil::ListenerBase<ParentChangeListener, VobjectEvent> VOS::VobjectState::parentListeners

Definition at line 93 of file vobjectstate.hh.

boost::recursive_mutex VOS::VobjectState::state_mutex

Definition at line 90 of file vobjectstate.hh.

VUtil::ListenerBase<TypeChangeListener, VobjectEvent> VOS::VobjectState::typeListeners

Definition at line 92 of file vobjectstate.hh.

---

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

• /home/tetron/hack/vos/libs/vos/vos/vobjectstate.hh