Belle II Software development
Belle2::TrackFindingCDC::NForwardBackward Namespace Reference

Namespace hiding the constants of the enum. More...

Enumerations

enum  EForwardBackward : signed short {
  c_Forward = 1 ,
  c_Unknown = 0 ,
  c_Backward = -1 ,
  c_Invalid = SHRT_MIN
}
 Enumeration to represent the distinct possibilities of the right left passage information. More...
 

Functions

EForwardBackward reversed (EForwardBackward eForwardBackward)
 Return the reversed forward backward indicator. Leaves EForwardBackward::c_Invalid the same.
 
bool isValid (EForwardBackward eForwardBackward)
 Check whether the given enum instance is one of the valid values.
 

Detailed Description

Namespace hiding the constants of the enum.

Enumeration Type Documentation

◆ EForwardBackward

enum EForwardBackward : signed short

Enumeration to represent the distinct possibilities of the right left passage information.

Enumerator
c_Forward 

Constant for a situation where something is more forward.

c_Unknown 

Constant for an not yet determined forward or backward arrangement.

c_Backward 

Constant for a situation where something is more backward.

c_Invalid 

Constant for an invalid information.

Definition at line 25 of file EForwardBackward.h.

25 : signed short {
26
28 c_Forward = 1,
29
31 c_Unknown = 0,
32
34 c_Backward = -1,
35
37 c_Invalid = SHRT_MIN,
38 };
@ c_Invalid
Constant for an invalid information.
@ c_Forward
Constant for a situation where something is more forward.
@ c_Backward
Constant for a situation where something is more backward.
@ c_Unknown
Constant for an not yet determined forward or backward arrangement.

Function Documentation

◆ isValid()

bool isValid ( EForwardBackward  eForwardBackward)
inline

Check whether the given enum instance is one of the valid values.

Definition at line 45 of file EForwardBackward.h.

46 { return std::abs(eForwardBackward) <= 1; }

◆ reversed()

EForwardBackward reversed ( EForwardBackward  eForwardBackward)
inline

Return the reversed forward backward indicator. Leaves EForwardBackward::c_Invalid the same.

Definition at line 41 of file EForwardBackward.h.

42 { return EForwardBackward(-eForwardBackward); }
EForwardBackward
Enumeration to represent the distinct possibilities of the right left passage information.