JDETECTOR::JPMTAddress Class Reference

Address of PMT in detector data structure. More...

#include <JPMTAddress.hh>

Inheritance diagram for JDETECTOR::JPMTAddress:

Public Member Functions
	JPMTAddress ()
	Default constructor.
	JPMTAddress (const JModuleAddress &module, const int pmt)
	Constructor.
bool	less (const JPMTAddress &address) const
	Less than method.
bool	equals (const JModuleAddress &address) const
	Equal method.

Public Attributes
int	second
	index of PMT in module data structure.
int	first
	index of module in detector data structure

Friends
std::istream &	operator>> (std::istream &in, JPMTAddress &object)
	Read PMT address from input.
std::ostream &	operator<< (std::ostream &out, const JPMTAddress &object)
	Write PMT address to output.

Detailed Description

Address of PMT in detector data structure.

The address of a PMT consists of a pair of integer values, where

• JPMTAddress::first refers to the index of the parent module in the detector data structure; and
• JPMTAddress::second refers to the index of the PMT in the corresponding module data structure.

This class implements the JLANG::JComparable interface.

Definition at line 32 of file JPMTAddress.hh.

Constructor & Destructor Documentation

JPMTAddress() [1/2]

JDETECTOR::JPMTAddress::JPMTAddress ( )

inline

Default constructor.

Definition at line 40 of file JPMTAddress.hh.

                  :
      JModuleAddress(-1),
      second(-1)
    {}

JPMTAddress() [2/2]

JDETECTOR::JPMTAddress::JPMTAddress ( const JModuleAddress & module, const int pmt )

inline

Constructor.

Parameters

module	module address
pmt	PMT index

Definition at line 52 of file JPMTAddress.hh.

                               :
      JModuleAddress(module),
      second(pmt)
    {}

Member Function Documentation

less()

bool JDETECTOR::JPMTAddress::less ( const JPMTAddress & address ) const

inline

Less than method.

Parameters

address

PMT address

Returns

true if this PMT address is less than given PMT address; else false

Definition at line 65 of file JPMTAddress.hh.

    {
      if (this->first == address.first)
        return this->second < address.second;
      else
        return this->first  < address.first;
    }

equals()

bool JDETECTOR::JModuleAddress::equals ( const JModuleAddress & address ) const

inlineinherited

Equal method.

Parameters

address

module address

Returns

true if this module address equal to given module address; else false

Definition at line 58 of file JModuleAddress.hh.

    {
      return this->first == address.first;
    }

Friends And Related Symbol Documentation

operator>>

std::istream & operator>> ( std::istream & in, JPMTAddress & object )

friend

Read PMT address from input.

Parameters

in	input stream
object	PMT address

Returns

input stream

Definition at line 81 of file JPMTAddress.hh.

    {
      return in >> static_cast<JModuleAddress&>(object) >> object.second;
    }

operator<<

std::ostream & operator<< ( std::ostream & out, const JPMTAddress & object )

friend

Write PMT address to output.

Parameters

out	output stream
object	PMT address

Returns

output stream

Definition at line 94 of file JPMTAddress.hh.

    {
      return out << static_cast<const JModuleAddress&>(object) << ' ' << object.second;
    }

Member Data Documentation

second

int JDETECTOR::JPMTAddress::second

index of PMT in module data structure.

Definition at line 100 of file JPMTAddress.hh.

first

int JDETECTOR::JModuleAddress::first

inherited

index of module in detector data structure

Definition at line 90 of file JModuleAddress.hh.

---

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

• JPMTAddress.hh