BALL
1.4.1
|
00001 // -*- Mode: C++; tab-width: 2; -*- 00002 // vi: set ts=2: 00003 // 00004 // $Id: shiftModule.h,v 1.18 2005/12/23 17:01:56 amoll Exp $ 00005 // 00006 00007 #ifndef BALL_NMR_SHIFTMODULE_H 00008 #define BALL_NMR_SHIFTMODULE_H 00009 00010 #ifndef BALL_KERNEL_SYSTEM_H 00011 # include<BALL/KERNEL/system.h> 00012 #endif 00013 00014 #ifndef BALL_DATATYPE_STRING_H 00015 # include<BALL/DATATYPE/string.h> 00016 #endif 00017 00018 #ifndef BALL_CONCEPT_PROCESSOR_H 00019 # include<BALL/CONCEPT/processor.h> 00020 #endif 00021 00022 #ifndef BALL_FORMAT_PARAMETERS_H 00023 # include<BALL/FORMAT/parameters.h> 00024 #endif 00025 00026 namespace BALL 00027 { 00041 class BALL_EXPORT ShiftModule 00042 : public UnaryProcessor<Composite> 00043 { 00044 public: 00045 00046 BALL_CREATE(ShiftModule) 00047 00048 00051 00058 static const char* PROPERTY__SHIFT; 00059 static const char* PROPERTY__EXPERIMENTAL__SHIFT; 00061 00065 00068 ShiftModule(); 00069 00072 ShiftModule(Parameters& parameters, const String& name = ""); 00073 00076 ShiftModule(const ShiftModule& module); 00077 00080 virtual ~ShiftModule(); 00081 00085 virtual void clear(); 00086 00088 00091 00094 const ShiftModule& operator = (const ShiftModule& module); 00095 00097 00100 00103 void setName(const String& name); 00104 00107 const String& getName() const; 00108 00115 void setParameters(Parameters& parameters); 00116 00119 const Parameters* getParameters() const; 00120 00129 virtual void init(); 00130 00132 00135 00140 virtual bool start(); 00141 00146 virtual bool finish(); 00147 00149 00152 00157 bool isValid() const; 00158 00160 00161 protected: 00162 00163 /*_ The module name 00164 */ 00165 String module_name_; 00166 00167 /*_ A pointer to the modules parameters 00168 */ 00169 Parameters* parameters_; 00170 00171 /*_ The module's validity flag. 00172 This flag should indicate that the module was correctly 00173 initialized (using \Ref{init}). 00174 */ 00175 bool valid_; 00176 }; 00177 00178 } // namespace BALL 00179 00180 #endif // BALL_NMR_SHIFTMODULE_H