Knight KE / Mbed OS Game_Master
Embed: (wiki syntax)

« Back to documentation index

pairing_failure_t Struct Reference

pairing_failure_t Struct Reference

Type that describe a pairing failure. More...

#include <BLETypes.h>

Inherits SafeEnum< pairing_failure_t, uint8_t >.

Public Types

enum  type
 

struct scoped enum wrapped by the class

More...

Public Member Functions

 pairing_failure_t (type value)
 Construct a new instance of pairing_failure_t.
uint8_t value () const
 Explicit access to the inner value of the SafeEnum instance.

Friends

bool operator== (SafeEnum lhs, SafeEnum rhs)
 Equal to operator for SafeEnum instances.
bool operator!= (SafeEnum lhs, SafeEnum rhs)
 Not equal to operator for SafeEnum instances.
bool operator< (SafeEnum lhs, SafeEnum rhs)
 Less than operator for SafeEnum instances.
bool operator<= (SafeEnum lhs, SafeEnum rhs)
 Less than or equal to operator for SafeEnum instances.
bool operator> (SafeEnum lhs, SafeEnum rhs)
 Greater than operator for SafeEnum instances.
bool operator>= (SafeEnum lhs, SafeEnum rhs)
 Greater than or equal to operator for SafeEnum instances.

Detailed Description

Type that describe a pairing failure.

Definition at line 145 of file BLETypes.h.


Member Enumeration Documentation

enum type

struct scoped enum wrapped by the class

Definition at line 147 of file BLETypes.h.


Constructor & Destructor Documentation

pairing_failure_t ( type  value )

Construct a new instance of pairing_failure_t.

Definition at line 167 of file BLETypes.h.


Member Function Documentation

uint8_t value (  ) const [inherited]

Explicit access to the inner value of the SafeEnum instance.

Definition at line 196 of file SafeEnum.h.


Friends And Related Function Documentation

bool operator!= ( SafeEnum< pairing_failure_t, uint8_t >  lhs,
SafeEnum< pairing_failure_t, uint8_t >  rhs 
) [friend, inherited]

Not equal to operator for SafeEnum instances.

Parameters:
lhsleft hand side of the comparison
rhsright hand side of the comparison
Returns:
true if the inner value of lhs and rhs are not equal and false otherwise.

Definition at line 138 of file SafeEnum.h.

bool operator< ( SafeEnum< pairing_failure_t, uint8_t >  lhs,
SafeEnum< pairing_failure_t, uint8_t >  rhs 
) [friend, inherited]

Less than operator for SafeEnum instances.

Parameters:
lhsleft hand side of the comparison
rhsright hand side of the comparison
Returns:
true if the inner value of lhs is less than rhs and false otherwise.

Definition at line 150 of file SafeEnum.h.

bool operator<= ( SafeEnum< pairing_failure_t, uint8_t >  lhs,
SafeEnum< pairing_failure_t, uint8_t >  rhs 
) [friend, inherited]

Less than or equal to operator for SafeEnum instances.

Parameters:
lhsleft hand side of the comparison
rhsright hand side of the comparison
Returns:
true if the inner value of lhs is less than or equal to rhs and false otherwise.

Definition at line 163 of file SafeEnum.h.

bool operator== ( SafeEnum< pairing_failure_t, uint8_t >  lhs,
SafeEnum< pairing_failure_t, uint8_t >  rhs 
) [friend, inherited]

Equal to operator for SafeEnum instances.

Parameters:
lhsleft hand side of the comparison
rhsright hand side of the comparison
Returns:
true if the inner value of lhs and rhs are equal and false otherwise.

Definition at line 125 of file SafeEnum.h.

bool operator> ( SafeEnum< pairing_failure_t, uint8_t >  lhs,
SafeEnum< pairing_failure_t, uint8_t >  rhs 
) [friend, inherited]

Greater than operator for SafeEnum instances.

Parameters:
lhsleft hand side of the comparison
rhsright hand side of the comparison
Returns:
true if the inner value of lhs is greater than rhs; false otherwise.

Definition at line 176 of file SafeEnum.h.

bool operator>= ( SafeEnum< pairing_failure_t, uint8_t >  lhs,
SafeEnum< pairing_failure_t, uint8_t >  rhs 
) [friend, inherited]

Greater than or equal to operator for SafeEnum instances.

Parameters:
lhsleft hand side of the comparison
rhsright hand side of the comparison
Returns:
true if the inner value of lhs is greater than or equal to rhs; false otherwise.

Definition at line 189 of file SafeEnum.h.