KM3NETDAQ::JDAQPMTIdentifier Class Reference

PMT identifier. More...

#include <JDAQPMTIdentifier.hh>

Inheritance diagram for KM3NETDAQ::JDAQPMTIdentifier:

Public Member Functions
	JDAQPMTIdentifier ()
	Default constructor. More...
	JDAQPMTIdentifier (const JDAQModuleIdentifier &id, const int pmt_address)
	Constructor. More...
const JDAQPMTIdentifier &	getPMTIdentifier () const
	Get PMT identifier. More...
void	setPMTIdentifier (const JDAQPMTIdentifier &pmt)
	Set PMT identifier. More...
int	getPMTAddress () const
	Get PMT identifier. More...
	ClassDefNV (JDAQPMTIdentifier, 1)
const JDAQModuleIdentifier &	getModuleIdentifier () const
	Get Module identifier. More...
void	setModuleIdentifier (const JDAQModuleIdentifier &module)
	Set Module identifier. More...
int	getModuleID () const
	Get module identifier. More...
	ClassDefNV (JDAQModuleIdentifier, 1)

Static Public Member Functions
static bool	compare (const JDAQPMTIdentifier &first, const JDAQPMTIdentifier &second)
	Compare PMT identifiers. More...

Protected Attributes
int	address
int	id

Friends
size_t	getSizeof ()
	Definition of method to get size of data type. More...
JReader &	operator>> (JReader &, JDAQPMTIdentifier &)
	Read PMT identifier from input. More...
JWriter &	operator<< (JWriter &, const JDAQPMTIdentifier &)
	Write PMT identifier to output. More...
std::istream &	operator>> (std::istream &in, JDAQPMTIdentifier &pmt)
	Read PMT identifier from input. More...
std::ostream &	operator<< (std::ostream &out, const JDAQPMTIdentifier &pmt)
	Write PMT identifier to output. More...

Detailed Description

PMT identifier.

Definition at line 20 of file JDAQPMTIdentifier.hh.

Constructor & Destructor Documentation

JDAQPMTIdentifier() [1/2]

KM3NETDAQ::JDAQPMTIdentifier::JDAQPMTIdentifier ( )

inline

Default constructor.

Definition at line 32 of file JDAQPMTIdentifier.hh.

                        :
      JDAQModuleIdentifier(),
      address            (0)
    {}

JDAQPMTIdentifier() [2/2]

KM3NETDAQ::JDAQPMTIdentifier::JDAQPMTIdentifier ( const JDAQModuleIdentifier &  id, const int  pmt_address  )

inline

Constructor.

Parameters

id	module identifier
pmt_address	PMT address

Definition at line 44 of file JDAQPMTIdentifier.hh.

                                                               :
      JDAQModuleIdentifier(id),
      address             (pmt_address)
    {}

Member Function Documentation

getPMTIdentifier()

const JDAQPMTIdentifier& KM3NETDAQ::JDAQPMTIdentifier::getPMTIdentifier ( ) const

inline

Get PMT identifier.

Returns

PMT identifier

Definition at line 56 of file JDAQPMTIdentifier.hh.

    { 
      return *this; 
    }

setPMTIdentifier()

void KM3NETDAQ::JDAQPMTIdentifier::setPMTIdentifier ( const JDAQPMTIdentifier &  pmt )

inline

Set PMT identifier.

Parameters

pmt	PMT identifier

Definition at line 67 of file JDAQPMTIdentifier.hh.

    { 
      *this = pmt;
    }

getPMTAddress()

int KM3NETDAQ::JDAQPMTIdentifier::getPMTAddress ( ) const

inline

Get PMT identifier.

Returns

PMT identifier

Definition at line 78 of file JDAQPMTIdentifier.hh.

    { 
      return address;
    }

compare()

static bool KM3NETDAQ::JDAQPMTIdentifier::compare ( const JDAQPMTIdentifier &  first, const JDAQPMTIdentifier &  second  )

inlinestatic

Compare PMT identifiers.

The comparison is applied to the module identifer and to the PMT address. If the module identifier or PMT address is -1, the corresponding comparison evaluates to true.

Parameters

