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

Service to communicate to PCP devices More...

#include <IPcpService.hpp>

Inheritance diagram for Arp::Io::Interbus::Services::IPcpService:
Inheritance graph

Public Types

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

Public Member Functions

 IPcpService (void)=default
 Constructs an IPcpService instance. More...
 
virtual InitiateResult PcpInitiate (uint8 communicationReference)=0
 Establish connection to a PCP device More...
 
virtual void PcpAbort (uint8 communicationReference, uint8 reasonCode, const std::vector< uint8 > &abortDetail)=0
 Abort connection to a PCP device More...
 
virtual IdentifyResult PcpIdentify (uint8 communicationReference, uint8 invokeId)=0
 Get device information of PCP device. More...
 
virtual StatusResult PcpStatus (uint8 communicationReference, uint8 invokeId)=0
 Get current status of PCP device More...
 
virtual InterbusResult PcpRead (uint8 communicationReference, uint8 invokeId, const ObjectAddress &pcpObject, std::vector< uint8 > &data)=0
 Read data record from PCP device More...
 
virtual InterbusResult PcpWrite (uint8 communicationReference, uint8 invokeId, const ObjectAddress &pcpObject, const std::vector< uint8 > &data)=0
 Write data record to a PCP device 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

Service to communicate to PCP devices

Constructor & Destructor Documentation

◆ IPcpService()

Arp::Io::Interbus::Services::IPcpService::IPcpService ( void  )
default

Constructs an IPcpService instance.

Member Function Documentation

◆ PcpAbort()

virtual void Arp::Io::Interbus::Services::IPcpService::PcpAbort ( uint8  communicationReference,
uint8  reasonCode,
const std::vector< uint8 > &  abortDetail 
)
pure virtual

Abort connection to a PCP device

Parameters
communicationReferenceCommunication reference
reasonCodeReason for connection abort
abortDetailAbort details

◆ PcpIdentify()

virtual IdentifyResult Arp::Io::Interbus::Services::IPcpService::PcpIdentify ( uint8  communicationReference,
uint8  invokeId 
)
pure virtual

Get device information of PCP device.

Parameters
communicationReferenceCommunication reference
invokeIdInvode ID (Default value = 0)
Returns
Structure with result Arp.Io.Interbus.Services.IdentifyResult

◆ PcpInitiate()

virtual InitiateResult Arp::Io::Interbus::Services::IPcpService::PcpInitiate ( uint8  communicationReference)
pure virtual

Establish connection to a PCP device

Parameters
communicationReferenceCommunication reference
Returns
Structure with result Arp.Io.Interbus.Services.InitiateResult

◆ PcpRead()

virtual InterbusResult Arp::Io::Interbus::Services::IPcpService::PcpRead ( uint8  communicationReference,
uint8  invokeId,
const ObjectAddress pcpObject,
std::vector< uint8 > &  data 
)
pure virtual

Read data record from PCP device

Parameters
communicationReferenceCommunication reference
invokeIdInvoke ID (Default value = 0)
pcpObjectPCP object
dataData that are read from the object
Returns
Structure with error information Arp.Io.Interbus.Services.InterbusResult

◆ PcpStatus()

virtual StatusResult Arp::Io::Interbus::Services::IPcpService::PcpStatus ( uint8  communicationReference,
uint8  invokeId 
)
pure virtual

Get current status of PCP device

Parameters
communicationReferenceCommunication reference
invokeIdInvoke ID (Default value = 0)
Returns
Structure with result Arp.Io.Interbus.Services.StatusResult

◆ PcpWrite()

virtual InterbusResult Arp::Io::Interbus::Services::IPcpService::PcpWrite ( uint8  communicationReference,
uint8  invokeId,
const ObjectAddress pcpObject,
const std::vector< uint8 > &  data 
)
pure virtual

Write data record to a PCP device

Parameters
communicationReferenceCommunication reference
invokeIdInvoke ID (Default value = 0)
pcpObjectPCP object
dataData that shall be written in the object
Returns
Structure with error information Arp.Io.Interbus.Services.InterbusResult

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