LArSoft  v07_13_02
Liquid Argon Software toolkit - http://larsoft.org/
geo_types.h File Reference

Definition of data types for geometry description. More...

#include <climits>
#include <cmath>
#include <string>
#include <sstream>
#include <iosfwd>
#include <limits>

Go to the source code of this file.

Classes

struct  geo::CryostatID
 The data type to uniquely identify a cryostat. More...
 
struct  geo::TPCID
 The data type to uniquely identify a TPC. More...
 
struct  geo::PlaneID
 The data type to uniquely identify a Plane. More...
 
struct  geo::WireID
 
struct  geo::WireIDIntersection
 

Namespaces

 geo
 Namespace collecting geometry-related classes utilities.
 
 geo::details
 

Functions

template<typename T >
std::string geo::details::writeToString (T const &value)
 Write the argument into a string. More...
 
Geometry element IDs
std::ostream & geo::operator<< (std::ostream &out, CryostatID const &cid)
 Generic output of CryostatID to stream. More...
 
std::ostream & geo::operator<< (std::ostream &out, TPCID const &tid)
 Generic output of TPCID to stream. More...
 
std::ostream & geo::operator<< (std::ostream &out, PlaneID const &pid)
 Generic output of PlaneID to stream. More...
 
std::ostream & geo::operator<< (std::ostream &out, WireID const &wid)
 Generic output of WireID to stream. More...
 
ID comparison operators

The result of comparison with invalid IDs is undefined.

bool geo::operator== (CryostatID const &a, CryostatID const &b)
 Comparison: the IDs point to the same cryostat (validity is ignored) More...
 
bool geo::operator!= (CryostatID const &a, CryostatID const &b)
 Comparison: the IDs point to different cryostats (validity is ignored) More...
 
bool geo::operator< (CryostatID const &a, CryostatID const &b)
 Order cryostats with increasing ID. More...
 
bool geo::operator== (TPCID const &a, TPCID const &b)
 Comparison: the IDs point to the same TPC (validity is ignored) More...
 
bool geo::operator!= (TPCID const &a, TPCID const &b)
 Comparison: the IDs point to different TPCs (validity is ignored) More...
 
bool geo::operator< (TPCID const &a, TPCID const &b)
 Order TPCID in increasing Cryo, then TPC. More...
 
bool geo::operator== (PlaneID const &a, PlaneID const &b)
 Comparison: the IDs point to the same plane (validity is ignored) More...
 
bool geo::operator!= (PlaneID const &a, PlaneID const &b)
 Comparison: the IDs point to different planes (validity is ignored) More...
 
bool geo::operator< (PlaneID const &a, PlaneID const &b)
 Order PlaneID in increasing TPC, then plane. More...
 
bool geo::operator== (WireID const &a, WireID const &b)
 Comparison: the IDs point to the same wire (validity is ignored) More...
 
bool geo::operator!= (WireID const &a, WireID const &b)
 Comparison: the IDs point to different wires (validity is ignored) More...
 
bool geo::operator< (WireID const &a, WireID const &b)
 Comparison: the IDs point to the same cryostat (validity is ignored) More...
 

Geometry enumerators

enum  geo::coordinates { geo::kXCoord, geo::kYCoord, geo::kZCoord }
 Enumerate the possible plane projections. More...
 
enum  geo::_plane_proj {
  geo::kU, geo::kV, geo::kW, geo::kZ =kW,
  geo::kY, geo::kX, geo::k3D, geo::kUnknown
}
 Enumerate the possible plane projections. More...
 
enum  geo::_plane_orient { geo::kHorizontal, geo::kVertical }
 Enumerate the possible plane projections. More...
 
enum  geo::_plane_sigtype { geo::kInduction, geo::kCollection, geo::kMysteryType }
 Enumerate the possible plane projections. More...
 
enum  geo::driftdir {
  geo::kUnknownDrift, geo::kPos, geo::kNeg, geo::kPosX = kPos,
  geo::kNegX = kNeg
}
 Drift direction: positive or negative. More...
 
typedef enum geo::coordinates geo::Coord_t
 Enumerate the possible plane projections. More...
 
typedef enum geo::_plane_proj geo::View_t
 Enumerate the possible plane projections. More...
 
typedef enum geo::_plane_orient geo::Orient_t
 Enumerate the possible plane projections. More...
 
typedef enum geo::_plane_sigtype geo::SigType_t
 Enumerate the possible plane projections. More...
 
typedef enum geo::driftdir geo::DriftDirection_t
 Drift direction: positive or negative. More...
 

Detailed Description

Definition of data types for geometry description.

Author
Brian Rebel (brebe.nosp@m.l@fn.nosp@m.al.go.nosp@m.v)

This library is currently header-only and depends only on standard C++.

Definition in file geo_types.h.