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
cOperationIdentifier.h
Go to the documentation of this file.
1 /**
2  * @file cOperationIdentifier
3  * file name: cOperationIdentifier.h
4  * @author Betti Oesterholz
5  * @date 26.02.2010
6  * @mail webmaster@BioKom.info
7  *
8  * System: C++
9  *
10  * This header specifies a class for identifiers for operations.
11  * Copyright (C) @c GPL3 2010 Betti Oesterholz
12  *
13  * This program is free software: you can redistribute it and/or modify
14  * it under the terms of the GNU General Public License (GPL) as
15  * published by the Free Software Foundation, either version 3 of the
16  * License, or any later version.
17  *
18  * This program is distributed in the hope that it will be useful,
19  * but WITHOUT ANY WARRANTY; without even the implied warranty of
20  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
21  * GNU Lesser General Public License for more details.
22  *
23  * You should have received a copy of the GNU General Public License
24  * along with this program. If not, see <http://www.gnu.org/licenses/>.
25  *
26  *
27  * This header specifies a class for identifiers for operations.
28  * The identifier is a unique object for all possible operations.
29  * @see cOperation
30  *
31  */
32 /*
33 History:
34 26.02.2010 Oesterholz created
35 */
36 
37 #ifndef ___C_OPERATION_IDENTIFIER_H__
38 #define ___C_OPERATION_IDENTIFIER_H__
39 
40 #include "version.h"
41 
42 
43 namespace enviroment{
44 
45 
46 class cOperationIdentifier{
47 
48 protected:
49 
50  /**
51  * the identifier of a operation, wich is unique for all operations
52  * in one enviroment instantiation
53  */
54  unsigned long long ulOperationIdentifier;
55 
56  /**
57  * the identifier of the enviroment instantiation, so this identifier
58  * is unique, even for different enviroment instantiations
59  */
60  unsigned long long ulAlgorithmIdentifier;
61 
62 public:
63 
64  /**
65  * constructor
66  *
67  * @param ulInAlgorithmIdentifier the identifier of the enviroment
68  * instantiation
69  */
70  cOperationIdentifier( unsigned long long ulInAlgorithmIdentifier );
71 
72 
73  /**
74  * Comparisson on equal method for two cOperationIdentifier objects.
75  *
76  * @param idOperation the idOperationobject to compare this
77  * idOperationobject to
78  * @return true if the cOperationIdentifier this object represents is
79  * equal to the cOperationIdentifier the given object idOperation
80  * represents
81  */
82  bool equal( const cOperationIdentifier &idOperation ) const;
83 
84  /**
85  * Comparisson on equal operator for two cOperationIdentifier objects.
86  *
87  * @param idOperation the idOperationobject to compare this
88  * idOperationobject to
89  * @return true if the cOperationIdentifier this object represents is
90  * equal to the cOperationIdentifier the given object idOperation
91  * represents
92  */
93  bool operator==( const cOperationIdentifier &idOperation ) const;
94 
95  /**
96  * Comparisson on not equal operator for two cOperationIdentifier objects.
97  *
98  * @param idOperation the idOperationobject to compare this
99  * idOperationobject to
100  * @return true if the cOperationIdentifier this object represents is
101  * not equal to the cOperationIdentifier the given object idOperation
102  * represents
103  */
104  bool operator!=( const cOperationIdentifier &idOperation ) const;
105 
106 private:
107 
108  /**
109  * @return a operation identifier that wasn't used bevor
110  */
111  static unsigned long long getNewOperationIdentifier();
112 
113 
114 
115 };//end class cOperationIdentifier
116 
117 
118 
119 };//end namespace enviroment
120 
121 #endif //___C_OPERATION_IDENTIFIER_H__
122 
123 
124 
125 
126 
127 
128