WireCell::IChannel Class Reference

#include <IChannel.h>

Inheritance diagram for WireCell::IChannel:

Public Member Functions
virtual	~IChannel ()
virtual int	ident () const =0
virtual int	index () const =0
virtual const IWire::vector &	wires () const =0
	Wire segments ordered in increasing distance from channel input. More...
virtual WirePlaneId	planeid () const
	The ID of the plane of wire zero. This is just sugar. More...
Public Member Functions inherited from WireCell::IData< IChannel >
virtual	~IData ()

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

Detailed Description

Definition at line 14 of file IChannel.h.

Constructor & Destructor Documentation

IChannel::~IChannel ( )

virtual

Definition at line 5 of file IChannel.cxx.

{
}

Member Function Documentation

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

pure virtual

Detector-dependent, globally unique channel ID number. Negative is illegal, not guaranteed consecutive over all given channels. This same number may be called simply "channel" in other contexts.

Implemented in WireCell::SimpleChannel.

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

pure virtual

The channel index is the "Wire Attachment Number". The WAN counts along points of attachment of the zero' zero-segment wires for a wire plane. Note, for detectors with wrapped wires this index also wraps. It counts in the same direction as the WIP number of IWire::index but starts at zero even with wrapped wire detectors.

Implemented in WireCell::SimpleChannel.

WirePlaneId IChannel::planeid ( ) const

virtual

The ID of the plane of wire zero. This is just sugar.

Definition at line 9 of file IChannel.cxx.

{
    static const WirePlaneId bogus(kUnknownLayer, -1, -1);
    const IWire::vector& w = wires();
    if (w.empty()) { return bogus; }
    return w.front()->planeid();
}

virtual const IWire::vector& WireCell::IChannel::wires ( ) const

pure virtual

Wire segments ordered in increasing distance from channel input.

Implemented in WireCell::SimpleChannel.

---

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

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