ChargeFilter< T > Class Template Reference

ChargeFilter can filter objects upon their charge. More...

#include <ChargeFilter.h>

Inheritance diagram for ChargeFilter< T >:

Collaboration diagram for ChargeFilter< T >:

Public Member Functions
	ChargeFilter ()
	Default constructor:
	ChargeFilter (const ChargeFilter< T > &rhs)
	Copy constructor:
virtual	~ChargeFilter ()
	Destructor:
ChargeFilter< T > &	operator= (const ChargeFilter< T > &rhs)
	Assignment operator:
virtual bool	isAccepted (const T *element) const
	Main filter method.
double	charge () const
	Returns the charge the filter is looking for.
void	setFilter (const IFilterCuts *filter)
	Copies the IFilterCuts properties of the given object to the current IFilterCuts object (ie: it copies the required charge() to the current object)
void	setCharge (const ChargeType &charge)
	Set the filter to look for the given charge.
bool	operator() (const T *element) const

Protected Attributes
std::optional< ChargeType >	m_charge
	The charge the filter is looking for.

Detailed Description

template<typename T>
class ChargeFilter< T >

ChargeFilter can filter objects upon their charge.

One can only require a charge (not a range in charges). But it could be extended to a range.

Definition at line 31 of file ChargeFilter.h.

Constructor & Destructor Documentation

ChargeFilter() [1/2]

template<typename T>

ChargeFilter< T >::ChargeFilter

(

)

Default constructor:

Implementation.

Definition at line 103 of file ChargeFilter.h.

                              :
  IFilterCuts(),
  IFilter<T>(),
  m_charge()
{}

ChargeFilter() [2/2]

template<typename T>

ChargeFilter< T >::ChargeFilter

(

const ChargeFilter< T > &

rhs

)

Copy constructor:

Definition at line 110 of file ChargeFilter.h.

                                                          :
  IFilterCuts(rhs),
  IFilter<T>(rhs),
  m_charge(rhs.m_charge)
{}

~ChargeFilter()

template<typename T>

ChargeFilter< T >::~ChargeFilter ( )

virtual

Destructor:

Definition at line 130 of file ChargeFilter.h.

{}

Member Function Documentation

charge()

template<typename T>

double ChargeFilter< T >::charge

(

)

const

Returns the charge the filter is looking for.

Definition at line 154 of file ChargeFilter.h.

{
  if (m_charge) {
    return *m_charge;
  }
  throw std::domain_error( "No charge selection defined" );
}

isAccepted()

template<typename T>

bool ChargeFilter< T >::isAccepted ( const T * element ) const

virtual

Main filter method.

This method takes the decision whether or not the filter has to accept the element. It returns true or false accordingly if the charge of the particle matchs the one of the filter, it is accepted. If no cut has been defined, it returns true by default.

Check if a charge cut has been set-up

The charge cut is un-initialized so by convention we return true;

Otherwise return true by convention

Implements IFilter< T >.

Definition at line 133 of file ChargeFilter.h.

{
  if ( !m_charge ) {
    return true;
  } else {
    const ChargeType charge = element->charge();
    if ( *m_charge == charge ) { 
      return true;
    } else { 
      return false; 
    }
  }

  return true;
}

operator()()

template<typename T>

bool IFilter< T >::operator() ( const T * element ) const

inlineinherited

Definition at line 101 of file IFilter.h.

{ 
  return isAccepted(element); 
}

operator=()

template<typename T>

ChargeFilter< T > & ChargeFilter< T >::operator= ( const ChargeFilter< T > & rhs )

inline

Assignment operator:

Definition at line 118 of file ChargeFilter.h.

{
  if ( this != &rhs ) {
    IFilterCuts::operator=(rhs);
    IFilter<T>::operator=(rhs);
    m_charge = rhs.m_charge;
  }
  return *this;
}

setCharge()

template<typename T>

void ChargeFilter< T >::setCharge

(

const ChargeType &

charge

)

Set the filter to look for the given charge.

Parameters

charge

: the charge the filter will be looking for.

Definition at line 181 of file ChargeFilter.h.

{
  m_charge = charge;
}

setFilter()

template<typename T>

void ChargeFilter< T >::setFilter ( const IFilterCuts * filter )

virtual

Copies the IFilterCuts properties of the given object to the current IFilterCuts object (ie: it copies the required charge() to the current object)

Implements IFilterCuts.

Definition at line 163 of file ChargeFilter.h.

{
  if ( filter ) {
    const ChargeFilter<T> * chFilter =
      dynamic_cast<const ChargeFilter<T> *>(filter);
    if ( chFilter ) {
      operator=(*chFilter);
    } else {
      MsgStream log( Athena::getMessageSvc(), "ChargeFilter" );
      log << MSG::ERROR
      << "Can't dynamic_cast " << typeid(filter).name() 
      << " to a ChargeFilter"
      << endmsg;
    }
  }
}

Member Data Documentation

m_charge

template<typename T>

std::optional<ChargeType> ChargeFilter< T >::m_charge

protected

The charge the filter is looking for.

It is unitialized by default (in the std::optional sense)

Definition at line 95 of file ChargeFilter.h.

---

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

• ChargeFilter.h