WireCell::IWire Class Reference

Interface to information about a physical wire segment. More...

#include <IWire.h>

Inheritance diagram for WireCell::IWire:

Public Member Functions
virtual	~IWire ()
virtual int	ident () const =0
virtual WirePlaneId	planeid () const =0
	The ID of the plane this wire is in. More...
virtual int	index () const =0
virtual int	channel () const =0
virtual int	segment () const =0
virtual WireCell::Ray	ray () const =0
	Return the ray representing the wire segment. More...
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 ()

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

Interface to information about a physical wire segment.

Definition at line 18 of file IWire.h.

Constructor & Destructor Documentation

WireCell::IWire::~IWire ( )

virtual

Definition at line 4 of file IWire.cxx.

{
}

Member Function Documentation

WireCell::Point WireCell::IWire::center ( ) const

virtual

Return the center point of the wire. Convenience method.

Definition at line 9 of file IWire.cxx.

{
    Ray seg = ray();
    return 0.5*(seg.first + seg.second);
}

virtual int WireCell::IWire::channel ( ) const

pure virtual

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

Implemented in WireCell::GenWire, WireCell::SimpleWire, and MyWire.

virtual int WireCell::IWire::ident ( ) const

pure virtual

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

Implemented in WireCell::GenWire, WireCell::SimpleWire, and MyWire.

virtual int WireCell::IWire::index ( ) const

pure virtual

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

Implemented in WireCell::GenWire, WireCell::SimpleWire, and MyWire.

virtual WirePlaneId WireCell::IWire::planeid ( ) const

pure virtual

The ID of the plane this wire is in.

Implemented in WireCell::GenWire, WireCell::SimpleWire, and MyWire.

virtual WireCell::Ray WireCell::IWire::ray ( ) const

pure virtual

Return the ray representing the wire segment.

Implemented in WireCell::GenWire, WireCell::SimpleWire, and MyWire.

virtual int WireCell::IWire::segment ( ) const

pure virtual

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

Implemented in WireCell::GenWire, WireCell::SimpleWire, and MyWire.

---

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

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