PLCnext API Documentation  22.0.0.43
IInterbusMasterService.hpp
1 //
3 // Copyright PHOENIX CONTACT Electronics GmbH
4 //
6 #pragma once
7 #include "Arp/System/Core/Arp.h"
8 #include "Arp/System/Rsc/Services/IRscService.hpp"
9 #include "InterbusMasterServiceProxyFactory.hpp"
10 #include "DeviceConfiguration.hpp"
11 #include "InterbusResult.hpp"
12 #include <vector>
13 
14 // DO NOT MODIFY THIS FILE, THIS FILE IS AUTOGENERATED BY IInterbusMasterService.cs
15 
16 namespace Arp { namespace Io { namespace Interbus { namespace Services
17 {
18 
19 using namespace Arp;
20 using namespace Arp::System::Rsc::Services;
21 
26 {
27 public: // typedefs
28  using Ptr = std::shared_ptr<IInterbusMasterService>;
29 
30 public: // construction/destruction
32  IInterbusMasterService(void) = default;
33 
34 public: // static policy operation
35  static IRscServiceProxyFactory& GetProxyFactory(void);
36 
37 public: // abstract operations
51  virtual uint16 InterbusControl(const std::vector<uint16>& inData, std::vector<uint16>& outData) = 0;
52 
62  virtual InterbusResult CreateConfiguration(uint16 frameReference) = 0;
63 
73  virtual InterbusResult ReadConfiguration(std::vector<DeviceConfiguration>& configuration) = 0;
74 
87  virtual InterbusResult WriteConfiguration(uint16 frameReference, const std::vector<DeviceConfiguration>& configuration) = 0;
88 
98  virtual InterbusResult ActivateConfiguration(uint16 frameReference) = 0;
99 
109  virtual InterbusResult DeactivateConfiguration(uint16 frameReference) = 0;
110 
117  virtual InterbusResult StartDataTransfer() = 0;
118 
125  virtual InterbusResult StopDataTransfer() = 0;
126 
133  virtual InterbusResult AlarmStop() = 0;
134 };
135 
137 // inline methods of class IInterbusMasterService
138 inline IRscServiceProxyFactory& IInterbusMasterService::GetProxyFactory()
139 {
140  return InterbusMasterServiceProxyFactory::GetInstance();
141 }
142 
143 }}}} // end of namespace Arp::Io::Interbus::Services
Provides the access to the Interbus master
Definition: IInterbusMasterService.hpp:25
Namespace for classes and interfaces for the Remote Service Call implementation
Definition: IRscReadEnumerator.hxx:9
Contains error information of Interbus service.
Definition: InterbusResult.hpp:23
Root namespace for the PLCnext API
std::uint16_t uint16
The Arp unsigned integer type of 2 byte size.
Definition: PrimitiveTypes.hpp:31
Base interface for all Rsc service interface.
Definition: IRscService.hpp:18