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

Interface to realizes an program provider. More...

#include <IProgramProvider.hpp>

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

Public Member Functions

 IProgramProvider (void)=default
 Constructs an IProgram instance. More...
 
virtual ~IProgramProvider (void)=default
 Destructs this instance and frees all resouces. More...
 
virtual IProgram::Ptr CreateProgram (const String &programName, const String &programType)=0
 Creates an instance of an program type. More...
 
virtual void Reset (void)=0
 Resets the program provider. More...
 

Detailed Description

Interface to realizes an program provider.

Instances of this class can be used to create program instances of program types are provided by this program provider.

Constructor & Destructor Documentation

◆ IProgramProvider()

Arp::Plc::Commons::Esm::IProgramProvider::IProgramProvider ( void  )
default

Constructs an IProgram instance.

◆ ~IProgramProvider()

virtual Arp::Plc::Commons::Esm::IProgramProvider::~IProgramProvider ( void  )
virtualdefault

Destructs this instance and frees all resouces.

Member Function Documentation

◆ CreateProgram()

virtual IProgram::Ptr Arp::Plc::Commons::Esm::IProgramProvider::CreateProgram ( const String programName,
const String programType 
)
pure virtual

Creates an instance of an program type.

Parameters
programNameThe name of the to creating program instance.
programTypeThe program type of the to creating program instance.
Returns
The instance of the created program.

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

◆ Reset()

virtual void Arp::Plc::Commons::Esm::IProgramProvider::Reset ( void  )
pure virtual

Resets the program provider.

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


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