PLCnext API Documentation  22.9.0.33
Public Member Functions | List of all members
Arp::System::Acf::IComponentFactory Class Referenceabstract

This interface is used by the Acf to create components dynamiically through configuration (.acf.config), and should be implemented by all component factories provided by an Acf library. More...

#include <IComponentFactory.hpp>

Inheritance diagram for Arp::System::Acf::IComponentFactory:
Inheritance graph

Public Member Functions

 IComponentFactory (void)=default
 Constructs an IComponentFactory instance. More...
 
virtual ~IComponentFactory (void)=default
 Destructs this instance and frees all resouces. More...
 
virtual bool HasComponentType (const String &typeName)=0
 Determines if this factory provides components of the given typename. More...
 
virtual IComponent::Ptr CreateComponent (IApplication &application, const String &componentTypeName, const String &componentName)=0
 Creates a component of the given typename. More...
 

Detailed Description

This interface is used by the Acf to create components dynamiically through configuration (.acf.config), and should be implemented by all component factories provided by an Acf library.

Constructor & Destructor Documentation

◆ IComponentFactory()

Arp::System::Acf::IComponentFactory::IComponentFactory ( void  )
default

Constructs an IComponentFactory instance.

◆ ~IComponentFactory()

virtual Arp::System::Acf::IComponentFactory::~IComponentFactory ( void  )
virtualdefault

Destructs this instance and frees all resouces.

Member Function Documentation

◆ CreateComponent()

virtual IComponent::Ptr Arp::System::Acf::IComponentFactory::CreateComponent ( IApplication application,
const String componentTypeName,
const String componentName 
)
pure virtual

Creates a component of the given typename.

Parameters
applicationThe application passed to the new created component.
componentTypeNameThe typename of the component to create.
componentNameThe name of the new created component.
Returns
The new component instance, if the specified type could be provided, otherwise nullptr.

Implemented in Arp::System::Acf::ComponentFactory.

◆ HasComponentType()

virtual bool Arp::System::Acf::IComponentFactory::HasComponentType ( const String typeName)
pure virtual

Determines if this factory provides components of the given typename.

Parameters
typeNameThe name of the component type to search for.
Returns
true if the specifeid type could be provided, otherwise false.

Implemented in Arp::System::Acf::ComponentFactory.


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