PUBLIC

GroupBodyC::GroupBodyC(const StringC &,BooleanT) GroupBodyC::Add(const ObjectC &) GroupBodyC::Del(const ObjectC &) GroupBodyC::IsChild(const ObjectC &) GroupBodyC::Add(const DListC &) GroupBodyC::Del(const DListC &) GroupBodyC::Empty(void) GroupBodyC::Child(const StringC &) GroupBodyC::Child(const StringC &,ObjectC &) GroupBodyC::SigAddObj(void) GroupBodyC::SigDelObj(void) GroupBodyC::TypeName(void) const GroupBodyC::Size(void) const GroupBodyC::List(void) const ObjectBodyC::SetName(const StringC &) ObjectBodyC::Name(void) const ObjectBodyC::SigChanged(void) ObjectBodyC::SetAttrib(const StringC &,const StringC &) ObjectBodyC::Attrib(const StringC &) ObjectBodyC::AttribInt(const StringC &) const ObjectBodyC::AttribReal(const StringC &) const ObjectBodyC::HasAttribute(const StringC &) const ObjectBodyC::IsReadOnly(void) const ObjectBodyC::SetReadOnly(BooleanT) ObjectBodyC::TypeName(void) const ObjectBodyC::Update(void) ObjectBodyC::Delta(const DeltaC &) ObjectBodyC::Write(OStreamC &) ObjectBodyC::WriteFile(StringC &) ObjectBodyC::Access(void) DPEntityBodyC::Save(ostream &) const DPEntityBodyC::Copy(void) const BodyRefCounterVC::Copy(void) const BodyRefCounterVC::operator==(const BodyRefCounterVC &) const BodyRefCounterVC::operator!=(const BodyRefCounterVC &) const BodyRefCounterVC::Save(ostream &) const BodyRefCounterC::AddReference(void) BodyRefCounterC::RemoveReference(void) BodyRefCounterC::SetConst(void) const BodyRefCounterC::SetConst(void) BodyRefCounterC::IsConst(void) const BodyRefCounterC::IsNotConst(void) const BodyRefCounterC::ToBeDeleted(void) const BodyRefCounterC::ToBeDeletedRemoveIgnoreNoRemove(void) BodyRefCounterC::ToBeDeletedRemove(void) BodyRefCounterC::BodyMightBeDeleted(void) const BodyRefCounterC::IsCountZero(void) const BodyRefCounterC::BRCPtrCanDeleteObject(void) const BodyRefCounterC::Count(void) const BodyRefCounterC::operator=(const BodyRefCounterC &) BodyRefCounterC::IsValidObject(void) const BodyRefCounterC::UserBitTest(IntT) const BodyRefCounterC::UserBitSet(IntT,BooleanT) BodyRefCounterC::UserBitZero(IntT) BodyRefCounterC::ReportBRCError(char *) BodyRefCounterC::Hash(void) const BodyRefCounterC::SetUndeletable(void) BodyRefCounterC::ReportInvalidObject(char *) const RefCounterBaseC::Label(void) const

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

Parent Classes:

public ObjectBodyC

DataBodyC
PlayControlBodyC

DListC contents;

Contents of group.

Signal1C sigAddObj;

Called when object is added.

Signal1C sigDelObj;

Called when object is removed.

GroupBodyC(const StringC & nname = "noname",BooleanT nReadOnly = false)

Constructor.

BooleanT Add(const ObjectC & obj)

Add new object.
Causes a 'changed' signal Note: Group 'access' is unlocked when signal is given.

BooleanT Del(const ObjectC & obj)

Delete old object.
Causes a 'changed' signal Note: Group 'access' is unlocked when signal is given.

BooleanT IsChild(const ObjectC & obj)

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

BooleanT Add(const DListC<ObjectC> & obj)

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

BooleanT Del(const DListC<ObjectC> & obj)

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

void Empty()

Empty group of all its children.

ObjectC & Child(const StringC & name)

Access a child object.
NB. If child doesn't exists, it will return an invalid handle. You must assign a valid obhect 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

Signal1C<ObjectC> & SigDelObj()

Called when object is deleted from group.

