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

Use this service for conversion of addresses and node IDs More...

#include <IAddressConversionService.hpp>

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

Public Types

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

Public Member Functions

 IAddressConversionService (void)
 Constructs an IAddressConversionService instance. More...
 
virtual ~IAddressConversionService (void)
 Destructs this instance and frees all resouces. More...
 
virtual uint32 AddressToId (const ProfinetAddress &address, uint32 &id)=0
 Convert an address to a node ID More...
 
virtual uint32 IdToAddress (uint32 id, ProfinetAddress &address)=0
 Convert a node id to an address 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 conversion of addresses and node IDs

Constructor & Destructor Documentation

◆ IAddressConversionService()

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

Constructs an IAddressConversionService instance.

◆ ~IAddressConversionService()

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

Destructs this instance and frees all resouces.

Member Function Documentation

◆ AddressToId()

virtual uint32 Arp::Io::ProfinetStack::Controller::Services::IAddressConversionService::AddressToId ( const ProfinetAddress address,
uint32 id 
)
pure virtual

Convert an address to a node ID

Parameters
addressStructure with all parameters of a PROFINET address Arp.Io.ProfinetStack.Controller.Services.ProfinetAddress
idNode ID
Returns

Status of service

ToDo

◆ IdToAddress()

virtual uint32 Arp::Io::ProfinetStack::Controller::Services::IAddressConversionService::IdToAddress ( uint32  id,
ProfinetAddress address 
)
pure virtual

Convert a node id to an address

Parameters
idNode ID
addressStructure with all parameters of a PROFINET address Arp.Io.ProfinetStack.Controller.Services.ProfinetAddress
Returns

Status of service

ToDo


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