geo::InvalidWireError Class Reference

Exception thrown on invalid wire number. More...

#include <Exceptions.h>

Inheritance diagram for geo::InvalidWireError:

Public Member Functions
	InvalidWireError (std::string cat)
	InvalidWireError (std::string cat, geo::PlaneID const &planeID, int badWireNo, int betterWireNo)
	Constructor with the complete information. More...
	InvalidWireError (std::string cat, geo::PlaneID const &planeID, int badWireNo)
	Constructor: no wire suggestions. More...
	InvalidWireError (std::string cat, int badWireNo, int betterWireNo)
	Constructor: no plane information. More...
	InvalidWireError (std::string cat, int badWireNo)
	Constructor: no plane information and no suggestion. More...
Access to bad wire
bool	hasBadWire () const
	Returns whether we known the bad wire number. More...
int	badWire () const
	Returns the bad wire number. More...
geo::WireID	badWireID () const
	Returns the bad wire ID. More...
Access to suggested wire
bool	hasSuggestedWire () const
	Returns whether we known a better wire number. More...
int	suggestedWire () const
	Returns a better wire number. More...
geo::WireID	suggestedWireID () const
	Returns a better wire ID. More...
Plane access
bool	hasPlane () const
	Return whether a plane is recorded with the exception. More...
geo::PlaneID const &	planeID () const
	Return the plane ID recorded with the exception. More...

Static Public Attributes
static constexpr int	InvalidWireNo = std::numeric_limits<int>::max()
	Value used to represent an invalid wire number. More...

Private Member Functions
geo::WireID	makeWireID (int wireNo) const
	Transform a wire number into wire ID. More...

Private Attributes
geo::PlaneID	fPlaneID
	plane the wire belongs to More...
int	fWireNumber = InvalidWireNo
	the invalid wire number More...
int	fBetterWireNo = InvalidWireNo
	a suggestion for a good wire number More...

Detailed Description

Exception thrown on invalid wire number.

---

This class is thrown, e.g., by Geometry::NearestWireID(). It contains the erroneous wire number, a suggestion of which one might be the right one, and a plane ID.

The wire numbers are signed.

Definition at line 42 of file Exceptions.h.

Constructor & Destructor Documentation

geo::InvalidWireError::InvalidWireError ( std::string  cat )

inline

Constructor: we don't have any information

Deprecated:

Specify at least the wrong wire number!

Definition at line 51 of file Exceptions.h.

: cet::exception(cat) {}

geo::InvalidWireError::InvalidWireError ( std::string  cat, geo::PlaneID const &  planeID, int  badWireNo, int  betterWireNo  )

inline

Constructor with the complete information.

Definition at line 54 of file Exceptions.h.

      : cet::exception(cat)
      , fPlaneID(planeID)
      , fWireNumber(badWireNo)
      , fBetterWireNo(betterWireNo)
      {}

geo::InvalidWireError::InvalidWireError ( std::string  cat, geo::PlaneID const &  planeID, int  badWireNo  )

inline

Constructor: no wire suggestions.

Definition at line 68 of file Exceptions.h.

      : cet::exception(cat)
      , fPlaneID(planeID)
      , fWireNumber(badWireNo)
      {}

geo::InvalidWireError::InvalidWireError ( std::string  cat, int  badWireNo, int  betterWireNo  )

inline

Constructor: no plane information.

Definition at line 75 of file Exceptions.h.

      : cet::exception(cat)
      , fWireNumber(badWireNo)
      , fBetterWireNo(betterWireNo)
      {}

geo::InvalidWireError::InvalidWireError ( std::string  cat, int  badWireNo  )

inline

Constructor: no plane information and no suggestion.

Definition at line 86 of file Exceptions.h.

      : cet::exception(cat)
      , fWireNumber(badWireNo)
      {}

Member Function Documentation

int geo::InvalidWireError::badWire ( ) const

inline

Returns the bad wire number.

Definition at line 102 of file Exceptions.h.

{ return fWireNumber; }

geo::WireID geo::InvalidWireError::badWireID ( ) const

inline

Returns the bad wire ID.

Definition at line 105 of file Exceptions.h.

{ return makeWireID(fWireNumber); }

bool geo::InvalidWireError::hasBadWire ( ) const

inline

Returns whether we known the bad wire number.

Definition at line 99 of file Exceptions.h.

{ return fWireNumber != InvalidWireNo; }

bool geo::InvalidWireError::hasPlane ( ) const

inline

Return whether a plane is recorded with the exception.

Definition at line 129 of file Exceptions.h.

{ return fPlaneID.isValid; }

bool geo::InvalidWireError::hasSuggestedWire ( ) const

inline

Returns whether we known a better wire number.

Definition at line 114 of file Exceptions.h.

{ return fBetterWireNo != InvalidWireNo; }

geo::WireID geo::InvalidWireError::makeWireID ( int  wireNo ) const

inlineprivate

Transform a wire number into wire ID.

Definition at line 146 of file Exceptions.h.

      { return { fPlaneID, (geo::WireID::WireID_t) wireNo }; }

geo::PlaneID const& geo::InvalidWireError::planeID ( ) const

inline

Return the plane ID recorded with the exception.

Definition at line 132 of file Exceptions.h.

{ return fPlaneID; }

int geo::InvalidWireError::suggestedWire ( ) const

inline

Returns a better wire number.

Definition at line 117 of file Exceptions.h.

{ return fBetterWireNo; }

geo::WireID geo::InvalidWireError::suggestedWireID ( ) const

inline

Returns a better wire ID.

Definition at line 120 of file Exceptions.h.

{ return makeWireID(fBetterWireNo); }

Member Data Documentation

int geo::InvalidWireError::fBetterWireNo = InvalidWireNo

private

a suggestion for a good wire number

Definition at line 143 of file Exceptions.h.

geo::PlaneID geo::InvalidWireError::fPlaneID

private

plane the wire belongs to

Definition at line 137 of file Exceptions.h.

int geo::InvalidWireError::fWireNumber = InvalidWireNo

private

the invalid wire number

Definition at line 140 of file Exceptions.h.

constexpr int geo::InvalidWireError::InvalidWireNo = std::numeric_limits<int>::max()

static

Value used to represent an invalid wire number.

Definition at line 46 of file Exceptions.h.

---

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

• larcorealg/larcorealg/Geometry/Exceptions.h