|
User Documentation |
|
Centre for Vision, Speech & Signal Processing |
Parent Classes:
Methods:
- MarkerC()
-
Default Constructor.
creates an invalid object.
- MarkerC(const StringC & nname)
-
Constructor.
- MarkerC(ObjectC & obj)
-
Base class constructor.
- StringC & Name()
-
Name of object.
- const StringC & Name() const
-
Name of object.
- void SetName(const StringC & nname)
-
Name of object.
- const char * TypeName() const
-
Get name of object type.
- void SetComment(const CommentInfoC & cinf)
-
Set comment info.
- 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)
-
Set variable.
- StringC Var(const StringC & nm) const
-
Set variable.
- bool IsVar(const StringC & nm) const
-
Set variable.
- void Dump(ostream & out,int indent = 0)
-
Dump to 'out' in human readable form.
- void SetScope(ObjectC & obj)
-
Set scope for object.
- void UpdateComment(CommentInfoC & newComment)
-
Update the comments for the object.
- ObjectC GetScope()
-
Set scope for object.
- void SetParentScope(ScopeBodyC * ns)
-
Setup parent scope.
- bool HasParentScope() const
-
Has a parent been set ?
- ScopeBodyC & ParentScope()
-
Access parent.
ONLY valid if HasParent() returns true.
- StringC FullPath() const
-
Get full path to object.
- StringC ActualPath() const
-
Resolve data refrences correctly.
- ObjectListC PathList() const
-
: Generate path list to this object.
- int & StartLineno()
-
where does object start.
- int & EndLineno()
-
where does object end.
- void CopyLineNo(const ObjectC & ob)
-
Copy line no from object.
- void IncludeLineNo(const ObjectC & ob)
-
Include lines into object.
- void SetupLineNos(const ObjectC & ob1,const ObjectC & ob2)
-
Include lines into object.
- void SetupLineNos(const ObjectC & ob1,const ObjectC & ob2,const ObjectC & ob3)
-
Include lines into object.
- bool IsTemplate() const
-
Is this a templated object ?
- ObjectListC & TemplArgList()
-
Access arg list.
- UIntT Hash() const
-
Hash number for object.
- bool operator==(const ObjectC & ob) const
-
Is equal ?
- const StringC & BaseName() const
-
Return base name.
- StringC FullName(RCHashARC<StringC,ObjectC> & templSub = emptyTemplSubst,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.
- 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<ObjectBodyC> & operator=(const RCHandleC<ObjectBodyC> & oth)
-
Assignment.
- BooleanT operator==(const RCHandleC<ObjectBodyC> & oth) const
-
Comparison operator.
- BooleanT operator!=(const RCHandleC<ObjectBodyC> & 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.
- ObjectBodyC & Body()
-
Direct access to body.
- const ObjectBodyC & Body() const
-
Constant access to body.
|
Programmer:Charles Galambos, Documentation by CxxDoc: Tue Mar 20 10:48:08 2001
|