JTRIGGER::JTriggerInterface Class Reference

Trigger interface. More...

#include <JTriggerInterface.hh>

Inheritance diagram for JTRIGGER::JTriggerInterface:

Classes
struct	JBit
	Auxiliary class for type definition of specific trigger bit. More...

Public Types
typedef JTriggerInput::value_type	value_type
typedef JMatch< value_type >	match_type

Public Member Functions
JTriggerbit_t	getTriggerBit () const
	Get the trigger bit.

Static Public Member Functions
static const char *	getTriggerName (JTriggerbit_t bit)
	Get trigger name.

Protected Member Functions
	JTriggerInterface ()
	Default constructor.
virtual	~JTriggerInterface ()
	Virtual destructor.
template<JTriggerbit_t N>
bool	checkTriggerBit () const
	Test whether specific trigger bit correponds to derived trigger class.
template<JTriggerbit_t N>
JTriggerbit_t	find_trigger_bit (JBit< N > bit) const
	Recursive method to find the trigger bit of the given trigger data.
JTriggerbit_t	find_trigger_bit (JBit< NUMBER_OF_TRIGGER_BITS > bit) const
	Termination method of recursive method to find the trigger bit of the given trigger data.

Static Protected Member Functions
template<JTriggerbit_t N>
static const char *	getTriggerName ()
	Get trigger name.
template<JTriggerbit_t N>
static const char *	get_trigger_name (JBit< N > bit, JTriggerbit_t value)
	Recursive method to get trigger name for given trigger bit.
static const char *	get_trigger_name (JBit< NUMBER_OF_TRIGGER_BITS > bit, JTriggerbit_t value)
	Termination method of recursive method to get trigger name.

Detailed Description

Trigger interface.

This interface is used to define a unique bit for each trigger.

Definition at line 36 of file JTriggerInterface.hh.

Member Typedef Documentation

value_type

JTriggerInput::value_type JTRIGGER::JTriggerInterface::value_type

Definition at line 161 of file JTriggerInterface.hh.

match_type

JMatch<value_type> JTRIGGER::JTriggerInterface::match_type

Definition at line 162 of file JTriggerInterface.hh.

Constructor & Destructor Documentation

JTriggerInterface()

JTRIGGER::JTriggerInterface::JTriggerInterface ( )

inlineprotected

Default constructor.

Definition at line 42 of file JTriggerInterface.hh.

    {}

~JTriggerInterface()

virtual JTRIGGER::JTriggerInterface::~JTriggerInterface ( )

inlineprotectedvirtual

Virtual destructor.

Definition at line 49 of file JTriggerInterface.hh.

    {} 

Member Function Documentation

checkTriggerBit()

template<JTriggerbit_t N>

bool JTRIGGER::JTriggerInterface::checkTriggerBit ( ) const

inlineprotected

Test whether specific trigger bit correponds to derived trigger class.

This method will be specialised using the marco setTriggerBit() so that it will return true if this triggered event corresponds to bit N.

This method will be repeatedly called by method find_trigger_bit() which in turn is called by the member method JTriggerInterface::getTriggerBit() so that it returns the correct trigger bit.

Returns

false

Definition at line 76 of file JTriggerInterface.hh.

    {
      return false;
    }

find_trigger_bit() [1/2]

template<JTriggerbit_t N>

JTriggerbit_t JTRIGGER::JTriggerInterface::find_trigger_bit ( JBit< N > bit ) const

inlineprotected

Recursive method to find the trigger bit of the given trigger data.

Parameters

bit	trigger bit

Returns

trigger bit

Definition at line 89 of file JTriggerInterface.hh.

    {
      if (checkTriggerBit<N>())
        return N;
      else
        return find_trigger_bit(JBit<N+1>());
    }

find_trigger_bit() [2/2]

JTriggerbit_t JTRIGGER::JTriggerInterface::find_trigger_bit ( JBit< NUMBER_OF_TRIGGER_BITS > bit ) const

inlineprotected

Termination method of recursive method to find the trigger bit of the given trigger data.

This method throws an error.

Parameters

bit	trigger bit

Returns

trigger bit

Definition at line 105 of file JTriggerInterface.hh.

    {
      throw JTriggerException("Method find_trigger_bit<>(): no corresponding trigger bit found.");
    }

getTriggerName() [1/2]

template<JTriggerbit_t N>

static const char * JTRIGGER::JTriggerInterface::getTriggerName ( )

inlinestaticprotected

Get trigger name.

This method will be specialised using the marco setTriggerBit() so that it will return name of trigger for bit N.

This method will be repeatedly called by method get_trigger_name() which in turn is called by the method JTriggerInterface::getTriggerName() so that it returns the correct trigger name.

Returns

NULL

Definition at line 124 of file JTriggerInterface.hh.

    {
      return NULL;
    }

get_trigger_name() [1/2]

template<JTriggerbit_t N>

static const char * JTRIGGER::JTriggerInterface::get_trigger_name ( JBit< N > bit, JTriggerbit_t value )

inlinestaticprotected

Recursive method to get trigger name for given trigger bit.

Parameters

bit	trigger bit
value	trigger bit

Returns

trigger name

Definition at line 138 of file JTriggerInterface.hh.

    {
      if (bit.value == value)
        return getTriggerName<N>();
      else
        return get_trigger_name(JBit<N+1>(), value);
    }

get_trigger_name() [2/2]

static const char * JTRIGGER::JTriggerInterface::get_trigger_name ( JBit< NUMBER_OF_TRIGGER_BITS > bit, JTriggerbit_t value )

inlinestaticprotected

Termination method of recursive method to get trigger name.

Parameters

bit	trigger bit
value	trigger bit

Returns

NULL

Definition at line 154 of file JTriggerInterface.hh.

    {
      return NULL;
    }

getTriggerBit()

JTriggerbit_t JTRIGGER::JTriggerInterface::getTriggerBit ( ) const

inline

Get the trigger bit.

Returns

trigger bit

Definition at line 170 of file JTriggerInterface.hh.

    {
      return find_trigger_bit(JBit<0>());
    }

getTriggerName() [2/2]

static const char * JTRIGGER::JTriggerInterface::getTriggerName ( JTriggerbit_t bit )

inlinestatic

Get trigger name.

param bit trigger bit

Returns

trigger name

Definition at line 182 of file JTriggerInterface.hh.

    {
      return get_trigger_name(JBit<0>(), bit);
    }

---

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

• JTriggerInterface.hh