Arp::Plc::Commons::Domain::IPlcComponent Class Reference

Public Types
typedef std::shared_ptr< IPlcComponent >	Ptr

Public Member Functions
virtual bool	LoadPlc (bool isChanging)=0
	Loads the configuration of this Plc component. More...
virtual bool	SetupPlc (bool isChanging, PlcStartKind startKind)=0
	Sets up the configuration of this Plc component. More...
virtual void	StartPlc (PlcStartKind startKind)=0
	Starts this Plc component using the specified kind. More...
virtual void	StopPlc (void)=0
	Stops this Plc component. More...
virtual void	ResetPlc (bool isChanging)=0
	Resets the configuration of this Plc component. More...
virtual void	UnloadPlc (bool isChanging)=0
	Unloads the configuration of this Plc component. More...

Protected Member Functions
	IPlcComponent (void)=default
	Constructs an IPlcComponent instance. More...
virtual	~IPlcComponent (void)=default
	Destructs this instance and frees all resources. More...

Constructor & Destructor Documentation

IPlcComponent()

Arp::Plc::Commons::Domain::IPlcComponent::IPlcComponent ( void  )

protecteddefault

Constructs an IPlcComponent instance.

~IPlcComponent()

virtual Arp::Plc::Commons::Domain::IPlcComponent::~IPlcComponent ( void  )

protectedvirtualdefault

Destructs this instance and frees all resources.

Member Function Documentation

LoadPlc()

virtual bool Arp::Plc::Commons::Domain::IPlcComponent::LoadPlc ( bool  isChanging )

pure virtual

Loads the configuration of this Plc component.

Parameters

isChanging

true, if the a Plc change is in process, otherwise false.

Returns

false if <paramref="isChanging"/> is true and the change is not possible, otherwise true.

ResetPlc()

virtual void Arp::Plc::Commons::Domain::IPlcComponent::ResetPlc ( bool  isChanging )

pure virtual

Resets the configuration of this Plc component.

SetupPlc()

virtual bool Arp::Plc::Commons::Domain::IPlcComponent::SetupPlc ( bool  isChanging, PlcStartKind  startKind  )

pure virtual

Sets up the configuration of this Plc component.

Parameters

isChanging

true, if the a Plc change is in process, otherwise false.

Returns

false if <paramref="isChanging"/> is true and the change is not possible, otherwise true.

StartPlc()

virtual void Arp::Plc::Commons::Domain::IPlcComponent::StartPlc ( PlcStartKind  startKind )

pure virtual

Starts this Plc component using the specified kind.

Parameters

startKind

The start kind to process (cold, warm, hot).

StopPlc()

virtual void Arp::Plc::Commons::Domain::IPlcComponent::StopPlc ( void  )

pure virtual

Stops this Plc component.

UnloadPlc()

virtual void Arp::Plc::Commons::Domain::IPlcComponent::UnloadPlc ( bool  isChanging )

pure virtual

Unloads the configuration of this Plc component.

---

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

• Arp/Plc/Commons/Domain/IPlcComponent.hpp