PLCnext API Documentation  20.6.0.30321
Public Types | Public Member Functions | Protected Member Functions | List of all members
Arp::Plc::Commons::Domain::IPlcEventComponent Class Referenceabstract

Public Types

typedef std::shared_ptr< IPlcEventComponentPtr
 

Public Member Functions

virtual PlcEventSenderGetPlcEventSender (void)=0
 Gets the event sender, if this Plc component sends any Plc events. More...
 
virtual PlcEventReceiverGetPlcEventReceiver (void)=0
 Gets the event receiver, if this Plc component receives any Plc events. More...
 

Protected Member Functions

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

Constructor & Destructor Documentation

◆ IPlcEventComponent()

Arp::Plc::Commons::Domain::IPlcEventComponent::IPlcEventComponent ( void  )
protecteddefault

Constructs an IPlcEventComponent instance.

◆ ~IPlcEventComponent()

virtual Arp::Plc::Commons::Domain::IPlcEventComponent::~IPlcEventComponent ( void  )
protectedvirtualdefault

Destructs this instance and frees all resources.

Member Function Documentation

◆ GetPlcEventReceiver()

virtual PlcEventReceiver* Arp::Plc::Commons::Domain::IPlcEventComponent::GetPlcEventReceiver ( void  )
pure virtual

Gets the event receiver, if this Plc component receives any Plc events.

Returns
The event receiver, if this Plc component receives any Plc events, otherwise nullptr.

◆ GetPlcEventSender()

virtual PlcEventSender* Arp::Plc::Commons::Domain::IPlcEventComponent::GetPlcEventSender ( void  )
pure virtual

Gets the event sender, if this Plc component sends any Plc events.

Returns
The event sender, if this Plc component sends any Plc events, otherwise nullptr.

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