JAANET::JEvtCategoryHelper Struct Reference

Helper class for event categories. More...

#include <JEvtCategoryHelper.hh>

Inheritance diagram for JAANET::JEvtCategoryHelper:

Public Types
typedef std::shared_ptr< JEvtCategory >	pointer_type

Public Member Functions
	JEvtCategoryHelper ()
	Default constructor. More...
	JEvtCategoryHelper (const pointer_type &p)
	Constructor. More...
	JEvtCategoryHelper (const JEvtCategory &category)
	Constructor. More...
	JEvtCategoryHelper (const JHead &header)
	Constructor. More...
	JEvtCategoryHelper (const int type)
	Constructor. More...
void	configure (const pointer_type &p)
	Configuration. More...
void	configure (const JEvtCategory &category)
	Configuration. More...
void	configure (const JHead &header)
	Configuration. More...
void	configure (const int type)
	Configuration. More...
JEvtCategory &	getEvtCategory () const
	Get reference to event category. More...
bool	is_valid () const
	Check if event category is valid. More...
bool	match (const JHead &header) const
	Check whether given MC header matches with this event category. More...
bool	match (const Evt &event) const
	Check whether given event matches with this event category. More...
bool	less (const JEvtCategory &category) const
	Less-than method. More...
bool	less (const JEvtCategoryHelper &helper) const
	Less-than method. More...
JProperties	getProperties (const JEquationParameters &equation=JEvtCategory::getEquationParameters()) const
	Get properties of this class. More...

Friends
std::istream &	operator>> (std::istream &in, JEvtCategoryHelper &object)
	Read event category from input. More...
std::ostream &	operator<< (std::ostream &out, const JEvtCategoryHelper &object)
	Write event category to output. More...

Detailed Description

Helper class for event categories.

Definition at line 32 of file JEvtCategoryHelper.hh.

Member Typedef Documentation

pointer_type

typedef std::shared_ptr<JEvtCategory> JAANET::JEvtCategoryHelper::pointer_type

Definition at line 36 of file JEvtCategoryHelper.hh.

Constructor & Destructor Documentation

JEvtCategoryHelper() [1/5]

JAANET::JEvtCategoryHelper::JEvtCategoryHelper ( )

inline

Default constructor.

Definition at line 41 of file JEvtCategoryHelper.hh.

                         :
      pointer_type()
    {}

JEvtCategoryHelper() [2/5]

JAANET::JEvtCategoryHelper::JEvtCategoryHelper ( const pointer_type &  p )

inline

Constructor.

Parameters

p	shared pointer to event category

Definition at line 51 of file JEvtCategoryHelper.hh.

                                              :
      pointer_type(p)
    {}

JEvtCategoryHelper() [3/5]

JAANET::JEvtCategoryHelper::JEvtCategoryHelper ( const JEvtCategory &  category )

inline

Constructor.

Parameters

category

event category

Definition at line 61 of file JEvtCategoryHelper.hh.

    {
      this->configure(category);
    }

JEvtCategoryHelper() [4/5]

JAANET::JEvtCategoryHelper::JEvtCategoryHelper ( const JHead &  header )

inline

Constructor.

Parameters

header

MC header

Definition at line 72 of file JEvtCategoryHelper.hh.

    {
      this->configure(header);
    }

JEvtCategoryHelper() [5/5]

JAANET::JEvtCategoryHelper::JEvtCategoryHelper ( const int  type )

inline

Constructor.

Parameters

type

PDG type

Definition at line 83 of file JEvtCategoryHelper.hh.

    {
      this->configure(type);
    }

Member Function Documentation

configure() [1/4]

void JAANET::JEvtCategoryHelper::configure ( const pointer_type &  p )

inline

Configuration.

Parameters

p	shared pointer to event category

Definition at line 94 of file JEvtCategoryHelper.hh.

    {
      static_cast<pointer_type&>(*this) = p;
    }

configure() [2/4]

void JAANET::JEvtCategoryHelper::configure ( const JEvtCategory &  category )

inline

Configuration.

Parameters

category

event category

Definition at line 105 of file JEvtCategoryHelper.hh.

    {
      reset(category.clone());      
    }

configure() [3/4]

void JAANET::JEvtCategoryHelper::configure ( const JHead &  header )

inline

Configuration.

Parameters

category

event category

Definition at line 116 of file JEvtCategoryHelper.hh.

    {
      using namespace JPP;
      
      if        (is_neutrino_primary(header.primary.type)) {
        reset(new JNeutrinoInteractionCategory(header));
      } else if (is_muon_bundle_primary(header.primary.type)) {
        reset(new JMuonBundleCategory(header));
      } else {
        THROW(JValueOutOfRange, "JEvtCategoryHelper::configure(): Cannot construct event category for given header with primary ID " << header.primary.type);
      }
    }

configure() [4/4]

