ChangeStateRequest.h
Go to the documentation of this file.
1
#pragma once
2
3
#include <cstdint>
4
5
#include <
armarx/control/ethercat/EtherCATState.h
>
6
7
#include "
RequestBase.h
"
8
9
namespace
armarx::control::ethercat
10
{
11
/**
12
* @class ChangeStateRequest
13
* @ingroup Library-ethercat
14
* @brief Brief description of class ChangeStateRequest.
15
*
16
* Detailed description of class ChangeStateRequest.
17
*/
18
class
ChangeStateRequest
:
public
virtual
RequestBase
19
{
20
public
:
21
ChangeStateRequest
() =
default
;
22
ChangeStateRequest
(std::uint16_t
slaveIndex
,
23
EtherCATState
state
,
24
bool
validate
,
25
EtherCATState
* actualState);
26
27
std::uint16_t
slaveIndex
= 0;
28
EtherCATState
state
=
EtherCATState::invalid
;
29
bool
validate
=
false
;
30
31
void
setActualState
(
EtherCATState
state
);
32
33
private
:
34
EtherCATState
* actualState =
nullptr
;
35
};
36
37
}
// namespace armarx::control::ethercat
armarx::control::ethercat::ChangeStateRequest
Brief description of class ChangeStateRequest.
Definition:
ChangeStateRequest.h:18
armarx::control::ethercat::ChangeStateRequest::state
EtherCATState state
Definition:
ChangeStateRequest.h:28
armarx::control::ethercat::EtherCATState
This class is a wrapper around an enum containing the different EtherCAT states.
Definition:
EtherCATState.h:25
armarx::control::ethercat::ChangeStateRequest::ChangeStateRequest
ChangeStateRequest()=default
EtherCATState.h
armarx::control::ethercat::ChangeStateRequest::validate
bool validate
Definition:
ChangeStateRequest.h:29
armarx::control::ethercat::EtherCATState::invalid
@ invalid
State is not valid, e.g. if a request for reading the actual bus state failed.
Definition:
EtherCATState.h:34
armarx::control::ethercat::ChangeStateRequest::slaveIndex
std::uint16_t slaveIndex
Definition:
ChangeStateRequest.h:27
armarx::control::ethercat
Definition:
Bus.cpp:24
armarx::control::ethercat::ChangeStateRequest::setActualState
void setActualState(EtherCATState state)
Definition:
ChangeStateRequest.cpp:14
armarx::control::ethercat::RequestBase
Brief description of class RequestBase.
Definition:
RequestBase.h:12
RequestBase.h
armarx
control
ethercat
bus_io
requests
ChangeStateRequest.h
Generated on Sat Oct 12 2024 09:14:14 for armarx_documentation by
1.8.17