File: CRelevanceLevel.h

package info (click to toggle)
gnuift 0.1.14%2Bds-1
  • links: PTS
  • area: main
  • in suites: stretch
  • size: 5,632 kB
  • ctags: 2,973
  • sloc: cpp: 15,867; sh: 8,281; ansic: 1,812; perl: 1,007; php: 651; makefile: 483; lisp: 344
file content (168 lines) | stat: -rw-r--r-- 3,350 bytes parent folder | download
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
/* -*- mode: c++ -*- 
*/
/* 

    GIFT, a flexible content based image retrieval system.
    Copyright (C) 1998, 1999, 2000, 2001, 2002, CUI University of Geneva

     Copyright (C) 2003, 2004 Bayreuth University
      2005 Bamberg University
    This program is free software; you can redistribute it and/or modify
    it under the terms of the GNU General Public License as published by
    the Free Software Foundation; either version 2 of the License, or
    (at your option) any later version.

    This program is distributed in the hope that it will be useful,
    but WITHOUT ANY WARRANTY; without even the implied warranty of
    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
    GNU General Public License for more details.

    You should have received a copy of the GNU General Public License
    along with this program; if not, write to the Free Software
    Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA

*/
/**
*
* CRELEVANCELEVEL
*
*
*
* modification history:
* WM   1099 changed documentation fromat 
* HM 090399 created the documentation
* WM   1098 created the file
*
*
* compiler defines used:
*
* @author Wolfgang Mueller
*
*/
#ifndef _CRELEVANCELEVEL
#define _CRELEVANCELEVEL
#include "libMRML/include/uses-declarations.h"
#include <iostream>
#include <string>
#include "libMRML/include/TID.h"
#include <functional>

/** 
 * Level of relevance given by the user to an image (URL) 
 * This structure is used both for user given relevances as 
 * well as for calculated relevances (scores).
 *
 * What do you think, folx? I think, that the relevance level
 * as it is, is too inflexible. We need to reflect a bit more
 * what is given by MRML. to be FIXME d
 *
 */
class CRelevanceLevel{
  /**  */
  string mURL;
  /**  */
  double mRelevanceLevel;
public:
  /**
   *
   * just used to be able to construct emtpy elements in 
   * which to copy (STL)
   *
   */
  CRelevanceLevel();
  
  /**
   *
   * The constructor most frequently used.
   *
   */
  CRelevanceLevel(const string& inURL,
		  double inRelevanceLevel);
  
  /**
   *
   * copy constructor
   *
   */
  CRelevanceLevel(const CRelevanceLevel& inElement);
  
  /**
   *
   *
   * binary input
   *
   */
  bool input(istream& inStream);
  
  /**
   *
   * binary output
   *
   */
  bool output(ostream& outStream)const;
  
  /**
   *
   * output as HTML
   *
   */
  bool outputHTML(ostream& outStream)const;
  
  //@}
  
  /**
   *
   * Accessors
   *
   */
  string getURL()const;
  
  /**
   *
   * 
   *
   */
  double getRelevanceLevel()const;
  
  /**
   *
   * 
   *
   */
  void setRelevanceLevel(const double inRelevanceLevel);
  
  /**
   *
   * 
   *
   */
  void adjustRelevanceLevel(const double inRelevanceLevel);
  
  /**
   *
   * 
   *
   */
  void divideRelevanceLevelBy(const double inDivisor);
  /**  */
  string toXML()const;
};

/**
* Default less operator for the CRelevanceLevel class.
*  Sorts by mRelevancelevel. For sorting in the STL.
*
*/
bool operator<(const CRelevanceLevel& l,
	       const CRelevanceLevel& t);

/** sort CAccessorElements by their ID */
class CSortByURL_RL:public binary_function<CRelevanceLevel,CRelevanceLevel,bool>{
 public:
  /**                                          */
  bool operator()(const CRelevanceLevel& l,
		  const CRelevanceLevel& t)const;
};


#endif