Kenji Arai / mbed-os_TYBLE16

Important changes to repositories hosted on mbed.com

Mbed hosted mercurial repositories are deprecated and are due to be permanently deleted in July 2026.

To keep a copy of this software download the repository Zip archive or clone locally using Mercurial.

It is also possible to export all your personal repositories from the account settings page.

Dependents:   TYBLE16_simple_data_logger TYBLE16_MP3_Air

Embed: (wiki syntax)

« Back to documentation index

clock_accuracy_t Struct Reference
Public Types | Public Member Functions | Friends

clock_accuracy_t Struct Reference
[Gap]

Accuracy of the master clock. More...

#include <Types.h>

Inherits SafeEnum< clock_accuracy_t, uint8_t >.

Public Types

enum  type {
  PPM_500 = 0x00, PPM_250 = 0x01, PPM_150 = 0x02, PPM_100 = 0x03,
  PPM_75 = 0x04, PPM_50 = 0x05, PPM_30 = 0x06, PPM_20 = 0x07
}
 

enumeration of clock_accuracy_t values.

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

Public Member Functions

uint16_t get_ppm ()
 Get clock accuracy.
 clock_accuracy_t (type value)
 Construct a new clock_accuracy_t value.
 clock_accuracy_t (uint8_t raw_value)
 Construct a new clock_accuracy_t value 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== (clock_accuracy_tlhs, clock_accuracy_trhs)
 Equal to operator for Target instances.
bool operator!= (clock_accuracy_tlhs, clock_accuracy_trhs)
 Not equal to operator for Target instances.
bool operator< (clock_accuracy_tlhs, clock_accuracy_trhs)
 Less than operator for Target instances.
bool operator<= (clock_accuracy_tlhs, clock_accuracy_trhs)
 Less than or equal to operator for Target instances.
bool operator> (clock_accuracy_tlhs, clock_accuracy_trhs)
 Greater than operator for Target instances.
bool operator>= (clock_accuracy_tlhs, clock_accuracy_trhs)
 Greater than or equal to operator for Target instances.

Detailed Description

Accuracy of the master clock.

Definition at line 607 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 clock_accuracy_t values.

Enumerator:
PPM_500 

500 PPM

PPM_250 

250 PPM

PPM_150 

150 PPM

PPM_100 

100 PPM

PPM_75 

75 PPM

PPM_50 

50 PPM

PPM_30 

30 PPM

PPM_20 

20 PPM

Definition at line 609 of file Types.h.

Constructor & Destructor Documentation

clock_accuracy_t ( type  value )

Construct a new clock_accuracy_t value.

Parameters:
valueThe value of the clock_accuracy_t created.

Definition at line 683 of file Types.h.

clock_accuracy_t ( uint8_t  raw_value ) [explicit]

Construct a new clock_accuracy_t value from a raw value.

Parameters:
raw_valueThe value of the clock accuracy.

Definition at line 693 of file Types.h.

Member Function Documentation

uint16_t get_ppm (  )

Get clock accuracy.

Returns:
Parts per million as a number.

Definition at line 655 of file Types.h.

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!= ( clock_accuracy_t  lhs,
clock_accuracy_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< ( clock_accuracy_t  lhs,
clock_accuracy_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<= ( clock_accuracy_t  lhs,
clock_accuracy_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== ( clock_accuracy_t  lhs,
clock_accuracy_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> ( clock_accuracy_t  lhs,
clock_accuracy_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>= ( clock_accuracy_t  lhs,
clock_accuracy_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.

Generated on Tue Jul 12 2022 13:55:40 by  doxygen 1.7.2