ECCE @ EIC Software
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Groups Pages
Acts::ChargedPolicy Class Reference

policy class for charged particles/tracks More...

#include <acts/blob/master/Core/include/Acts/EventData/ChargePolicy.hpp>

Public Member Functions

 ChargedPolicy (double charge)
 constructor with given charge
 
bool operator== (const ChargedPolicy &rhs) const
 equality operator
 
bool operator!= (const ChargedPolicy &rhs) const
 inequality operator
 
double getCharge () const
 retrieve stored value of the electric charge
 
void setCharge (double charge)
 sets charge
 
void flipSign ()
 flip sign of electric charge
 

Private Attributes

double m_dCharge
 value of electric charge
 

Detailed Description

policy class for charged particles/tracks

This type is meant to be used as template parameter to the SingleTrackParameters class and its derived classes in order to provide a distinction between charged and neutral track (parameters) at the C++ type level. This allows other class to employ optimized algorithms for either case by using template specializations.

Definition at line 24 of file ChargePolicy.hpp.

View newest version in sPHENIX GitHub at line 24 of file ChargePolicy.hpp

Constructor & Destructor Documentation

Acts::ChargedPolicy::ChargedPolicy ( double  charge)
inline

constructor with given charge

Parameters
chargeelectric charge of particle/track (parameters)

Definition at line 29 of file ChargePolicy.hpp.

View newest version in sPHENIX GitHub at line 29 of file ChargePolicy.hpp

Member Function Documentation

void Acts::ChargedPolicy::flipSign ( )
inline

flip sign of electric charge

Definition at line 54 of file ChargePolicy.hpp.

View newest version in sPHENIX GitHub at line 54 of file ChargePolicy.hpp

References m_dCharge.

double Acts::ChargedPolicy::getCharge ( ) const
inline

retrieve stored value of the electric charge

Returns
value for charge

Definition at line 46 of file ChargePolicy.hpp.

View newest version in sPHENIX GitHub at line 46 of file ChargePolicy.hpp

References m_dCharge.

bool Acts::ChargedPolicy::operator!= ( const ChargedPolicy rhs) const
inline

inequality operator

Returns
true if rhs has a different charge, otherwise false

Definition at line 41 of file ChargePolicy.hpp.

View newest version in sPHENIX GitHub at line 41 of file ChargePolicy.hpp

bool Acts::ChargedPolicy::operator== ( const ChargedPolicy rhs) const
inline

equality operator

Returns
true if rhs has the same charge, otherwise false

Definition at line 34 of file ChargePolicy.hpp.

View newest version in sPHENIX GitHub at line 34 of file ChargePolicy.hpp

References m_dCharge.

void Acts::ChargedPolicy::setCharge ( double  charge)
inline

sets charge

Parameters
chargenew value for the electric charge

Definition at line 51 of file ChargePolicy.hpp.

View newest version in sPHENIX GitHub at line 51 of file ChargePolicy.hpp

References charge, and m_dCharge.

Member Data Documentation

double Acts::ChargedPolicy::m_dCharge
private

value of electric charge

Definition at line 57 of file ChargePolicy.hpp.

View newest version in sPHENIX GitHub at line 57 of file ChargePolicy.hpp

Referenced by flipSign(), getCharge(), operator==(), and setCharge().


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