The Fib multimedia system
Fib is a system for storing multimedia data (like images or films).
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros
cOpFindSimilarLineNBi.h
Go to the documentation of this file.
1 /**
2  * @file cOpFindSimilarLineNBi
3  * file name: cOpFindSimilarLineNBi.h
4  * @author Betti Oesterholz
5  * @date 05.07.2010
6  * @mail webmaster@BioKom.info
7  *
8  * System: C++
9  *
10  * This operator chooses n random points and combines it with all
11  * neibourpoints in an random choosen dimension with similar properties.
12  * Copyright (C) @c GPL3 2010 Betti Oesterholz
13  *
14  * This program is free software: you can redistribute it and/or modify
15  * it under the terms of the GNU General Public License (GPL) as
16  * published by the Free Software Foundation, either version 3 of the
17  * License, or any later version.
18  *
19  * This program is distributed in the hope that it will be useful,
20  * but WITHOUT ANY WARRANTY; without even the implied warranty of
21  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
22  * GNU Lesser General Public License for more details.
23  *
24  * You should have received a copy of the GNU General Public License
25  * along with this program. If not, see <http://www.gnu.org/licenses/>.
26  *
27  *
28  * This operator chooses s random points and combines it with all
29  * neibourpoints in an random choosen dimension with similar properties,
30  * with the help of an areaelement and if needed an functionelement.
31  * (The number n is randomly choosen.)
32  * In an last step it removes from the created fib -object all underobjects
33  * which point properties are overwritten and so not necessary.
34  *
35  *
36  * @see cOperationFib
37  * @see cOperation
38  * @see cEnviroment
39  */
40 /*
41 History:
42 05.07.2010 Oesterholz created
43 */
44 
45 
46 #ifndef ___C_OP_FIND_SIMILAR_LINE_N_Bi_H__
47 #define ___C_OP_FIND_SIMILAR_LINE_N_Bi_H__
48 
49 #include "version.h"
50 
51 #include "cOperationFib.h"
52 
53 #include <string>
54 
55 
56 namespace enviroment{
57 namespace fib{
58 
59 
61 public:
62 
63  /**
64  * The standardconstructor for the operation.
65  * It will create the operation, but won't start it.
66  *
67  * @param operationId the identifer for the operation
68  */
69  cOpFindSimilarLineNBi( const cOperationIdentifier & operationId );
70 
71  /**
72  * Destructor of the class cOpFindSimilarLineNBi.
73  */
74  virtual ~cOpFindSimilarLineNBi();
75 
76  /**
77  * This method creats a new instance of this operator.
78  * Beware: You have to delete the instance after usage.
79  *
80  * @param operationId the identifer for the operation
81  * @return a pointer to a new instance of this operation
82  */
83  virtual cOpFindSimilarLineNBi * createInstance( const cOperationIdentifier & operationId ) const;
84 
85  /**
86  * This method runs the operation.
87  * It will wait till the operation is ended befor returning.
88  * Beware: If overwriten call setIsRunning( false ), when the operation
89  * is done.
90  *
91  * @see start()
92  * @see stop()
93  * @see setIsRunning()
94  * @return true if the operation was started
95  */
96  virtual bool run();
97 
98  /**
99  * @return the (class-)name of the operation
100  */
101  virtual std::string getName() const;
102 
103 
104 };//end class cOpFindSimilarLineNBi
105 
106 
107 };//end namespace fib
108 };//end namespace enviroment
109 
110 #endif //___C_OP_FIND_SIMILAR_LINE_N_Bi_H__perator
111 
112 
113 
114 
115 
116 
117