WireCell::WirePlaneId Class Reference

#include <WirePlaneId.h>

Public Member Functions
	WirePlaneId (WirePlaneLayer_t layer, int face=0, int apa=0)
	WirePlaneId (int packed)
int	ident () const
	Unit ID as integer. More...
WirePlaneLayer_t	layer () const
	Layer as enum. More...
int	ilayer () const
	Layer as integer (not index!) More...
int	index () const
	Layer as index number (0,1 or 2). -1 if unknown. More...
int	face () const
	APA face number. More...
int	apa () const
	APA number. More...
bool	valid () const
	return true if valid More...
bool	operator== (const WirePlaneId &rhs)
bool	operator!= (const WirePlaneId &rhs)
bool	operator< (const WirePlaneId &rhs)

Private Attributes
int	m_pack

Detailed Description

Definition at line 16 of file WirePlaneId.h.

Constructor & Destructor Documentation

WireCell::WirePlaneId::WirePlaneId ( WirePlaneLayer_t  layer, int  face = 0, int  apa = 0  )

explicit

Definition at line 9 of file WirePlaneId.cxx.

    : m_pack( (((int)layer)&layer_mask) | (face << face_shift) | (apa<<apa_shift))
{
}

WireCell::WirePlaneId::WirePlaneId ( int  packed )

explicit

Definition at line 13 of file WirePlaneId.cxx.

    : m_pack(packed)
{
    // It is very dubious that I allow this constructor.  I do it for
    // reading WireSchema files where the packing is done by the user.
    // Very dubious indeed.
}

Member Function Documentation

int WireCell::WirePlaneId::apa

(

)

const

APA number.

Definition at line 48 of file WirePlaneId.cxx.

{
    return m_pack>>apa_shift;
}

int WireCell::WirePlaneId::face

(

)

const

APA face number.

Definition at line 44 of file WirePlaneId.cxx.

{
    return (m_pack&(1<<face_shift))>>3;
}

int WireCell::WirePlaneId::ident

(

)

const

Unit ID as integer.

Definition at line 21 of file WirePlaneId.cxx.

{
    return m_pack;
}

int WireCell::WirePlaneId::ilayer

(

)

const

Layer as integer (not index!)

Definition at line 29 of file WirePlaneId.cxx.

{
    return m_pack & layer_mask;
}

int WireCell::WirePlaneId::index

(

)

const

Layer as index number (0,1 or 2). -1 if unknown.

Definition at line 34 of file WirePlaneId.cxx.

{
    switch (layer()) {
    case kUlayer : return 0;
    case kVlayer : return 1;
    case kWlayer : return 2;
    case kUnknownLayer: return -1;
    }
    return -1;
}

WireCell::WirePlaneLayer_t WireCell::WirePlaneId::layer

(

)

const

Layer as enum.

Definition at line 25 of file WirePlaneId.cxx.

{
    return WirePlaneLayer_t(ilayer());
}

bool WireCell::WirePlaneId::operator!=

(

const WirePlaneId &

rhs

)

Definition at line 64 of file WirePlaneId.cxx.

{
    return !(*this == rhs);
}

bool WireCell::WirePlaneId::operator<

(

const WirePlaneId &

rhs

)

Definition at line 69 of file WirePlaneId.cxx.

{
    if (!this->valid() || !rhs.valid()) { return false; }

    if (apa() == rhs.apa()) {
        if (face() == rhs.face()) {
            return index() < rhs.index();
        }
        return face() < rhs.face();
    }
    return apa() < rhs.apa();
}

bool WireCell::WirePlaneId::operator==

(

const WirePlaneId &

rhs

)

Definition at line 59 of file WirePlaneId.cxx.

{
    return m_pack == rhs.m_pack;
}

bool WireCell::WirePlaneId::valid

(

)

const

return true if valid

Definition at line 53 of file WirePlaneId.cxx.

{
    int ind = index();
    return 0 <= ind && ind < 3;
}

Member Data Documentation

int WireCell::WirePlaneId::m_pack

private

Definition at line 51 of file WirePlaneId.h.

---

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

• wire-cell-build/iface/inc/WireCellIface/WirePlaneId.h
• wire-cell-build/iface/src/WirePlaneId.cxx