Listens to the modbus_read topic and publishes a message informing about a required brake test. More...

#include <modbus_adapter_brake_test.h>

Public Member Functions
bool	isBrakeTestRequired (IsBrakeTestRequired::Request &, IsBrakeTestRequired::Response &res)
	Stores the brake test required flag and initializes the brake test service, the first time the function is called. More...

	ModbusAdapterBrakeTest (TWriteModbusRegister &&write_modbus_register_func, const ModbusApiSpec &read_api_spec, const ModbusApiSpec &write_api_spec)

void	modbusMsgCallback (const ModbusMsgInStampedConstPtr &msg_raw)
	Called whenever a new modbus message arrives. More...

bool	sendBrakeTestResult (SendBrakeTestResult::Request &req, SendBrakeTestResult::Response &res)
	Sends the brake test result data to the modbus client. More...

Private Types
using	TBrakeTestRequired = IsBrakeTestRequiredResponse::_result_type

using	TRegIdx = uint16_t

using	TRegIdxCont = std::map< std::string, TRegIdx >

Private Member Functions
void	updateBrakeTestRequiredState (TBrakeTestRequired brake_test_required)

Static Private Member Functions
static const TRegIdxCont::mapped_type &	getMaxRegisterIdx (const TRegIdxCont &reg_idx_cont)

static const TRegIdxCont::mapped_type &	getMinRegisterIdx (const TRegIdxCont &reg_idx_cont)

static unsigned long	getRegisterBlockSize (const TRegIdxCont &reg_idx_cont)

static TRegIdxCont	getRegisters (const ModbusApiSpec &write_api_spec)

Private Attributes
const ModbusApiSpec	api_spec_

TBrakeTestRequired	brake_test_required_ {IsBrakeTestRequiredResponse::UNKNOWN}
	Store the current state of whether a brake test is required. More...

const RegCont::size_type	reg_block_size_ {getRegisterBlockSize(reg_idx_cont_)}

const TRegIdxCont	reg_idx_cont_

const TRegIdx	reg_start_idx_ {getMinRegisterIdx(reg_idx_cont_)}

TWriteModbusRegister	write_modbus_register_func_

Detailed Description

Listens to the modbus_read topic and publishes a message informing about a required brake test.

Definition at line 43 of file modbus_adapter_brake_test.h.

Member Typedef Documentation

using prbt_hardware_support::ModbusAdapterBrakeTest::TBrakeTestRequired = IsBrakeTestRequiredResponse::_result_type

private

Definition at line 74 of file modbus_adapter_brake_test.h.

using prbt_hardware_support::ModbusAdapterBrakeTest::TRegIdx = uint16_t

private

Definition at line 78 of file modbus_adapter_brake_test.h.

using prbt_hardware_support::ModbusAdapterBrakeTest::TRegIdxCont = std::map<std::string, TRegIdx>

private

Definition at line 79 of file modbus_adapter_brake_test.h.

Constructor & Destructor Documentation

prbt_hardware_support::ModbusAdapterBrakeTest::ModbusAdapterBrakeTest	(	TWriteModbusRegister &&	write_modbus_register_func,
		const ModbusApiSpec &	read_api_spec,
		const ModbusApiSpec &	write_api_spec
	)

Definition at line 31 of file modbus_adapter_brake_test.cpp.

Member Function Documentation

const ModbusAdapterBrakeTest::TRegIdxCont::mapped_type & prbt_hardware_support::ModbusAdapterBrakeTest::getMaxRegisterIdx ( const TRegIdxCont & reg_idx_cont )

inlinestaticprivate

Returns: the highest register index stored in the specified container.

Definition at line 131 of file modbus_adapter_brake_test.h.

const ModbusAdapterBrakeTest::TRegIdxCont::mapped_type & prbt_hardware_support::ModbusAdapterBrakeTest::getMinRegisterIdx ( const TRegIdxCont & reg_idx_cont )

inlinestaticprivate

Returns: the lowest register index stored in the specified container.

Definition at line 123 of file modbus_adapter_brake_test.h.

unsigned long prbt_hardware_support::ModbusAdapterBrakeTest::getRegisterBlockSize ( const TRegIdxCont & reg_idx_cont )

inlinestaticprivate

Returns: the number of registers specified by the given register index container.

Definition at line 140 of file modbus_adapter_brake_test.h.

ModbusAdapterBrakeTest::TRegIdxCont prbt_hardware_support::ModbusAdapterBrakeTest::getRegisters ( const ModbusApiSpec & write_api_spec )

staticprivate

Returns: the indicies of the modbus registers, needed to write the brake test results back to the modbus.

Definition at line 43 of file modbus_adapter_brake_test.cpp.

bool prbt_hardware_support::ModbusAdapterBrakeTest::isBrakeTestRequired	(	IsBrakeTestRequired::Request &	,
		IsBrakeTestRequired::Response &	res
	)

inline

Stores the brake test required flag and initializes the brake test service, the first time the function is called.

Definition at line 113 of file modbus_adapter_brake_test.h.

void prbt_hardware_support::ModbusAdapterBrakeTest::modbusMsgCallback ( const ModbusMsgInStampedConstPtr & msg_raw )

Called whenever a new modbus message arrives.

Note: Filters like for example the UpdateFilter can restrict the number of incoming messages.

Definition at line 73 of file modbus_adapter_brake_test.cpp.

bool prbt_hardware_support::ModbusAdapterBrakeTest::sendBrakeTestResult	(	SendBrakeTestResult::Request &	req,
		SendBrakeTestResult::Response &	res
	)

Sends the brake test result data to the modbus client.

Definition at line 118 of file modbus_adapter_brake_test.cpp.

void prbt_hardware_support::ModbusAdapterBrakeTest::updateBrakeTestRequiredState ( TBrakeTestRequired brake_test_required )

private

Definition at line 107 of file modbus_adapter_brake_test.cpp.

Member Data Documentation

const ModbusApiSpec prbt_hardware_support::ModbusAdapterBrakeTest::api_spec_

private

Definition at line 96 of file modbus_adapter_brake_test.h.

TBrakeTestRequired prbt_hardware_support::ModbusAdapterBrakeTest::brake_test_required_ {IsBrakeTestRequiredResponse::UNKNOWN}

private

Store the current state of whether a brake test is required.

Definition at line 99 of file modbus_adapter_brake_test.h.

const RegCont::size_type prbt_hardware_support::ModbusAdapterBrakeTest::reg_block_size_ {getRegisterBlockSize(reg_idx_cont_)}

private

Definition at line 106 of file modbus_adapter_brake_test.h.

const TRegIdxCont prbt_hardware_support::ModbusAdapterBrakeTest::reg_idx_cont_

private

Contains the indicies of the modbus registers, needed to write the brake test results back to the modbus.

Definition at line 103 of file modbus_adapter_brake_test.h.

const TRegIdx prbt_hardware_support::ModbusAdapterBrakeTest::reg_start_idx_ {getMinRegisterIdx(reg_idx_cont_)}

private

Definition at line 105 of file modbus_adapter_brake_test.h.

TWriteModbusRegister prbt_hardware_support::ModbusAdapterBrakeTest::write_modbus_register_func_

private

Definition at line 108 of file modbus_adapter_brake_test.h.

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

Public Member Functions

Private Types

Private Member Functions

Static Private Member Functions

Private Attributes

Detailed Description

Member Typedef Documentation

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation