Arp::Plc::Domain::Commons Namespace Reference

Namespace for interface types of the PLC domain More...

Classes
class	DcgResultInfo
	This class is used to return the result of a PLC operation concerning download-changes (Dcg). More...
class	DomainBase
	This class is used as base class of structures, which shall be adapted by DualDomain to support download-changes operations. More...
class	DomainSelector
	This class is for internal use only. Never use it directly. More...
class	DualDomain
	This class adapts a domain structure, which shall be doubled for supporting download-changes. More...
class	IPlcComponent
	This is the most important interface of the PLC domain. It is used to load and unload the PLC project of any component implementing this interface. Furthermore it provides the operations to start and stop any component, if it is required, otherwise the operations are left empty. More...
struct	TestDomain

Enumerations
enum class	DcgResult : uint32 { None = 0 , Success = 1 , Refused = 2 }
	The result of a PLC download-changes operation. More...
enum class	PlcStartKind : uint8 {   None = 0 , Cold = 1 , Warm = 2 , Hot = 3 ,   RestoreWarm = 4 }
	Determines which kind of start operation is initiated using PlcManager::StartPlc(PlcStartKind startKind, bool async) operation. More...

Functions
ARP_EXPORT std::ostream &	operator<< (std::ostream &os, DcgResult value)
ARP_EXPORT std::istream &	operator>> (std::istream &is, DcgResult &value)
ARP_EXPORT std::ostream &	operator<< (std::ostream &os, PlcStartKind value)
ARP_EXPORT std::istream &	operator>> (std::istream &is, PlcStartKind &value)

Detailed Description

Namespace for interface types of the PLC domain

Enumeration Type Documentation

DcgResult

enum class Arp::Plc::Domain::Commons::DcgResult : uint32

strong

The result of a PLC download-changes operation.

Enumerator
None	Determines an empty download-changes result.
Success	The download-changes operation was successful.
Refused	The download-changes operation was refused by any component.

PlcStartKind

enum class Arp::Plc::Domain::Commons::PlcStartKind : uint8

strong

Determines which kind of start operation is initiated using PlcManager::StartPlc(PlcStartKind startKind, bool async) operation.

Enumerator
None	Value not set or initialized.
Cold	Initiates a PLC cold start, i.e. all data is reset to initial values.
Warm	Initiates a PLC warm start, i.e. all data is reset to initial values, but retained data remains.
Hot	Initiates a PLC hot start, i.e. the PLC is just continued without setting or resetting any data.
RestoreWarm	Initiates a PLC warm start by restore, i.e. all data is reset to initial values, but retained data is restored from backup.