PLCnext API Documentation  20.6.0.30321
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  typedef std::shared_ptr<IInterbusMasterService> Ptr;
29 
30 public: // construction/destruction
34  virtual ~IInterbusMasterService(void);
35 
36 public: // static policy operation
37  static IRscServiceProxyFactory& GetProxyFactory(void);
38 
39 public: // abstract operations
53  virtual uint16 InterbusControl(const std::vector<uint16>& inData, std::vector<uint16>& outData) = 0;
54 
64  virtual InterbusResult CreateConfiguration(uint16 frameReference) = 0;
65 
75  virtual InterbusResult ReadConfiguration(std::vector<DeviceConfiguration>& configuration) = 0;
76 
89  virtual InterbusResult WriteConfiguration(uint16 frameReference, const std::vector<DeviceConfiguration>& configuration) = 0;
90 
100  virtual InterbusResult ActivateConfiguration(uint16 frameReference) = 0;
101 
111  virtual InterbusResult DeactivateConfiguration(uint16 frameReference) = 0;
112 
119  virtual InterbusResult StartDataTransfer() = 0;
120 
127  virtual InterbusResult StopDataTransfer() = 0;
128 
135  virtual InterbusResult AlarmStop() = 0;
136 
137 private: // deleted methods (for non-copyable classes)
138  IInterbusMasterService(const IInterbusMasterService& arg) = delete;
139  IInterbusMasterService& operator=(const IInterbusMasterService& arg) = delete;
140 };
141 
143 // inline methods of class IInterbusMasterService
145 {
146 }
147 
149 {
150 }
151 
152 inline IRscServiceProxyFactory& IInterbusMasterService::GetProxyFactory()
153 {
154  return InterbusMasterServiceProxyFactory::GetInstance();
155 }
156 
157 }}}} // end of namespace Arp::Io::Interbus::Services
Contains error information of Interbus service.
Definition: InterbusResult.hpp:23
Provides the access to the Interbus master
Definition: IInterbusMasterService.hpp:25
virtual ~IInterbusMasterService(void)
Destructs this instance and frees all resouces.
Definition: IInterbusMasterService.hpp:148
Namespace for classes and interfaces for the Remote Service Call implementation
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
IInterbusMasterService(void)
Constructs an IInterbusMasterService instance.
Definition: IInterbusMasterService.hpp:144