mcprotocol::serial::Status Struct Reference

Result object returned by most public APIs. More...

#include <status.hpp>

Public Member Functions
constexpr bool	ok () const noexcept

Public Attributes
StatusCode	code = StatusCode::Ok
std::uint16_t	plc_error_code = 0
const char *	message = "ok"

Detailed Description

Result object returned by most public APIs.

plc_error_code is meaningful when code == StatusCode::PlcError.

Definition at line 26 of file status.hpp.

Member Function Documentation

ok()

constexpr bool mcprotocol::serial::Status::ok ( ) const

inlineconstexprnoexcept

Definition at line 31 of file status.hpp.

Member Data Documentation

code

StatusCode mcprotocol::serial::Status::code = StatusCode::Ok

Definition at line 27 of file status.hpp.

message

const char* mcprotocol::serial::Status::message = "ok"

Definition at line 29 of file status.hpp.

plc_error_code

std::uint16_t mcprotocol::serial::Status::plc_error_code = 0

Definition at line 28 of file status.hpp.

---

The documentation for this struct was generated from the following file:

• include/mcprotocol/serial/status.hpp