MIP SDK  0.0.1
MicroStrain Communications Library for embedded systems
Functions
Field Iteration [C]

Functions for iterating over fields in a MIP packet. More...

Collaboration diagram for Field Iteration [C]:

Functions

void mip::C::mip_field_init_empty (mip_field *field)
 
mip_field mip::C::mip_field_from_header_ptr (const uint8_t *header, uint8_t total_length, uint8_t descriptor_set)
 
mip_field mip::C::mip_field_first_from_packet (const mip_packet *packet)
 
mip_field mip::C::mip_field_next_after (const mip_field *field)
 
bool mip::C::mip_field_next (mip_field *field)
 
bool mip::C::mip_field_next_in_packet (mip_field *field, const mip_packet *packet)
 

Detailed Description

Functions for iterating over fields in a MIP packet.

Use these functions to iterate over the fields in a MIP packet.

Example:

// Iterate over fields, starting with the first in the packet.
// Continue as long as a valid field is found.
for(mip_field field = mip_field_from_packet(packet); mip_field_is_valid(&field); mip_field_next(&field))
{
// Check the field descriptor for what kind of data it holds.
switch( mip_field_field_desriptor(&field) )
{
case MIP_DATA_DESC_SENSOR_SCALED_ACCEL:
break;
}
}
bool mip_field_is_valid(const mip_field *field)
bool mip_field_next(mip_field *field)
struct mip::C::mip_field mip_field
A structure representing a MIP field.

Function Documentation

◆ mip_field_first_from_packet()

mip_field mip::C::mip_field_first_from_packet ( const mip_packet packet)

◆ mip_field_from_header_ptr()

mip_field mip::C::mip_field_from_header_ptr ( const uint8_t *  header,
uint8_t  total_length,
uint8_t  descriptor_set 
)

◆ mip_field_init_empty()

void mip::C::mip_field_init_empty ( mip_field field)

◆ mip_field_next()

bool mip::C::mip_field_next ( mip_field field)

◆ mip_field_next_after()

mip_field mip::C::mip_field_next_after ( const mip_field field)

◆ mip_field_next_in_packet()

bool mip::C::mip_field_next_in_packet ( mip_field field,
const mip_packet packet 
)