rodbus::WriteResult Struct Reference

Describes to the server if a write operation was successful or not. More...

#include <rodbus.hpp>

Static Public Member Functions
static WriteResult	success_init ()
	Initialize a WriteResult to indicate a successful write operation. More...
static WriteResult	exception_init (ModbusException exception)
	Initialize a WriteResult to indicate a standard Modbus exception. More...
static WriteResult	raw_exception_init (uint8_t raw_exception)
	Initialize a WriteResult to indicate a non-standard Modbus exception. More...

Public Attributes
bool	success
	true if the operation was successful, false otherwise. Error details found in the exception field. More...
ModbusException	exception
	Exception enumeration. If ModbusException::unknown, look at the raw value. More...
uint8_t	raw_exception
	Raw exception value when WriteResult::exception field is ModbusException::unknown More...

Friends
class	CppWriteResultFriend

Detailed Description

Describes to the server if a write operation was successful or not.

May either be 'success' or an exception code returned to the client.

Used in implementations of the WriteHandler.

Member Function Documentation

exception_init()

static WriteResult rodbus::WriteResult::exception_init ( ModbusException  exception )

static

Initialize a WriteResult to indicate a standard Modbus exception.

Note

Values are initialized to:

• WriteResult::success : false
• WriteResult::raw_exception : 0

Parameters

exception

Exception enumeration. If ModbusException::unknown, look at the raw value

Returns

New instance of WriteResult

raw_exception_init()

static WriteResult rodbus::WriteResult::raw_exception_init ( uint8_t  raw_exception )

static

Initialize a WriteResult to indicate a non-standard Modbus exception.

Note

Values are initialized to:

• WriteResult::success : false
• WriteResult::exception : ModbusException::unknown

Parameters

raw_exception

Raw exception value when WriteResult::exception field is ModbusException::unknown

Returns

New instance of WriteResult

success_init()

static WriteResult rodbus::WriteResult::success_init ( )

static

Initialize a WriteResult to indicate a successful write operation.

Note

Values are initialized to:

• WriteResult::success : true
• WriteResult::exception : ModbusException::unknown
• WriteResult::raw_exception : 0

Returns

New instance of WriteResult

Member Data Documentation

exception

ModbusException rodbus::WriteResult::exception

Exception enumeration. If ModbusException::unknown, look at the raw value.

raw_exception

uint8_t rodbus::WriteResult::raw_exception

Raw exception value when WriteResult::exception field is ModbusException::unknown

success

bool rodbus::WriteResult::success

true if the operation was successful, false otherwise. Error details found in the exception field.

---

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

• rodbus.hpp