Type for the neighbor relationship from one wire to another. More...

Public Member Functions
	WireNeighborKind ()=default
	Default constructor - constructs an invalid neighbor kind.

	WireNeighborKind (short cellDistance, short oClockDirection)
	Useful constructor from cell distance and direction to reach the designated neighbor.

short	getILayerDifference () const
	Calculate the distance between the current and the layer of the designated neighbor.

short	getAbsILayerDifference () const
	Calculate the absolute distance between the current and the layer of the designated neighbor.

short	getILayerDifferenceSign () const
	Calculate if the designated neighbor is more outside.

short	getCellDistance () const
	Get the distance to the wire neighbor counted in number of cells. More...

short	getOClockDirection () const
	Get the direction on the clock to follow to reach the neighbor.

bool	isValid () const
	Check if the neighbor kind is in principle valid.

Private Attributes
short	m_cellDistance = 0
	Memory for the distance between to wires counted in numbers of cells.

short	m_oClockDirection = 0
	Memory for the direction the neighbor is located. Range 1 - 12 imaged on a regular clock.

Detailed Description

Type for the neighbor relationship from one wire to another.

Representations is tailored to cover the primary and secondary neighborhood only.

Definition at line 25 of file WireNeighborKind.h.

Member Function Documentation

short getCellDistance ( ) const

inline

Get the distance to the wire neighbor counted in number of cells.

This is typically 1 for the primary neighbors and 2 for the secondary neighbors

Definition at line 62 of file WireNeighborKind.h.

63 { return m_cellDistance; }

short m_cellDistance

Memory for the distance between to wires counted in numbers of cells.

Definition: WireNeighborKind.h:81

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