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

Use this service for acyclic axioline communication More...

#include <IAcyclicCommunicationService.hpp>

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

Public Types

typedef std::shared_ptr< IAcyclicCommunicationServicePtr
 
- Public Types inherited from Arp::System::Rsc::Services::IRscService
typedef std::shared_ptr< IRscServicePtr
 

Public Member Functions

 IAcyclicCommunicationService (void)
 Constructs an IAcyclicCommunicationService instance. More...
 
virtual ~IAcyclicCommunicationService (void)
 Destructs this instance and frees all resouces. More...
 
virtual PdiResult PdiRead (const PdiParam &pdiParam, std::vector< uint8 > &data)=0
 Read a PDI object from an axioline module (blocking mode) More...
 
virtual PdiResult PdiWrite (const PdiParam &pdiParam, const std::vector< uint8 > &data)=0
 Write a PDI object on an axioline 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 axioline communication

Constructor & Destructor Documentation

◆ IAcyclicCommunicationService()

Arp::Io::Axioline::Services::IAcyclicCommunicationService::IAcyclicCommunicationService ( void  )
inline

Constructs an IAcyclicCommunicationService instance.

◆ ~IAcyclicCommunicationService()

Arp::Io::Axioline::Services::IAcyclicCommunicationService::~IAcyclicCommunicationService ( void  )
inlinevirtual

Destructs this instance and frees all resouces.

Member Function Documentation

◆ PdiRead()

virtual PdiResult Arp::Io::Axioline::Services::IAcyclicCommunicationService::PdiRead ( const PdiParam pdiParam,
std::vector< uint8 > &  data 
)
pure virtual

Read a PDI object from an axioline module (blocking mode)

Parameters
pdiParamStructure with all parameter to address an object on a module to read from Arp.Io.Axioline.Services.PdiParam
dataData that are read from the module
Returns
Structure with error information Arp.Io.Axioline.Services.PdiResult

◆ PdiWrite()

virtual PdiResult Arp::Io::Axioline::Services::IAcyclicCommunicationService::PdiWrite ( const PdiParam pdiParam,
const std::vector< uint8 > &  data 
)
pure virtual

Write a PDI object on an axioline module (blocking mode)

Parameters
pdiParamStructure with all parameter to address an object on a module to write on Arp.Io.Axioline.Services.PdiParam
dataData that shall be written on the module
Returns
Structure with error information Arp.Io.Axioline.Services.PdiResult

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