Class holding a tool communication configuration. More...
#include <tool_communication.h>
Public Types | |
using | RxIdleCharsT = Limited< float > |
using | StopBitsT = Limited< uint32_t > |
using | TxIdleCharsT = Limited< float > |
Public Member Functions | |
uint32_t | getBaudRate () const |
Return the baud rate currently stored. More... | |
Parity | getParity () const |
Return the parity currently stored. More... | |
RxIdleCharsT::Datatype | getRxIdleChars () const |
Return the number of rx idle chars currently stored. More... | |
StopBitsT::Datatype | getStopBits () const |
Return the number of stop bits currently stored. More... | |
ToolVoltage | getToolVoltage () const |
Return the tool voltage currently stored. More... | |
TxIdleCharsT::Datatype | getTxIdleChars () const |
Return the number of tx idle chars currently stored. More... | |
void | setBaudRate (const uint32_t baud_rate) |
Setup the tool communication baud rate that will be configured on the robot. This will not immediately change values on the robot, it will only be stored inside the ToolCommSetup object. More... | |
void | setParity (const Parity parity) |
Setup the tool communication parity that will be configured on the robot. This will not immediately change values on the robot, it will only be stored inside the ToolCommSetup object. More... | |
void | setRxIdleChars (const RxIdleCharsT::Datatype rx_idle_chars) |
Setup the tool communication number of idle chars for the rx channel that will be configured on the robot. This will not immediately change values on the robot, it will only be stored inside the ToolCommSetup object. More... | |
void | setStopBits (const StopBitsT::Datatype stop_bits) |
Setup the tool communication number of stop bits that will be configured on the robot. This will not immediately change values on the robot, it will only be stored inside the ToolCommSetup object. More... | |
void | setToolVoltage (const ToolVoltage tool_voltage) |
Setup the tool voltage that will be configured on the robot. This will not immediately change values on the robot, it will only be stored inside the ToolCommSetup object. More... | |
void | setTxIdleChars (const TxIdleCharsT::Datatype tx_idle_chars) |
Setup the tool communication number of idle chars for the tx channel that will be configured on the robot. This will not immediately change values on the robot, it will only be stored inside the ToolCommSetup object. More... | |
ToolCommSetup () | |
~ToolCommSetup ()=default | |
Private Attributes | |
uint32_t | baud_rate_ |
const std::set< uint32_t > | baud_rates_allowed_ |
Parity | parity_ |
RxIdleCharsT | rx_idle_chars_ |
StopBitsT | stop_bits_ |
ToolVoltage | tool_voltage_ |
TxIdleCharsT | tx_idle_chars_ |
Class holding a tool communication configuration.
Definition at line 118 of file tool_communication.h.
using urcl::ToolCommSetup::RxIdleCharsT = Limited<float> |
Definition at line 125 of file tool_communication.h.
using urcl::ToolCommSetup::StopBitsT = Limited<uint32_t> |
Definition at line 124 of file tool_communication.h.
using urcl::ToolCommSetup::TxIdleCharsT = Limited<float> |
Definition at line 126 of file tool_communication.h.
urcl::ToolCommSetup::ToolCommSetup | ( | ) |
Definition at line 32 of file tool_communication.cpp.
|
default |
|
inline |
Return the baud rate currently stored.
Definition at line 171 of file tool_communication.h.
|
inline |
Return the parity currently stored.
Definition at line 156 of file tool_communication.h.
|
inline |
Return the number of rx idle chars currently stored.
Definition at line 207 of file tool_communication.h.
|
inline |
Return the number of stop bits currently stored.
Definition at line 189 of file tool_communication.h.
|
inline |
Return the tool voltage currently stored.
Definition at line 140 of file tool_communication.h.
|
inline |
Return the number of tx idle chars currently stored.
Definition at line 225 of file tool_communication.h.
void urcl::ToolCommSetup::setBaudRate | ( | const uint32_t | baud_rate | ) |
Setup the tool communication baud rate that will be configured on the robot. This will not immediately change values on the robot, it will only be stored inside the ToolCommSetup object.
baud_rate | must be one of baud_rates_allowed_ or an exception will be thrown |
Definition at line 42 of file tool_communication.cpp.
|
inline |
Setup the tool communication parity that will be configured on the robot. This will not immediately change values on the robot, it will only be stored inside the ToolCommSetup object.
Definition at line 149 of file tool_communication.h.
|
inline |
Setup the tool communication number of idle chars for the rx channel that will be configured on the robot. This will not immediately change values on the robot, it will only be stored inside the ToolCommSetup object.
rx_idle_chars | must be inside [1.0, 40] or this will throw an exception. |
Definition at line 200 of file tool_communication.h.
|
inline |
Setup the tool communication number of stop bits that will be configured on the robot. This will not immediately change values on the robot, it will only be stored inside the ToolCommSetup object.
stop_bits | must be inside [1,2] or this will throw an exception. |
Definition at line 182 of file tool_communication.h.
|
inline |
Setup the tool voltage that will be configured on the robot. This will not immediately change values on the robot, it will only be stored inside the ToolCommSetup object.
Definition at line 132 of file tool_communication.h.
|
inline |
Setup the tool communication number of idle chars for the tx channel that will be configured on the robot. This will not immediately change values on the robot, it will only be stored inside the ToolCommSetup object.
tx_idle_chars | must be inside [0.0, 40] or this will throw an exception. |
Definition at line 218 of file tool_communication.h.
|
private |
Definition at line 242 of file tool_communication.h.
|
private |
Definition at line 231 of file tool_communication.h.
|
private |
Definition at line 241 of file tool_communication.h.
|
private |
Definition at line 244 of file tool_communication.h.
|
private |
Definition at line 243 of file tool_communication.h.
|
private |
Definition at line 240 of file tool_communication.h.
|
private |
Definition at line 245 of file tool_communication.h.