#include <G4TrajectoryDrawByAttribute.hh>

Inheritance diagram for G4TrajectoryDrawByAttribute:

Public Member Functions
void	AddIntervalContext (const G4String &name, G4VisTrajContext *context)

void	AddValueContext (const G4String &name, G4VisTrajContext *context)

virtual void	Draw (const G4VTrajectory &trajectory, const G4bool &visible=true) const

	G4TrajectoryDrawByAttribute (const G4String &name="Unspecified", G4VisTrajContext *context=0)

const G4VisTrajContext &	GetContext () const

G4bool	GetVerbose () const

G4String	Name () const

virtual void	Print (std::ostream &ostr) const

void	Set (const G4String &attribute)

void	SetVerbose (const G4bool &)

virtual	~G4TrajectoryDrawByAttribute ()

Private Types
enum	Config { Interval , SingleValue }

typedef std::map< Pair, G4VisTrajContext * >	ContextMap

typedef std::pair< G4String, Config >	Pair

Private Attributes
G4String	fAttName

ContextMap	fContextMap

G4bool	fFirst

G4VAttValueFilter *	filter

G4String	fName

G4VisTrajContext *	fpContext

G4bool	fVerbose

G4bool	fWarnedMissingAttribute

Detailed Description

Definition at line 41 of file G4TrajectoryDrawByAttribute.hh.

Member Typedef Documentation

◆ ContextMap

typedef std::map<Pair, G4VisTrajContext*> G4TrajectoryDrawByAttribute::ContextMap

private

Definition at line 68 of file G4TrajectoryDrawByAttribute.hh.

◆ Pair

typedef std::pair<G4String, Config> G4TrajectoryDrawByAttribute::Pair

private

Definition at line 67 of file G4TrajectoryDrawByAttribute.hh.

Member Enumeration Documentation

◆ Config

enum G4TrajectoryDrawByAttribute::Config

private

Enumerator
Interval
SingleValue

Definition at line 65 of file G4TrajectoryDrawByAttribute.hh.

65{Interval, SingleValue};

G4TrajectoryDrawByAttribute::SingleValue

@ SingleValue

Definition: G4TrajectoryDrawByAttribute.hh:65

G4TrajectoryDrawByAttribute::Interval

@ Interval

Definition: G4TrajectoryDrawByAttribute.hh:65

Constructor & Destructor Documentation

◆ G4TrajectoryDrawByAttribute()

G4TrajectoryDrawByAttribute::G4TrajectoryDrawByAttribute	(	const G4String &	name = `"Unspecified"`,
		G4VisTrajContext *	context = `0`
	)

Definition at line 40 of file G4TrajectoryDrawByAttribute.cc.

  :G4VTrajectoryModel(name, context)
  ,fAttName("")
  ,fFirst(true)
  ,fWarnedMissingAttribute(false)
  ,filter(0)
{}

◆ ~G4TrajectoryDrawByAttribute()

G4TrajectoryDrawByAttribute::~G4TrajectoryDrawByAttribute ( )

virtual

Definition at line 48 of file G4TrajectoryDrawByAttribute.cc.

{
  ContextMap::iterator iter = fContextMap.begin();
  
  while (iter != fContextMap.end()) {
    delete iter->second;
    iter++;
  }
  
  delete filter;
}

References fContextMap, and filter.

Member Function Documentation

◆ AddIntervalContext()

void G4TrajectoryDrawByAttribute::AddIntervalContext	(	const G4String &	name,
		G4VisTrajContext *	context
	)

Definition at line 204 of file G4TrajectoryDrawByAttribute.cc.

{
  // Takes ownership of context
  std::pair<G4String, Config> myPair(name, G4TrajectoryDrawByAttribute::Interval);
 
  ContextMap::iterator iter = fContextMap.find(myPair);
  
  if (iter != fContextMap.end()) {
    G4ExceptionDescription ed;
    ed <<"Interval "<< name <<" already exists";
    G4Exception
      ("G4TrajectoryDrawByAttribute::AddIntervalContext",
       "modeling0119", FatalErrorInArgument, ed, ". Invalid interval");
  }
 
  fContextMap[myPair] = context;
}

