PlcState.hpp

 
//
//  Copyright PHOENIX CONTACT Electronics GmbH
//
#pragma once
#include "Arp/System/Core/Arp.h"
#include "Arp/System/Core/Enum.hxx"
 
namespace Arp { namespace Plc { namespace Commons { namespace Domain
{
 
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),
    Changing = (1 << 16),
    Hot = (1 << 17),
    Forcing = (1 << 18),
    Debugging = (1 << 19),
    Warm = (1 << 20),
    StartingDelayed = (1 << 21),
    DcgNotPossible = (1 << 30),
    DcgRealTimeViolation = (1U << 31),
    ClearMask = StateMask | Hot | Warm | Changing | Forcing | Debugging,
    RemainingMask = StateMask | Hot | Warm | Forcing | Debugging | Warning | Error | FatalError,
};
 
// global stream operators of enum PlcState for logging and parsing
ARP_CXX_SYMBOL_EXPORT std::ostream& operator<<(std::ostream& os, PlcState value);
ARP_CXX_SYMBOL_EXPORT std::istream& operator>>(std::istream& is, PlcState& value);
 
// global logical operators of enum PlcState
inline constexpr PlcState operator&(PlcState lhs, PlcState rhs)
{
    using U = std::underlying_type<PlcState>::type;
    return static_cast<PlcState>(static_cast<U>(lhs) & static_cast<U>(rhs));
}
 
inline constexpr PlcState operator|(PlcState lhs, PlcState rhs)
{
    using U = std::underlying_type<PlcState>::type;
    return static_cast<PlcState>(static_cast<U>(lhs) | static_cast<U>(rhs));
}
 
inline PlcState& operator&=(PlcState& lhs, PlcState rhs)
{
    lhs = lhs & rhs;
    return lhs;
}
 
inline PlcState& operator|=(PlcState& lhs, PlcState rhs)
{
    lhs = lhs | rhs;
    return lhs;
}
 
inline PlcState operator~(PlcState arg)
{
    using U = std::underlying_type<PlcState>::type;
    return static_cast<PlcState>(~static_cast<U>(arg));
}
 
}}}} // end of namespace Arp::Plc::Commons::Domain