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 JLocation &location, const JPMTReadoutAddress &tdc)
	Constructor. More...

std::string	toString () const
	Convert PMT channel to string. 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...

const JLocation &	getLocation () const
	Get location. More...

JLocation &	getLocation ()
	Get location. More...

void	setLocation (const JLocation &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 JLocation &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

JDETECTOR::JPMTChannel::JPMTChannel ( )

inline

Default constructor.

Definition at line 37 of file JPMTChannel.hh.

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

JDETECTOR::JPMTChannel::JPMTChannel	(	const JObjectID &	id,
		const JLocation &	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),
       JLocation         (location),
       JPMTReadoutAddress(tdc)
     {}

Member Function Documentation

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

int JLANG::JObjectID::getID ( ) const

inlineinherited

Get identifier.

Returns: identifier

Definition at line 50 of file JObjectID.hh.

     { 
       return __id;
     }

int& JLANG::JObjectID::getID ( )

inlineinherited

Get identifier.

Returns: identifier

Definition at line 61 of file JObjectID.hh.

     { 
       return __id;
     }

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

inlineinherited

Set identifier.

Parameters

id	identifier

Definition at line 72 of file JObjectID.hh.

     { 
       this->__id = id;
     }

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

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;
     }

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;
     }

const JLocation& JDETECTOR::JLocation::getLocation ( ) const

inlineinherited

Get location.

Returns: location

Definition at line 69 of file JLocation.hh.

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

JLocation& JDETECTOR::JLocation::getLocation ( )

inlineinherited

Get location.

Returns: location

Definition at line 80 of file JLocation.hh.

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

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

inlineinherited

Set location.

Parameters

location location

Definition at line 91 of file JLocation.hh.

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

std::string JDETECTOR::JLocation::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 118 of file JLocation.hh.

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

int JDETECTOR::JLocation::getString ( ) const

inlineinherited

Get string number.

Returns: string number

Definition at line 134 of file JLocation.hh.

     {
       return string;
     }

int JDETECTOR::JLocation::getFloor ( ) const

inlineinherited

Get floor number.

Returns: floor number

Definition at line 145 of file JLocation.hh.

     {
       return floor;
     }

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

inlineinherited

Less than method.

Parameters

location module location

Returns: true if first location before second location; else false

Definition at line 157 of file JLocation.hh.

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

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

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<JLocation&>         (object);
       in >> static_cast<JPMTReadoutAddress&>(object);
 
       return in;
     }

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 JLocation&>         (object) << ' ';
       out << static_cast<const JPMTReadoutAddress&>(object);
 
       return out;
     }

Member Data Documentation

int JLANG::JObjectID::__id

protectedinherited

Definition at line 140 of file JObjectID.hh.

int JDETECTOR::JLocation::string

protectedinherited

Definition at line 234 of file JLocation.hh.

int JDETECTOR::JLocation::floor

protectedinherited

Definition at line 235 of file JLocation.hh.

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

Public Member Functions

Public Attributes

Protected Attributes

Friends

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation

Friends And Related Function Documentation

Member Data Documentation