PLCnext API Documentation  20.0.0.24462
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  typedef std::shared_ptr<IAxioMasterService> Ptr;
29 
30 public: // construction/destruction
32  IAxioMasterService(void);
34  virtual ~IAxioMasterService(void);
35 
36 public: // static policy operation
37  static IRscServiceProxyFactory& GetProxyFactory(void);
38 
39 public: // abstract operations
53  virtual uint16 AxioControl(const std::vector<uint16>& inData, std::vector<uint16>& outData) = 0;
54 
64  virtual AxioResult CreateConfiguration(uint16 frameReference) = 0;
65 
78  virtual AxioResult ReadConfiguration(uint16 frameReference, std::vector<AxioDeviceConfiguration>& configuration) = 0;
79 
92  virtual AxioResult WriteConfiguration(uint16 frameReference, const std::vector<AxioDeviceConfiguration>& configuration) = 0;
93 
103  virtual AxioResult ActivateConfiguration(uint16 frameReference) = 0;
104 
114  virtual AxioResult DeactivateConfiguration(uint16 frameReference) = 0;
115 
122  virtual AxioResult ResetMaster() = 0;
123 
124 private: // deleted methods (for non-copyable classes)
125  IAxioMasterService(const IAxioMasterService& arg) = delete;
126  IAxioMasterService& operator=(const IAxioMasterService& arg) = delete;
127 };
128 
130 // inline methods of class IAxioMasterService
132 {
133 }
134 
136 {
137 }
138 
139 inline IRscServiceProxyFactory& IAxioMasterService::GetProxyFactory()
140 {
141  return AxioMasterServiceProxyFactory::GetInstance();
142 }
143 
144 }}}} // end of namespace Arp::Io::Axioline::Services
Contains error information of AXIO service
Definition: AxioResult.hpp:23
virtual ~IAxioMasterService(void)
Destructs this instance and frees all resouces.
Definition: IAxioMasterService.hpp:135
Namespace for classes and interfaces for the Remote Service Call implementation
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
IAxioMasterService(void)
Constructs an IAxioMasterService instance.
Definition: IAxioMasterService.hpp:131