Wrapper class to add semantic to a raw ModbusMsgInStamped. More...
#include <modbus_msg_brake_test_wrapper.h>
Public Member Functions | |
| virtual void | checkStructuralIntegrity () const override |
| Calls ModbusMsgWrapper::checkStructuralIntegrity(). More... | |
| pilz_msgs::IsBrakeTestRequiredResult::_value_type | getBrakeTestRequirementStatus () const |
| Get the brake test required flag from the Modbus message. More... | |
| ModbusMsgBrakeTestWrapper (const ModbusMsgInStampedConstPtr &modbus_msg_raw, const ModbusApiSpec &api_spec) | |
 Public Member Functions inherited from prbt_hardware_support::ModbusMsgWrapper | |
| const ros::Time & | getTimeStamp () const |
| unsigned int | getVersion () const |
| bool | isDisconnect () const |
| Check if the Modbus message informs about a disconnect from the server. More... | |
| ModbusMsgWrapper (const ModbusMsgInStampedConstPtr &modbus_msg_raw, const ModbusApiSpec &api_spec) | |
| Construct a new Modbus Msg Wrapper object. More... | |
| virtual | ~ModbusMsgWrapper ()=default |
Private Member Functions | |
| bool | hasBrakeTestRequiredFlag () const |
| Check if the message contains a brake test required definition. More... | |
Additional Inherited Members | |
| Protected Member Functions inherited from prbt_hardware_support::ModbusMsgWrapper | |
| const ModbusApiSpec & | getApiSpec () const |
| uint16_t | getRegister (uint32_t reg) const |
| bool | hasRegister (uint32_t reg) const |
| Check if a certain holding register is define in the Modbus message. More... | |
| bool | hasVersion () const |
| Check if the modbus_msg contains the API version. More... | |
Detailed Description
Wrapper class to add semantic to a raw ModbusMsgInStamped.
Allows to easy access to the content behind a raw modbus message which is assumed to contain data about brake test.
Definition at line 39 of file modbus_msg_brake_test_wrapper.h.
Constructor & Destructor Documentation
◆ ModbusMsgBrakeTestWrapper()
|
inline |
Definition at line 68 of file modbus_msg_brake_test_wrapper.h.
Member Function Documentation
◆ checkStructuralIntegrity()
|
inlineoverridevirtual |
Calls ModbusMsgWrapper::checkStructuralIntegrity().
- Exceptions
-
ModbusMsgBrakeTestWrapperException if brake test required register is missing.
Reimplemented from prbt_hardware_support::ModbusMsgWrapper.
Definition at line 95 of file modbus_msg_brake_test_wrapper.h.
◆ getBrakeTestRequirementStatus()
|
inline |
Get the brake test required flag from the Modbus message.
- Returns
- true if the a brake test is required, otherwise false.
Definition at line 80 of file modbus_msg_brake_test_wrapper.h.
◆ hasBrakeTestRequiredFlag()
|
inlineprivate |
Check if the message contains a brake test required definition.
- Returns
- true if a brake test required flag is defined, false otherwise.
Definition at line 74 of file modbus_msg_brake_test_wrapper.h.
The documentation for this class was generated from the following file: