PLCnext API Documentation 26.0.1.58
Application.hpp
1
2//
3// Copyright Phoenix Contact GmbH & Co. KG
4//
6#pragma once
8#include "Arp/Base/Acf/Commons/SystemStateEnum.hpp"
9#include "Arp/Base/Acf/Commons/SystemEventProvider.hpp"
10
11namespace Arp::Base::Acf::Commons
12{
13
16class ARP_EXPORT Application
17{
18public: // Impl forward declaration
19 class Impl;
20
21public: // usings
23
24public: // construction
25 explicit Application(Pimpl pimpl);
26
27 // canonical construction/destruction/assignment
28 Application(const Application& arg) = delete;
29 Application(Application&& arg)noexcept;
30 Application& operator=(const Application& arg) = delete;
33
34public: // setter/getter operations
35 ARP_DEPRECATED("Use Application::GetProcessName() instead.")
36 String GetName(void)const;
37 String GetProcessName(void)const;
38 bool IsMainProcess(void)const;
39 bool IsChildProcess(void)const;
40 SystemStateEnum GetSystemState(void)const;
41 SystemEventProvider& GetSystemEvents(void);
42
43public: // internal operations
44 Impl& GetImpl(void);
45 const Impl& GetImpl(void)const;
46
47private: // Impl fields
48 Pimpl pimpl;
49};
50
51} // end of Arp::Base::Acf::Commons
This class provides some system functionality and infos.
Definition: Application.hpp:17
~Application(void)
Default destructor.
Application & operator=(Application &&arg) noexcept
Default move-assignment operator.
Application(Application &&arg) noexcept
Default move constructor.
This class provides system event handling functionality.
Definition: SystemEventProvider.hpp:21
This wrapper class extends the SystemState enum by some special operations.
Definition: SystemStateEnum.hpp:16
Adapter class to implement PImpl idiom.
Definition: PimplPtr.hxx:15
This class represents the Arp String. The implementation is based on std::string.
Definition: String.hpp:39
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