HdrUpdateC - Update documentation variables at the top of header files.

Developer Documentation

Centre for Vision, Speech & Signal Processing

Parent Classes:

SrcCheckC

Variables:

BooleanT possess;: Possess RCS files.
StringC addLabel;
StringC addValue;
BooleanT forceValueUpdate;
BooleanT dryRun;

Methods:

HdrUpdateC(): Default constructor.
HdrUpdateC(FilenameC adir,BooleanT adryRun,BooleanT Enabled = TRUE,BooleanT possess = FALSE): Directory constructor.
HdrUpdateC(FilenameC adir,StringC naddVar,StringC naddVal,BooleanT nforceValueUpdate,BooleanT adryRun,BooleanT Enabled = TRUE,BooleanT possess = FALSE): Directory constructor.
BRCPtrC<SrcCheckC> NewSrc(FilenameC dir,BooleanT Enabled = TRUE): Open a new directory.
BooleanT DoOp(): Do operation on local directory.
Return TRUE=Continue. FALSE=Abort.
void SetForceValueUpdate(BooleanT val): Set force value update.

#include "amma/util/SrcCheck.hh"

BRCPtrC<SrcCheckC> NewSrc(FilenameC dir,BooleanT Enabled = TRUE): Open a new directory.
BooleanT LoadNested(BooleanT recurse = TRUE,BooleanT loadAll = FALSE,IntT CurDepth = 0): Load all sub-directories.
BooleanT DoOp(): Do operation on local directory.
Return TRUE=Continue. FALSE=Abort.
BooleanT MissingSubDir(StringC & dirName): Called if sub directory missing.
BooleanT DoNested(BooleanT all = FALSE): Call DoOp on subdirectories.
if all is true then even disabled directories are processed. This routine will return TRUE, if all the DoOp's succeded.
BooleanT IsEnabled() const: Has directory been enabled ?
BooleanT IsVerbose() const: In verbose mode ?
void SetVerbose(BooleanT v): Set verbose mode.
FilenameC CWD() const: Get Current Working Directory.
DefMkFileC & Defs(): Access def.mk info.
void SetSkipSubdir(BooleanT val): Set Skip Subdirectory flag.

#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.
void SetUndeletable(): Make object undeletable.
Usefull to prevent recursive deleting in graph structures. Only hackers need this function.
void ReportInvalidObject(char * Msg = 0) const: Tell user about validation failure.

#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:49:27 2001

HdrUpdateC

Update documentation variables at the top of header files.

include	"amma/util/HdrUpdate.hh"
User Level:	Default
Library:	SysUtil
Example:	exEndPoint.cc
Section:	Utilities.AMMA Maintenance
In Scope:	std