void JAANET::JEvtCategoryHelper::configure ( const int  type )

inline

Configuration.

Parameters

type

PDG type

Definition at line 135 of file JEvtCategoryHelper.hh.

    {
      using namespace JPP;
      
      if        (is_neutrino_primary(type)) {
        reset(new JNeutrinoInteractionCategory(type));
      } else if (is_muon_bundle_primary(type)) {
        reset(new JMuonBundleCategory(type));
      } else {
        THROW(JValueOutOfRange, "JEvtCategoryHelper::configure(): Cannot construct event category for PDG type " << type);
      }
    }

getEvtCategory()

JEvtCategory& JAANET::JEvtCategoryHelper::getEvtCategory ( ) const

inline

Get reference to event category.

Returns

reference to event category

Definition at line 154 of file JEvtCategoryHelper.hh.

    {
      using namespace JPP;
 
      if (static_cast<const JEvtCategoryHelper&>(*this)) {
        return *(this->get());
      } else {
        THROW(JNullPointerException, "JEvtCategoryHelper::getEvtCategory(): Event category is not set.");
      }
    }

is_valid()

bool JAANET::JEvtCategoryHelper::is_valid ( ) const

inline

Check if event category is valid.

Returns

true if event category is valid; else false

Definition at line 171 of file JEvtCategoryHelper.hh.

    {
      return static_cast<const JEvtCategoryHelper&>(*this) && this->get()->is_valid();
    }

match() [1/2]

bool JAANET::JEvtCategoryHelper::match ( const JHead &  header ) const

inline

Check whether given MC header matches with this event category.

Parameters

header

MC header

Returns

true if matching; else false

Definition at line 183 of file JEvtCategoryHelper.hh.

    {
      const JEvtCategory& category = getEvtCategory();
 
      return category.match(header);
    }

match() [2/2]

bool JAANET::JEvtCategoryHelper::match ( const Evt &  event ) const

inline

Check whether given event matches with this event category.

Parameters

event

event

Returns

true if matching; else false

Definition at line 197 of file JEvtCategoryHelper.hh.

    {
      const JEvtCategory& category = getEvtCategory();
 
      return category.match(event);
    }

less() [1/2]

bool JAANET::JEvtCategoryHelper::less ( const JEvtCategory &  category ) const

inline

Less-than method.

Parameters

category

event category

Returns

true if this event category is less than given event category; else false

Definition at line 211 of file JEvtCategoryHelper.hh.

    {
      const JEvtCategory& cat = getEvtCategory();
 
      return cat.less(category);
    }

less() [2/2]

bool JAANET::JEvtCategoryHelper::less ( const JEvtCategoryHelper &  helper ) const

inline

Less-than method.

Parameters

helper

shared pointer to event category

Returns

true if this event category is less than given event category; else false

Definition at line 225 of file JEvtCategoryHelper.hh.

    {
      return this->less(helper.getEvtCategory());
    }

getProperties()

JProperties JAANET::JEvtCategoryHelper::getProperties ( const JEquationParameters &  equation = JEvtCategory::getEquationParameters() ) const

inline

Get properties of this class.

Parameters

equation

equation parameters

Definition at line 236 of file JEvtCategoryHelper.hh.

    {
      const JEvtCategory& cat = getEvtCategory();
 
      return cat.getProperties();
    }

Friends And Related Function Documentation

operator>>

std::istream& operator>> ( std::istream &  in, JEvtCategoryHelper &  object  )

friend

Read event category from input.

Parameters

in	input stream
object	event category

Returns

input stream

Definition at line 251 of file JEvtCategoryHelper.hh.

    {
      using namespace std;
 
      if (object) {
 
        return object.get()->read(in);
        
      } else {
 
        streampos pos = in.tellg();
        
        int type = 0;
 
        if (in >> type) {
          object.configure(type);
          return in;
        }
 
        in.clear();
        in.seekg(pos);
 
        JNeutrinoInteractionCategory neutrinoInteraction;
        neutrinoInteraction.getProperties().read(in);
 
        if (neutrinoInteraction.is_valid()) {
          object.configure(neutrinoInteraction);
          return in;
        }
 
        in.clear();
        in.seekg(pos);
 
        JMuonBundleCategory muonBundle;
        muonBundle.getProperties().read(in);    
        
        if (muonBundle.is_valid()) {
          object.configure(muonBundle);
        }
        
        return in;
      }
    }

operator<<

std::ostream& operator<< ( std::ostream &  out, const JEvtCategoryHelper &  object  )

friend

Write event category to output.

Parameters

out	output stream
object	event category

Returns

output stream

Definition at line 303 of file JEvtCategoryHelper.hh.

    {
      if (object.is_valid()) {
        return out << object.getEvtCategory();
      } else {
        return out << 0;
      }
    }

---

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

• JEvtCategoryHelper.hh