PUBLIC

GroupC::GroupC(void) GroupC::IsA(const ObjectC &) GroupC::IsGroup(const ObjectC &) GroupC::GroupC(const ObjectC &) GroupC::GroupC(const StringC &) GroupC::CView(void) GroupC::Add(const ObjectC &) GroupC::Add(const DListC &) GroupC::Del(const ObjectC &) GroupC::Del(const DListC &) GroupC::operator+=(const ObjectC &) GroupC::operator-=(const ObjectC &) GroupC::Child(const StringC &) GroupC::Child(const StringC &,ObjectC &) GroupC::SigAddObj(void) GroupC::SigDelObj(void) GroupC::IsChild(const ObjectC &) GroupC::Contents(void) GroupC::Size(void) const GroupC::List(void) const GroupC::Empty(void) ObjectC::Body(void) const ObjectC::CHandle(void) ObjectC::Name(void) const ObjectC::SetName(const StringC &) ObjectC::SigChanged(void) ObjectC::SetAttrib(const StringC &,const StringC &) ObjectC::Attrib(const StringC &) ObjectC::AttribInt(const StringC &) const ObjectC::AttribReal(const StringC &) const ObjectC::HasAttribute(const StringC &) const ObjectC::IsReadOnly(void) const ObjectC::SetReadOnly(BooleanT) ObjectC::Delta(const DeltaC &) ObjectC::Write(OStreamC &) ObjectC::WriteFile(StringC &) ObjectC::TypeName(void) const ObjectC::Access(void) DPEntityC::operator=(const DPEntityC &) DPEntityC::Body(void) DPEntityC::Body(void) const DPEntityC::Save(ostream &) const RCHandleAC::Abstract(void) RCHandleAC::IsHandleType(const DT &) const RCHandleAC::CheckHandleType(const DT &) const RCHandleAC::Save(ostream &) const RCHandleAC::Copy(void) const RCHandleC::IsValid(void) const RCHandleC::IsValidObject(void) const RCHandleC::operator=(const RCHandleC &) RCHandleC::operator==(const RCHandleC &) const RCHandleC::operator!=(const RCHandleC &) const RCHandleC::Hash(void) const RCHandleC::IsConst(void) const RCHandleC::IsNotConst(void) const RCHandleC::SetConst(void) const RCHandleC::Invalidate(void) RCHandleC::Body(void) RCHandleC::Body(void) const

GroupC
Object Group handle
include	"amma/GUI/ViewGroup.hh"
User Level:	Default
Library:	GUIView
Example:	ex3DCanvas.cc
Section:	GUI.View
In Scope:	StdView

Comments:
This can be used to describe an object or a relation.

Note: Thread locking is done ONLY for the group list, it is up to individual objects to ensure all accesses are thread safe.

public ObjectC

DataC
PlayControlC

typedef DLIterC<ObjectC> IteratorT;

Iterate through a group.

GroupC()

Default constructor.
Creates an invalid handle.

BooleanT IsA(const ObjectC & obj)

Is object a group ?

BooleanT IsGroup(const ObjectC & obj)

Is object a group ?
OBSOLETE: Use IsA(..) instead.

GroupC(const ObjectC & obj)

Upcast constructor.
Creates an invalid if object is not of the correct type.

GroupC(const StringC & name)

Constructor.
Create a named group.

void * CView()

Get arg for 'C' funcs.

BooleanT Add(const ObjectC & obj)

Add new object.
Causes a 'changed' signal Thread safe.

BooleanT Add(const DListC<ObjectC> & obj)

Add list of objects.
Causes a 'changed' signal Thread safe.

BooleanT Del(const ObjectC & obj)

Delete old object.
Causes a 'changed' signal Thread safe.

BooleanT Del(const DListC<ObjectC> & obj)

Delete list of old objects.
Causes a 'changed' signal Thread safe.

const GroupC & operator+=(const ObjectC & obj)

Add operator.

const GroupC & operator-=(const ObjectC & obj)

Del operator.

ObjectC & Child(const StringC & name)

Access a child object.
NB. If child doesn't exists, it will return an invalid handle. You may assign to this handle however.

BooleanT Child(const StringC & name,ObjectC & child)

Access a child object.
Returns true if child exists, and places handle in 'child'.

Signal1C<ObjectC> & SigAddObj()

Called when object is added to group
Note: In mulithreaded applications a Access() wrlock should be held when modifiying this signal.

Signal1C<ObjectC> & SigDelObj()

Called when object is deleted from group.
Note: In mulithreaded applications a Access() wrlock should be held when modifiying this signal.

BooleanT IsChild(const ObjectC & obj)

Is 'obj' directly or indirectly a child of this group ?
Note: Slow!

IteratorT Contents()

Access contents of group
Note: In mulithreaded applications a Access() rdlock should be held when interating through the contents of the list.

UIntT Size() const

Return number of items in the group.

DListC<ObjectC> List() const

Make new a list of the contents of the group.
Thread safe.

void Empty()

Empty group of all its children.

const ObjectBodyC & Body() const

Access body
Use only for base constructors of derived classes!!!

void * CHandle()

Get a 'C' handle for the object.

const StringC & Name() const

Access object name.

void SetName(const StringC & nm)

Set name of object.

Signal0C & SigChanged()

Access changed signal.

void SetAttrib(const StringC & attr,const StringC & val)

Set attribute.
Thread safe.

StringC Attrib(const StringC & attr)

Access attribute.
Thread safe.

IntT AttribInt(const StringC & attr) const

Access attribute as int
Thread safe.

RealT AttribReal(const StringC & attr) const

Access attribute as real
Thread safe.

BooleanT HasAttribute(const StringC & attr) const

Test if attribute set.

BooleanT IsReadOnly() const

Is object read only ?

void SetReadOnly(BooleanT only = true)

Is object read only ?

void Delta(const DeltaC & delta)

Queue update.
Thread safe.

BooleanT Write(OStreamC & out)

Save object to stream.

BooleanT WriteFile(StringC & out)

Save object to stream.

const char * TypeName() const

Get type name.
Used for selecting rendering method.

RWLockC & Access()

Access control lock.

const DPEntityC & operator=(const DPEntityC & dat)

Assignment.

DPEntityBodyC & Body()

Access body.

const DPEntityBodyC & Body() const

Access body.

BooleanT Save(ostream & out) const

RCAbstractC Abstract()

Create an abstract handle to this object.

BooleanT IsHandleType(const DT &) const

Is handle of given type ?

void CheckHandleType(const DT & dummy) const

Check handle type. Throw an expception if not.

BooleanT Save(ostream & out) const

Save to ostream.

RCHandleAC<DPEntityBodyC> Copy() const

Creat a deep copy of this object.
protected:

BooleanT IsValid() const

Check its a valid handle.

BooleanT IsValidObject() const

Check its a valid handle, and that the object is pointed to is also valid.

RCHandleC<DPEntityBodyC> & operator=(const RCHandleC<DPEntityBodyC> & oth)

Assignment.

BooleanT operator==(const RCHandleC<DPEntityBodyC> & oth) const

Comparison operator.

BooleanT operator!=(const RCHandleC<DPEntityBodyC> & oth) const

Comparison operator.

UIntT Hash() const

Hash function.x

BooleanT IsConst() const

Is object constant ?

BooleanT IsNotConst() const

Is object not constant ?

void SetConst(void) const

Lock the object.
This is const as a convience though it actual modified the object, often object you wish to ensure are constant already have const set. protected:

void Invalidate()

Turn this into an invalid handle.

DPEntityBodyC & Body()

Direct access to body.

const DPEntityBodyC & Body() const

Constant access to body.