Low-level interface for event categories.
More...
#include <JEvtCategory.hh>
Low-level interface for event categories.
Definition at line 35 of file JEvtCategory.hh.
◆ clone_type
template<class JClonable_t , class JDerived_t >
◆ JEvtCategory() [1/2]
JAANET::JEvtCategory::JEvtCategory |
( |
| ) |
|
|
inline |
Default constructor.
Definition at line 42 of file JEvtCategory.hh.
42 :
44 {}
int primaryType
Event primary PDG type.
◆ JEvtCategory() [2/2]
JAANET::JEvtCategory::JEvtCategory |
( |
const int | primaryType | ) |
|
|
inline |
Constructor.
- Parameters
-
primaryType | primary PDG type |
Definition at line 52 of file JEvtCategory.hh.
◆ ~JEvtCategory()
virtual JAANET::JEvtCategory::~JEvtCategory |
( |
| ) |
|
|
inlinevirtual |
◆ is_valid()
virtual bool JAANET::JEvtCategory::is_valid |
( |
| ) |
const |
|
pure virtual |
Check if event category is valid.
- Returns
- true if event category is valid; else false
◆ check_validity()
void JAANET::JEvtCategory::check_validity |
( |
| ) |
const |
|
inline |
Check validity.
Definition at line 75 of file JEvtCategory.hh.
76 {
78
81 }
82 }
#define THROW(JException_t, A)
Marco for throwing exception with std::ostream compatible message.
Exception for accessing a value in a collection that is outside of its range.
This name space includes all other name spaces (except KM3NETDAQ, KM3NET and ANTARES).
virtual bool is_valid() const =0
Check if event category is valid.
◆ match() [1/2]
virtual bool JAANET::JEvtCategory::match |
( |
const JHead & | header | ) |
const |
|
pure virtual |
Check whether given MC header matches with this event category.
- Parameters
-
- Returns
- true if matching; else false
◆ match() [2/2]
virtual bool JAANET::JEvtCategory::match |
( |
const Evt & | event | ) |
const |
|
pure virtual |
Check whether given event matches with this event category.
- Parameters
-
- Returns
- true if matching; else false
◆ less()
virtual bool JAANET::JEvtCategory::less |
( |
const JEvtCategory & | category | ) |
const |
|
inlinevirtual |
Less-than method.
- Parameters
-
- Returns
- true if this event category is less than given event category; else false
Definition at line 109 of file JEvtCategory.hh.
110 {
111 return this->
primaryType < category.getPrimaryType();
112 }
◆ getPrimaryType()
int JAANET::JEvtCategory::getPrimaryType |
( |
| ) |
const |
|
inline |
Get primary PDG type of this event category.
- Returns
- primary PDG type
Definition at line 120 of file JEvtCategory.hh.
◆ getEquationParameters()
Get equation parameters.
- Returns
- equation parameters
Definition at line 131 of file JEvtCategory.hh.
132 {
134
135 return eqpars;
136 }
Simple data structure to support I/O of equations (see class JLANG::JEquation).
◆ setEquationParameters()
Set equation parameters.
- Parameters
-
eqpars | equation parameters |
Definition at line 144 of file JEvtCategory.hh.
145 {
147 }
static JEquationParameters & getEquationParameters()
Get equation parameters.
◆ getProperties() [1/2]
Get properties of this class.
- Parameters
-
eqpars | equation parameters |
Definition at line 155 of file JEvtCategory.hh.
156 {
158
160
161 return properties;
162 }
#define gmake_property(A)
macros to convert (template) parameter to JPropertiesElement object
Utility class to parse parameter values.
◆ getProperties() [2/2]
Get properties of this class.
- Parameters
-
eqpars | equation parameters |
Definition at line 170 of file JEvtCategory.hh.
171 {
173
175
176 return properties;
177 }
◆ read()
virtual std::istream & JAANET::JEvtCategory::read |
( |
std::istream & | in | ) |
|
|
inlinevirtual |
Read event category from input.
- Parameters
-
- Returns
- input stream
Definition at line 186 of file JEvtCategory.hh.
187 {
190
192
193 if (getFileStatus(is.str().c_str())) {
194 is.load();
195 }
196
198 is >> properties;
199
201
202 return in;
203 }
Wrapper class around STL stringstream class to facilitate optional loading of data from file.
void check_validity() const
Check validity.
virtual JProperties getProperties(const JEquationParameters &eqpars=JEvtCategory::getEquationParameters())
Get properties of this class.
◆ write()
virtual std::ostream & JAANET::JEvtCategory::write |
( |
std::ostream & | out | ) |
const |
|
inlinevirtual |
Write event category to output.
- Parameters
-
- Returns
- output stream
Definition at line 213 of file JEvtCategory.hh.
◆ clone()
template<class JClonable_t , class JDerived_t >
|
inlineoverridevirtualinherited |
Get clone of this object.
- Returns
- pointer to newly created object
Reimplemented in JPHYSICS::JPD0Transformer_t< JArgument_t >, JPHYSICS::JPDFTransformer< 2, JArgument_t >, JPHYSICS::JPDFTransformer< 3, JArgument_t >, JPHYSICS::JPDFTransformer< 4, JArgument_t >, JPHYSICS::JPDFTransformer< 5, JArgument_t >, JPHYSICS::JPDFTransformer_t< JArgument_t >, JPHYSICS::JPDGTransformer_t< JArgument_t >, and JTOOLS::JMultiMapTransformer< N, JArgument_t >::JMultiMapDefaultTransformer.
Definition at line 69 of file JClonable.hh.
70 {
71 return new JDerived_t(static_cast<const JDerived_t&>(*this));
72 }
◆ operator>>
std::istream & operator>> |
( |
std::istream & | in, |
|
|
JEvtCategory & | object ) |
|
friend |
Read event category from input.
- Parameters
-
in | input stream |
object | event category |
- Returns
- input stream
Definition at line 226 of file JEvtCategory.hh.
227 {
228 return object.read(in);
229 }
◆ operator<<
std::ostream & operator<< |
( |
std::ostream & | out, |
|
|
const JEvtCategory & | object ) |
|
friend |
Write event category to output.
- Parameters
-
out | output stream |
object | event category |
- Returns
- output stream
Definition at line 239 of file JEvtCategory.hh.
240 {
241 return object.write(out);
242 }
◆ primaryType
int JAANET::JEvtCategory::primaryType |
|
protected |
The documentation for this struct was generated from the following file: