MIP_SDK  v3.0.0
MicroStrain Communications Library for embedded systems
Classes | Namespaces | Typedefs | Functions
mip_field.h File Reference
#include <stdint.h>
#include <stdbool.h>
#include "mip_packet.h"

Go to the source code of this file.

Classes

struct  mip::C::mip_field_view
 A structure representing a MIP field. More...
 

Namespaces

 mip
 A collection of C++ classes and functions covering the full mip api.
 
 mip::C
 

Typedefs

typedef struct mip::C::mip_field_view mip::C::mip_field_view
 A structure representing a MIP field. More...
 

Functions

void mip::C::mip_field_init (mip_field_view *field, uint8_t descriptor_set, uint8_t field_descriptor, const uint8_t *payload, uint8_t payload_length)
 Constructs a field view given the parameters. More...
 
uint8_t mip::C::mip_field_descriptor_set (const mip_field_view *field)
 Returns the descriptor set of the packet containing this field._. More...
 
uint8_t mip::C::mip_field_field_descriptor (const mip_field_view *field)
 Returns the field descriptor. More...
 
uint8_t mip::C::mip_field_payload_length (const mip_field_view *field)
 Returns the length of the payload. More...
 
const uint8_t * mip::C::mip_field_payload (const mip_field_view *field)
 Returns the payload pointer for the field data. More...
 
bool mip::C::mip_field_is_valid (const mip_field_view *field)
 Returns true if the field has a valid field descriptor. More...
 
void mip::C::mip_field_init_empty (mip_field_view *field)
 Initialize a mip_field struct to an invalid/empty state. More...
 
mip_field_view mip::C::mip_field_from_header_ptr (const uint8_t *header, uint8_t total_length, uint8_t descriptor_set)
 Constructs a mip_field from a pointer to the heaader. More...
 
mip_field_view mip::C::mip_field_first_from_packet (const mip_packet_view *packet)
 Extracts the first field from a MIP packet. More...
 
mip_field_view mip::C::mip_field_next_after (const mip_field_view *field)
 Gets the next field after the specified field. More...
 
bool mip::C::mip_field_next (mip_field_view *field)
 Updates the mip_field to refer to the next field in a packet. More...
 
bool mip::C::mip_field_next_in_packet (mip_field_view *field, const mip_packet_view *packet)
 Iterates over all fields in a packet. More...