PLCnext API Documentation  21.0.0.35466
Public Member Functions | List of all members
Arp::Plc::Commons::Esm::RtEventManagerProxy Class Reference

This class implements a event manager proxy to get instances of RtEvent. More...

#include <RtEventManagerProxy.hpp>

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

Public Member Functions

 RtEventManagerProxy (void)
 Constructs an RtEventManagerProxy instance. More...
 
 RtEventManagerProxy (const RtEventManagerProxy &arg)=default
 Copy constructor. More...
 
RtEventManagerProxyoperator= (const RtEventManagerProxy &arg)=default
 Assignment operator. More...
 
 ~RtEventManagerProxy (void)
 Destructs this instance and frees all resources. More...
 
RtEvent::Ptr GetEvent (const String &name) override
 Get shared pointer of the give event. More...
 
bool HasEvent (const String &name) override
 Checks that a given event exists. More...
 

Additional Inherited Members

- Static Public Member Functions inherited from Arp::AppDomainSingleton< RtEventManagerProxy >
static RtEventManagerProxy & CreateInstance (Args &&... args)
 Creates this singleton instance. More...
 
static bool IsCreated (void)
 Determines if this singleton instance is created yet. More...
 
static RtEventManagerProxy & GetInstance (void)
 Gets a reference of the singleton instance. More...
 
static RtEventManagerProxy * GetInstancePtr (void)
 Gets a pointer to the singleton instance. More...
 
static void DisposeInstance (void)
 Disposes this singleton instance. More...
 
- Protected Types inherited from Arp::AppDomainSingleton< RtEventManagerProxy >
typedef AppDomainSingleton< RtEventManagerProxy > SingletonBase
 Defines this type to be used from derived classes. More...
 
- Protected Member Functions inherited from Arp::Plc::Commons::Esm::IRtEventManager
 IRtEventManager (void)=default
 Constructs an IRtEventManager instance. More...
 
virtual ~IRtEventManager (void)=default
 Destructs this instance and frees all resources. More...
 
- Protected Member Functions inherited from Arp::AppDomainSingleton< RtEventManagerProxy >
 AppDomainSingleton (void)=default
 The protected default constructor. More...
 
 ~AppDomainSingleton (void)=default
 The protected default destructor. More...
 

Detailed Description

This class implements a event manager proxy to get instances of RtEvent.

Constructor & Destructor Documentation

◆ RtEventManagerProxy() [1/2]

Arp::Plc::Commons::Esm::RtEventManagerProxy::RtEventManagerProxy ( void  )

Constructs an RtEventManagerProxy instance.

◆ RtEventManagerProxy() [2/2]

Arp::Plc::Commons::Esm::RtEventManagerProxy::RtEventManagerProxy ( const RtEventManagerProxy arg)
default

Copy constructor.

◆ ~RtEventManagerProxy()

Arp::Plc::Commons::Esm::RtEventManagerProxy::~RtEventManagerProxy ( void  )

Destructs this instance and frees all resources.

Member Function Documentation

◆ GetEvent()

RtEvent::Ptr Arp::Plc::Commons::Esm::RtEventManagerProxy::GetEvent ( const String name)
overridevirtual

Get shared pointer of the give event.

Parameters
nameName identifier of event to be get.
Returns
If the event exists the shared pointer is returned, otherwise nullptr.

Implements Arp::Plc::Commons::Esm::IRtEventManager.

◆ HasEvent()

bool Arp::Plc::Commons::Esm::RtEventManagerProxy::HasEvent ( const String name)
overridevirtual

Checks that a given event exists.

Parameters
nameName identifier of event to be check.
Returns
If the event exists true is returned, otherwise false.

Implements Arp::Plc::Commons::Esm::IRtEventManager.

◆ operator=()

RtEventManagerProxy& Arp::Plc::Commons::Esm::RtEventManagerProxy::operator= ( const RtEventManagerProxy arg)
default

Assignment operator.


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