trigger::TrigEnergySum Class Reference

Contains the trigger output for generic calo objects. More...

#include <TrigEnergySum.h>

Public Member Functions
	TrigEnergySum ()=default
	Default Constructor.
	TrigEnergySum (int layer, int hwEnergy=0)
	Preferred Constructor.
	TrigEnergySum (int layer, int module, float energy)
virtual	~TrigEnergySum ()=default
	Destructor.
bool	operator< (const TrigEnergySum &sum)
	Sort the collection to trig digis by the raw ID.
void	clear ()
void	setLayer (int layer)
int	layer () const
void	setModule (int module)
int	module () const
void	setEnergy (float energy)
float	energy () const
void	setHwEnergy (int hwEnergy)
int	hwEnergy () const

Private Member Functions
	ClassDef (TrigEnergySum, 2)
	ROOT Dictionary class definition macro.

Private Attributes
int	layer_ {0}
	the raw ID for this trigger channel
int	module_ {0}
int	hw_energy_ {0}
float	energy_ {0}

Friends
std::ostream &	operator<< (std::ostream &o, const TrigEnergySum &d)
	Stream the input digi.
std::ostream &	operator<< (std::ostream &o, const TrigEnergySumCollection &c)
	Stream the input digi collection.

Detailed Description

Contains the trigger output for generic calo objects.

Definition at line 24 of file TrigEnergySum.h.

Constructor & Destructor Documentation

TrigEnergySum() [1/3]

trigger::TrigEnergySum::TrigEnergySum ( )

default

Default Constructor.

Needed for ROOT dictionary definition, suggested to not use this constructor.

TrigEnergySum() [2/3]

trigger::TrigEnergySum::TrigEnergySum	(	int	layer,
		int	hwEnergy = 0 )

Preferred Constructor.

Defines the trigger group ID and the trigger primitive value.

Parameters

[in]	tid	raw trigger group ID
[in]	tp	trigger primitive value

Definition at line 8 of file TrigEnergySum.cxx.

    : layer_{layer}, module_{0}, hw_energy_{hwEnergy}, energy_{0} {}

TrigEnergySum() [3/3]

trigger::TrigEnergySum::TrigEnergySum	(	int	layer,
		int	module,
		float	energy )

Definition at line 10 of file TrigEnergySum.cxx.

    : layer_{layer}, module_{module}, hw_energy_{0}, energy_{energy} {}

~TrigEnergySum()

virtual trigger::TrigEnergySum::~TrigEnergySum ( )

virtualdefault

Destructor.

Needs to be defined for ROOT dictionary definition, does nothing right now.

Member Function Documentation

clear()

void trigger::TrigEnergySum::clear ( )

inline

Definition at line 66 of file TrigEnergySum.h.

               {
    energy_ = 0;
    hw_energy_ = 0;
    layer_ = 0;
    module_ = 0;
  }

energy()

float trigger::TrigEnergySum::energy ( ) const

inline

Definition at line 80 of file TrigEnergySum.h.

{ return energy_; }

hwEnergy()

int trigger::TrigEnergySum::hwEnergy ( ) const

inline

Definition at line 83 of file TrigEnergySum.h.

{ return hw_energy_; }

layer()

int trigger::TrigEnergySum::layer ( ) const

inline

Definition at line 74 of file TrigEnergySum.h.

{ return layer_; }

module()

int trigger::TrigEnergySum::module ( ) const

inline

Definition at line 77 of file TrigEnergySum.h.

{ return module_; }

operator<()

bool trigger::TrigEnergySum::operator< ( const TrigEnergySum & sum )

inline

Sort the collection to trig digis by the raw ID.

Parameters

[in]

d

another digi to compare against

Returns

true if this ID is less than the other ID

Definition at line 62 of file TrigEnergySum.h.

                                           {
    return hw_energy_ < sum.hw_energy_;
  }

setEnergy()

void trigger::TrigEnergySum::setEnergy ( float energy )

inline

Definition at line 79 of file TrigEnergySum.h.

{ energy_ = energy; }

setHwEnergy()

void trigger::TrigEnergySum::setHwEnergy ( int hwEnergy )

inline

Definition at line 82 of file TrigEnergySum.h.

{ hw_energy_ = hwEnergy; }

setLayer()

void trigger::TrigEnergySum::setLayer ( int layer )

inline

Definition at line 73 of file TrigEnergySum.h.

{ layer_ = layer; }

setModule()

void trigger::TrigEnergySum::setModule ( int module )

inline

Definition at line 76 of file TrigEnergySum.h.

{ module_ = module; }

Friends And Related Symbol Documentation

operator<< [1/2]

std::ostream & operator<< ( std::ostream & o, const TrigEnergySum & d )

friend

Stream the input digi.

In one line, prints out the ID (in hex), the primitive (in hex), and the linearized primitive (in dec).

Parameters

[in]	o	ostream to write to
[in]	d	digi to write out

Returns

modified ostream

Definition at line 13 of file TrigEnergySum.cxx.

                                                                       {
  s << "TrigEnergySum { " << "(layer " << sum.layer() << ", hwEnergy "
    << sum.hwEnergy() << " } ";
  return s;
}

operator<< [2/2]

std::ostream & operator<< ( std::ostream & o, const TrigEnergySumCollection & c )

friend

Stream the input digi collection.

Prints out each digi member of the collection on a new line.

Parameters

[in]	o	ostream to write to
[in]	c	collection to write out

Returns

modified ostream

Definition at line 19 of file TrigEnergySum.cxx.

                                                                     {
  s << "TrigEnergySumCollection { " << std::endl;
  for (auto sum : sums) s << "  " << sum << std::endl;
  s << "}";
  return s;
}

Member Data Documentation

energy_

float trigger::TrigEnergySum::energy_ {0}

private

Definition at line 119 of file TrigEnergySum.h.

{0};

hw_energy_

int trigger::TrigEnergySum::hw_energy_ {0}

private

Definition at line 118 of file TrigEnergySum.h.

{0};

layer_

int trigger::TrigEnergySum::layer_ {0}

private

the raw ID for this trigger channel

Definition at line 116 of file TrigEnergySum.h.

{0};

module_

int trigger::TrigEnergySum::module_ {0}

private

Definition at line 117 of file TrigEnergySum.h.

{0};

---

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

• Trigger/Algo/include/Trigger/Event/TrigEnergySum.h
• Trigger/Algo/src/Trigger/Event/TrigEnergySum.cxx