Arp::Base::Acf::Commons::Application Class Reference

This class provides some system functionality and infos. More...

#include <Application.hpp>

Public Types
using	Pimpl = PimplPtr< Impl >
	The Impl pointer type.

Public Member Functions
	Application (Pimpl pimpl)
	Constructs an Application instance. More...
	Application (const Application &arg)=delete
	Application (Application &&arg) noexcept
	Default move constructor. More...
Application &	operator= (const Application &arg)=delete
Application &	operator= (Application &&arg) noexcept
	Default move-assignment operator. More...
	~Application (void)
	Default destructor.
String	GetName (void) const
	Gets the name of the current process. More...
String	GetProcessName (void) const
	Gets the name of the current process. More...
bool	IsMainProcess (void) const
	Determines if the current process is the main process. More...
bool	IsChildProcess (void) const
	Determines if the current process is a child process. More...
SystemStateEnum	GetSystemState (void) const
	Gets the actual system state. More...
SystemEventProvider &	GetSystemEvents (void)
	Gets the provider of system events. More...
Impl &	GetImpl (void)
	For internal use only. More...
const Impl &	GetImpl (void) const

Detailed Description

This class provides some system functionality and infos.

The Application class is the code pendant to an Arp process.

Constructor & Destructor Documentation

Application() [1/2]

Arp::Base::Acf::Commons::Application::Application ( Pimpl  pimpl )

explicit

Constructs an Application instance.

Parameters

pimpl

The implementation pointer of this instance.

Application() [2/2]

Arp::Base::Acf::Commons::Application::Application ( Application &&  arg )

defaultnoexcept

Default move constructor.

Parameters

arg	The argument to move.

Member Function Documentation

GetImpl()

const Application::Impl & Arp::Base::Acf::Commons::Application::GetImpl

(

void

)

For internal use only.

Returns

This implementation instance.

GetName()

String Arp::Base::Acf::Commons::Application::GetName

(

void

)

const

Gets the name of the current process.

Returns

The name of the current process

This operation is DEPRECATED, use GetProcessName instead.

GetProcessName()

String Arp::Base::Acf::Commons::Application::GetProcessName

(

void

)

const

Gets the name of the current process.

Returns

The name of the current process

GetSystemEvents()

SystemEventProvider & Arp::Base::Acf::Commons::Application::GetSystemEvents

(

void

)

Gets the provider of system events.

Returns

The system events provider.

The system events might be used to consume special system events while registering specific delegates.

GetSystemState()

SystemStateEnum Arp::Base::Acf::Commons::Application::GetSystemState

(

void

)

const

Gets the actual system state.

Returns

The actual system state.

IsChildProcess()

bool Arp::Base::Acf::Commons::Application::IsChildProcess

(

void

)

const

Determines if the current process is a child process.

Returns

true if the current process is a child process, otherwise false.

IsMainProcess()

bool Arp::Base::Acf::Commons::Application::IsMainProcess

(

void

)

const

Determines if the current process is the main process.

Returns

true if the current process is the main process, otherwise false.

operator=()

Application & Arp::Base::Acf::Commons::Application::operator= ( Application &&  arg )

defaultnoexcept

Default move-assignment operator.

Parameters

arg	The argument to move.

Returns

This instance.

---

The documentation for this class was generated from the following files:

• Arp/Base/Acf/Commons/Application.hpp
• Arp/Base/Acf/Commons/Application.cpp