shiftModel.h

Go to the documentation of this file.

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

#ifndef BALL_NMR_SHIFTMODEL_H
#define BALL_NMR_SHIFTMODEL_H

#ifndef BALL_NMR_SHIFTMODULE_H
# include <BALL/NMR/shiftModule.h>
#endif

#ifndef BALL_DATATYPE_OPTIONS_H
# include <BALL/DATATYPE/options.h>
#endif

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

namespace BALL 
{
  class BALL_EXPORT ShiftModel 
    : public ShiftModule    
  {
    public: 

    BALL_CREATE(ShiftModel)

    

    typedef std::list<ShiftModule*> ModuleList;

    typedef void * (*CreateMethod) ();

    typedef StringHashMap<CreateMethod> CreateMethodMap;



    static const char* MODULE_LIST_SECTION;


    
    ShiftModel();

    ShiftModel(const String& filename);

    ShiftModel(const ShiftModel& model);

    virtual ~ShiftModel();

    void clear();



    Parameters& getParameters();

    ModuleList& getModuleList();

    void setFilename(const String& filename)
      throw(Exception::FileNotFound);

    const String& getFilename() const;
    
    void registerModule(const String& name, CreateMethod method) 
      throw(Exception::NullPointer);

    void unregisterModule(const String& name) ;


      
    bool isValid() const;

    bool isRegistered(const String& name) const;


      
    const ShiftModel& operator = (const ShiftModel& model);

    const ShiftModel& operator = (const String& filename);



    Options options;



    bool start();

    bool finish();

    Processor::Result operator () (Composite& composite);

    protected:

    /*_ Initialize the model from the parameter file.
        This method assumes that object has a valid parameter file assigned.
        It sets {\tt valid_} to <b>  true </b> if it could create a shift model 
        from the contents of the parameter file.
    */
    bool init_()
      throw(Exception::FileNotFound);

    /*_ Create a ShiftModule from a symbolic name.
        This method create a shift module from the symbolic
        name if this name is contained in the hash map \Ref{registered_modules_}.
    */
    ShiftModule* createModule_(const String& type, const String& name) const;

    /*_ Register the standard modules.
    */
    void registerStandardModules_();
    
    /*_ The parameters object
    */
    Parameters parameters_;

    /*_ The list of shift modules of this model
    */
    ModuleList modules_;

    /*_ A hash map containing all registered module types and their creation methods.
    */
    CreateMethodMap registered_modules_;

    /*_ The validity flag.
        Set to <b>  true </b> if the object was initialized correctly.
    */
    bool valid_;
  };
  
} // namespace BALL

#endif // BALL_NMR_SHIFTMODEL_H