Geant4  10.03.p02
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Groups Pages
G4ModelColourMap.hh
Go to the documentation of this file.
1 //
2 // ********************************************************************
3 // * License and Disclaimer *
4 // * *
5 // * The Geant4 software is copyright of the Copyright Holders of *
6 // * the Geant4 Collaboration. It is provided under the terms and *
7 // * conditions of the Geant4 Software License, included in the file *
8 // * LICENSE and available at http://cern.ch/geant4/license . These *
9 // * include a list of copyright holders. *
10 // * *
11 // * Neither the authors of this software system, nor their employing *
12 // * institutes,nor the agencies providing financial support for this *
13 // * work make any representation or warranty, express or implied, *
14 // * regarding this software system or assume any liability for its *
15 // * use. Please see the license in the file LICENSE and URL above *
16 // * for the full disclaimer and the limitation of liability. *
17 // * *
18 // * This code implementation is the result of the scientific and *
19 // * technical work of the GEANT4 collaboration. *
20 // * By using, copying, modifying or distributing the software (or *
21 // * any work based on the software) you agree to acknowledge its *
22 // * use in resulting scientific publications, and indicate your *
23 // * acceptance of all terms of the Geant4 Software license. *
24 // ********************************************************************
25 //
26 // $Id: G4ModelColourMap.hh 95593 2016-02-16 10:48:50Z gcosmo $
27 //
28 // Generic variable->G4Colour map, where "variable" is the template
29 // parameter.
30 //
31 // Jane Tinslay March 2006
32 
33 #ifndef G4MODELCOLOURMAP_HH
34 #define G4MODELCOLOURMAP_HH
35 
36 #include "G4Colour.hh"
37 #include "G4String.hh"
38 #include <map>
39 
40 template <typename T>
42 
43 public: // With description
44 
46 
47  virtual ~G4ModelColourMap();
48 
49  // Configuration functions
50  void Set(const T&, const G4Colour&);
51  void Set(const T&, const G4String&);
52  G4Colour& operator[](const T& quantity);
53 
54  // Access functions
55  const std::map<T, G4Colour>& GetBasicMap() const;
56  bool GetColour(const T&, G4Colour&) const;
57  void Print(std::ostream& ostr) const;
58 
59 private:
60 
61  // Data member
62  std::map<T, G4Colour> fMap;
63 
64 };
65 
66 template <typename T>
67 G4Colour&
68 G4ModelColourMap<T>::operator[](const T& quantity) {return fMap[quantity];}
69 
70 template <typename T>
72 
73 template <typename T>
75 
76 template <typename T>
77 void
78 G4ModelColourMap<T>::Set(const T& quantity, const G4String& colour)
79 {
80  G4Colour myColour;
81 
82  // Will not setup the map if colour key does not exist
83  if (!G4Colour::GetColour(colour, myColour)) {
85  ed << "G4Colour with key "<<colour<<" does not exist ";
87  ("G4ColourMap::Set(Charge charge, const G4String& colour)",
88  "modeling0108", JustWarning, ed);
89  return;
90  }
91 
92 
93  // Will not modify myColour if colour key does not exist
94  Set(quantity, myColour);
95 }
96 
97 template <typename T>
98 void
99 G4ModelColourMap<T>::Set(const T& quantity, const G4Colour& colour)
100 {
101  fMap[quantity] = colour;
102 }
103 
104 template <typename T>
105 const std::map<T, G4Colour>& G4ModelColourMap<T>::GetBasicMap() const
106 { return fMap; }
107 
108 template <typename T>
109 bool
110 G4ModelColourMap<T>::GetColour(const T& quantity, G4Colour& colour) const
111 {
112  typename std::map<T, G4Colour>::const_iterator iter = fMap.find(quantity);
113 
114  if (iter != fMap.end()) {
115  colour = iter->second;
116  return true;
117  }
118 
119  return false;
120 }
121 
122 template <typename T>
123 void
124 G4ModelColourMap<T>::Print(std::ostream& ostr) const
125 {
126  typename std::map<T, G4Colour>::const_iterator iter = fMap.begin();
127 
128  while (iter != fMap.end()) {
129  ostr<< iter->first <<" : "<< iter->second <<G4endl;
130  iter++;
131  }
132 }
133 #endif
G4Colour & operator[](const T &quantity)
const std::map< T, G4Colour > & GetBasicMap() const
std::ostringstream G4ExceptionDescription
Definition: globals.hh:76
static G4bool GetColour(const G4String &key, G4Colour &result)
Definition: G4Colour.cc:126
void Set(const T &, const G4Colour &)
bool GetColour(const T &, G4Colour &) const
void Print(std::ostream &ostr) const
virtual ~G4ModelColourMap()
void G4Exception(const char *originOfException, const char *exceptionCode, G4ExceptionSeverity severity, const char *comments)
Definition: G4Exception.cc:41
void Set(G4int Elements, T *To, T Value)
Definition: G4ArrayOps.hh:51
#define G4endl
Definition: G4ios.hh:61