JAANET::JEvtCategory Struct Reference

Low-level interface for event categories. More...

#include <JEvtCategory.hh>

Inheritance diagram for JAANET::JEvtCategory:

Public Types
typedef JClonable< JClonable_t >::clone_type	clone_type

Public Member Functions
	JEvtCategory ()
	Default constructor.
	JEvtCategory (const int primaryType)
	Constructor.
virtual	~JEvtCategory ()
	Virtual destructor.
virtual bool	is_valid () const =0
	Check if event category is valid.
void	check_validity () const
	Check validity.
virtual bool	match (const JHead &header) const =0
	Check whether given MC header matches with this event category.
virtual bool	match (const Evt &event) const =0
	Check whether given event matches with this event category.
virtual bool	less (const JEvtCategory &category) const
	Less-than method.
int	getPrimaryType () const
	Get primary PDG type of this event category.
virtual JProperties	getProperties (const JEquationParameters &eqpars=JEvtCategory::getEquationParameters())
	Get properties of this class.
virtual JProperties	getProperties (const JEquationParameters &eqpars=JEvtCategory::getEquationParameters()) const
	Get properties of this class.
virtual std::istream &	read (std::istream &in)
	Read event category from input.
virtual std::ostream &	write (std::ostream &out) const
	Write event category to output.
virtual clone_type	clone () const override
	Get clone of this object.

Static Public Member Functions
static JEquationParameters &	getEquationParameters ()
	Get equation parameters.
static void	setEquationParameters (const JEquationParameters &eqpars)
	Set equation parameters.

Protected Attributes
int	primaryType
	Event primary PDG type.

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

Detailed Description

Low-level interface for event categories.

Definition at line 35 of file JEvtCategory.hh.

Member Typedef Documentation

clone_type

template<class JClonable_t , class JDerived_t >

JClonable<JClonable_t>::clone_type JLANG::JClonable< JClonable_t, JDerived_t >::clone_type

inherited

Definition at line 61 of file JClonable.hh.

Constructor & Destructor Documentation

JEvtCategory() [1/2]

JAANET::JEvtCategory::JEvtCategory ( )

inline

Default constructor.

Definition at line 42 of file JEvtCategory.hh.

                   :
      primaryType(0)
    {}

JEvtCategory() [2/2]

JAANET::JEvtCategory::JEvtCategory ( const int primaryType )

inline

Constructor.

Parameters

primaryType

primary PDG type

Definition at line 52 of file JEvtCategory.hh.

                                        :
      primaryType(primaryType)
    {}

~JEvtCategory()

virtual JAANET::JEvtCategory::~JEvtCategory ( )

inlinevirtual

Virtual destructor.

Definition at line 60 of file JEvtCategory.hh.

    {}

Member Function Documentation

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.

    {
      using namespace JPP;
        
      if (!is_valid()) {
        THROW(JValueOutOfRange, "JEvtCategory::check_validity(): Invalid category " << *this);
      }
    }

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

header

MC header

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

event

event

Returns

true if matching; else false

less()

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

inlinevirtual

Less-than method.

Parameters

category

event category

Returns

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

Definition at line 109 of file JEvtCategory.hh.

    {
      return this->primaryType < category.getPrimaryType();
    }

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.

    {
      return primaryType;
    }

getEquationParameters()

static JEquationParameters & JAANET::JEvtCategory::getEquationParameters ( )

inlinestatic

Get equation parameters.

Returns

equation parameters

Definition at line 131 of file JEvtCategory.hh.

    {
      static JEquationParameters eqpars("=", ",", "./", "#");
 
      return eqpars;
    }

setEquationParameters()

static void JAANET::JEvtCategory::setEquationParameters ( const JEquationParameters & eqpars )

inlinestatic

Set equation parameters.

Parameters

eqpars

equation parameters

Definition at line 144 of file JEvtCategory.hh.

    {
      getEquationParameters() = eqpars;
    }

getProperties() [1/2]

virtual JProperties JAANET::JEvtCategory::getProperties ( const JEquationParameters & eqpars = JEvtCategory::getEquationParameters() )

inlinevirtual

Get properties of this class.

Parameters

eqpars

equation parameters

Definition at line 155 of file JEvtCategory.hh.

    {
      JProperties properties(eqpars,1);
      
      properties.insert(gmake_property(primaryType));
 
      return properties;
    }

getProperties() [2/2]

virtual JProperties JAANET::JEvtCategory::getProperties ( const JEquationParameters & eqpars = JEvtCategory::getEquationParameters() ) const

inlinevirtual

Get properties of this class.

Parameters

eqpars

equation parameters

Definition at line 170 of file JEvtCategory.hh.

    {
      JProperties properties(eqpars,1);
      
      properties.insert(gmake_property(primaryType));
 
      return properties;
    }

read()

virtual std::istream & JAANET::JEvtCategory::read ( std::istream & in )

inlinevirtual

Read event category from input.

Parameters

in	input stream

Returns

input stream

Definition at line 186 of file JEvtCategory.hh.

    {
      using namespace std;
      using namespace JPP;
 
      JStringStream is(in);
 
      if (getFileStatus(is.str().c_str())) {
        is.load();
      }
 
      JProperties properties = getProperties();
      is >> properties;
      
      check_validity();
      
      return in;      
    }

write()

virtual std::ostream & JAANET::JEvtCategory::write ( std::ostream & out ) const

inlinevirtual

Write event category to output.

Parameters

out	output stream

Returns

output stream

Definition at line 213 of file JEvtCategory.hh.

    {
      return out << getProperties();      
    }

clone()

template<class JClonable_t , class JDerived_t >

virtual clone_type JLANG::JClonable< JClonable_t, JDerived_t >::clone ( ) const

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.

    {
      return new JDerived_t(static_cast<const JDerived_t&>(*this));
    }

Friends And Related Symbol Documentation

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.

    {
      return object.read(in);
    }

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.

    {
      return object.write(out);
    }

Member Data Documentation

primaryType

int JAANET::JEvtCategory::primaryType

protected

Event primary PDG type.

Definition at line 247 of file JEvtCategory.hh.

---

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

• JEvtCategory.hh