first	PMT identifier
second	PMT identifier

Returns

true if first PMT equal second PMT; else false

Definition at line 126 of file JDAQPMTIdentifier.hh.

    {
      return ((first .getModuleIdentifier() == second.getModuleIdentifier() ||
               first .getModuleIdentifier() == -1                           ||
               second.getModuleIdentifier() == -1)                          &&
              (first .getPMTAddress()       == second.getPMTAddress()       ||
               first .getPMTAddress()       == -1                           ||
               second.getPMTAddress()       == -1));
    }

ClassDefNV() [1/2]

KM3NETDAQ::JDAQPMTIdentifier::ClassDefNV	(	JDAQPMTIdentifier	,
		1
	)

getModuleIdentifier()

const JDAQModuleIdentifier& KM3NETDAQ::JDAQModuleIdentifier::getModuleIdentifier ( ) const

inlineinherited

Get Module identifier.

Returns

Module identifier

Definition at line 50 of file JDAQModuleIdentifier.hh.

    { 
      return *this; 
    }

setModuleIdentifier()

void KM3NETDAQ::JDAQModuleIdentifier::setModuleIdentifier ( const JDAQModuleIdentifier &  module )

inlineinherited

Set Module identifier.

Parameters

module

Module identifier

Definition at line 61 of file JDAQModuleIdentifier.hh.

    { 
      *this = module;
    }

getModuleID()

int KM3NETDAQ::JDAQModuleIdentifier::getModuleID ( ) const

inlineinherited

Get module identifier.

Returns

module identifier

Definition at line 72 of file JDAQModuleIdentifier.hh.

    { 
      return id;
    }

ClassDefNV() [2/2]

KM3NETDAQ::JDAQModuleIdentifier::ClassDefNV ( JDAQModuleIdentifier  , 1    )

inherited

Friends And Related Function Documentation

getSizeof

size_t getSizeof ( )

friend

Definition of method to get size of data type.

This method should be specialised for each desired data type with fixed length.

Returns

number of bytes

operator>> [1/2]

JReader& operator>> ( JReader &  in, JDAQPMTIdentifier &  pmt  )

friend

Read PMT identifier from input.

Parameters

in	reader
pmt	PMT identifier

Returns

reader

Definition at line 35 of file JDAQPMTIdentifierIO.hh.

  {
    in >> static_cast<JDAQModuleIdentifier&>(pmt);
    in >> pmt.address;
 
    return in;
  }

operator<< [1/2]

JWriter& operator<< ( JWriter &  out, const JDAQPMTIdentifier &  pmt  )

friend

Write PMT identifier to output.

Parameters

out	writer
pmt	PMT identifier

Returns

writer

Definition at line 51 of file JDAQPMTIdentifierIO.hh.

  {
    out << static_cast<const JDAQModuleIdentifier&>(pmt);
    out << pmt.address;
 
    return out;
  }

operator>> [2/2]

std::istream& operator>> ( std::istream &  in, JDAQPMTIdentifier &  pmt  )

friend

Read PMT identifier from input.

Parameters

in	input stream
pmt	PMT identifier

Returns

input stream

Definition at line 91 of file JDAQPMTIdentifier.hh.

    {
      in >> static_cast<JDAQModuleIdentifier&>(pmt);
      in >> pmt.address;
 
      return in;
    }

operator<< [2/2]

std::ostream& operator<< ( std::ostream &  out, const JDAQPMTIdentifier &  pmt  )

friend

Write PMT identifier to output.

Parameters

out	output stream
pmt	PMT identifier

Returns

output stream

Definition at line 107 of file JDAQPMTIdentifier.hh.

    {
      out << static_cast<const JDAQModuleIdentifier&>(pmt) << ' ';
      out << pmt.address;
 
      return out;
    }

Member Data Documentation

address

int KM3NETDAQ::JDAQPMTIdentifier::address

protected

Definition at line 141 of file JDAQPMTIdentifier.hh.

id

int KM3NETDAQ::JDAQModuleIdentifier::id

protectedinherited

Definition at line 112 of file JDAQModuleIdentifier.hh.

---

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

• JDAQPMTIdentifier.hh