const char * TypeName() const

Get type name.
Used for selecting rendering method.

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 SetName(const StringC & nm)

Set name.
Be carefull, this function does nothing to check consistancy with display's etc.

const StringC & Name() const

Access object name.

Signal0C & SigChanged()

Access changed signal.

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

Set attribute.

StringC Attrib(const StringC & attr)

Access attribute.

IntT AttribInt(const StringC & attr) const

Access attribute as int

RealT AttribReal(const StringC & attr) const

Access attribute as real

BooleanT HasAttribute(const StringC & attr) const

Test if attribute set.

BooleanT IsReadOnly() const

Is object read only ?

void SetReadOnly(BooleanT only = true)

Set the readonly flag.

const char * TypeName() const

Get type name.
Used for selecting rendering method.

void Update()

Update object from list of pending changes.

void Delta(const DeltaC & val)

Queue update.
Thread safe.

BooleanT Write(OStreamC & out)

Save object to stream.

BooleanT WriteFile(StringC & fn)

Save object to stream.

RWLockC & Access()

Access control lock.

BooleanT Save(ostream & out) const

Save to ostream.

BodyRefCounterVC & Copy() const

Creat a copy of this object.

BodyRefCounterVC & Copy() const

Creat a copy of this object.

BooleanT operator==(const BodyRefCounterVC & oth) const

Compair identitys.

BooleanT operator!=(const BodyRefCounterVC & oth) const

Compair identitys.

BooleanT Save(ostream & out) const

Save to ostream.

void AddReference()

Another reference to the object has been created.

void RemoveReference()

One reference to the object was deleted.
Locking scheme -------------- The object is possible to lock (to make constant). The scheme assumes that the object is created, it can be locked, after that it can only be destroyed. The locked object cannot be unlocked. This locking scheme is very useful during debugging, using assert() function, when it is necassary to check that object is treated as constant and the constancy is not violated by any casting or passing through the copy constructor of shared objects.

void SetConst(void) const

This locks the object.
Often objects you wish to lock are already const.

void SetConst(void)

This locks the object.

BooleanT IsConst(void) const

Returns TRUE if the object is locked, ie. it is assumed to be constant.

BooleanT IsNotConst(void) const

Returns TRUE if the object is unlocked.
ie. there is no special information if the object is constant or not. Counter state information -------------------------

BooleanT ToBeDeleted() const

Returns TRUE if there is only one reference to the object and the whole object or its reference counting part can be deleted.

BooleanT ToBeDeletedRemoveIgnoreNoRemove()

Decrement refrence by 1 return true if this leaves no refrences to the object.

BooleanT ToBeDeletedRemove()

Decrement refrence by 1 return true if this leaves no refrences to the object. This also checks the NoRemove flag.

BooleanT BodyMightBeDeleted() const

Returns TRUE if the reference counted part of the object can be deleted, ie. flag NOREMOVE is false .

BooleanT IsCountZero() const

Are there any refrences left ?

BooleanT BRCPtrCanDeleteObject() const

Used by BRRCPtrC to establish if an object has ZERO refrences and can be deleted.

IntT Count() const

Returns the current state of the counter, ie. how many references to this object exist.

const BodyRefCounterC & operator=(const BodyRefCounterC & b)

It has not meaning to assign object 'b' to this object because it would destroy a history of the object which is counted. So this is a dummy function.

BooleanT IsValidObject() const

Test if object is valid.
When amma check is disabled this always returns true.

BooleanT UserBitTest(IntT x) const

Test user flag.

void UserBitSet(IntT x,BooleanT setit = TRUE)

Test user flag.

void UserBitZero(IntT x)

Set bit to zero.

void ReportBRCError(char * Msg)

Report error, used in BRCPtrC.

UIntT Hash() const

Hash on address of object.

void SetUndeletable()

Make object undeletable.
Usefull to prevent recursive deleting in graph structures. Only hackers need this function.

void ReportInvalidObject(char * Msg = 0) const

Tell user about validation failure.

LabelT Label() const

Returns the label of this reference counter.
The member function is useful mainly to recognize objects during debugging. The value of the label is uniquely defined pointer.