shiftModule.h

Go to the documentation of this file.

// -*- Mode: C++; tab-width: 2; -*-
// vi: set ts=2:
//
// $Id: shiftModule.h,v 1.18 2005/12/23 17:01:56 amoll Exp $
//

#ifndef BALL_NMR_SHIFTMODULE_H
#define BALL_NMR_SHIFTMODULE_H

#ifndef BALL_KERNEL_SYSTEM_H
# include<BALL/KERNEL/system.h>
#endif

#ifndef BALL_DATATYPE_STRING_H
# include<BALL/DATATYPE/string.h>
#endif

#ifndef BALL_CONCEPT_PROCESSOR_H
# include<BALL/CONCEPT/processor.h>
#endif

#ifndef BALL_FORMAT_PARAMETERS_H
# include<BALL/FORMAT/parameters.h>
#endif

namespace BALL 
{
  class BALL_EXPORT ShiftModule 
    : public UnaryProcessor<Composite>
  {
    public: 

    BALL_CREATE(ShiftModule)

    

    static const char* PROPERTY__SHIFT;
    static const char* PROPERTY__EXPERIMENTAL__SHIFT;

    
    ShiftModule();

    ShiftModule(Parameters& parameters, const String& name = "");

    ShiftModule(const ShiftModule& module);

    virtual ~ShiftModule();

    virtual void clear();



    const ShiftModule& operator = (const ShiftModule& module);



    void setName(const String& name);

    const String& getName() const;

    void setParameters(Parameters& parameters);

    const Parameters* getParameters() const;

    virtual void init();



    virtual bool start();

    virtual bool finish();



    bool isValid() const;


    protected:

    /*_ The module name
    */
    String  module_name_;   

    /*_ A pointer to the modules parameters
    */
    Parameters* parameters_;

    /*_ The module's validity flag.
        This flag should indicate that the module was correctly
        initialized (using \Ref{init}).
    */
    bool valid_;
  };
  
} // namespace BALL

#endif // BALL_NMR_SHIFTMODULE_H