mip_result.h File Reference

#include <stdbool.h>
#include <stdint.h>

Go to the source code of this file.

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

Typedefs
typedef enum mip::C::mip_cmd_result	mip::C::mip_cmd_result
	Represents the status of a MIP command. More...

Enumerations
enum	mip::C::mip_cmd_result {   mip::C::MIP_STATUS_USER_START = -10, mip::C::MIP_STATUS_ERROR = -6, mip::C::MIP_STATUS_CANCELLED = -5, mip::C::MIP_STATUS_TIMEDOUT = -4,   mip::C::MIP_STATUS_WAITING = -3, mip::C::MIP_STATUS_PENDING = -2, mip::C::MIP_STATUS_NONE = -1, mip::C::MIP_ACK_OK = 0x00,   mip::C::MIP_NACK_COMMAND_UNKNOWN = 0x01, mip::C::MIP_NACK_INVALID_CHECKSUM = 0x02, mip::C::MIP_NACK_INVALID_PARAM = 0x03, mip::C::MIP_NACK_COMMAND_FAILED = 0x04,   mip::C::MIP_NACK_COMMAND_TIMEOUT = 0x05 }
	Represents the status of a MIP command. More...

Functions
const char *	mip::C::mip_cmd_result_to_string (enum mip_cmd_result result)
	Converts the command result to a string for debugging. More...
bool	mip::C::mip_cmd_result_is_finished (enum mip_cmd_result status)
	Determines if the command has completed, timed out, been cancelled, or otherwise is no longer waiting for a response. More...
bool	mip::C::mip_cmd_result_is_reply (enum mip_cmd_result result)
	Determines if the result is a reply from the device (i.e. mip_ack). More...
bool	mip::C::mip_cmd_result_is_status (enum mip_cmd_result result)
	Determines if the result code was generated by this lib (i.e. mip_cmd_status). More...
bool	mip::C::mip_cmd_result_is_user (enum mip_cmd_result result)
	Determines if the result code was generated by user software. More...
bool	mip::C::mip_cmd_result_is_ack (enum mip_cmd_result result)
	Determines if the result is an ack (successful response from the device) More...