WireCell::SimpleWire Class Reference

#include <SimpleWire.h>

Inheritance diagram for WireCell::SimpleWire:

Public Member Functions
	SimpleWire (WireCell::WirePlaneId wpid, int ident, int index, int channel, const WireCell::Ray &ray, int segment=0)
virtual	~SimpleWire ()
int	ident () const
WireCell::WirePlaneId	planeid () const
	The ID of the plane this wire is in. More...
int	index () const
int	channel () const
WireCell::Ray	ray () const
	Return the ray representing the wire segment. More...
int	segment () const
Public Member Functions inherited from WireCell::IWire
virtual	~IWire ()
virtual WireCell::Point	center () const
	Return the center point of the wire. Convenience method. More...
Public Member Functions inherited from WireCell::IData< IWire >
virtual	~IData ()

Private Attributes
WireCell::WirePlaneId	m_wpid
int	m_ident
int	m_index
int	m_channel
int	m_segment
WireCell::Ray	m_ray

Additional Inherited Members
Public Types inherited from WireCell::IData< IWire >
typedef IWire	value_type
typedef std::shared_ptr< const IWire >	pointer
typedef std::vector< pointer >	vector
typedef std::shared_ptr< const vector >	shared_vector

Detailed Description

A wire that simply holds all its data.

Definition at line 10 of file SimpleWire.h.

Constructor & Destructor Documentation

WireCell::SimpleWire::SimpleWire ( WireCell::WirePlaneId  wpid, int  ident, int  index, int  channel, const WireCell::Ray &  ray, int  segment = 0  )

inline

Definition at line 18 of file SimpleWire.h.

            : m_wpid(wpid)
            , m_ident(ident)
            , m_index(index)
            , m_channel(channel)
            , m_segment(segment)
            , m_ray(ray) { }

SimpleWire::~SimpleWire ( )

virtual

Definition at line 174 of file IfaceDesctructors.cxx.

{}

Member Function Documentation

int WireCell::SimpleWire::channel ( ) const

inlinevirtual

Detector-dependent electronics channel number, negative is illegal. All wires with a common channel number are considered electrically connected.

Implements WireCell::IWire.

Definition at line 35 of file SimpleWire.h.

{ return m_channel; }

int WireCell::SimpleWire::ident ( ) const

inlinevirtual

Detector-dependent, globally unique ID number. Negative is illegal, not guaranteed consecutive.

Implements WireCell::IWire.

Definition at line 29 of file SimpleWire.h.

{ return m_ident; }

int WireCell::SimpleWire::index ( ) const

inlinevirtual

Consecutive, zero-based index into an ordered sequence of wires in their plane

Implements WireCell::IWire.

Definition at line 33 of file SimpleWire.h.

{ return m_index; }

WireCell::WirePlaneId WireCell::SimpleWire::planeid ( ) const

inlinevirtual

The ID of the plane this wire is in.

Implements WireCell::IWire.

Definition at line 31 of file SimpleWire.h.

{ return m_wpid; }

WireCell::Ray WireCell::SimpleWire::ray ( ) const

inlinevirtual

Return the ray representing the wire segment.

Implements WireCell::IWire.

Definition at line 37 of file SimpleWire.h.

{ return m_ray; }

int WireCell::SimpleWire::segment ( ) const

inlinevirtual

Return the number of wire segments between the channel input and this wire. Wire directly attached to channel input is segment==0.

Implements WireCell::IWire.

Definition at line 39 of file SimpleWire.h.

{return m_segment;}

Member Data Documentation

int WireCell::SimpleWire::m_channel

private

Definition at line 14 of file SimpleWire.h.

int WireCell::SimpleWire::m_ident

private

Definition at line 12 of file SimpleWire.h.

int WireCell::SimpleWire::m_index

private

Definition at line 13 of file SimpleWire.h.

WireCell::Ray WireCell::SimpleWire::m_ray

private

Definition at line 16 of file SimpleWire.h.

int WireCell::SimpleWire::m_segment

private

Definition at line 15 of file SimpleWire.h.

WireCell::WirePlaneId WireCell::SimpleWire::m_wpid

private

Definition at line 11 of file SimpleWire.h.

---

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

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