Developer Documentation
Centre for Vision, Speech & Signal Processing
USER IN NAMESPACE AMMA TREE ROOT AMMA SEARCH AMMA HOME
 

  PUBLIC
QueryControlBodyC::QueryControlBodyC(void)
QueryControlBodyC::QueryControlBodyC(const FilenameC &)
QueryControlBodyC::QueryControlBodyC(istream &)
QueryControlBodyC::Copy(void) const
QueryControlBodyC::Save(ostream &) const
QueryControlBodyC::QueryImage(void) const
QueryControlBodyC::QueryFile(void) const
QueryControlBodyC::SetQueryFile(const FilenameC &)
QueryControlBodyC::Canvas(void)
QueryControlBodyC::CanvasData(void)
QueryControlBodyC::PaintImage(void) const
QueryControlBodyC::TextEntry(void) const
QueryControlBodyC::operator<<(ostream &,const QueryControlBodyC &)
QueryControlBodyC::operator>>(istream &,QueryControlBodyC &)
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
BodyRefCounterC::SetUndeletable(void)
BodyRefCounterC::ReportInvalidObject(char *) const
RefCounterBaseC::Label(void) const
QueryControlBodyC
 
Put a brief description of your class body here
 
include "amma/visualdb/QueryControl.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.

Parent Classes: Variables:
RGBImageC query;
display query image
indIndex of types of intererest.

FilenameC queryfile;
name of file to put queries into
indIndex of types of intererest.

GUICanvasC canvas;
This is where we are going to display the image
indIndex of types of intererest.

GUITextEntryC ginfo;
Display some information about image
indIndex of types of intererest.

QueryCanvasDataC qcd;
query canvas data
indIndex of types of intererest.

Methods:
QueryControlBodyC()
Constructor
indIndex of types of intererest.

QueryControlBodyC(const FilenameC & inFile)
Construct with input query image
indIndex of types of intererest.

QueryControlBodyC(istream & in)
Operators ---------
indIndex of types of intererest.

BodyRefCounterVC & Copy() const
Creat a copy of this object.
indIndex of types of intererest.

BooleanT Save(ostream & out) const
Methods -------
indIndex of types of intererest.

RGBImageC QueryImage() const
Access to master display image
indIndex of types of intererest.

FilenameC QueryFile() const
access to query file
indIndex of types of intererest.

void SetQueryFile(const FilenameC & fn)
set query file
indIndex of types of intererest.

GUICanvasC Canvas()
Access to the canvas
indIndex of types of intererest.

QueryCanvasDataC CanvasData()
Access to the canvas data
indIndex of types of intererest.

void PaintImage() const
Draw the image onto the canvas
indIndex of types of intererest.

GUITextEntryC TextEntry() const
Display some info about image Friends -------
indIndex of types of intererest.

ostream & operator<<(ostream & s,const QueryControlBodyC & out)
output stream operator
indIndex of types of intererest.

istream & operator>>(istream & s,QueryControlBodyC & in)
input stream operator
indIndex of types of intererest.

#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.

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:Kieron J Messer, Documentation by CxxDoc: Tue Mar 20 10:49:27 2001