PLCnext API Documentation  22.9.0.33
IInterbusMasterService.hpp
1 //
3 // Copyright PHOENIX CONTACT Electronics GmbH
4 //
6 #pragma once
7 #include "Arp/System/Core/Arp.h"
8 #include <vector>
9 #include "Arp/Io/Interbus/Services/DeviceConfiguration.hpp"
10 #include "Arp/Io/Interbus/Services/InterbusMasterServiceProxyFactory.hpp"
11 #include "Arp/Io/Interbus/Services/InterbusResult.hpp"
12 #include "Arp/System/Rsc/Services/IRscService.hpp"
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 
27 {
28 public: // typedefs
29  using Ptr = std::shared_ptr<IInterbusMasterService>;
30 
31 public: // construction/destruction
33  IInterbusMasterService(void) = default;
34 
35 public: // static policy operation
36  static IRscServiceProxyFactory& GetProxyFactory(void);
37 
38 public: // abstract operations
52  virtual uint16 InterbusControl(const std::vector<uint16>& inData, std::vector<uint16>& outData) = 0;
53 
63  virtual InterbusResult CreateConfiguration(uint16 frameReference) = 0;
64 
74  virtual InterbusResult ReadConfiguration(std::vector<DeviceConfiguration>& configuration) = 0;
75 
88  virtual InterbusResult WriteConfiguration(uint16 frameReference, const std::vector<DeviceConfiguration>& configuration) = 0;
89 
99  virtual InterbusResult ActivateConfiguration(uint16 frameReference) = 0;
100 
110  virtual InterbusResult DeactivateConfiguration(uint16 frameReference) = 0;
111 
119 
127 
134  virtual InterbusResult AlarmStop() = 0;
135 };
136 
138 // inline methods of class IInterbusMasterService
139 inline IRscServiceProxyFactory& IInterbusMasterService::GetProxyFactory()
140 {
141  return InterbusMasterServiceProxyFactory::GetInstance();
142 }
143 
144 }}}} // end of namespace Arp::Io::Interbus::Services
Provides the access to the Interbus master
Definition: IInterbusMasterService.hpp:27
virtual InterbusResult CreateConfiguration(uint16 frameReference)=0
Automatic creation of a new configuration
virtual InterbusResult StartDataTransfer()=0
Start cyclic data transfer
IInterbusMasterService(void)=default
Constructs an IInterbusMasterService instance.
virtual uint16 InterbusControl(const std::vector< uint16 > &inData, std::vector< uint16 > &outData)=0
Raw Interbus service to communicate with the AXIO master.
virtual InterbusResult DeactivateConfiguration(uint16 frameReference)=0
Deactivate configuration
virtual InterbusResult WriteConfiguration(uint16 frameReference, const std::vector< DeviceConfiguration > &configuration)=0
Write configuration
virtual InterbusResult ReadConfiguration(std::vector< DeviceConfiguration > &configuration)=0
Read current configuration
virtual InterbusResult AlarmStop()=0
Trigger a long reset
virtual InterbusResult StopDataTransfer()=0
Stop cyclic data transfer
virtual InterbusResult ActivateConfiguration(uint16 frameReference)=0
Activate configuration
Contains error information of Interbus service.
Definition: InterbusResult.hpp:24
Base interface for all Rsc service interface.
Definition: IRscService.hpp:19
std::uint16_t uint16
The Arp unsigned integer type of 2 byte size.
Definition: PrimitiveTypes.hpp:31
Namespace for classes and interfaces for the Remote Service Call implementation
Definition: IRscReadEnumerator.hxx:10
Root namespace for the PLCnext API