api_docs_2025-0/Commons_2Domain_2PlcStartKind_8hpp_source.html

//

//  Copyright Phoenix Contact GmbH & Co. KG

//

#pragma once

#include "Arp/System/Core/Arp.h"

#include "Arp/System/Core/Enum.hxx"


ARP_DEPRECATED_IGNORE_BEGIN


namespace Arp { namespace Plc { namespace Commons { namespace Domain

{


enum class ARP_DEPRECATED("Use 'Arp::Plc::Domain::Commons::PlcStartKind' instead.") PlcStartKind : uint8

    {

    None = 0,

    Cold = 1,

    Warm = 2,

    Hot = 3,

    RestoreWarm = 4,

};


// global stream operators of enum PlcStartKind for logging and parsing

ARP_CXX_SYMBOL_EXPORT std::ostream& operator<<(std::ostream& os, PlcStartKind value);

ARP_CXX_SYMBOL_EXPORT std::istream& operator>>(std::istream& is, PlcStartKind& value);


}}}} // end of namespace Arp::Plc::Commons::Domain


template<> struct fmt::formatter<Arp::Plc::Commons::Domain::PlcStartKind>: public fmt::ostream_formatter {};


ARP_DEPRECATED_IGNORE_END

Arp.h

Arp::Base::Core::uint8
std::uint8_t uint8
The Arp unsigned integer type of 1 byte size.
Definition: PrimitiveTypes.hpp:25

Arp::Plc::Commons::Domain::PlcState::Warm
@ Warm
The PLC is stopped in warm state, that is the retain data has been restored.

Arp::Plc::Commons::Domain::PlcState::Hot
@ Hot
The PLC is stopped in hot state, that is all data still remains.

Arp::Plc::Domain::Commons::PlcStartKind::RestoreWarm
@ RestoreWarm
Initiates a PLC warm start by restore, i.e. all data is reset to initial values, but retained data is...

Arp::Plc::Domain::Commons::PlcStartKind::Cold
@ Cold
Initiates a PLC cold start, i.e. all data is reset to initial values.

Arp
Root namespace for the PLCnext API

Arp::ARP_DEPRECATED
class ARP_DEPRECATED("Use Arp::Enum<T> instead.") EnumStrings
Deprecated! The class implements an adapter for enums to define the string literals of the enum entri...
Definition: EnumStrings.hxx:38