|
Developer Documentation |
|
Centre for Vision, Speech & Signal Processing |
Comments:
This intented for data objects that the graphical
part of the interface understands. e.g. BooleanT
strings, numbers etc.
Parent Classes:
Methods:
- DataC()
-
Default constructor.
Creates an invalid handle.
- DataC(const StringC & name,const DataT & dat,BooleanT nReadOnly = true)
-
Constructor.
Create a named object.
- DataC(const DataT & dat,BooleanT nReadOnly = true)
-
Constructor.
Create an annonymous object.
- BooleanT IsData(const ObjectC & obj)
-
Is object a group ?
- DataC(const ObjectC & bod)
-
Upcast constructor.
- DataC(DataBodyC<DataT> & bod)
-
Body constructor.
- DataBodyC<DataT> & Body()
-
Access body
- const DataBodyC<DataT> & Body() const
-
Access body
For consistancy only.
- const char * ClassTypeName()
-
Get class typename.
This is like TypeName(), but is static.
- DataT & Data()
-
Access data.
- const DataT & Data() const
-
Constant access to data.
- void Update(const DataT & val)
-
Update data.
This also sends the appropriate signal.
- Signal1C<DataT> & SigUpdate()
-
Update signal.
- BooleanT IsA(const ObjectC & obj)
-
Is object a group ?
- BooleanT IsGroup(const ObjectC & obj)
-
Is object a group ?
OBSOLETE: Use IsA(..) instead.
- void * CView()
-
Get arg for 'C' funcs.
- GroupBodyC & Body()
-
Access body
- const GroupBodyC & Body() const
-
Access body
For consistancy only.
- 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.
- ObjectBodyC & Body()
-
Access body
- 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.
|
Programmer:Charles Galambos, Documentation by CxxDoc: Tue Mar 20 10:49:27 2001
|