ChooseableHitStyling Class Reference

This Class handles the mapping from the colormapping-method name given as a string to the actual color mapping for CDCHits. More...

#include <Styling.h>

Inheritance diagram for ChooseableHitStyling:

Public Types
using	ObjectMapping = Mapping< const CDCHit >
	Mapping for the object type.

Public Member Functions
std::unique_ptr< ObjectMapping >	createMapping (const std::string &mappingName) override
	Method defining the available mapping names.
AttributeMap	map (int index, const CDCHit &object) override
	Create a map of attributes from the stored attribute maps.
virtual AttributeMap	map (int index, AObject &object)
	Maps the object at the given index to attribute values.
std::string	info () override
	Returns informal string about the currently set mappings.
void	set (const std::string &key, std::unique_ptr< ObjectMapping > mapping)
	Sets the given attribute to the attribute mapping.
void	set (const std::string &key, const std::string &mappingName)
	Sets the given attribute to the fixed value.
void	setStroke (const std::string &mappingName)
	Legacy method to set the mapping on how to match a object to the stroke color.
void	setStrokeWidth (const std::string &mappingName)
	Legacy method to set the mapping on how to match a object to the stroke width.

Protected Attributes
std::map< std::string, std::unique_ptr< ObjectMapping > >	m_mappingsByKey
	Map of attribute keys to mappings to be used.

Private Types
using	Super = ChooseableStyling< const CDCHit >
	Type of the base class.

Detailed Description

This Class handles the mapping from the colormapping-method name given as a string to the actual color mapping for CDCHits.

Definition at line 234 of file Styling.h.

Member Typedef Documentation

ObjectMapping

using ObjectMapping = Mapping<const CDCHit >

inherited

Mapping for the object type.

Definition at line 103 of file Styling.h.

Super

using Super = ChooseableStyling<const CDCHit>

private

Type of the base class.

Definition at line 238 of file Styling.h.

Member Function Documentation

createMapping()

std::unique_ptr< ChooseableHitStyling::ObjectMapping > createMapping ( const std::string &  mappingName )

overridevirtual

Method defining the available mapping names.

Reimplemented from ChooseableStyling< const CDCHit >.

Definition at line 53 of file Styling.cc.

{
  if (mappingName == "ZeroDriftLengthColorMap") {
    return std::make_unique<ZeroDriftLengthColorMap>();
  } else if (mappingName == "ZeroDriftLengthStrokeWidthMap") {
    return std::make_unique<ZeroDriftLengthStrokeWidthMap>();
  } else if (mappingName == "TakenFlagColorMap") {
    return std::make_unique<TakenFlagColorMap>();
  } else if (mappingName == "RLColorMap") {
    return std::make_unique<RLColorMap>();
  } else if (mappingName == "PosFlagColorMap") {
    return std::make_unique<PosFlagColorMap>();
  } else if (mappingName == "BackgroundTagColorMap") {
    return std::make_unique<BackgroundTagColorMap>();
  } else if (mappingName == "MCSegmentIdColorMap") {
    return std::make_unique<MCSegmentIdColorMap>();
  } else if (mappingName == "TOFColorMap") {
    return std::make_unique<TOFColorMap>();
  } else if (mappingName == "ReassignedSecondaryMap") {
    return std::make_unique<ReassignedSecondaryMap>();
  } else if (mappingName == "MCParticleColorMap") {
    return std::make_unique<MCParticleColorMap>();
  } else if (mappingName == "MCPDGCodeColorMap") {
    return std::make_unique<MCPDGCodeColorMap>();
  } else if (mappingName == "MCPrimaryColorMap") {
    return std::make_unique<MCPrimaryColorMap>();
  } else if (mappingName == "SimHitPDGCodeColorMap") {
    return std::make_unique<SimHitPDGCodeColorMap>();
  } else if (mappingName == "SimHitIsBkgColorMap") {
    return std::make_unique<SimHitIsBkgColorMap>();
  } else if (mappingName == "NLoops") {
    return std::make_unique<NLoopsColorMap>();
  } else {
    return Super::createMapping(mappingName);
  }
}

info()

std::string info ( )

inlineoverridevirtualinherited

Returns informal string about the currently set mappings.

Reimplemented from Styling< AObject >.

Definition at line 119 of file Styling.h.

      {
        std::ostringstream oss;
        for (const auto& keyMapping : m_mappingsByKey) {
          const std::string& key = keyMapping.first;
          const std::unique_ptr<ObjectMapping>& mapping = keyMapping.second;
          oss << key << ": " << mapping->info();
        }
        return oss.str();
      }

map() [1/2]

virtual AttributeMap map ( int  index, AObject &  object  )

inlinevirtualinherited

Maps the object at the given index to attribute values.

Reimplemented in FixedStyling< AObject >, and ChooseableStyling< AObject >.

Definition at line 39 of file Styling.h.

      {
        return {};
      }

map() [2/2]

AttributeMap map ( int  index, const CDCHit &  object  )

inlineoverrideinherited

Create a map of attributes from the stored attribute maps.

Definition at line 107 of file Styling.h.

      {
        AttributeMap attributeMap;
        for (const auto& keyMapping : m_mappingsByKey) {
          const std::string& key = keyMapping.first;
          const std::unique_ptr<ObjectMapping>& mapping = keyMapping.second;
          attributeMap[key] = mapping->map(index, object);
        }
        return attributeMap;
      }

set() [1/2]

void set ( const std::string &  key, const std::string &  mappingName  )

inlineinherited

Sets the given attribute to the fixed value.

Definition at line 150 of file Styling.h.

      {
        std::unique_ptr<ObjectMapping> objectMapping = this->createMapping(mappingName);
        if (objectMapping) {
          set(key, std::move(objectMapping));
        }
      }

set() [2/2]

void set ( const std::string &  key, std::unique_ptr< ObjectMapping >  mapping  )

inlineinherited

Sets the given attribute to the attribute mapping.

Definition at line 142 of file Styling.h.

      {
        if (mapping) {
          m_mappingsByKey[key] = std::move(mapping);
        }
      }

setStroke()

void setStroke ( const std::string &  mappingName )

inlineinherited

Legacy method to set the mapping on how to match a object to the stroke color.

Parameters

mappingName

The Name of the Mapping to be used. The translation from name to Mapping class must be defined in createMapping.

Definition at line 163 of file Styling.h.

      {
        set("stroke", mappingName);
      }

setStrokeWidth()

void setStrokeWidth ( const std::string &  mappingName )

inlineinherited

Legacy method to set the mapping on how to match a object to the stroke width.

Parameters

mappingName

The Name of the Mapping to be used. The translation from name to Mapping class must be defined in createMapping.

Definition at line 173 of file Styling.h.

      {
        set("stroke-width", mappingName);
      }

Member Data Documentation

m_mappingsByKey

std::map<std::string, std::unique_ptr<ObjectMapping> > m_mappingsByKey

protectedinherited

Map of attribute keys to mappings to be used.

Definition at line 180 of file Styling.h.

---

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

• tracking/trackFindingCDC/display/include/Styling.h
• tracking/trackFindingCDC/display/src/Styling.cc