PLCnext API Documentation 25.0.2.69
Public Types | Public Member Functions | Static Public Member Functions | List of all members
Arp::Io::Profibus::Services::IAcyclicCommunicationService Class Referenceabstract

Use this service for acyclic communication with Profibus slaves More...

#include <IAcyclicCommunicationService.hpp>

Inheritance diagram for Arp::Io::Profibus::Services::IAcyclicCommunicationService:
Inheritance graph

Public Types

using Ptr = std::shared_ptr< IAcyclicCommunicationService >
 
- Public Types inherited from Arp::Base::Rsc::Commons::IRscService
using Ptr = std::shared_ptr< IRscService >
 The shared_ptr type of IRscService.
 

Public Member Functions

 IAcyclicCommunicationService (void)=default
 Constructs an IAcyclicCommunicationService instance.
 
virtual RecordResult ReadRecord (const RecordParameters &parameters, std::vector< byte > &data)=0
 Reads object from Profibus module More...
 
virtual RecordResult WriteRecord (const RecordParameters &parameters, const std::vector< byte > &data)=0
 Writes object to Profibus module More...
 
- Public Member Functions inherited from Arp::Base::Rsc::Commons::IRscService
 IRscService (void)=default
 The default constructor.
 
 IRscService (const IRscService &arg)=delete
 The deleted copy constructor. More...
 
 IRscService (IRscService &&arg) noexcept=default
 The default move constructor. More...
 
IRscServiceoperator= (const IRscService &arg)=delete
 The deleted assignment operator. More...
 
IRscServiceoperator= (IRscService &&arg) noexcept=default
 The default move-assignment operator. More...
 
virtual ~IRscService (void)=default
 Destructs this instance and frees all resources.
 

Static Public Member Functions

static IRscServiceProxyFactoryGetProxyFactory (void)
 
- Static Public Member Functions inherited from Arp::Base::Rsc::Commons::IRscService
static IRscServiceProxyFactoryGetProxyFactory (void)
 Returns a reference to service proxy factory to create a proxy instance of this service. More...
 

Detailed Description

Use this service for acyclic communication with Profibus slaves

This service is defined in library Arp.Io.Profibus.

Realtime Usage: This API call does not have to be deterministic in runtime behaviour, so an asynchronous execution should be considered.

Member Function Documentation

◆ ReadRecord()

virtual RecordResult Arp::Io::Profibus::Services::IAcyclicCommunicationService::ReadRecord ( const RecordParameters parameters,
std::vector< byte > &  data 
)
pure virtual

Reads object from Profibus module

Parameters
parametersStructure with paramaters of module and object
dataData read from object
Returns
Structure with error informations

◆ WriteRecord()

virtual RecordResult Arp::Io::Profibus::Services::IAcyclicCommunicationService::WriteRecord ( const RecordParameters parameters,
const std::vector< byte > &  data 
)
pure virtual

Writes object to Profibus module

Parameters
parametersStructure with parameters of module and object
dataData to write in object
Returns
Structure with error informations

The documentation for this class was generated from the following file: