Request message for register functions. More...

#include <uuid/modbus.h>

Inheritance diagram for uuid::modbus::RegisterRequest:

Collaboration diagram for uuid::modbus::RegisterRequest:

[legend]

Public Member Functions
	RegisterRequest (uint16_t device, uint8_t function_code, uint16_t timeout_ms, uint16_t address, uint16_t data, const std::shared_ptr< Response > &response)
	Create a new register request message (not directly useful). More...

uint16_t	encode (frame_buffer_t &frame) override
	Encode this request and store it in a message frame buffer. More...

uint16_t	address () const
	Get the register address. More...

uint16_t	data () const
	Get the register size or value. More...

Public Member Functions inherited from uuid::modbus::Request
	Request (uint16_t device, uint8_t function_code, uint16_t timeout_ms, const std::shared_ptr< Response > &response)
	Create a new request message (not directly useful). More...

uint16_t	device () const
	Get the destination device address. More...

uint8_t	function_code () const
	Get the function code of the request. More...

uint16_t	timeout_ms () const
	Get the timeout to wait for a response in milliseconds. More...

Response &	response () const
	Get the response object. More...

Private Attributes
const uint16_t	address_

const uint16_t	data_

Detailed Description

Request message for register functions.

This will be created when a request is submitted and then discarded when the response is updated with the outcome.

Since: 0.1.0

Definition at line 422 of file modbus.h.

Constructor & Destructor Documentation

◆ RegisterRequest()

uuid::modbus::RegisterRequest::RegisterRequest	(	uint16_t	device,
		uint8_t	function_code,
		uint16_t	timeout_ms,
		uint16_t	address,
		uint16_t	data,
		const std::shared_ptr< Response > &	response
	)

Create a new register request message (not directly useful).

Parameters

[in]	device	Destination device address.
[in]	function_code	Function code of the request.
[in]	timeout_ms	Timeout to wait for a response in milliseconds.
[in]	address	Register address.
[in]	data	Number of registers to read or register value to write.
[in]	response	Response object.

Since: 0.1.0

Definition at line 99 of file register_functions.cpp.

Member Function Documentation

◆ address()

uint16_t uuid::modbus::RegisterRequest::address ( ) const

inline

Get the register address.

Returns: Register address.

Since: 0.1.0

Definition at line 454 of file modbus.h.

◆ data()

uint16_t uuid::modbus::RegisterRequest::data ( ) const

inline

Get the register size or value.

Returns: Register size or value.

Since: 0.1.0

Definition at line 462 of file modbus.h.

◆ encode()

uint16_t uuid::modbus::RegisterRequest::encode ( frame_buffer_t & frame )

overridevirtual

Encode this request and store it in a message frame buffer.

Parameters

[out] frame Message frame data.

Returns: Size of message frame.

Since: 0.1.0

Reimplemented from uuid::modbus::Request.

Definition at line 106 of file register_functions.cpp.

Member Data Documentation

◆ address_

const uint16_t uuid::modbus::RegisterRequest::address_

private

Register address.

Since: 0.1.0

Definition at line 462 of file modbus.h.

◆ data_

const uint16_t uuid::modbus::RegisterRequest::data_

private

Register size or value.

Since: 0.1.0

Definition at line 466 of file modbus.h.

The documentation for this class was generated from the following files:

mcu-uuid-modbus/src/uuid/modbus.h
mcu-uuid-modbus/src/register_functions.cpp

Public Member Functions

Private Attributes