G4ModelColourMap< T > Class Template Reference

#include <G4ModelColourMap.hh>

Public Member Functions
	G4ModelColourMap ()
const std::map< T, G4Colour > &	GetBasicMap () const
bool	GetColour (const T &, G4Colour &) const
G4Colour &	operator[] (const T &quantity)
void	Print (std::ostream &ostr) const
void	Set (const T &, const G4Colour &)
void	Set (const T &, const G4String &)
virtual	~G4ModelColourMap ()

Private Attributes
std::map< T, G4Colour >	fMap

Detailed Description

template<typename T>
class G4ModelColourMap< T >

Definition at line 40 of file G4ModelColourMap.hh.

Constructor & Destructor Documentation

G4ModelColourMap()

template<typename T >

G4ModelColourMap< T >::G4ModelColourMap

Definition at line 70 of file G4ModelColourMap.hh.

{}

~G4ModelColourMap()

template<typename T >

G4ModelColourMap< T >::~G4ModelColourMap

virtual

Definition at line 73 of file G4ModelColourMap.hh.

{}

Member Function Documentation

GetBasicMap()

template<typename T >

const std::map< T, G4Colour > & G4ModelColourMap< T >::GetBasicMap

Definition at line 104 of file G4ModelColourMap.hh.

{ return fMap; }

Referenced by G4TrajectoryDrawByEncounteredVolume::Draw().

GetColour()

template<typename T >

bool G4ModelColourMap< T >::GetColour	(	const T &	quantity,
		G4Colour &	colour
	)		const

Definition at line 109 of file G4ModelColourMap.hh.

{
  typename std::map<T, G4Colour>::const_iterator iter = fMap.find(quantity);
 
  if (iter != fMap.end()) {
    colour = iter->second;
    return true;
  }
  
  return false;
}

Referenced by G4TrajectoryDrawByCharge::Draw(), G4TrajectoryDrawByEncounteredVolume::Draw(), G4TrajectoryDrawByOriginVolume::Draw(), and G4TrajectoryDrawByParticleID::Draw().

operator[]()

template<typename T >

G4Colour & G4ModelColourMap< T >::operator[]

(

const T &

quantity

)

Definition at line 67 of file G4ModelColourMap.hh.

{return fMap[quantity];}

Print()

template<typename T >

void G4ModelColourMap< T >::Print

(

std::ostream &

ostr

)

const

Definition at line 123 of file G4ModelColourMap.hh.

{
  typename std::map<T, G4Colour>::const_iterator iter = fMap.begin();
  
  while (iter != fMap.end()) {
    ostr<< iter->first <<" : "<< iter->second <<G4endl;
    iter++;
  }
}

References G4endl.

Referenced by G4TrajectoryDrawByCharge::Print(), G4TrajectoryDrawByEncounteredVolume::Print(), G4TrajectoryDrawByOriginVolume::Print(), and G4TrajectoryDrawByParticleID::Print().

Set() [1/2]

template<typename T >

void G4ModelColourMap< T >::Set	(	const T &	quantity,
		const G4Colour &	colour
	)

Definition at line 98 of file G4ModelColourMap.hh.

{
  fMap[quantity] = colour;
}   

Referenced by G4TrajectoryDrawByCharge::Set(), G4TrajectoryDrawByOriginVolume::Set(), G4TrajectoryDrawByParticleID::Set(), and G4TrajectoryDrawByEncounteredVolume::Set().

Set() [2/2]

template<typename T >

void G4ModelColourMap< T >::Set	(	const T &	quantity,
		const G4String &	colour
	)

Definition at line 77 of file G4ModelColourMap.hh.

{
  G4Colour myColour;
  
  // Will not setup the map if colour key does not exist
  if (!G4Colour::GetColour(colour, myColour)) {
    G4ExceptionDescription ed;
    ed << "G4Colour with key "<<colour<<" does not exist ";
    G4Exception
      ("G4ColourMap::Set(Charge charge, const G4String& colour)",
       "modeling0108", JustWarning, ed);
    return;
  }
  
  
  // Will not modify myColour if colour key does not exist
  Set(quantity, myColour);
}

References G4Exception(), G4Colour::GetColour(), JustWarning, and G4ArrayOps::Set().

Field Documentation

fMap

template<typename T >

std::map<T, G4Colour> G4ModelColourMap< T >::fMap

private

Definition at line 61 of file G4ModelColourMap.hh.

---

The documentation for this class was generated from the following file:

• source/visualization/modeling/include/G4ModelColourMap.hh