PLCnext API Documentation  22.9.0.33
IAxioMasterService.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/Axioline/Services/AxioDeviceConfiguration.hpp"
10 #include "Arp/Io/Axioline/Services/AxioMasterServiceProxyFactory.hpp"
11 #include "Arp/Io/Axioline/Services/AxioResult.hpp"
12 #include "Arp/System/Rsc/Services/IRscService.hpp"
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 
27 {
28 public: // typedefs
29  using Ptr = std::shared_ptr<IAxioMasterService>;
30 
31 public: // construction/destruction
33  IAxioMasterService(void) = default;
34 
35 public: // static policy operation
36  static IRscServiceProxyFactory& GetProxyFactory(void);
37 
38 public: // abstract operations
52  virtual uint16 AxioControl(const std::vector<uint16>& inData, std::vector<uint16>& outData) = 0;
53 
63  virtual AxioResult CreateConfiguration(uint16 frameReference) = 0;
64 
77  virtual AxioResult ReadConfiguration(uint16 frameReference, std::vector<AxioDeviceConfiguration>& configuration) = 0;
78 
91  virtual AxioResult WriteConfiguration(uint16 frameReference, const std::vector<AxioDeviceConfiguration>& configuration) = 0;
92 
102  virtual AxioResult ActivateConfiguration(uint16 frameReference) = 0;
103 
113  virtual AxioResult DeactivateConfiguration(uint16 frameReference) = 0;
114 
121  virtual AxioResult ResetMaster() = 0;
122 };
123 
125 // inline methods of class IAxioMasterService
126 inline IRscServiceProxyFactory& IAxioMasterService::GetProxyFactory()
127 {
128  return AxioMasterServiceProxyFactory::GetInstance();
129 }
130 
131 }}}} // end of namespace Arp::Io::Axioline::Services
Contains error information of AXIO service
Definition: AxioResult.hpp:24
Provides the access to the AXIO master
Definition: IAxioMasterService.hpp:27
IAxioMasterService(void)=default
Constructs an IAxioMasterService instance.
virtual AxioResult DeactivateConfiguration(uint16 frameReference)=0
Deactivate configuration
virtual AxioResult CreateConfiguration(uint16 frameReference)=0
Automatic creation of a new configuration
virtual AxioResult ReadConfiguration(uint16 frameReference, std::vector< AxioDeviceConfiguration > &configuration)=0
Read current configuration
virtual AxioResult ActivateConfiguration(uint16 frameReference)=0
Activate configuration
virtual uint16 AxioControl(const std::vector< uint16 > &inData, std::vector< uint16 > &outData)=0
Raw AXIO service to communicate with the AXIO master.
virtual AxioResult ResetMaster()=0
Reset AXIO master
virtual AxioResult WriteConfiguration(uint16 frameReference, const std::vector< AxioDeviceConfiguration > &configuration)=0
Write configuration
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