References g4zmq::context, FatalErrorInArgument, fContextMap, G4Exception(), Interval, and G4InuclParticleNames::name().

◆ AddValueContext()

void G4TrajectoryDrawByAttribute::AddValueContext	(	const G4String &	name,
		G4VisTrajContext *	context
	)

Definition at line 223 of file G4TrajectoryDrawByAttribute.cc.

{
  // Takes ownership of context
  std::pair<G4String, Config> myPair(name, G4TrajectoryDrawByAttribute::SingleValue);
 
  ContextMap::iterator iter = fContextMap.find(myPair);
  
  if (iter != fContextMap.end()) {
    G4ExceptionDescription ed;
    ed <<"Single value "<< name <<" already exists";
    G4Exception
      ("G4TrajectoryDrawByAttribute::AddSingleValueContext",
       "modeling0120", FatalErrorInArgument, ed, ". Invalid value");
  }
 
  fContextMap[myPair] = context;
}

References g4zmq::context, FatalErrorInArgument, fContextMap, G4Exception(), G4InuclParticleNames::name(), and SingleValue.

◆ Draw()

void G4TrajectoryDrawByAttribute::Draw	(	const G4VTrajectory &	trajectory,
		const G4bool &	visible = `true`
	)		const

virtual

Implements G4VTrajectoryModel.

Definition at line 61 of file G4TrajectoryDrawByAttribute.cc.

{
  // Return if attribute name has not been set. Just print one warning
  if (fAttName.empty()) {
 
    if (!fWarnedMissingAttribute) {
      G4ExceptionDescription ed;
      ed<<"Null attribute name";
      G4Exception("G4TrajectoryDrawByAttribute::Draw",
          "modeling0116",
          JustWarning, ed);
      fWarnedMissingAttribute = true;
    }
    
    return;
  }
  
  // Basically cache data loaded filter for efficiency
  if (fFirst) {
    
    fFirst = false;
    
    // Get attribute definition
    G4AttDef attDef;
    
    // Expect definition to exist    
    if (!G4AttUtils::ExtractAttDef(object, fAttName, attDef)) {
      static G4bool warnedUnableToExtract = false;
      if (!warnedUnableToExtract) {
    G4ExceptionDescription ed;
    ed <<"Unable to extract attribute definition named "<<fAttName;
    G4Exception
      ("G4TrajectoryDrawByAttribute::Draw",
       "modeling0117", JustWarning, ed, ". Invalid attribute name");
    G4cout << "Available attributes:\n"
           << *object.GetAttDefs();
    warnedUnableToExtract = true;
      }
      return;
    }
    
    // Get new G4AttValue filter
    filter = G4AttFilterUtils::GetNewFilter(attDef);
    assert (0 != filter);
    
    // Load both interval and single valued data. Single valued data should
    // override interval data.
    ContextMap::const_iterator iter = fContextMap.begin();
    
    while (iter != fContextMap.end()) {
      if (iter->first.second == G4TrajectoryDrawByAttribute::Interval) {
    filter->LoadIntervalElement(iter->first.first);
      }
      else if (iter->first.second == G4TrajectoryDrawByAttribute::SingleValue) {
    filter->LoadSingleValueElement(iter->first.first);
      }
      iter++;
    }
  }
 
  // Get attribute value
  G4AttValue attVal;
 
  // Expect value to exist
  if (!G4AttUtils::ExtractAttValue(object, fAttName, attVal)) {
    static G4bool warnedUnableToExtract = false;
    if (!warnedUnableToExtract) {
      G4ExceptionDescription ed;
      ed <<"Unable to extract attribute value named "<<fAttName;
      G4Exception
    ("G4TrajectoryDrawByAttribute::Draw",
     "modeling0118", JustWarning, ed, ". Invalid attribute name");
    G4cout << "Available attributes:\n"
           << *object.GetAttDefs();
      warnedUnableToExtract = true;
    }
      return;
  }
  
  G4VisTrajContext myContext(GetContext());
  G4String key;
 
  // If attribute value passes filter, get corresponding interval/single value 
  // key loaded into G4AttValue filter.
  if (filter->GetValidElement(attVal, key)) {
 
    // Extract context corresponding to valid key.
    // Single value match should have overriden interval match.
    ContextMap::const_iterator iter = fContextMap.begin();
 
    G4bool gotContext(false);
 
    while (!gotContext && (iter != fContextMap.end())) {
      if (iter->first.first == key) {
    myContext = *(iter->second);
    gotContext = true;
      }
      iter++;
    }
 
    assert (gotContext);
  }
  
  if (GetVerbose()) {
    G4cout<<"G4TrajectoryDrawByAttribute drawer named "<<Name();
    G4cout<<", drawing style selected according to value of attribute "<<fAttName;
    G4cout<<" : "<<attVal.GetValue()<<".  Selected context:"<<G4endl;
    myContext.Print(G4cout);
  }
 
  // Draw the trajectory
  G4TrajectoryDrawerUtils::DrawLineAndPoints(object, myContext);
}

