ClassBodyC - Class storage object.

Developer Documentation

Centre for Vision, Speech & Signal Processing

Comments:
This includes structs and unions.

Parent Classes:

ScopeBodyC

Derived Classes:

ClassTemplateBodyC

Variables:

DListC inherit;
StringC curAccess;: Used in building class description to hold current access type.

Methods:

ClassBodyC(): Default constructor.
ClassBodyC(const StringC & nname): Constructor.
ClassBodyC(const StringC & nname,DListC<ObjectC> & contents): Constructor.
ClassBodyC(const StringC & nname,const ObjectC & contents,const ObjectC & inherit): Constructor.
const char * TypeName() const: Get name of object type.
void Append(ObjectC & obj): Append to list.
DListC<ScopeC> & Inherit(): List of classes inherited from.
const char * TypeName() const: Get name of object type.
void Append(ObjectC & obj): Append to scope.
ObjectC & Lookup(const StringC & name): Lookup object.
bool Merge(const ScopeC & oth): Merge this scope with another.
bool Merge(const ObjectC & oth): Merge this scope with another.
ObjectC ResolveName(const StringC & str): Resolve a path
ObjectC ResolveName(DListC<ObjectC> path,RCHashARC<StringC,ObjectC> & tempTab): Resolve a path
templSub contains any template paramiter subsitutions found when resolving the path.
BooleanT MatchTemplateArgs(ClassTemplateC & tc,ObjectC & pathObj,RCHashARC<StringC,ObjectC> & templTab): Match template arguments.
puts the results into templTab.
ScopeC RootScope(): Get the root scope.
DListC<ObjectC> & Uses(): Access inherit from list.
void Resolve(): Resolve links in input data.
const char * TypeName() const: Get name of object type.
DListC<ObjectC> & List(): Access list.
const DListC<ObjectC> & List() const: Access list.
ObjectC Find(const StringC & name): Find named child.
returns an invalid handle if not found.
void Append(ObjectC & obj): Append to list.
bool IsWrapper() const: Is a wrapper ?
Is this used to return multipal items ??
void Dump(ostream & out,int indent = 0): Dump to 'out' in human readable form.
void AppendList(DListC<ObjectC> & contents): Append list to list one.
void AppendList(const ObjectC & contents): Append list to list one.
void SetAll(const StringC & var,const StringC & dat): Set variable in all immediate children.
void SetWrapper(bool val = true): Set the wrapper flag.
StringC & Name(): Name of object.
const StringC & Name() const: Name of object.
const char * TypeName() const: Get name of object type.
void SetName(const StringC & nname): Set name of object.
void SetComment(const CommentInfoC & cinf): Set comment information.
CommentInfoC & Comment(): Access comment.
const CommentInfoC & Comment() const: Access comment.
void SetVar(const StringC & nm,const StringC & value): Set variable.
StringC Var(const StringC & nm) const: Get variable.
bool IsVar(const StringC & nm) const: Test if variable is set.
void Dump(ostream & out,int indent = 0): Dump to 'out' in human readable form.
void SetScope(ObjectC & obj): Set scope for object.
ObjectC GetScope(): Set scope for object.
void UpdateComment(CommentInfoC & newComment): Update the comments for the object.
bool HasParentScope() const: Has a parent been set ?
ScopeBodyC & ParentScope(): Access parent.
ONLY valid if HasParent() returns true.
const ScopeBodyC & ParentScope() const: Access parent.
ONLY valid if HasParent() returns true.
void SetParentScope(ScopeBodyC * ns): Setup parent scope.
ObjectListC PathList() const: : Generate path list to this object.
StringC FullPath() const: Get full path to object.
StringC ActualPath() const: Resolve data refrences correctly.
int & StartLineno(): Starting line of object.
int & EndLineno(): End line of object.
void CopyLineNo(const ObjectBodyC & ob): Copy line no from object.
void IncludeLineNo(const ObjectBodyC & ob): Include lines into object.
void CopyLineNo(const ObjectC & ob): Copy line no from object.
void IncludeLineNo(const ObjectC & ob): Include lines into object.
ObjectListC & TemplArgList(): Access arg list.
bool IsTemplate() const: Is this a templated object ?
const StringC & BaseName() const: Return base name.
UIntT Hash() const: Hash name.
bool operator==(const ObjectC & ob) const: Is equal ?
StringC FullName(RCHashARC<StringC,ObjectC> & templSub,DesciptionGeneratorC & dg = defaultDescGen,int maxDepth = 30) const: Get full name of object
template args and all.
ObjectC Subst(RCHashARC<StringC,ObjectC> & subst) const: Create a new object with subsituted args.
ostream & Pad(ostream & out,int indent): Put padding spaces in.

#include "amma/BRefCntV.hh"

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.

#include "amma/BRefCnt.hh"

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.

#include "amma/RefCBase.hh"

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.

Programmer:Charles Galambos, Documentation by CxxDoc: Tue Mar 20 10:49:27 2001

ClassBodyC

Class storage object.

include	"amma/Cxx/Object.hh"
User Level:	Default
Library:	CxxDoc
Example:	exEndPoint.cc
Section:	default.Charles Galambos
In Scope:	CxxParser