JDETECTOR::JPMTChannel Class Reference

Auxiliary class to uniquely identify PMT readout channel. More...

#include <JPMTChannel.hh>

Inheritance diagram for JDETECTOR::JPMTChannel:

Public Member Functions
	JPMTChannel ()
	Default constructor. More...
	JPMTChannel (const JObjectID &id, const JModuleLocation &location, const JPMTReadoutAddress &tdc)
	Constructor. More...
std::string	toString () const
	Convert PMT channel to string. More...
int	getID () const
	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...
const JModuleLocation &	getLocation () const
	Get location. More...
JModuleLocation &	getLocation ()
	Get location. More...
void	setLocation (const JModuleLocation &location)
	Set location. More...
std::string	toString (const std::string &fmt, const std::string target="%") const
	Convert module loation to string. More...
int	getString () const
	Get string number. More...
int	getFloor () const
	Get floor number. More...
bool	less (const JModuleLocation &location) const
	Less than method. More...
int	getTDC () const
	Get TDC. More...

Public Attributes
int	tdc
	TDC channel. More...

Protected Attributes
int	__id
int	string
int	floor

Friends
std::istream &	operator>> (std::istream &in, JPMTChannel &object)
	Read PMT channel. More...
std::ostream &	operator<< (std::ostream &out, const JPMTChannel &object)
	Write PMT channel. More...

Detailed Description

Auxiliary class to uniquely identify PMT readout channel.

Definition at line 28 of file JPMTChannel.hh.

Constructor & Destructor Documentation

JPMTChannel() [1/2]

JDETECTOR::JPMTChannel::JPMTChannel ( )

inline

Default constructor.

Definition at line 37 of file JPMTChannel.hh.

                  :
      JObjectID(),
      JModuleLocation(),
      JPMTReadoutAddress()
    {}

JPMTChannel() [2/2]

JDETECTOR::JPMTChannel::JPMTChannel ( const JObjectID &  id, const JModuleLocation &  location, const JPMTReadoutAddress &  tdc  )

inline

Constructor.

Parameters

id	detector identifier
location	module location
tdc	PMT readout address

Definition at line 51 of file JPMTChannel.hh.

                                               :
      JObjectID         (id),
      JModuleLocation   (location),
      JPMTReadoutAddress(tdc)
    {}

Member Function Documentation

toString() [1/2]

std::string JDETECTOR::JPMTChannel::toString ( ) const

inline

Convert PMT channel to string.

Returns

string

Definition at line 65 of file JPMTChannel.hh.

    {
      std::ostringstream os;
 
      os << *this;
 
      return os.str();
    }

getID()

int JLANG::JObjectID::getID ( ) const

inlineinherited

Get identifier.

Returns

identifier

Definition at line 55 of file JObjectID.hh.

    { 
      return __id;
    }

setID()

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

inlineinherited

Set identifier.

Parameters

id	identifier

Definition at line 66 of file JObjectID.hh.

    { 
      this->__id = id;
    }

less() [1/3]

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 78 of file JObjectID.hh.

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

less() [2/3]

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 90 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 102 of file JObjectID.hh.

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

getLocation() [1/2]

const JModuleLocation& JDETECTOR::JModuleLocation::getLocation ( ) const

inlineinherited

Get location.

Returns

location

Definition at line 68 of file JModuleLocation.hh.

    {
      return static_cast<const JModuleLocation&>(*this);
    }

getLocation() [2/2]

JModuleLocation& JDETECTOR::JModuleLocation::getLocation ( )

inlineinherited

Get location.

Returns

location

Definition at line 79 of file JModuleLocation.hh.

    {
      return static_cast<JModuleLocation&>(*this);
    }

setLocation()

void JDETECTOR::JModuleLocation::setLocation ( const JModuleLocation &  location )

inlineinherited

Set location.

Parameters

location

location

Definition at line 90 of file JModuleLocation.hh.

    {
      static_cast<JModuleLocation&>(*this) = location;
    }

toString() [2/2]

std::string JDETECTOR::JModuleLocation::toString ( const std::string &  fmt, const std::string  target = "%"  ) const

inlineinherited

Convert module loation to string.

The targets target in the format string fmt are consecutively replaced by floor and string.

Parameters

fmt	format
target	target

Returns

string

Definition at line 117 of file JModuleLocation.hh.

    {
      JLANG::JString buffer(fmt);
 
      buffer.replace(target, string, 1);
      buffer.replace(target, floor,  1);
 
      return buffer;
    }

getString()

int JDETECTOR::JModuleLocation::getString ( ) const

inlineinherited

Get string number.

Returns

string number

Definition at line 133 of file JModuleLocation.hh.

    {
      return string;
    }

getFloor()

int JDETECTOR::JModuleLocation::getFloor ( ) const

inlineinherited

Get floor number.

Returns

floor number

Definition at line 144 of file JModuleLocation.hh.

    {
      return floor;
    }

less() [3/3]

bool JDETECTOR::JModuleLocation::less ( const JModuleLocation &  location ) const

inlineinherited

Less than method.

Parameters

location

module location

Returns

true if first location before second location; else false

Definition at line 156 of file JModuleLocation.hh.

    {
      if (this->getString() == location.getString())
        return this->getFloor()  < location.getFloor();
      else
        return this->getString() < location.getString();
    }

getTDC()

int JDETECTOR::JPMTReadoutAddress::getTDC ( ) const

inlineinherited

Get TDC.

Returns

TDC

Definition at line 55 of file JPMTReadoutAddress.hh.

    {
      return tdc;
    }

Friends And Related Function Documentation

operator>>

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

friend

Read PMT channel.

Parameters

in	input stream
object	PMT channel

Returns

input stream

Definition at line 82 of file JPMTChannel.hh.

    {
      in >> static_cast<JObjectID&>         (object);
      in >> static_cast<JModuleLocation&>   (object);
      in >> static_cast<JPMTReadoutAddress&>(object);
 
      return in;
    }

operator<<

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

friend

Write PMT channel.

Parameters

out	output stream
object	PMT channel

Returns

output stream

Definition at line 99 of file JPMTChannel.hh.

    {
      out << static_cast<const JObjectID&>         (object) << ' ';
      out << static_cast<const JModuleLocation&>   (object) << ' ';
      out << static_cast<const JPMTReadoutAddress&>(object);
 
      return out;
    }

Member Data Documentation

__id

int JLANG::JObjectID::__id

protectedinherited

Definition at line 160 of file JObjectID.hh.

string

int JDETECTOR::JModuleLocation::string

protectedinherited

Definition at line 233 of file JModuleLocation.hh.

floor

int JDETECTOR::JModuleLocation::floor

protectedinherited

Definition at line 234 of file JModuleLocation.hh.

tdc

int JDETECTOR::JPMTReadoutAddress::tdc

inherited

TDC channel.

Definition at line 113 of file JPMTReadoutAddress.hh.

---

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

• JPMTChannel.hh