MF_Messenger.h

Go to the documentation of this file.

//! \file
//!
//! Header file for Magnetic_Field messenger class.
//!
//! Declares the singleton messenger class and its member routines which
//! control the parameters of Magnetic_Field detector within the OLYMPUS
//! Monte Carlo.  This allow the user to control the parameters and/or
//! running from command files or interactively.
//!
//! \author D.K. Hasell
//! \version 1.0
//! \date 2010-11-05
//!
//! \ingroup control

// Ensure header file is included only once.

#ifndef MF_MESSENGER_H
#define MF_MESSENGER_H

// Include the GEANT4 header files referenced in this file.

#include "G4UImessenger.hh"
#include "G4UIcommand.hh"
#include "G4UIdirectory.hh"
#include "G4UIcmdWithADouble.hh"
#include "G4UIcmdWithoutParameter.hh"

// Declare the classes referenced here.

class Magnetic_Field;

//! Declare the Messenger class based on G4UImessenger.

class MF_Messenger : public G4UImessenger {

public:

     //! Routine to return a pointer to the single instance of MF_Messenger.

     static MF_Messenger * Instance();

     //! Routine to set a pointer to the MF_SD class and define the user
     //! functions available.

     void setMFptr( Magnetic_Field * ptr );

     //! Routines to set new values and get current values.

     void SetNewValue( G4UIcommand * command, G4String newValues );

     //! Routine to get current value (not used).

     G4String GetCurrentValue( G4UIcommand * command );

//! These routines are kept private to preserve singleton class.

private:

     //! Constructor.

     MF_Messenger();

     //! Copy constructor.

     MF_Messenger( MF_Messenger const & ) {}

     //! Assignment operator.

     MF_Messenger & operator = ( MF_Messenger const & );

//! Data members of MF_Messenger class.

private:

     static MF_Messenger * m_pInstance; //!< Instance of MF_Messenger class.

     Magnetic_Field * pMF;              //!< Pointer to Magnetic_Field class.
     G4UIdirectory * MFdir;             //!< Pointer to MF UI structure.

     G4UIcmdWithADouble * MFsetScale;        //!< Magnetic field scale command.
     G4UIcmdWithoutParameter * MFgetScale;   //!< Magnetic field scale command.

};

#endif