PlcManager.h

/******************************************************************************
 *
//  Copyright Phoenix Contact GmbH & Co. KG
 *
 *****************************************************************************/
#ifndef __APRPLCDOMAIN_PLCMANAGER_H
#define __APRPLCDOMAIN_PLCMANAGER_H
 
/*************************************************************************/
/*  INCLUDES                                                             */
/*************************************************************************/
#include "Arp/Plc/AnsiC/ArpPlc.h"
 
/*************************************************************************/
/*  DEFINES                                                              */
/*************************************************************************/
 
#ifdef __cplusplus
extern "C"
{
#endif /*__cplusplus*/
 
// PlcStartKind
typedef enum
{
    PlcStartKind_Cold = 1,
    PlcStartKind_Warm = 2,
    PlcStartKind_Hot = 3,
    PlcStartKind_RestoreWarm = 4,
} TPlcStartKind;
 
 
// PlcState
typedef enum
{
    PlcState_None = 0,
    PlcState_Ready = 1,
    PlcState_Stop = 2,
    PlcState_Running = 3,
    PlcState_Halt = 4,
    PlcState_StateMask = 0x3F,
    /* error/warning flags */
    PlcState_Warning = (1 << 6),
    PlcState_Error = (1 << 7),
    PlcState_SuspendedBySwitch = (1 << 8), /* Deprecated since 2022.0! Please use "PlcState_Suspended" instead */
    PlcState_Suspended = (1 << 8),
    PlcState_FatalError = (1 << 9),
    PlcState_Blocked = (1 << 10),
    /* combined hint flags */
    PlcState_Changing = (1 << 16),
    /* combined flags usually with PlcState_Running */
    PlcState_DcgNotPossible = (1 << 30),
    PlcState_DcgRealTimeViolation = (1U << 31)
 
} TPlcState;
 
/*************************************************************************/
/*    GLOBAL FUNCTION DECLARATIONS (EXTERNAL)                            */
/*************************************************************************/
 
 
extern ARP_C_SYMBOL_EXPORT bool ArpPlcDomain_Load(void);
 
extern ARP_C_SYMBOL_EXPORT bool ArpPlcDomain_Start(TPlcStartKind plcStartKind);
 
extern ARP_C_SYMBOL_EXPORT bool ArpPlcDomain_Stop(void);
 
extern ARP_C_SYMBOL_EXPORT bool ArpPlcDomain_Reset(void);
 
extern ARP_C_SYMBOL_EXPORT TPlcState ArpPlcDomain_GetPlcState(void);
 
#ifdef __cplusplus
} /*extern "C"*/
#endif /*__cplusplus*/
 
#endif /*__APRPLCDOMAIN_PLCMANAGER_H*/