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

Use this service for acyclic PROFINET communication More...

#include <IAcyclicCommunicationService.hpp>

Inheritance diagram for Arp::Io::ProfinetStack::Controller::Services::IAcyclicCommunicationService:
Inheritance graph

Public Types

using Ptr = std::shared_ptr< IAcyclicCommunicationService >
 
- Public Types inherited from Arp::System::Rsc::Services::IRscService
typedef std::shared_ptr< IRscServicePtr
 

Public Member Functions

 IAcyclicCommunicationService (void)=default
 Constructs an IAcyclicCommunicationService instance. More...
 
virtual RecordResult RecordRead (const RecordParam &recordParam, std::vector< uint8 > &data)=0
 Read data from a device module (blocking mode) More...
 
virtual RecordResult RecordWrite (const RecordParam &recordParam, const std::vector< uint8 > &data)=0
 Write data on a device module (blocking mode) More...
 
- Public Member Functions inherited from Arp::System::Rsc::Services::IRscService
 IRscService (void)=default
 Constructs an IRscService instance. More...
 
virtual ~IRscService (void)=default
 Destructs this instance and frees all resouces. More...
 

Static Public Member Functions

static IRscServiceProxyFactory & GetProxyFactory (void)
 
- Static Public Member Functions inherited from Arp::System::Rsc::Services::IRscService
static IRscServiceProxyFactory & GetProxyFactory (void)
 Returns a reference to service proxy factory to create a proxy instance of the service More...
 

Detailed Description

Use this service for acyclic PROFINET communication

Constructor & Destructor Documentation

◆ IAcyclicCommunicationService()

Arp::Io::ProfinetStack::Controller::Services::IAcyclicCommunicationService::IAcyclicCommunicationService ( void  )
default

Constructs an IAcyclicCommunicationService instance.

Member Function Documentation

◆ RecordRead()

virtual RecordResult Arp::Io::ProfinetStack::Controller::Services::IAcyclicCommunicationService::RecordRead ( const RecordParam recordParam,
std::vector< uint8 > &  data 
)
pure virtual

Read data from a device module (blocking mode)

Parameters
recordParamStructure with parameters to address an object on a module to read from
dataData that are read from the module
Returns
Structure with error information Arp.Io.ProfinetStack.Controller.Services.RecordResult

◆ RecordWrite()

virtual RecordResult Arp::Io::ProfinetStack::Controller::Services::IAcyclicCommunicationService::RecordWrite ( const RecordParam recordParam,
const std::vector< uint8 > &  data 
)
pure virtual

Write data on a device module (blocking mode)

Parameters
recordParamStructure with parameters to address an object on a module to write on Arp.Io.ProfinetStack.Controller.Services.RecordParam
dataData that shall be written on the module
Returns
Structure with error information Arp.Io.ProfinetStack.Controller.Services.RecordResult

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