JTRIGGER::JPrescaler Class Reference

Auxiliary class for prescaling. More...

#include <JPrescaler.hh>

Inheritance diagram for JTRIGGER::JPrescaler:

Public Member Functions
	JPrescaler ()
	Default constructor.
	JPrescaler (const long long int value)
	Constructor.
virtual	~JPrescaler ()
	Virtual destructor.
bool	equals (const JPrescaler &prescaler) const
	Equality.
bool	operator() () const
	Test operator.
	operator bool () const
	Check status.
	ClassDef (JPrescaler, 2)

Public Attributes
long long int	prescale
long long int	counter

Detailed Description

Auxiliary class for prescaling.

Definition at line 23 of file JPrescaler.hh.

Constructor & Destructor Documentation

JPrescaler() [1/2]

JTRIGGER::JPrescaler::JPrescaler ( )

inline

Default constructor.

Definition at line 30 of file JPrescaler.hh.

                 :
      prescale(0),
      counter (0)
    {}

JPrescaler() [2/2]

JTRIGGER::JPrescaler::JPrescaler ( const long long int value )

inline

Constructor.

Parameters

value

prescale value (0 is off)

Definition at line 41 of file JPrescaler.hh.

                                          :
      prescale(value),
      counter (0)
    {}

~JPrescaler()

virtual JTRIGGER::JPrescaler::~JPrescaler ( )

inlinevirtual

Virtual destructor.

Definition at line 50 of file JPrescaler.hh.

    {}

Member Function Documentation

equals()

bool JTRIGGER::JPrescaler::equals ( const JPrescaler & prescaler ) const

inline

Equality.

Parameters

prescaler

prescaler

Returns

true if equals; else false

Definition at line 60 of file JPrescaler.hh.

    {
      return  prescale == prescaler.prescale;
    }

operator()()

bool JTRIGGER::JPrescaler::operator() ( ) const

inline

Test operator.

This operator increments the internal counter and checks whether this counter complies with the prescale value.

Returns

true if this turn not prescaled; else false

Definition at line 74 of file JPrescaler.hh.

    {
      ++counter;
      
      return prescale != 0 && counter%prescale == 0;
    }

operator bool()

JTRIGGER::JPrescaler::operator bool ( ) const

inline

Check status.

Returns

true if this turn not prescaled; else false

Definition at line 87 of file JPrescaler.hh.

    {
      return prescale != 0 && counter%prescale == 0;
    }

ClassDef()

JTRIGGER::JPrescaler::ClassDef	(	JPrescaler	,
		2	)

Member Data Documentation

prescale

long long int JTRIGGER::JPrescaler::prescale

Definition at line 96 of file JPrescaler.hh.

counter

long long int JTRIGGER::JPrescaler::counter

mutable

Definition at line 97 of file JPrescaler.hh.

---

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

• JPrescaler.hh