MF_Messenger.cc

Go to the documentation of this file.

//! \file
//!
//! Source file for Magnetic_Field messenger class for the user interface.
//!
//! Defines 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-10-17
//!
//! \ingroup control

// *+****1****+****2****+****3****+****4****+****5****+****6****+****7****+****

// Include user header files referenced in this file.

#include "MF_Messenger.h"
#include "Magnetic_Field.h"

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

#include "G4UIdirectory.hh"

// Initialise the static data pointer for the MF_Messenger class.

MF_Messenger * MF_Messenger::m_pInstance = 0;

// Use the standard namespace.

using namespace std;

// *+****1****+****2****+****3****+****4****+****5****+****6****+****7****+****

// Define the routine to return pointer to the instance of MF_Messenger.

MF_Messenger * MF_Messenger::Instance() {
   if( m_pInstance == 0 ) {
      m_pInstance = new MF_Messenger();
   }
   return m_pInstance;
}

// Constructor of MF_Messenger class.

MF_Messenger::MF_Messenger() {

   MFdir = new G4UIdirectory( "/Olympus/MF/" );
   MFdir->SetGuidance( "Magnetic Field user commands." );

}

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

void MF_Messenger::setMFptr( Magnetic_Field * ptr ) {

   pMF = ptr;

   // Magnetic field scale.

   MFsetScale = new G4UIcmdWithADouble( "/Olympus/MF/setScale", this );
   MFsetScale->SetGuidance( "Set magnetic field scale factor." );
   MFsetScale->SetParameterName( "scale", false );
   MFsetScale->SetRange( "scale >= -2.0 && scale <= 2.0" );
   MFsetScale->AvailableForStates( G4State_Idle );

   MFgetScale = new G4UIcmdWithoutParameter( "/Olympus/MF/getScale", this );
   MFgetScale->SetGuidance( "Get magnetic field scale factor." );
}

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

void MF_Messenger::SetNewValue( G4UIcommand * command, G4String newValue ) {

   // Magnetic field scale.

   if( command == MFsetScale ) {
      pMF->setScale( MFsetScale->GetNewDoubleValue( newValue ) );
      G4cout << "Magnetic Field scale = " << newValue << G4endl;
   }
   else if( command == MFgetScale ) {
      G4cout << "Magnetic Field scale = " << pMF->getScale() << G4endl;
   }

}

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

G4String MF_Messenger::GetCurrentValue( G4UIcommand * command ) {
   G4String cv;
   return cv;
}