PLCnext API Documentation 25.0.2.69
Public Types | Public Member Functions | List of all members
Arp::Plc::Meta::Commons::IIoMetaComponent Class Referenceabstract

Interface for all components providing IO related meta data More...

#include <IIoMetaComponent.hpp>

Inheritance diagram for Arp::Plc::Meta::Commons::IIoMetaComponent:
Inheritance graph

Public Types

using Ptr = std::shared_ptr< IIoMetaComponent >
 
using VariableRegistry = Arp::Plc::Meta::Commons::Io::VariableRegistry
 

Public Member Functions

 IIoMetaComponent (void)=default
 Constructs an IIoMetaComponent instance.
 
 IIoMetaComponent (const IIoMetaComponent &arg)=default
 Copy constructor.
 
 IIoMetaComponent (IIoMetaComponent &&arg) noexcept=default
 Move constructor.
 
IIoMetaComponentoperator= (const IIoMetaComponent &arg)=default
 Copy-assignment operator.
 
IIoMetaComponentoperator= (IIoMetaComponent &&arg) noexcept=default
 Move-assignment operator.
 
virtual ~IIoMetaComponent (void)=default
 Destructs this instance and frees all resources.
 
virtual VariableRegistryGetVariableRegistry ()=0
 Gets the VariableRegistry of this component to provide meta data of this IO component. More...
 

Detailed Description

Interface for all components providing IO related meta data

All components that wish to provide IO data must implement this interface. The VariableRegistry of the component makes informations of the component's IO variables available.

Member Function Documentation

◆ GetVariableRegistry()

virtual VariableRegistry & Arp::Plc::Meta::Commons::IIoMetaComponent::GetVariableRegistry ( )
pure virtual

Gets the VariableRegistry of this component to provide meta data of this IO component.

Returns
VariableRegistry of this component

Implemented in Arp::Io::Commons::IoComponentBase.


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