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

Use this service to manage PROFINET Controller Application Relationships (AR) More...

#include <IArDataService.hpp>

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

Public Types

typedef std::shared_ptr< IArDataServicePtr
 
typedef delegate< void(IRscReadEnumerator< ArInfo > &)> GetAllArInfoResultDelegate
 
typedef delegate< void(IRscReadEnumerator< RscString< 256 >> &)> GetAllArAttributeNamesResultDelegate
 
typedef delegate< void(IRscWriteEnumerator< RscString< 256 >> &)> GetAttributeValuesAttributeNameDelegate
 
typedef delegate< void(IRscReadEnumerator< ArDataResult > &)> GetAttributeValuesResultDelegate
 
- Public Types inherited from Arp::System::Rsc::Services::IRscService
typedef std::shared_ptr< IRscServicePtr
 

Public Member Functions

 IArDataService (void)
 Constructs an IArDataService instance. More...
 
virtual ~IArDataService (void)
 Destructs this instance and frees all resouces. More...
 
virtual void GetAllArInfo (GetAllArInfoResultDelegate resultDelegate)=0
 This method returns a list of ArInfo-objects with DNS-Name and AR-User-Id of each configured profinet device More...
 
virtual void GetAllArAttributeNames (uint16 arUserId, GetAllArAttributeNamesResultDelegate resultDelegate)=0
 This method returns an array of strings with all available attributes of specified AR-User-Id of which values can be read More...
 
virtual ArDataResult GetAttributeValue (uint16 arUserId, const RscString< 256 > &attributeName)=0
 Read a single attribute value More...
 
virtual void GetAttributeValues (uint16 arUserId, GetAttributeValuesAttributeNameDelegate attributeNameDelegate, GetAttributeValuesResultDelegate resultDelegate)=0
 Read a list of attribute values More...
 
virtual std::vector< DiagnosticResultGetArDiagnosis (const std::vector< uint16 > &arUserId)=0
 Read an array of diagnosis information 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 to manage PROFINET Controller Application Relationships (AR)

Constructor & Destructor Documentation

◆ IArDataService()

Arp::Io::ProfinetStack::Controller::Services::IArDataService::IArDataService ( void  )
inline

Constructs an IArDataService instance.

◆ ~IArDataService()

Arp::Io::ProfinetStack::Controller::Services::IArDataService::~IArDataService ( void  )
inlinevirtual

Destructs this instance and frees all resouces.

Member Function Documentation

◆ GetAllArAttributeNames()

virtual void Arp::Io::ProfinetStack::Controller::Services::IArDataService::GetAllArAttributeNames ( uint16  arUserId,
GetAllArAttributeNamesResultDelegate  resultDelegate 
)
pure virtual

This method returns an array of strings with all available attributes of specified AR-User-Id of which values can be read

Parameters
arUserIdArUserId to specify AR of requested items
Returns
array of strings with all available attributes

◆ GetAllArInfo()

virtual void Arp::Io::ProfinetStack::Controller::Services::IArDataService::GetAllArInfo ( GetAllArInfoResultDelegate  resultDelegate)
pure virtual

This method returns a list of ArInfo-objects with DNS-Name and AR-User-Id of each configured profinet device

Returns
result as array of Arp.Io.ProfinetStack.Controller.Services.ArInfo

◆ GetArDiagnosis()

virtual std::vector<DiagnosticResult> Arp::Io::ProfinetStack::Controller::Services::IArDataService::GetArDiagnosis ( const std::vector< uint16 > &  arUserId)
pure virtual

Read an array of diagnosis information

Parameters
arUserIdArray of uint16-Ar-User-Ids, for which diagnosis is requested, if empty, diagnosis for all configured ARs is returned
Returns
result as array of Arp.Io.ProfinetStack.Controller.Services.DiagnosticResult

◆ GetAttributeValue()

virtual ArDataResult Arp::Io::ProfinetStack::Controller::Services::IArDataService::GetAttributeValue ( uint16  arUserId,
const RscString< 256 > &  attributeName 
)
pure virtual

Read a single attribute value

Parameters
arUserIdArUserId to specify AR of requested items
attributeNameString for the requested attribute
Returns
result as Arp.Io.ProfinetStack.Controller.Services.ArDataResult

◆ GetAttributeValues()

virtual void Arp::Io::ProfinetStack::Controller::Services::IArDataService::GetAttributeValues ( uint16  arUserId,
GetAttributeValuesAttributeNameDelegate  attributeNameDelegate,
GetAttributeValuesResultDelegate  resultDelegate 
)
pure virtual

Read a list of attribute values

Parameters
arUserIdArUserId to specify AR of requested items
attributeNameArray of string for select the items
Returns
result as array of Arp.Io.ProfinetStack.Controller.Services.ArDataResult

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