Kenji Arai / mbed-os_TYBLE16

Dependents:   TYBLE16_simple_data_logger TYBLE16_MP3_Air

Embed: (wiki syntax)

« Back to documentation index

advertising_data_status_t Struct Reference

advertising_data_status_t Struct Reference
[Gap]

Used to indicate if the packet is complete and if it's truncated. More...

#include <Types.h>

Inherits SafeEnum< advertising_data_status_t, uint8_t >.

Public Types

enum  type { , INCOMPLETE_MORE_DATA = 0x01, INCOMPLETE_DATA_TRUNCATED = 0x02 }
 

enumeration of advertising_data_status_t values

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

Public Member Functions

 advertising_data_status_t (type value)
 Construct a new advertising_data_status_t value.
 advertising_data_status_t (uint8_t raw_value)
 Explicit constructor from a raw value.
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== (advertising_data_status_tlhs, advertising_data_status_trhs)
 Equal to operator for Target instances.
bool operator!= (advertising_data_status_tlhs, advertising_data_status_trhs)
 Not equal to operator for Target instances.
bool operator< (advertising_data_status_tlhs, advertising_data_status_trhs)
 Less than operator for Target instances.
bool operator<= (advertising_data_status_tlhs, advertising_data_status_trhs)
 Less than or equal to operator for Target instances.
bool operator> (advertising_data_status_tlhs, advertising_data_status_trhs)
 Greater than operator for Target instances.
bool operator>= (advertising_data_status_tlhs, advertising_data_status_trhs)
 Greater than or equal to operator for Target instances.

Detailed Description

Used to indicate if the packet is complete and if it's truncated.

Definition at line 219 of file Types.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

enumeration of advertising_data_status_t values

Enumerator:
INCOMPLETE_MORE_DATA 

Advertising payload complete.

INCOMPLETE_DATA_TRUNCATED 

Partial advertising payload, more to come.

Definition at line 221 of file Types.h.


Constructor & Destructor Documentation

Construct a new advertising_data_status_t value.

Parameters:
valueThe value of the advertising_data_status_t created.

Definition at line 232 of file Types.h.

advertising_data_status_t ( uint8_t  raw_value ) [explicit]

Explicit constructor from a raw value.

Definition at line 241 of file Types.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!= ( advertising_data_status_t  lhs,
advertising_data_status_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< ( advertising_data_status_t  lhs,
advertising_data_status_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<= ( advertising_data_status_t  lhs,
advertising_data_status_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== ( advertising_data_status_t  lhs,
advertising_data_status_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> ( advertising_data_status_t  lhs,
advertising_data_status_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>= ( advertising_data_status_t  lhs,
advertising_data_status_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.