Belle II Software development
WireNeighborPair Class Reference

Class representing a pair of neighbors in the CDC in a single layer For certain circumstances it is allowed that both wires point to nullptr, e.g. More...

#include <WireNeighborPair.h>

Inheritance diagram for WireNeighborPair:

Public Types

using Super = std::pair< MayBePtr< const CDCWire >, MayBePtr< const CDCWire > >
 Type of the base class.
 

Public Member Functions

MayBePtr< const CDCWiregetFirst () const
 Getter for the first wire.
 
MayBePtr< const CDCWiregetSecond () const
 Getter for the second wire.
 
WireNeighborKind getNeighborKind () const
 Getter for the kind of neighbor hood relation the first wire has with the second.
 

Detailed Description

Class representing a pair of neighbors in the CDC in a single layer For certain circumstances it is allowed that both wires point to nullptr, e.g.

at the borders of super layers. Hence you have to check before accessing the wires.

Definition at line 29 of file WireNeighborPair.h.

Member Typedef Documentation

◆ Super

using Super = std::pair<MayBePtr<const CDCWire>, MayBePtr<const CDCWire> >

Type of the base class.

Definition at line 33 of file WireNeighborPair.h.

Member Function Documentation

◆ getFirst()

MayBePtr< const CDCWire > getFirst ( ) const
inline

Getter for the first wire.

Definition at line 39 of file WireNeighborPair.h.

40 { return this->first; }

◆ getNeighborKind()

WireNeighborKind getNeighborKind ( ) const

Getter for the kind of neighbor hood relation the first wire has with the second.

Definition at line 15 of file WireNeighborPair.cc.

16{
17 if (not getFirst() or not getSecond()) return WireNeighborKind();
18
20}
WireNeighborKind getNeighborKind(const WireID &wireID, const WireID &otherWireID) const
Checks if two wires are closest neighbors.
static CDCWireTopology & getInstance()
Getter for the singleton instance of the wire topology.
Type for the neighbor relationship from one wire to another.
MayBePtr< const CDCWire > getSecond() const
Getter for the second wire.
MayBePtr< const CDCWire > getFirst() const
Getter for the first wire.

◆ getSecond()

MayBePtr< const CDCWire > getSecond ( ) const
inline

Getter for the second wire.

Definition at line 43 of file WireNeighborPair.h.

44 { return this->second; }

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