|
|
using | Deleter = std::function< void(void)> |
| |
|
|
| LoanedStateInterface (const StateInterface &state_interface) |
| |
|
| LoanedStateInterface (const StateInterface &state_interface, Deleter &&deleter) |
| |
|
| LoanedStateInterface (StateInterface::ConstSharedPtr state_interface) |
| |
|
| LoanedStateInterface (StateInterface::ConstSharedPtr state_interface, Deleter &&deleter) |
| |
|
| LoanedStateInterface (const LoanedStateInterface &other)=delete |
| |
|
| LoanedStateInterface (LoanedStateInterface &&other)=default |
| |
|
const std::string & | get_name () const |
| |
|
const std::string & | get_interface_name () const |
| |
|
const std::string | get_full_name () const |
| |
|
const std::string & | get_prefix_name () const |
| |
|
double | get_value () const |
| |
| template<typename T = double> |
| std::optional< T > | get_optional (unsigned int max_tries=10) const |
| | Get the value of the state interface.
|
| |
| template<typename T > |
| bool | get_value (T &value, unsigned int max_tries=10) const |
| | Get the value of the state interface.
|
| |
◆ get_optional()
template<typename T = double>
| std::optional< T > hardware_interface::LoanedStateInterface::get_optional |
( |
unsigned int |
max_tries = 10 | ) |
const |
|
inline |
Get the value of the state interface.
- Template Parameters
-
| T | The type of the value to be retrieved. |
- Returns
- The value of the state interface if it accessed successfully, std::nullopt otherwise.
- Parameters
-
| max_tries | The maximum number of tries to get the value. |
- Note
- The method is thread-safe and non-blocking.
-
When different threads access the internal handle at same instance, and if they are unable to lock the handle to access the value, the handle returns std::nullopt. If the operation is successful, the value is returned.
-
The method will try to get the value max_tries times before returning std::nullopt. The method will yield the thread between tries. If the value is retrieved successfully, the method returns the value immediately.
◆ get_value()
template<typename T >
| bool hardware_interface::LoanedStateInterface::get_value |
( |
T & |
value, |
|
|
unsigned int |
max_tries = 10 |
|
) |
| const |
|
inline |
Get the value of the state interface.
- Template Parameters
-
| T | The type of the value to be retrieved. |
- Parameters
-
| value | The value of the state interface. |
| max_tries | The maximum number of tries to get the value. |
- Returns
- true if the value is accessed successfully, false otherwise.
- Note
- The method is thread-safe and non-blocking.
-
When different threads access the same handle at same instance, and if they are unable to lock the handle to access the value, the handle returns false. If the operation is successful, the value is updated and returns true.
-
The method will try to get the value max_tries times before returning false. The method will yield the thread between tries. If the value is retrieved successfully, the method updates the value and returns true immediately.
The documentation for this class was generated from the following file:
1.9.8
