Developer Documentation
RAVL, Recognition And Vision Library
USER HOME PAGE CLASS LIST CONTENTS
Ravl - Source Tools - CxxDoc - Internal - DocumentC
 

  PUBLIC
DocumentC::DocumentC(void)
DocumentC::DocumentC(const FilenameC &,const StringC &,const DocTreeC &,const StringC &,const StringC &)
DocumentC::Body(void)
DocumentC::Body(void) const
DocumentC::Document(ObjectListC &)
DocumentC::DocTree(void)
TemplateComplexC::Body(void)
TemplateComplexC::Body(void) const
TemplateComplexC::Build(StringC &)
TemplateComplexC::SetupPresets(const HSetC &)
TemplateComplexC::SetVar(const StringC &,const StringC &)
TemplateComplexC::GetVar(const StringC &)
TemplateComplexC::Interpret(const StringC &)
RCHandleC::operator =(const RCHandleC &)
RCHandleC::DeepCopy(UIntT) const
RCHandleC::operator ==(const RCHandleC &) const
RCHandleC::operator !=(const RCHandleC &) const
RCHandleC::Hash(void) const
RCHandleC::IsValid(void) const
RCHandleC::Invalidate(void)
RCHandleC::IsHandleType(const DT &) const
RCHandleC::CheckHandleType(const DT &) const
RCHandleC::Body(void)
RCHandleC::Body(void) const
RCHandleC::References(void) const
RCHandleC::operator <<(ostream &,const RCHandleC &)
RCHandleC::operator >>(istream &,RCHandleC &)

   DocumentC   
 
Documentor
 
include "Ravl/CxxDoc/Document.hh"
Created:03/02/2000 
Source file:Ravl/SourceTools/CxxDoc/Document.hh
User Level:Normal
Library:RavlCxxDoc
In Scope:RavlCxxDocN

Parent Classes: Methods:
DocumentC()
Default contructor.
Creates an invalid handle.

DocumentC(const FilenameC & tmplName,const StringC & outDir,const DocTreeC & docTree = DocTreeC (),const StringC & projName = StringC (),const StringC & projDesc = StringC ())
Contructor.
Create a documentor

DocumentBodyC & Body()
Access body.

const DocumentBodyC & Body() const
Access body.

void Document(ObjectListC & ol)
Document list of files.

DocTreeC & DocTree()
Access doc tree.

#include "Ravl/Text/TemplateComplex.hh"
TemplateComplexBodyC & Body()
Access body.

const TemplateComplexBodyC & Body() const
Access body.

bool Build(StringC & fn)
Start build of document.

void SetupPresets(const HSetC<StringC> & nameset)
Setup presets.

void SetVar(const StringC & var,const StringC & val)
Set value of variable.

StringC GetVar(const StringC & var)
Get value of a variable.

StringC Interpret(const StringC & str)
Interpret string 'str' and return the result.

#include "Ravl/RefCounter.hh"
const RCHandleC<TemplateComplexBodyC> & operator =(const RCHandleC<TemplateComplexBodyC> & oth)
Assign handle.

RCHandleC<TemplateComplexBodyC> DeepCopy(UIntT levels = ((UIntT))) const
Do a deep copy of the object.

bool operator ==(const RCHandleC<TemplateComplexBodyC> & oth) const
Are handles to the same object ?

bool operator !=(const RCHandleC<TemplateComplexBodyC> & oth) const
Are handles to different objects ?

UIntT Hash() const
Default hash function.
This hashes on the address of the body.

bool IsValid() const
Test if this is a valid handle.

void Invalidate()
Invalidate this handle.
Unattaches the body from the handle.

bool IsHandleType(const DT &) const
Is handle of given type ?

void CheckHandleType(const DT & dummy) const
Check handle type. Throw an expception if not.

TemplateComplexBodyC & Body()
Access body of object.

const TemplateComplexBodyC & Body() const
Constant access to body of object.

UIntT References() const
Find the number of references to the body of this object.

ostream & operator <<(ostream & strm,const RCHandleC<TemplateComplexBodyC> & obj)

istream & operator >>(istream & strm,RCHandleC<TemplateComplexBodyC> & obj)


Maintainer:Charles Galambos, Created: 03/02/2000, Documentation by CxxDoc: Tue Aug 13 09:59:30 2002