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

Namespace for interfaces and classes of the PLC Domain More...

Classes
class	PlcDomainProxy

Enumerations
enum class	PlcStartKind : uint8 {   None = 0 , Cold = 1 , Warm = 2 , Hot = 3 ,   RestoreWarm = 4 }
enum class	PlcState : uint32 {   None = 0 , Ready = 1 , Stop = 2 , Running = 3 ,   Halt = 4 , StateMask = 0x3F , FlagsMask = ~StateMask , Warning = (1 << 6) ,   Error = (1 << 7) , SuspendedBySwitch = (1 << 8) , Suspended = (1 << 8) , FatalError = (1 << 9) ,   SuspendedBySystemWatchdog = (1 << 10) , Blocked = (1 << 10) , Loading = (1 << 12) , Starting = (1 << 13) ,   Stopping = (1 << 14) , Resetting = (1 << 15) , Changing = (1 << 16) , Hot = (1 << 17) ,   Forcing = (1 << 18) , Debugging = (1 << 19) , Warm = (1 << 20) , StartingDelayed = (1 << 21) ,   DcgFailed = (1 << 29) , DcgNotPossible = (1 << 30) , DcgRealTimeViolation = (1U << 31) , ClearMask = StateMask | Hot | Warm | Changing | Forcing | Debugging ,   RemainingMask = StateMask | Hot | Warm | Forcing | Debugging | Warning | Error | FatalError }

Functions
ARP_CXX_SYMBOL_EXPORT std::ostream &	operator<< (std::ostream &os, PlcStartKind value)
ARP_CXX_SYMBOL_EXPORT std::istream &	operator>> (std::istream &is, PlcStartKind &value)
ARP_CXX_SYMBOL_EXPORT std::ostream &	operator<< (std::ostream &os, PlcState value)
ARP_CXX_SYMBOL_EXPORT std::istream &	operator>> (std::istream &is, PlcState &value)
constexpr PlcState	operator& (PlcState lhs, PlcState rhs)
constexpr PlcState	operator| (PlcState lhs, PlcState rhs)
PlcState &	operator&= (PlcState &lhs, PlcState rhs)
PlcState &	operator|= (PlcState &lhs, PlcState rhs)
PlcState	operator~ (PlcState arg)

Detailed Description

Namespace for interfaces and classes of the PLC Domain

Enumeration Type Documentation

PlcState

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

strong

Enumerator
None	Not specified.
Ready	The firmware is setup, and the PLC is ready.
Stop	The PLC is loaded and setup but not started yet.
Running	The PLC is started.
Halt	The PLC is halted for debug purpose.
StateMask	Use this entry to de-mask the raw PLC state value.
FlagsMask	Use this entry to de-mask the flags portion of this PLC state.
Warning	An unspecified warning occurs.
Error	An unspecified error or exception occurs, and the PLC is in state error.
SuspendedBySwitch	Deprecated since 2022.0! Please use <cref name="Suspended"> instead. This error bit is set, if it could not be started because the PLC is suspended by the hardware switch (STOP-switch).
Suspended	This error bit is set, if the PLC could not be started because it was prevented by a component.
FatalError	An unspecified fatal error or exception occurs, and the PLC is in state error.
SuspendedBySystemWatchdog	Deprecated since 2022.0! Please use <cref name="Blocked"> instead. This error bit is set, if the PLC could not be loaded because it is blocked by the system watchdog.
Blocked	This error bit is set, if the PLC could not be loaded because it was prevented by a component.
Loading	The PLC is loading the Plc components.
Starting	The PLC is starting the Plc components.
Stopping	The PLC is stopping the Plc components.
Resetting	The PLC is resetting the Plc components.
Changing	The PLC is changing a configuration, this implies, that the state Running is set.
Hot	The PLC is stopped in hot state, that is all data still remains.
Forcing	The PLC is in force mode. One or more variables are forced by the GDS.
Debugging	The PLC is in debug mode. One or more breakpoints are set.
Warm	The PLC is stopped in warm state, that is the retain data has been restored.
StartingDelayed	The PLC is about to start, but due to component conditions the PLC start has to be delayed.
DcgFailed	This error bit is set, if the PLC tried to perform a change operation, but an error occurred. This bit is usually combined with the state Running.
DcgNotPossible	This error bit is set, if the PLC tries to perform a change operation, but it is not possible. This bit is usually combined with the state Running.
DcgRealTimeViolation	This error bit is set, if the PLC tries to perform a change operation, but it is not possible in real time. This bit is usually combined with the state Running.
ClearMask	This mask defines all states which should be cleared before any PLC operation. It is a combination of all bits which should remain. ARP_DEPRECATED("Use RemainingMask instead. The name of this entry is not self-explanatory.")
RemainingMask	This mask defines all states which should not be cleared before any PLC operation. All other flags are reset. It is a combination of all bits which should remain.