User Documentation
RAVL, Recognition And Vision Library
DEVELOP HOME PAGE CLASS LIST CONTENTS
Ravl - Source Tools - CxxDoc - Internal - ObjectBodyC
 

  PUBLIC
ObjectBodyC::ObjectBodyC(void)
ObjectBodyC::ObjectBodyC(const StringC &)
ObjectBodyC::Name(void)
ObjectBodyC::Name(void) const
ObjectBodyC::TypeName(void) const
ObjectBodyC::SetName(const StringC &)
ObjectBodyC::SetComment(const CommentInfoC &)
ObjectBodyC::Comment(void)
ObjectBodyC::Comment(void) const
ObjectBodyC::SetVar(const StringC &,const StringC &)
ObjectBodyC::Var(const StringC &) const
ObjectBodyC::IsVar(const StringC &) const
ObjectBodyC::Dump(ostream &,int)
ObjectBodyC::SetScope(ObjectC &)
ObjectBodyC::GetScope(void)
ObjectBodyC::UpdateComment(CommentInfoC &)
ObjectBodyC::HasParentScope(void) const
ObjectBodyC::ParentScope(void)
ObjectBodyC::ParentScope(void) const
ObjectBodyC::SetParentScope(ScopeBodyC *)
ObjectBodyC::PathList(void) const
ObjectBodyC::FullPath(void) const
ObjectBodyC::ActualPath(void) const
ObjectBodyC::StartLineno(void)
ObjectBodyC::EndLineno(void)
ObjectBodyC::CopyLineNo(const ObjectBodyC &)
ObjectBodyC::IncludeLineNo(const ObjectBodyC &)
ObjectBodyC::CopyLineNo(const ObjectC &)
ObjectBodyC::IncludeLineNo(const ObjectC &)
ObjectBodyC::TemplArgList(void)
ObjectBodyC::IsTemplate(void) const
ObjectBodyC::BaseName(void) const
ObjectBodyC::Hash(void) const
ObjectBodyC::operator ==(const ObjectC &) const
ObjectBodyC::FullName(RCHashC &,DesciptionGeneratorC &,int) const
ObjectBodyC::Subst(RCHashC &) const
RCBodyVC::Save(ostream &) const
RCBodyVC::Save(BinOStreamC &) const
RCBodyVC::Copy(void) const
RCBodyVC::DeepCopy(UIntT) const
RCBodyC::References(void) const
RCBodyC::Copy(void) const
RCBodyC::DeepCopy(UIntT) const
RCBodyC::IncRefCounter(void)
RCBodyC::DecRefCounter(void)

   ObjectBodyC   
 
Object body.
 
include "Ravl/CxxDoc/Object.hh"
Created:08/12/1999 
User Level:Develop
Library:RavlCxxDoc
In Scope:RavlCxxDocN

Comments:
The base body class for all parsed output.

Parent Classes: Derived Classes: Variables:
Methods:
ObjectBodyC()
Constructor.

ObjectBodyC(const StringC & nname)
Constructor.

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 this object.

ObjectC GetScope()
Get scope for this 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 references 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(RCHashC<StringC,ObjectC> & templSub,DesciptionGeneratorC & dg = defaultDescGen,int maxDepth = 60) const
Get full name of object
template args and all.

ObjectC Subst(RCHashC<StringC,ObjectC> & subst) const
Create a new object with subsituted args.

#include "Ravl/RCHandleV.hh"
bool Save(ostream & out) const
Save to stream 'out'.

bool Save(BinOStreamC & out) const
Save to binary stream 'out'.

RCBodyVC & Copy() const
Make copy of body.
This should be provided in derived classes. this funtion will issue an assertion failure if called.

RCBodyC & DeepCopy(UIntT levels = ((UIntT))) const
Make a deep copy of body.
This should be provided in derived classes. this funtion will issue an assertion failure if called.

#include "Ravl/RefCounter.hh"
UIntT References() const
Access count of handles open to this object.

RCBodyC & Copy() const
Make copy of body.
This should be provided in derived classes. this funtion will issue an assertion failure if called.

RCBodyC & DeepCopy(UIntT levels = ((UIntT))) const
Make a deep copy of body.
This should be provided in derived classes. this funtion will issue an assertion failure if called.

void IncRefCounter()
Increment reference counter.

bool DecRefCounter()
Decrement reference counter.


Maintainer:Charles Galambos, Created: 08/12/1999, Documentation by CxxDoc: Tue Aug 13 09:59:02 2002