References G4TrajectoryDrawerUtils::DrawLineAndPoints(), G4AttUtils::ExtractAttDef(), G4AttUtils::ExtractAttValue(), fAttName, fContextMap, fFirst, filter, fWarnedMissingAttribute, G4cout, G4endl, G4Exception(), G4VTrajectoryModel::GetContext(), G4AttFilterUtils::GetNewFilter(), G4VAttValueFilter::GetValidElement(), G4AttValue::GetValue(), G4VTrajectoryModel::GetVerbose(), Interval, JustWarning, G4VAttValueFilter::LoadIntervalElement(), G4VAttValueFilter::LoadSingleValueElement(), G4VTrajectoryModel::Name(), G4VisTrajContext::Print(), and SingleValue.

◆ GetContext()

const G4VisTrajContext & G4VTrajectoryModel::GetContext ( ) const

inherited

Definition at line 53 of file G4VTrajectoryModel.cc.

{
  // Expect context to exist
  assert (0 != fpContext);
  return *fpContext;
}

References G4VTrajectoryModel::fpContext.

Referenced by G4HepRepFileSceneHandler::BeginModeling(), Draw(), G4TrajectoryDrawByCharge::Draw(), G4TrajectoryDrawByEncounteredVolume::Draw(), G4TrajectoryDrawByOriginVolume::Draw(), G4TrajectoryDrawByParticleID::Draw(), G4TrajectoryGenericDrawer::Draw(), Print(), G4TrajectoryDrawByCharge::Print(), G4TrajectoryDrawByEncounteredVolume::Print(), G4TrajectoryDrawByOriginVolume::Print(), G4TrajectoryDrawByParticleID::Print(), and G4TrajectoryGenericDrawer::Print().

◆ GetVerbose()

G4bool G4VTrajectoryModel::GetVerbose ( ) const

inherited

Definition at line 73 of file G4VTrajectoryModel.cc.

{
  return fVerbose;
}

References G4VTrajectoryModel::fVerbose.

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

◆ Name()

G4String G4VTrajectoryModel::Name ( ) const

inherited

Definition at line 61 of file G4VTrajectoryModel.cc.

{
  return fName;
}

References G4VTrajectoryModel::fName.

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

◆ Print()

void G4TrajectoryDrawByAttribute::Print ( std::ostream & ostr ) const

virtual

Implements G4VTrajectoryModel.

Definition at line 177 of file G4TrajectoryDrawByAttribute.cc.

{
  ostr<<"G4TrajectoryDrawByAttribute, dumping configuration for model named "<< Name() <<":"<<std::endl;;
 
  ostr<<"Default configuration:"<<G4endl;
  GetContext().Print(ostr);
 
  ostr<<"\nAttribute name "<<fAttName<<std::endl;
  ostr<<"\nKey<->Context map dump:"<<std::endl;
 
  ContextMap::const_iterator iter = fContextMap.begin();
 
  while (iter != fContextMap.end()) {
    ostr<<"Context for key "<<iter->first.first<<":"<<std::endl;
    iter->second->Print(ostr);
    
    iter++;
  }
}