readout Namespace Reference

Namespaces
	details
	fhicl
	FHiCL objects representing geometry classes as configuration parameters.

Classes
struct	ElementLevel
class	ROPDataContainer
	Container with one element per readout plane. More...
struct	ROPID
	Class identifying a set of planes sharing readout channels. More...
class	ROPIDmapper
	Mapping for readout plane identifiers. More...
class	TPCsetDataContainer
	Container with one element per readout TPC set. More...
struct	TPCsetID
	Class identifying a set of TPC sharing readout channels. More...
class	TPCsetIDmapper
	Mapping for TPC set identifiers. More...

Typedefs
using	CryostatID = geo::CryostatID

Functions
std::ostream &	operator<< (std::ostream &out, TPCsetID const &sid)
	Generic output of TPCsetID to stream. More...
std::ostream &	operator<< (std::ostream &out, ROPID const &rid)
Readout ID comparison operators
The result of comparison with invalid IDs is undefined.
constexpr bool	operator== (TPCsetID const &a, TPCsetID const &b)
	Comparison: the IDs point to the same TPC set (validity is ignored) More...
constexpr bool	operator!= (TPCsetID const &a, TPCsetID const &b)
	Comparison: the IDs point to different TPC sets (validity is ignored) More...
constexpr bool	operator< (TPCsetID const &a, TPCsetID const &b)
	Order TPCsetID in increasing Cryo, then TPC set. More...
constexpr bool	operator== (ROPID const &a, ROPID const &b)
	Comparison: the IDs point to the same ROP (validity is ignored) More...
constexpr bool	operator!= (ROPID const &a, ROPID const &b)
	Comparison: the IDs point to different ROPs (validity is ignored) More...
constexpr bool	operator< (ROPID const &a, ROPID const &b)
	Order ROPID in increasing Cryo, then TPC set, then ROP. More...

Typedef Documentation

using readout::CryostatID = typedef geo::CryostatID

Definition at line 59 of file readout_types.h.

Function Documentation

constexpr bool readout::operator!= ( TPCsetID const &  a, TPCsetID const &  b  )

inline

Comparison: the IDs point to different TPC sets (validity is ignored)

Definition at line 268 of file readout_types.h.

                                                                          {
    return (a.asCryostatID() != b.asCryostatID()) || (a.TPCset != b.TPCset);
  } // operator!= (TPCsetID, TPCsetID)

constexpr bool readout::operator!= ( ROPID const &  a, ROPID const &  b  )

inline

Comparison: the IDs point to different ROPs (validity is ignored)

Definition at line 288 of file readout_types.h.

                                                                    {
    return (a.asTPCsetID() != b.asTPCsetID()) || (a.ROP != b.ROP);
  } // operator!= (ROPID, ROPID)

constexpr bool readout::operator< ( TPCsetID const &  a, TPCsetID const &  b  )

inline

Order TPCsetID in increasing Cryo, then TPC set.

Definition at line 273 of file readout_types.h.

                                                                         {
    int cmp_res = a.asCryostatID().cmp(b);
    if (cmp_res == 0) // same cryostat: compare TPC set
      return a.TPCset < b.TPCset;
    else              // return the order of cryostats
      return cmp_res < 0;
  } // operator< (TPCsetID, TPCsetID)

constexpr bool readout::operator< ( ROPID const &  a, ROPID const &  b  )

inline

Order ROPID in increasing Cryo, then TPC set, then ROP.

Definition at line 293 of file readout_types.h.

                                                                   {
    int cmp_res = a.asTPCsetID().cmp(b);
    if (cmp_res == 0) // same TPC set: compare ROP
      return a.ROP < b.ROP;
    else              // return the order of TPC set
      return cmp_res < 0;
  } // operator< (ROPID, ROPID)

std::ostream& readout::operator<< ( std::ostream &  out, TPCsetID const &  sid  )

inline

Generic output of TPCsetID to stream.

Definition at line 308 of file readout_types.h.

                                                                       {
    out << sid.asCryostatID() << " S:" << sid.TPCset;
    return out;
  } // operator<< (TPCsetID)

std::ostream& readout::operator<< ( std::ostream &  out, ROPID const &  rid  )

inline

Definition at line 313 of file readout_types.h.

                                                                    {
    out << rid.asTPCsetID() << " R:" << rid.ROP;
    return out;
  } // operator<< (ROPID)

constexpr bool readout::operator== ( TPCsetID const &  a, TPCsetID const &  b  )

inline

Comparison: the IDs point to the same TPC set (validity is ignored)

Definition at line 263 of file readout_types.h.

                                                                          {
    return (a.asCryostatID() == b.asCryostatID()) && (a.TPCset == b.TPCset);
  } // operator== (TPCsetID, TPCsetID)

constexpr bool readout::operator== ( ROPID const &  a, ROPID const &  b  )

inline

Comparison: the IDs point to the same ROP (validity is ignored)

Definition at line 283 of file readout_types.h.

                                                                    {
    return (a.asTPCsetID() == b.asTPCsetID()) && (a.ROP == b.ROP);
  } // operator== (ROPID, ROPID)