System documentation of the GNU Image-Finding Tool

Public Member Functions | Protected Member Functions | Protected Attributes | List of all members
CQHierarchy Class Reference

This is a simple hierarchy based browser. More...

#include <CQHierarchy.h>

Inheritance diagram for CQHierarchy:
CQuery CMagic

Public Member Functions

 CQHierarchy ()
 default constructor More...
 
 ~CQHierarchy ()
 we need to unregister the accessors used More...
 
 CQHierarchy (CAccessorAdminCollection &inAccessorAdminCollection, CAlgorithm &inAlgorithm)
 In fact, what we are doing here is to get ourselves an accessor ACURL2FTS to do a proper fastQuery.
 
virtual CIDRelevanceLevelPairListfastQuery (const CXMLElement &inQuery, int inNumberOfInterestingImages, double inDifferenceToBest)
 enables moving in the hierarchy. More...
 
virtual bool setAlgorithm (CAlgorithm &inAlgorithm)
 set the Algorithm.
 
- Public Member Functions inherited from CQuery
 CQuery ()
 default constructor More...
 
virtual ~CQuery ()
 destructor More...
 
 CQuery (CAccessorAdminCollection &inAccessorAdminCollection, CAlgorithm &inAlgorithm)
 this constructor takes all the information ANY CQuery needs to configure itself. More...
 
void addChild (CQuery *inChild, double inWeight=1)
 adding a child to this. More...
 
virtual CXMLElementquery (const CXMLElement &inQuery)
 do a query More...
 
virtual CXMLElementgetRandomImages (int inNumberOfInterestingImages) const
 get some random images (handed through to accessor) More...
 
virtual CIDRelevanceLevelPairListgetRandomIDs (int inNumberOfInterestingImages) const
 get some random images (handed through to accessor) More...
 
virtual list< TID > * getAllIDs () const
 get the IDs of all images (handed through to accessor) More...
 
virtual list< CAccessorElement > * getAllAccessorElements () const
 get the IDs of all images (handed through to accessor) More...
 
const CAlgorithmgetAlgorithm () const
 get the Algorithm. More...
 
virtual void finishInit ()
 it might be necessary to wait until all the children are added before ending the initialisation phase. More...
 
- Public Member Functions inherited from CMagic
void check () const
 This function checks the magic number of this and asserts to zero, if something is wrong, if things are ok, this function keeps quiet.
 
void checkNPrint () const
 as check(), but it also prints a small message to cout, saying that the check worked.
 
 CMagic ()
 sets the magic number to 42
 
 ~CMagic ()
 sets the magic number to another value (36)
 

Protected Member Functions

void init ()
 sets mCurrentPosition to 0
 

Protected Attributes

list< TID > mCurrentPath
 The current position in the hierarchy.
 
- Protected Attributes inherited from CQuery
CAccessormAccessor
 needed to translate URLs to IDs this is a pointer, only because we cannot change references it does not imply any destruction responsability
 
CAccessorAdminmAccessorAdmin
 This is where the the Accessor comes from. More...
 
CAccessorAdminCollectionmAccessorAdminCollection
 Where to get CAccessorAdmins from.
 
CAlgorithmmAlgorithm
 the structure containing everything we know about the algorithm used do not destroy this
 
lCChildren mChildren
 The children of this.
 

Additional Inherited Members

- Protected Types inherited from CQuery
typedef list< lCChildlCChildren
 type for children of this
 

Detailed Description

This is a simple hierarchy based browser.

: Wolfgang Müller

Constructor & Destructor Documentation

§ CQHierarchy()

CQHierarchy::CQHierarchy ( )

default constructor

§ ~CQHierarchy()

CQHierarchy::~CQHierarchy ( )

we need to unregister the accessors used

Member Function Documentation

§ fastQuery()

virtual CIDRelevanceLevelPairList* CQHierarchy::fastQuery ( const CXMLElement inQuery,
int  inNumberOfInterestingImages,
double  inDifferenceToBest 
)
virtual

enables moving in the hierarchy.

You can either move down (i.e. you select an image) or up in the hierarchy (by getting a cui-hierarchy-move-up signal as query). RICHLY COMMENTED IN THE *.cc FILE.

Parameters
inQueryan CXMLElement containing a query-step element
inNumberOfInterestingImagespreferred number of result images (ignored)
inDifferenceToBestpreferred relevance cutoff (ignored)

Implements CQuery.


The documentation for this class was generated from the following file:

Need for discussion? Want to contribute? Contact
help-gift@gnu.org Generated using Doxygen