mip_result.hpp

Go to the documentation of this file.

#pragma once
 
#include <mip/mip_result.h>
 
 
namespace mip
{
 
struct CmdResult
{
    static constexpr C::mip_cmd_result STATUS_USER      = C::MIP_STATUS_USER_START;  
    static constexpr C::mip_cmd_result STATUS_ERROR     = C::MIP_STATUS_ERROR;       
    static constexpr C::mip_cmd_result STATUS_CANCELLED = C::MIP_STATUS_CANCELLED;   
    static constexpr C::mip_cmd_result STATUS_TIMEDOUT  = C::MIP_STATUS_TIMEDOUT;    
    static constexpr C::mip_cmd_result STATUS_WAITING   = C::MIP_STATUS_WAITING;     
    static constexpr C::mip_cmd_result STATUS_QUEUED    = C::MIP_STATUS_PENDING;     
    static constexpr C::mip_cmd_result STATUS_NONE      = C::MIP_STATUS_NONE;        
 
    static constexpr C::mip_cmd_result ACK_OK                = C::MIP_ACK_OK;                
    static constexpr C::mip_cmd_result NACK_COMMAND_UNKNOWN  = C::MIP_NACK_COMMAND_UNKNOWN;  
    static constexpr C::mip_cmd_result NACK_INVALID_CHECKSUM = C::MIP_NACK_INVALID_CHECKSUM; 
    static constexpr C::mip_cmd_result NACK_INVALID_PARAM    = C::MIP_NACK_INVALID_PARAM;    
    static constexpr C::mip_cmd_result NACK_COMMAND_FAILED   = C::MIP_NACK_COMMAND_FAILED;   
    static constexpr C::mip_cmd_result NACK_COMMAND_TIMEOUT  = C::MIP_NACK_COMMAND_TIMEOUT;  
 
#ifndef MICROSTRAIN_PLATFORM_WINDOWS // Avoid name conflict with windows.h
    static constexpr C::mip_cmd_result STATUS_PENDING = STATUS_QUEUED;
#endif
 
    C::mip_cmd_result value = C::MIP_STATUS_NONE;
 
    constexpr CmdResult() : value(C::MIP_ACK_OK) {}
    constexpr CmdResult(C::mip_cmd_result result) : value(result) {}
    ~CmdResult() = default;
 
    CmdResult& operator=(const CmdResult& other) = default;
    CmdResult& operator=(C::mip_cmd_result other) { value = other; return *this; }
 
    static constexpr CmdResult userResult(uint8_t n) { return CmdResult(static_cast<C::mip_cmd_result>(STATUS_USER - int8_t(n))); }
    static constexpr CmdResult fromAckNack(uint8_t code) { return CmdResult(static_cast<C::mip_cmd_result>(code)); }
 
    operator const void*() const { return isAck() ? this : nullptr; }
    bool operator!() const { return !isAck(); }
 
    constexpr bool operator==(CmdResult other) const { return value == other.value; }
    constexpr bool operator!=(CmdResult other) const { return value != other.value; }
 
    constexpr bool operator==(C::mip_cmd_result other) const { return value == other; }
    constexpr bool operator!=(C::mip_cmd_result other) const { return value != other; }
 
    const char* name() const { return C::mip_cmd_result_to_string(value); }
 
    bool isReplyCode() const { return C::mip_cmd_result_is_reply(value); }
    bool isStatusCode() const { return C::mip_cmd_result_is_status(value); }
    bool isFinished() const { return C::mip_cmd_result_is_finished(value); }
    bool isAck() const { return C::mip_cmd_result_is_ack(value); }
};
 
} // namespace mip