Analysis Software
Documentation for sPHENIX simulation software
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Groups Pages
Acts::Neutral Struct Reference

Charge and momentum interpretation for neutral particles. More...

#include <acts/blob/sPHENIX/Core/include/Acts/EventData/Charge.hpp>

Public Member Functions

constexpr Neutral ()=default
 
constexpr Neutral (float absQ) noexcept
 
constexpr float absQ () const noexcept
 
template<typename T >
constexpr auto extractCharge (T) const noexcept
 
template<typename T >
constexpr auto extractMomentum (T qOverP) const noexcept
 
template<typename P , typename Q >
constexpr auto qOverP (P momentum, Q signedQ) const noexcept
 

Friends

constexpr bool operator== (Neutral, Neutral) noexcept
 

Detailed Description

Charge and momentum interpretation for neutral particles.

Definition at line 55 of file Charge.hpp.

View newest version in sPHENIX GitHub at line 55 of file Charge.hpp

Constructor & Destructor Documentation

constexpr Acts::Neutral::Neutral ( )
default
constexpr Acts::Neutral::Neutral ( float  absQ)
inlinenoexcept

Construct and verify the input charge magnitude (in debug builds).

This constructor is only provided to allow consistent construction.

Definition at line 63 of file Charge.hpp.

View newest version in sPHENIX GitHub at line 63 of file Charge.hpp

References absQ(), and assert.

+ Here is the call graph for this function:

Member Function Documentation

constexpr float Acts::Neutral::absQ ( ) const
inlinenoexcept

Definition at line 68 of file Charge.hpp.

View newest version in sPHENIX GitHub at line 68 of file Charge.hpp

Referenced by Neutral().

+ Here is the caller graph for this function:

template<typename T >
constexpr auto Acts::Neutral::extractCharge ( T  ) const
inlinenoexcept

Definition at line 71 of file Charge.hpp.

View newest version in sPHENIX GitHub at line 71 of file Charge.hpp

Referenced by BOOST_AUTO_TEST_CASE().

+ Here is the caller graph for this function:

template<typename T >
constexpr auto Acts::Neutral::extractMomentum ( T  qOverP) const
inlinenoexcept

Definition at line 76 of file Charge.hpp.

View newest version in sPHENIX GitHub at line 76 of file Charge.hpp

References assert, and qOverP().

Referenced by BOOST_AUTO_TEST_CASE().

+ Here is the call graph for this function:

+ Here is the caller graph for this function:

template<typename P , typename Q >
constexpr auto Acts::Neutral::qOverP ( P  momentum,
Q  signedQ 
) const
inlinenoexcept

Definition at line 82 of file Charge.hpp.

View newest version in sPHENIX GitHub at line 82 of file Charge.hpp

References assert, and momentum.

Referenced by extractMomentum().

+ Here is the caller graph for this function:

Friends And Related Function Documentation

constexpr bool operator== ( Neutral  ,
Neutral   
)
friend

Compare for equality.

This is always true as Neutral has no internal state. Must be available to provide a consistent interface.

Definition at line 92 of file Charge.hpp.

View newest version in sPHENIX GitHub at line 92 of file Charge.hpp


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