Kenji Arai / mbed-os_TYBLE16

Dependents:   TYBLE16_simple_data_logger TYBLE16_MP3_Air

Embed: (wiki syntax)

« Back to documentation index

byte_array_t< array_size > Struct Template Reference

byte_array_t< array_size > Struct Template Reference

Model fixed size array values. More...

#include <BLETypes.h>

Public Member Functions

 byte_array_t ()
 Default to all zeroes.
 byte_array_t (const uint8_t *input_value)
 Initialize a data from an array of bytes.
 byte_array_t (const uint8_t *input_value, size_t size)
 Initialize a data from an buffer of bytes.
uint8_t & operator[] (size_t i)
 Subscript operator to access data content.
uint8_t operator[] (size_t i) const
 Subscript operator to access data content.
const uint8_t * data () const
 Return the pointer to the buffer holding data.
uint8_t * data ()
 Return the pointer to the buffer holding data.

Static Public Member Functions

static size_t size ()
 Size in byte of a data.

Static Public Attributes

static const size_t size_ = array_size
 Size of the array; accessible at compile time.

Friends

bool operator== (const byte_array_t &lhs, const byte_array_t &rhs)
 Equal operator between two octet types.
bool operator!= (const byte_array_t &lhs, const byte_array_t &rhs)
 Non equal operator between two octet types.

Detailed Description

template<size_t array_size>
struct ble::byte_array_t< array_size >

Model fixed size array values.

Template Parameters:
array_sizeThe size of the array.

Definition at line 333 of file BLETypes.h.


Constructor & Destructor Documentation

byte_array_t (  )

Default to all zeroes.

Definition at line 342 of file BLETypes.h.

byte_array_t ( const uint8_t *  input_value )

Initialize a data from an array of bytes.

Parameters:
[in]input_valuevalue of the data.

Definition at line 351 of file BLETypes.h.

byte_array_t ( const uint8_t *  input_value,
size_t  size 
)

Initialize a data from an buffer of bytes.

Parameters:
[in]input_valuepointer to buffer.
[in]sizebuffer size

Definition at line 361 of file BLETypes.h.


Member Function Documentation

const uint8_t* data (  ) const

Return the pointer to the buffer holding data.

Definition at line 396 of file BLETypes.h.

uint8_t* data (  )

Return the pointer to the buffer holding data.

Definition at line 403 of file BLETypes.h.

uint8_t operator[] ( size_t  i ) const

Subscript operator to access data content.

Definition at line 389 of file BLETypes.h.

uint8_t& operator[] ( size_t  i )

Subscript operator to access data content.

Definition at line 382 of file BLETypes.h.

static size_t size (  ) [static]

Size in byte of a data.

Definition at line 410 of file BLETypes.h.


Friends And Related Function Documentation

bool operator!= ( const byte_array_t< array_size > &  lhs,
const byte_array_t< array_size > &  rhs 
) [friend]

Non equal operator between two octet types.

Definition at line 375 of file BLETypes.h.

bool operator== ( const byte_array_t< array_size > &  lhs,
const byte_array_t< array_size > &  rhs 
) [friend]

Equal operator between two octet types.

Definition at line 368 of file BLETypes.h.


Field Documentation

const size_t size_ = array_size [static]

Size of the array; accessible at compile time.

Definition at line 337 of file BLETypes.h.