PUBLIC

DocNodeBodyC::DocNodeBodyC(const StringC &,const StringC &,const StringC &,const StringC &,const StringC &,const StringC &,bool) DocNodeBodyC::AddNode(const DListC &,bool,const StringC &) DocNodeBodyC::FindChild(const StringC &,bool,const StringC &) DocNodeBodyC::DocFilename(void) DocNodeBodyC::Userlevel(void) DocNodeBodyC::SetUserlevel(const StringC &) DocNodeBodyC::SetDetailComment(const StringC &) DocNodeBodyC::SetBriefComment(const StringC &) DocNodeBodyC::UpdateVars(const HashC &) DocNodeBodyC::OrderChildren(const DListC &) DocNodeBodyC::TypeName(void) const DocNodeBodyC::ActualPath(void) const ObjectListBodyC::TypeName(void) const ObjectListBodyC::List(void) ObjectListBodyC::List(void) const ObjectListBodyC::Find(const StringC &) ObjectListBodyC::Append(ObjectC &) ObjectListBodyC::IsWrapper(void) const ObjectListBodyC::Dump(ostream &,int) ObjectListBodyC::AppendList(DListC &) ObjectListBodyC::AppendList(const ObjectC &) ObjectListBodyC::SetAll(const StringC &,const StringC &) ObjectListBodyC::SetWrapper(bool) 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)

public ObjectListBodyC

DocNodeBodyC(const StringC & nm,const StringC & position = StringC (),const StringC & userlvl = "Default",const StringC & brief = StringC (),const StringC & docName = StringC (),const StringC & nodeType = StringC ("class"),bool aplaceHolder = false)

Default constructor.

DocNodeC AddNode(const DListC<StringC> & id,bool create = true,const StringC & path = StringC ())

Find/Create node corresponding to the the address including and after 'it'.

DocNodeC FindChild(const StringC & name,bool doadd = false,const StringC & path = StringC ())

Find the named child.
if doadd is true, add the new DocNode. NB. this may fail if node exists, but is not a DocNode.

StringC & DocFilename()

Filename for info on this node.
This may be an empty string.

StringC & Userlevel()

User level for this node.

bool SetUserlevel(const StringC & value)

Set the user level of this node.

bool SetDetailComment(const StringC & value)

Set the detailed comment of the node.

bool SetBriefComment(const StringC & value)

Set the brief comment of the node.

bool UpdateVars(const HashC<StringC,StringC> & value)

Update node's variables.

bool OrderChildren(const DListC<StringC> & children)

Put children in given order.

const char * TypeName() const

Get name of object type.

StringC ActualPath() const

Resolve data references correctly.

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

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.

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.