RegisterReadRequest.h
Go to the documentation of this file.
1 #pragma once
2 
3 #include <unordered_map>
4 
6 
7 #include "RequestBase.h"
8 
10 {
11  struct EtherCATFrameList;
12 
13  /**
14  * @class RegisterReadRequest
15  * @ingroup Library-ethercat
16  * @brief Brief description of class RegisterReadRequest.
17  *
18  * Detailed description of class RegisterReadRequest.
19  */
20  class RegisterReadRequest : public virtual RequestBase
21  {
22  public:
23  RegisterReadRequest() = default;
24  RegisterReadRequest(std::vector<RegisterDataList>* requestedRegisters);
25  RegisterReadRequest(EtherCATFrameList* preallocatedFrames,
26  std::uint16_t amountFramesToRead = 0);
27 
28  std::vector<RegisterDataList>* requestedRegisters = nullptr;
29 
30  std::pair<EtherCATFrameList*, std::uint16_t> getFrames();
31 
33 
34  private:
35  EtherCATFrameList* frames;
36  std::uint16_t amountFramesToRead;
37  };
38 
39 } // namespace armarx::control::ethercat
armarx::control::ethercat::RegisterReadRequest::requestedRegisters
std::vector< RegisterDataList > * requestedRegisters
Definition: RegisterReadRequest.h:28
armarx::control::ethercat::RegisterReadRequest::updateRequestedRegisters
void updateRequestedRegisters()
Definition: RegisterReadRequest.cpp:52
SlaveRegisters.h
armarx::control::ethercat::RegisterReadRequest::RegisterReadRequest
RegisterReadRequest()=default
armarx::control::ethercat::RegisterReadRequest
Brief description of class RegisterReadRequest.
Definition: RegisterReadRequest.h:20
armarx::control::ethercat::EtherCATFrameList
The EtherCATFrameList struct holds a list of EtherCAT frames that can be scheduled in round-robin-sty...
Definition: EtherCATFrame.h:124
armarx::control::ethercat
Definition: Bus.cpp:24
armarx::control::ethercat::RegisterReadRequest::getFrames
std::pair< EtherCATFrameList *, std::uint16_t > getFrames()
Definition: RegisterReadRequest.cpp:39
armarx::control::ethercat::RequestBase
Brief description of class RequestBase.
Definition: RequestBase.h:12
RequestBase.h