PLCnext API Documentation  22.3.0.20
IAxioMasterService.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 "AxioMasterServiceProxyFactory.hpp"
10 #include "AxioDeviceConfiguration.hpp"
11 #include "AxioResult.hpp"
12 #include <vector>
13 
14 // DO NOT MODIFY THIS FILE, THIS FILE IS AUTOGENERATED BY IAxioMasterService.cs
15 
16 namespace Arp { namespace Io { namespace Axioline { 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<IAxioMasterService>;
29 
30 public: // construction/destruction
32  IAxioMasterService(void) = default;
33 
34 public: // static policy operation
35  static IRscServiceProxyFactory& GetProxyFactory(void);
36 
37 public: // abstract operations
51  virtual uint16 AxioControl(const std::vector<uint16>& inData, std::vector<uint16>& outData) = 0;
52 
62  virtual AxioResult CreateConfiguration(uint16 frameReference) = 0;
63 
76  virtual AxioResult ReadConfiguration(uint16 frameReference, std::vector<AxioDeviceConfiguration>& configuration) = 0;
77 
90  virtual AxioResult WriteConfiguration(uint16 frameReference, const std::vector<AxioDeviceConfiguration>& configuration) = 0;
91 
101  virtual AxioResult ActivateConfiguration(uint16 frameReference) = 0;
102 
112  virtual AxioResult DeactivateConfiguration(uint16 frameReference) = 0;
113 
120  virtual AxioResult ResetMaster() = 0;
121 };
122 
124 // inline methods of class IAxioMasterService
125 inline IRscServiceProxyFactory& IAxioMasterService::GetProxyFactory()
126 {
127  return AxioMasterServiceProxyFactory::GetInstance();
128 }
129 
130 }}}} // end of namespace Arp::Io::Axioline::Services
Namespace for classes and interfaces for the Remote Service Call implementation
Definition: IRscReadEnumerator.hxx:9
Provides the access to the AXIO master
Definition: IAxioMasterService.hpp:25
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
Contains error information of AXIO service
Definition: AxioResult.hpp:23