DocumentBodyC - Documenter Body.

User Documentation

Centre for Vision, Speech & Signal Processing

Parent Classes:

TemplateComplexBodyC

DesciptionGeneratorC

Variables:

Methods:

DocumentBodyC(const FilenameC & tmplName,const StringC & outDir): Default contructor.
BooleanT Foralli(StringC & data,BooleanT ifAny = false): Do a forall build.
void Forall(StringC & data): Do a forall build.
void IfAny(StringC & data): Do a forall build.
void GotoInherit(StringC & param): Goto an inherited class.
void MakeFilename(StringC & pattern): Make a filename from a pattern and a full object name.
void Document(ObjectListC & ol): Document list of files.
FilenameC MakeFilename(ObjectC & obj,BooleanT relative = false): Makefile name
FilenameC MakeFilename(StringC pattern,ObjectC & obj,BooleanT relative = false): Make a filename from a pattern and a full object name.
void HtmlMethodName(StringC & arg): Make a linked version of the method name.
StringC GetHtmlTypeName(const DataTypeC & tn): Make a linked version of the method name.
void HtmlTypeName(StringC & arg): Make a linked version of the method name.
StringC MakeHRef(StringC name): Make a string suitable for an href.
BooleanT Lookup(const StringC & varname,StringC & buff): Lookup variable.
if found put value into 'buff' and return true. otherwise return false.

#include "amma/TemplateCmplx.hh"

void SetupPresets(const HSetC<StringC> & nameset): Setup preset variables.
BooleanT Scan(FilenameC & templ): Scan template file for preset variables.
The key, and values are added to the vars list.
BooleanT Scan(TextPFileC & templ): Scan template file for preset variables.
The key, and values are added to the vars list.
BooleanT Build(FilenameC & fn): Start build of document.
BooleanT BuildSub(TextPFileC & templ): Start build of document.
BooleanT Lookup(const StringC & varname,StringC & buff): Lookup variable.
if found put value into 'buff' and return true. otherwise return false.
void InitCommands(): Setup default commands.
void DoSet(StringC & txt): Set variable.
void DoFor(StringC & txt): Look over a list.
void DoIf(StringC & txt): If condition.
void DoIfSet(StringC & txt): If a variable is set.
void DoElse(StringC & txt): If a variable is set.
void DoInclude(StringC & txt): Include another template file.
void DoSub(StringC & txt): Make a sub context.
void DoSubCopy(StringC & txt): Make a sub context, copy old context.
void DoSubst(StringC & txt): Substution
void DoDefine(StringC & txt): Make a sub context, copy old context.
void DoMacro(StringC & txt,StringC & macro): Make a sub context, copy old context.
void DoUpperCase(StringC & txt): Make all text upper case.
void DoLowerCase(StringC & txt): Make all text lower case.
void DoSilent(StringC & txt): Make all text lower case.
Redirect output to /dev/null
void HtmlSafe(StringC & txt): Make sure text will be taken literally in html.
StringC MakeHtml(const StringC & name): Make string suitable for use in plain html.
void SetVar(const StringC & var,const StringC & val): Set value of a variable.
StringC GetVar(const StringC & var): Get value of a variable.
void SetupCommand(const StringC & cmd,ObjT & obj,ScopePath (*)(FuncArgList) func): Setup new command.
NB. Obj is used as a refrence, it is assumed to be a derived instance of this class.
OStreamC & Output(): Access current output stream.
BooleanT CheckCondition(StringC & cond): Check if a condition is met.

#include "amma/Cxx/Object.hh"

StringC TextFor(char let): Render a charactor.
Typical used for '<' '>' and the like..
StringC TextFor(const ObjectC & obj): Render a charactor.
StringC TextFor(const StringC & obj): Render a string 'as is'.
StringC MethodNameText(const StringC & obj): Render a method name appropriatly. (e.g. bold.)

#include "amma/BRefCntV.hh"

BodyRefCounterVC & Copy() const: Creat a copy of this object.
BooleanT operator==(const BodyRefCounterVC & oth) const: Compair identitys.
BooleanT operator!=(const BodyRefCounterVC & oth) const: Compair identitys.
BooleanT Save(ostream & out) const: Save to ostream.

#include "amma/BRefCnt.hh"

void AddReference(): Another reference to the object has been created.
void RemoveReference(): One reference to the object was deleted.
Locking scheme -------------- The object is possible to lock (to make constant). The scheme assumes that the object is created, it can be locked, after that it can only be destroyed. The locked object cannot be unlocked. This locking scheme is very useful during debugging, using assert() function, when it is necassary to check that object is treated as constant and the constancy is not violated by any casting or passing through the copy constructor of shared objects.
void SetConst(void) const: This locks the object.
Often objects you wish to lock are already const.
void SetConst(void): This locks the object.
BooleanT IsConst(void) const: Returns TRUE if the object is locked, ie. it is assumed to be constant.
BooleanT IsNotConst(void) const: Returns TRUE if the object is unlocked.
ie. there is no special information if the object is constant or not. Counter state information -------------------------
BooleanT ToBeDeleted() const: Returns TRUE if there is only one reference to the object and the whole object or its reference counting part can be deleted.
BooleanT ToBeDeletedRemoveIgnoreNoRemove(): Decrement refrence by 1 return true if this leaves no refrences to the object.
BooleanT ToBeDeletedRemove(): Decrement refrence by 1 return true if this leaves no refrences to the object. This also checks the NoRemove flag.
BooleanT BodyMightBeDeleted() const: Returns TRUE if the reference counted part of the object can be deleted, ie. flag NOREMOVE is false .
BooleanT IsCountZero() const: Are there any refrences left ?
BooleanT BRCPtrCanDeleteObject() const: Used by BRRCPtrC to establish if an object has ZERO refrences and can be deleted.
IntT Count() const: Returns the current state of the counter, ie. how many references to this object exist.
const BodyRefCounterC & operator=(const BodyRefCounterC & b): It has not meaning to assign object 'b' to this object because it would destroy a history of the object which is counted. So this is a dummy function.
BooleanT IsValidObject() const: Test if object is valid.
When amma check is disabled this always returns true.
BooleanT UserBitTest(IntT x) const: Test user flag.
void UserBitSet(IntT x,BooleanT setit = TRUE): Test user flag.
void UserBitZero(IntT x): Set bit to zero.
void ReportBRCError(char * Msg): Report error, used in BRCPtrC.
UIntT Hash() const: Hash on address of object.

#include "amma/RefCBase.hh"

LabelT Label() const: Returns the label of this reference counter.
The member function is useful mainly to recognize objects during debugging. The value of the label is uniquely defined pointer.

Programmer:Charles Galambos, Documentation by CxxDoc: Tue Mar 20 10:48:08 2001

DocumentBodyC

Documenter Body.

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