JACOUSTICS::JEKey Struct Reference

Emitter key. More...

#include <JEKey.hh>

Inheritance diagram for JACOUSTICS::JEKey:

Public Member Functions
	JEKey ()
	Default constructor.
	JEKey (const JObjectID &id, const JCounter &counter)
	Constructor.
int	getKey () const
	Get hash key.
int	getCounter () const
	Get counter.
	ClassDefNV (JCounter, 1)

Static Public Attributes
static const int	COUNTER = 100
	Multiplication factor applied to the event counter for the evaluation of the hash key.

Protected Attributes
int	counter

Friends
std::ostream &	operator<< (std::ostream &out, const JEKey &key)
	Write emitter key to output stream.

Detailed Description

Emitter key.

The emitter key can be used to umambiguously address an event in a data set.

Definition at line 32 of file JEKey.hh.

Constructor & Destructor Documentation

JEKey() [1/2]

JACOUSTICS::JEKey::JEKey ( )

inline

Default constructor.

Definition at line 47 of file JEKey.hh.

    {}

JEKey() [2/2]

JACOUSTICS::JEKey::JEKey ( const JObjectID & id, const JCounter & counter )

inline

Constructor.

Parameters

id	emitter identifier
counter	event counter

Definition at line 57 of file JEKey.hh.

                                    :
      JObjectID(id),
      JCounter (counter)
    {}

Member Function Documentation

getKey()

int JACOUSTICS::JEKey::getKey ( ) const

inline

Get hash key.

Returns

hash key

Definition at line 69 of file JEKey.hh.

    {
      return getCounter() * COUNTER  +  getID();
    }

getCounter()

int JACOUSTICS::JCounter::getCounter ( ) const

inlineinherited

Get counter.

Returns

counter

Definition at line 50 of file JCounter.hh.

    {
      return counter;
    }

ClassDefNV()

JACOUSTICS::JCounter::ClassDefNV ( JCounter , 1  )

inherited

Friends And Related Symbol Documentation

operator<<

std::ostream & operator<< ( std::ostream & out, const JEKey & key )

friend

Write emitter key to output stream.

Parameters

out	output stream
key	emitter key

Returns

output stream

Definition at line 82 of file JEKey.hh.

    {
      using namespace std;
 
      return out << setw(3) << key.getID()      << ' ' 
                 << setw(4) << key.getCounter();
    }

Member Data Documentation

COUNTER

const int JACOUSTICS::JEKey::COUNTER = 100

static

Multiplication factor applied to the event counter for the evaluation of the hash key.

Note that the object identifier of any emitter should not exceed this value.

Definition at line 41 of file JEKey.hh.

counter

int JACOUSTICS::JCounter::counter

protectedinherited

Definition at line 88 of file JCounter.hh.

---

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

• JEKey.hh