BALL 1.5.0
shiftModule.h
Go to the documentation of this file.
1// -*- Mode: C++; tab-width: 2; -*-
2// vi: set ts=2:
3//
4// $Id: shiftModule.h,v 1.18 2005/12/23 17:01:56 amoll Exp $
5//
6
7#ifndef BALL_NMR_SHIFTMODULE_H
8#define BALL_NMR_SHIFTMODULE_H
9
10#ifndef BALL_KERNEL_SYSTEM_H
11# include<BALL/KERNEL/system.h>
12#endif
13
14#ifndef BALL_DATATYPE_STRING_H
16#endif
17
18#ifndef BALL_CONCEPT_PROCESSOR_H
20#endif
21
22#ifndef BALL_FORMAT_PARAMETERS_H
24#endif
25
26namespace BALL
27{
42 : public UnaryProcessor<Composite>
43 {
44 public:
45
47
48
51
52
58 static const char* PROPERTY__SHIFT;
59 static const char* PROPERTY__EXPERIMENTAL__SHIFT;
61
65
69
72 ShiftModule(Parameters& parameters, const String& name = "");
73
76 ShiftModule(const ShiftModule& module);
77
80 virtual ~ShiftModule();
81
85 virtual void clear();
86
88
91
94 const ShiftModule& operator = (const ShiftModule& module);
95
97
100
103 void setName(const String& name);
104
107 const String& getName() const;
108
115 void setParameters(Parameters& parameters);
116
119 const Parameters* getParameters() const;
120
129 virtual void init();
130
132
135
140 virtual bool start();
141
146 virtual bool finish();
147
149
152
157 bool isValid() const;
158
160
161 protected:
162
163 /*_ The module name
164 */
165 String module_name_;
166
167 /*_ A pointer to the modules parameters
168 */
169 Parameters* parameters_;
170
171 /*_ The module's validity flag.
172 This flag should indicate that the module was correctly
173 initialized (using \Ref{init}).
174 */
175 bool valid_;
176 };
177
178} // namespace BALL
179
180#endif // BALL_NMR_SHIFTMODULE_H
#define BALL_CREATE(name)
Definition: create.h:62
Definition: constants.h:13
const char * getName()
Definition: rtti.h:97
#define BALL_EXPORT
Definition: COMMON/global.h:50