Arp::Plc::Commons::Esm::RtEventManagerProxy Class Reference

With the rt event manager proxy can be get instances of RtEvent. The instances of RtEvent will be created by the configuration of ESM at the plc startup. More...

#include <RtEventManagerProxy.hpp>

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

Public Types
using	Instance = RtEventManagerProxy
using	InstancePtr = std::unique_ptr< Instance >

Public Member Functions
	RtEventManagerProxy (void)
	Constructs an RtEventManagerProxy instance.
	RtEventManagerProxy (const RtEventManagerProxy &arg)=delete
	Copy constructor.
RtEventManagerProxy &	operator= (const RtEventManagerProxy &arg)=delete
	Assignment operator.
	~RtEventManagerProxy (void) override
	Destructs this instance and frees all resources.
RtEvent::Ptr	GetEvent (const String &name) override
	Get the shared pointer of the give RtEvent. More...
bool	HasEvent (const String &name) override
	Checks that a given RtEvent exists. More...
Impl &	GetImpl (void)
	For internal use only.
const Impl &	GetImpl (void) const
virtual RtEvent::Ptr	GetEvent (const String &name)=0
virtual bool	HasEvent (const String &name)=0

Static Public Member Functions
static Instance &	CreateInstance (void)
static bool	IsCreated (void)
static void	DisposeInstance (void)
static Instance &	GetInstance (void)

Additional Inherited Members
Protected Member Functions inherited from Arp::Plc::Commons::Esm::IRtEventManager
	IRtEventManager (void)=default
	Constructs an IRtEventManager instance.
virtual	~IRtEventManager (void)=default
	Destructs this instance and frees all resources.

Detailed Description

With the rt event manager proxy can be get instances of RtEvent. The instances of RtEvent will be created by the configuration of ESM at the plc startup.

Member Function Documentation

GetEvent()

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

overridevirtual

Get the shared pointer of the give RtEvent.

Parameters

name	Name identifier of RtEvent to be get.

Returns

If the RtEvent 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 RtEvent exists.

Parameters

name	Name identifier of RtEvent to be check.

Returns

If the event exists true is returned, otherwise false.

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

---

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

• Arp/Plc/Commons/Esm/RtEventManagerProxy.hpp
• Arp/Plc/Commons/Esm/RtEventManagerProxy.cpp