PUBLIC

QueryOptionBodyC::QueryOptionBodyC(void) QueryOptionBodyC::QueryOptionBodyC(istream &) QueryOptionBodyC::Copy(void) const QueryOptionBodyC::Save(ostream &) const QueryOptionBodyC::QueryList(void) const QueryOptionBodyC::QueryList(const FilenameC) QueryOptionBodyC::ImageList(void) const QueryOptionBodyC::ImageList(const FilenameC &) QueryOptionBodyC::WorldDataSet(void) const QueryOptionBodyC::WorldDataSet(const FilenameC &) QueryOptionBodyC::FeatureList(void) const QueryOptionBodyC::FeatureList(const FilenameC &) QueryOptionBodyC::IndexDir(void) const QueryOptionBodyC::IndexDir(const FilenameC &) QueryOptionBodyC::TrainList(void) const QueryOptionBodyC::TrainList(const FilenameC &) QueryOptionBodyC::ExtraTrainSamps(void) const QueryOptionBodyC::ExtraTrainSamps(const IntT &) QueryOptionBodyC::TrainingAlgorithm(void) const QueryOptionBodyC::TrainingAlgorithm(const StringC &) QueryOptionBodyC::ScoringFunction(void) const QueryOptionBodyC::ScoringFunction(const StringC &) QueryOptionBodyC::File(void) const QueryOptionBodyC::File(const FilenameC &) QueryOptionBodyC::Threshold(void) const QueryOptionBodyC::Threshold(RealT) QueryOptionBodyC::HiddenUnits(void) const QueryOptionBodyC::HiddenUnits(IntT) QueryOptionBodyC::Cycles(void) const QueryOptionBodyC::Cycles(IntT) QueryOptionBodyC::TrainingSamples(void) const QueryOptionBodyC::TrainingSamples(IntT) QueryOptionBodyC::LearningRate(void) const QueryOptionBodyC::LearningRate(RealT) QueryOptionBodyC::Momentum(void) const QueryOptionBodyC::Momentum(RealT) QueryOptionBodyC::Verbose(void) const QueryOptionBodyC::Verbose(BooleanT) QueryOptionBodyC::operator<<(ostream &,const QueryOptionBodyC &) QueryOptionBodyC::operator>>(istream &,QueryOptionBodyC &) BodyRefCounterVC::Copy(void) const BodyRefCounterVC::operator==(const BodyRefCounterVC &) const BodyRefCounterVC::operator!=(const BodyRefCounterVC &) const BodyRefCounterVC::Save(ostream &) const BodyRefCounterC::AddReference(void) BodyRefCounterC::RemoveReference(void) BodyRefCounterC::SetConst(void) const BodyRefCounterC::SetConst(void) BodyRefCounterC::IsConst(void) const BodyRefCounterC::IsNotConst(void) const BodyRefCounterC::ToBeDeleted(void) const BodyRefCounterC::ToBeDeletedRemoveIgnoreNoRemove(void) BodyRefCounterC::ToBeDeletedRemove(void) BodyRefCounterC::BodyMightBeDeleted(void) const BodyRefCounterC::IsCountZero(void) const BodyRefCounterC::BRCPtrCanDeleteObject(void) const BodyRefCounterC::Count(void) const BodyRefCounterC::operator=(const BodyRefCounterC &) BodyRefCounterC::IsValidObject(void) const BodyRefCounterC::UserBitTest(IntT) const BodyRefCounterC::UserBitSet(IntT,BooleanT) BodyRefCounterC::UserBitZero(IntT) BodyRefCounterC::ReportBRCError(char *) BodyRefCounterC::Hash(void) const RefCounterBaseC::Label(void) const

QueryOptionBodyC
Put a brief description of your class body here
include	"amma/visualdb/QueryOption.hh"
User Level:	Default
Library:	Browser
Example:	exIndex.cc
Section:	Applications.Image Database
In Scope:	std

Comments:
Put a more detailed description of your class here. You use embedded html to make it clearer in the html documentation. This documentation should be aimed at people who might what to extend your class.

public BodyRefCounterVC

QueryOptionBodyC()

Constructor

ind	Index of types of intererest.

QueryOptionBodyC(istream & in)

Operators ---------

ind	Index of types of intererest.

BodyRefCounterVC & Copy() const

Creat a copy of this object.

ind	Index of types of intererest.

BooleanT Save(ostream & out) const

Methods -------

ind	Index of types of intererest.

FilenameC QueryList() const

ind	Index of types of intererest.

void QueryList(const FilenameC ql)

access/modify query list

ind	Index of types of intererest.

FilenameC ImageList() const

ind	Index of types of intererest.

void ImageList(const FilenameC & il)

access/modify image list

ind	Index of types of intererest.

FilenameC WorldDataSet() const

ind	Index of types of intererest.

void WorldDataSet(const FilenameC & wd)

access/modify wdset

ind	Index of types of intererest.

FilenameC FeatureList() const

ind	Index of types of intererest.

void FeatureList(const FilenameC & fl)

access/modify feature list

ind	Index of types of intererest.

FilenameC IndexDir() const

ind	Index of types of intererest.

void IndexDir(const FilenameC & id)

access/modify index dir Added by Lee Gregory 16th March 00

ind	Index of types of intererest.

FilenameC TrainList() const

ind	Index of types of intererest.

void TrainList(const FilenameC & tl)

access/modify the training list Added by Lee Gregory 20th March 00

ind	Index of types of intererest.

IntT ExtraTrainSamps() const

ind	Index of types of intererest.

void ExtraTrainSamps(const IntT & Et)

access/modify the number if extra training samples

ind	Index of types of intererest.

StringC TrainingAlgorithm() const

ind	Index of types of intererest.

void TrainingAlgorithm(const StringC & ta)

ind	Index of types of intererest.

StringC ScoringFunction() const

ind	Index of types of intererest.

void ScoringFunction(const StringC & sc)

ind	Index of types of intererest.

FilenameC File() const

ind	Index of types of intererest.

void File(const FilenameC & fn)

ind	Index of types of intererest.

RealT Threshold() const

ind	Index of types of intererest.

void Threshold(RealT t)

ind	Index of types of intererest.

IntT HiddenUnits() const

ind	Index of types of intererest.

void HiddenUnits(IntT h)

ind	Index of types of intererest.

IntT Cycles() const

ind	Index of types of intererest.

void Cycles(IntT c)

ind	Index of types of intererest.

IntT TrainingSamples() const

ind	Index of types of intererest.

void TrainingSamples(IntT s)

ind	Index of types of intererest.

RealT LearningRate() const

ind	Index of types of intererest.

void LearningRate(RealT l)

ind	Index of types of intererest.

RealT Momentum() const

ind	Index of types of intererest.

void Momentum(RealT m)

ind	Index of types of intererest.

BooleanT Verbose() const

ind	Index of types of intererest.

void Verbose(BooleanT v)

Friends -------

ind	Index of types of intererest.

ostream & operator<<(ostream & s,const QueryOptionBodyC & out)

output stream operator

ind	Index of types of intererest.

istream & operator>>(istream & s,QueryOptionBodyC & in)

input stream operator

ind	Index of types of intererest.

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.

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.

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.