BDSMagnetStrength.hh

/* 
Beam Delivery Simulation (BDSIM) Copyright (C) Royal Holloway, 
University of London 2001 - 2023.
 
This file is part of BDSIM.
 
BDSIM is free software: you can redistribute it and/or modify 
it under the terms of the GNU General Public License as published 
by the Free Software Foundation version 3 of the License.
 
BDSIM is distributed in the hope that it will be useful, but 
WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
GNU General Public License for more details.
 
You should have received a copy of the GNU General Public License
along with BDSIM.  If not, see <http://www.gnu.org/licenses/>.
*/
#ifndef BDSMAGNETSTRENGTH_H
#define BDSMAGNETSTRENGTH_H
 
#include "globals.hh" // geant4 globals / types
 
#include <map>
#include <ostream>
#include <vector>
 
class BDSMagnetStrength
{
private:
  typedef std::map<G4String, G4double> StrengthMap;
 
  StrengthMap strengths;
  
public:
  BDSMagnetStrength(){;}
 
  explicit BDSMagnetStrength(const std::map<G4String, G4double>& keyvalues);
 
  ~BDSMagnetStrength(){;}
 
  friend std::ostream& operator<< (std::ostream &out, BDSMagnetStrength const &st);
 
  std::ostream& WriteValuesInSIUnitsForSuvey(std::ostream& out,
                                             const G4int precision = 14) const;
 
  struct unitsFactors
  {
    G4String unit;
    G4double factor;
  };
  
  G4double& operator[](const G4String& key);
  const G4double& operator[](const G4String& key) const;
  const G4double& at(const G4String& key) const {return (*this)[key];}
 
  static const std::vector<G4String>& AllKeys() {return keys;}
  
  static G4bool ValidKey(const G4String& key);
 
  static const std::map<G4String, unitsFactors>& UnitsAndFactors() {return unitsFactorsMap;}
 
  static inline std::vector<G4String> NormalComponentKeys() {return normalComponentKeys;}
 
  static inline std::vector<G4String> SkewComponentKeys() {return skewComponentKeys;}
 
  std::vector<G4double> NormalComponents() const;
 
  std::vector<G4double> SkewComponents() const;
 
  static G4String UnitName(const G4String& key);
 
  static G4double Unit(const G4String& key);
  
  G4bool KeyHasBeenSet(const G4String& key) const;
  
  typedef StrengthMap::iterator       iterator;
  typedef StrengthMap::const_iterator const_iterator;
  iterator       begin()       {return strengths.begin();}
  iterator       end()         {return strengths.end();}
  const_iterator begin() const {return strengths.begin();}
  const_iterator end()   const {return strengths.end();}
  G4bool         empty() const {return strengths.empty();}
  
private:
  const G4double& GetValue(const G4String& key) const;
 
  static const std::vector<G4String> keys;
 
  static const std::map<G4String, unitsFactors> unitsFactorsMap;
 
  static const std::vector<G4String> normalComponentKeys;
 
  static const std::vector<G4String> skewComponentKeys;
 
  static const G4double zero;
 
  static G4double variable;
};
 
 
#endif