Kenji Arai / mbed-os_TYBLE16

Dependents:   TYBLE16_simple_data_logger TYBLE16_MP3_Air

Embed: (wiki syntax)

« Back to documentation index

coded_symbol_per_bit_t Struct Reference

coded_symbol_per_bit_t Struct Reference

Type describing the number of symbols per bit in le coded PHY. More...

#include <BLETypes.h>

Inherits SafeEnum< coded_symbol_per_bit_t, uint8_t >.

Public Types

enum  type { UNDEFINED, S2, S8 }
 

struct scoped enum wrapped by the class

More...
typedef uint8_t representation_t
 Type of the representation.

Public Member Functions

 coded_symbol_per_bit_t (type value)
 Construct a new instance of coded_symbol_per_bit_t.
uint8_t value () const
 Explicit access to the inner value of the SafeEnum instance.
const uint8_t * storage () const
 Return a pointer to the inner storage.

Friends

bool operator== (coded_symbol_per_bit_tlhs, coded_symbol_per_bit_trhs)
 Equal to operator for Target instances.
bool operator!= (coded_symbol_per_bit_tlhs, coded_symbol_per_bit_trhs)
 Not equal to operator for Target instances.
bool operator< (coded_symbol_per_bit_tlhs, coded_symbol_per_bit_trhs)
 Less than operator for Target instances.
bool operator<= (coded_symbol_per_bit_tlhs, coded_symbol_per_bit_trhs)
 Less than or equal to operator for Target instances.
bool operator> (coded_symbol_per_bit_tlhs, coded_symbol_per_bit_trhs)
 Greater than operator for Target instances.
bool operator>= (coded_symbol_per_bit_tlhs, coded_symbol_per_bit_trhs)
 Greater than or equal to operator for Target instances.

Detailed Description

Type describing the number of symbols per bit in le coded PHY.

Definition at line 808 of file BLETypes.h.


Member Typedef Documentation

typedef uint8_t representation_t [inherited]

Type of the representation.

Definition at line 113 of file SafeEnum.h.


Member Enumeration Documentation

enum type

struct scoped enum wrapped by the class

Enumerator:
UNDEFINED 

The Number of symbol used to code a bit is undefined.

S2 

Two symbols to code a bit.

S8 

Eight symbols to code a bit.

Definition at line 810 of file BLETypes.h.


Constructor & Destructor Documentation

Construct a new instance of coded_symbol_per_bit_t.

Definition at line 830 of file BLETypes.h.


Member Function Documentation

const uint8_t * storage (  ) const [inherited]

Return a pointer to the inner storage.

Definition at line 209 of file SafeEnum.h.

uint8_t value (  ) const [inherited]

Explicit access to the inner value of the SafeEnum instance.

Definition at line 202 of file SafeEnum.h.


Friends And Related Function Documentation

bool operator!= ( coded_symbol_per_bit_t  lhs,
coded_symbol_per_bit_t  rhs 
) [friend, inherited]

Not equal to operator for Target 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 144 of file SafeEnum.h.

bool operator< ( coded_symbol_per_bit_t  lhs,
coded_symbol_per_bit_t  rhs 
) [friend, inherited]

Less than operator for Target 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 156 of file SafeEnum.h.

bool operator<= ( coded_symbol_per_bit_t  lhs,
coded_symbol_per_bit_t  rhs 
) [friend, inherited]

Less than or equal to operator for Target 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 169 of file SafeEnum.h.

bool operator== ( coded_symbol_per_bit_t  lhs,
coded_symbol_per_bit_t  rhs 
) [friend, inherited]

Equal to operator for Target 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 131 of file SafeEnum.h.

bool operator> ( coded_symbol_per_bit_t  lhs,
coded_symbol_per_bit_t  rhs 
) [friend, inherited]

Greater than operator for Target 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 182 of file SafeEnum.h.

bool operator>= ( coded_symbol_per_bit_t  lhs,
coded_symbol_per_bit_t  rhs 
) [friend, inherited]

Greater than or equal to operator for Target 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 195 of file SafeEnum.h.