PLCnext API Documentation  22.9.0.33
Public Types | Public Member Functions | Protected Member Functions | List of all members
Arp::Plc::Commons::Esm::IProgramComponent Class Referenceabstract

Interface to realizes an access to a plc program provider. More...

#include <IProgramComponent.hpp>

Inheritance diagram for Arp::Plc::Commons::Esm::IProgramComponent:
Inheritance graph

Public Types

typedef std::shared_ptr< IProgramComponentPtr
 Shared pointer type of IProgramComponent. More...
 

Public Member Functions

virtual IProgramProviderGetProgramProvider (bool useBackgroundDomain)=0
 Returns the program provider of this component. More...
 

Protected Member Functions

 IProgramComponent (void)=default
 Constructs an IProgramComponent instance. More...
 
virtual ~IProgramComponent (void)=default
 Destructs this instance and frees all resouces. More...
 

Detailed Description

Interface to realizes an access to a plc program provider.

Instances of this class can be used to get an access to a plc program provider.

Member Typedef Documentation

◆ Ptr

Shared pointer type of IProgramComponent.

Constructor & Destructor Documentation

◆ IProgramComponent()

Arp::Plc::Commons::Esm::IProgramComponent::IProgramComponent ( void  )
protecteddefault

Constructs an IProgramComponent instance.

◆ ~IProgramComponent()

virtual Arp::Plc::Commons::Esm::IProgramComponent::~IProgramComponent ( void  )
protectedvirtualdefault

Destructs this instance and frees all resouces.

Member Function Documentation

◆ GetProgramProvider()

virtual IProgramProvider& Arp::Plc::Commons::Esm::IProgramComponent::GetProgramProvider ( bool  useBackgroundDomain)
pure virtual

Returns the program provider of this component.

Returns
The program provider of this component.

Implemented in Arp::Plc::Commons::Esm::ProgramComponentBase.


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