Emitter key. More...

#include <JEKey.hh>

Inheritance diagram for JACOUSTICS::JEKey:

Public Member Functions
	JEKey ()
	Default constructor. More...

	JEKey (const JObjectID &id, const JCounter &counter)
	Constructor. More...

int	getKey () const
	Get hash key. More...

int	getID () const
	Get identifier. More...

int &	getID ()
	Get identifier. More...

void	setID (const int id)
	Set identifier. More...

bool	less (const JObjectID &object) const
	Less than method. More...

bool	less (const int id) const
	Less than method. More...

bool	more (const int id) const
	More than method. More...

int	getCounter () const
	Get counter. More...

	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. More...

Static Protected Member Functions
template<class JHead_t , class JTail_t >
static bool	lt (const JClass_t &first, const JClass_t &second, const JType< JTypeList< JHead_t, JTail_t > > &type)
	Less than method for composite data types. More...

template<class JHead_t >
static bool	lt (const JClass_t &first, const JClass_t &second, const JType< JTypeList< JHead_t, JNullType > > &type)
	Less than method for composite data types. More...

Protected Attributes
int	__id

int	counter

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

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.

48 {}

◆ 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();
     }

◆ getID() [1/2]

int JLANG::JObjectID::getID ( ) const

inlineinherited

Get identifier.

Returns: identifier

Definition at line 50 of file JObjectID.hh.

     { 
       return __id;
     }

◆ getID() [2/2]

int& JLANG::JObjectID::getID ( )

inlineinherited

Get identifier.

Returns: identifier

Definition at line 61 of file JObjectID.hh.

     { 
       return __id;
     }

◆ setID()

void JLANG::JObjectID::setID ( const int id )

inlineinherited

Set identifier.

Parameters

id	identifier

Definition at line 72 of file JObjectID.hh.

     { 
       this->__id = id;
     }

◆ less() [1/2]

bool JLANG::JObjectID::less ( const JObjectID & object ) const

inlineinherited

Less than method.

Parameters

object object identifier

Returns: true if this identifier less than given identifier; else false

Definition at line 84 of file JObjectID.hh.

     { 
       return this->getID() < object.getID();
     }

◆ less() [2/2]

bool JLANG::JObjectID::less ( const int id ) const

inlineinherited

Less than method.

Parameters

id	identifier

Returns: true if this identifier less than given identifier; else false

Definition at line 96 of file JObjectID.hh.

     { 
       return this->getID() < id;
     }

◆ more()

bool JLANG::JObjectID::more ( const int id ) const

inlineinherited

More than method.

Parameters

id	identifier

Returns: true if this identifier greater than given identifier; else false

Definition at line 108 of file JObjectID.hh.

     { 
       return this->getID() > id;
     }

◆ getCounter()

int JACOUSTICS::JCounter::getCounter ( ) const

inlineinherited

Get counter.

Returns: counter

Definition at line 51 of file JAcoustics/JCounter.hh.

     {
       return counter;
     }

◆ ClassDefNV()

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

inherited

◆ lt() [1/2]

template<class JClass_t , class JTypelist_t >

template<class JHead_t , class JTail_t >

static bool JLANG::JMultiComparable< JClass_t, JTypelist_t >::lt	(	const JClass_t &	first,
		const JClass_t &	second,
		const JType< JTypeList< JHead_t, JTail_t > > &	type
	)

inlinestaticprotectedinherited

Less than method for composite data types.

Parameters

first	first object
second	second object
type	type

Returns: true if first object is less than second object; else false

Definition at line 43 of file JMultiComparable.hh.

     {
       if      (static_cast<const JHead_t&>(first)  <
                static_cast<const JHead_t&>(second))
         return true;
       else if (static_cast<const JHead_t&>(second)  <
                static_cast<const JHead_t&>(first))
         return false;
       else
         return lt(first, second, JType<JTail_t>());
     }

◆ lt() [2/2]

template<class JClass_t , class JTypelist_t >

template<class JHead_t >

static bool JLANG::JMultiComparable< JClass_t, JTypelist_t >::lt	(	const JClass_t &	first,
		const JClass_t &	second,
		const JType< JTypeList< JHead_t, JNullType > > &	type
	)

inlinestaticprotectedinherited

Less than method for composite data types.

Parameters

first	first object
second	second object
type	type

Returns: true if first object is less than second object; else false

Definition at line 67 of file JMultiComparable.hh.

     {
       return (static_cast<const JHead_t&>(first) <
               static_cast<const JHead_t&>(second));
     }

Friends And Related Function 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.

◆ __id

int JLANG::JObjectID::__id

protectedinherited

Definition at line 140 of file JObjectID.hh.

◆ counter

int JACOUSTICS::JCounter::counter

protectedinherited

Definition at line 89 of file JAcoustics/JCounter.hh.

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

JEKey.hh

Public Member Functions

Static Public Attributes

Static Protected Member Functions

Protected Attributes

Friends

Detailed Description

Constructor & Destructor Documentation

◆ JEKey() [1/2]

◆ JEKey() [2/2]

Member Function Documentation

◆ getKey()

◆ getID() [1/2]

◆ getID() [2/2]

◆ setID()

◆ less() [1/2]

◆ less() [2/2]

◆ more()

◆ getCounter()

◆ ClassDefNV()

◆ lt() [1/2]

◆ lt() [2/2]

Friends And Related Function Documentation

◆ operator<<

Member Data Documentation

◆ COUNTER

◆ __id

◆ counter