Encapsulation of high or low side. More...

#include <LoHiSide.H>

Public Types
enum	LoHiSide { Invalid =-1, Lo =0, Hi, NUMSIDES }

Public Member Functions
	Side ()

	~Side ()

Static Public Member Functions
static Side::LoHiSide	flip (const Side::LoHiSide &a_side)

Friends
Side::LoHiSide	flip (const Side::LoHiSide &a_side)

int	sign (const Side::LoHiSide &a_side)

Detailed Description

Encapsulation of high or low side.

Member Enumeration Documentation

◆ LoHiSide

enum Side::LoHiSide

Lo is the low side.
Hi is the high side.

Enumerator
Invalid
Lo
Hi
NUMSIDES

Constructor & Destructor Documentation

◆ Side()

Side::Side ( )

inline

Constructor.

◆ ~Side()

Side::~Side ( )

inline

Destructor.

References flip, and sign.

Member Function Documentation

◆ flip()

static Side::LoHiSide Side::flip ( const Side::LoHiSide & a_side )

static

Friends And Related Function Documentation

◆ flip

Side::LoHiSide flip ( const Side::LoHiSide & a_side )

friend

Returns the other side. That is, swap Hi for Lo and vice versa.

Referenced by ~Side().

◆ sign

int sign ( const Side::LoHiSide & a_side )

friend

Returns -1 for Lo Side, +1 for Hi Side.