IWirePlane.h

Go to the documentation of this file.

/**
   Provides geometrical information about one wire plane in terms of
   its wire direction, pitch, bounding box and individual wires from
   which channel information can be derived.
 */

#ifndef WIRECELLIFACES_IWIREPLANE
#define WIRECELLIFACES_IWIREPLANE

#include "WireCellUtil/IComponent.h"

#include "WireCellUtil/Pimpos.h"

#include "WireCellIface/IWire.h"
#include "WireCellIface/IChannel.h"

namespace WireCell {

    class IWirePlane : public IComponent<IWirePlane> {
    public:

        virtual ~IWirePlane();

        virtual int ident() const = 0;

        /// Return a Pimpos object for this wire plane
        virtual const Pimpos* pimpos() const = 0;

        /// Return vector of wire objects ordered by increasing Z.
        virtual const IWire::vector& wires() const = 0;

        /// Return vector of channel objects ordered by their index
        /// (NOT their channel ident number).
        virtual const IChannel::vector& channels() const = 0;

        /// The ID of the plane of wire zero.  This is just sugar.
        virtual WirePlaneId planeid() const;
    };
}

#endif