PUBLIC

DocumentC::DocumentC(void) DocumentC::DocumentC(const FilenameC &,const StringC &) DocumentC::Body(void) DocumentC::Body(void) const DocumentC::Document(ObjectListC &) TemplateComplexC::Body(void) TemplateComplexC::Body(void) const TemplateComplexC::Build(FilenameC &) TemplateComplexC::SetupPresets(const HSetC &) TemplateComplexC::SetVar(const StringC &,const StringC &) TemplateComplexC::GetVar(const StringC &) RCHandleC::IsValid(void) const RCHandleC::IsValidObject(void) const RCHandleC::operator=(const RCHandleC &) RCHandleC::operator==(const RCHandleC &) const RCHandleC::operator!=(const RCHandleC &) const RCHandleC::Hash(void) const RCHandleC::IsConst(void) const RCHandleC::IsNotConst(void) const RCHandleC::SetConst(void) const RCHandleC::Invalidate(void) RCHandleC::Body(void) RCHandleC::Body(void) const

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

Parent Classes:

public TemplateComplexC

DocumentC()

Default contructor.
Creates an invalid handle.

DocumentC(const FilenameC & tmplName,const StringC & outDir)

Contructor.
Create a documentor

DocumentBodyC & Body()

Access body.

const DocumentBodyC & Body() const

Access body.

void Document(ObjectListC & ol)

Document list of files.

TemplateComplexBodyC & Body()

Access body.

const TemplateComplexBodyC & Body() const

Access body.

BooleanT Build(FilenameC & 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.

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<TemplateComplexBodyC> & operator=(const RCHandleC<TemplateComplexBodyC> & oth)

Assignment.

BooleanT operator==(const RCHandleC<TemplateComplexBodyC> & oth) const

Comparison operator.

BooleanT operator!=(const RCHandleC<TemplateComplexBodyC> & 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.

TemplateComplexBodyC & Body()

Direct access to body.

const TemplateComplexBodyC & Body() const

Constant access to body.