PLCnext API Documentation 25.0.2.69
Public Types | Public Member Functions | Static Public Member Functions | Friends | List of all members
Arp::Base::Core::AppDomain Class Reference

This central singleton class provides access to main functionality. More...

#include <AppDomain.hpp>

Public Types

using Instance = AppDomain
 

Public Member Functions

 AppDomain (const AppDomain &arg)=delete
 
 AppDomain (AppDomain &&arg)=delete
 
AppDomainoperator= (const AppDomain &arg)=delete
 
AppDomainoperator= (AppDomain &&arg)=delete
 
 ~AppDomain (void)
 Default destructor.
 
ApplicationGetApplication (void)
 Gets the Acf application object. More...
 
Impl & GetImpl (void)
 For internal use only.
 
const Impl & GetImpl (void) const
 

Static Public Member Functions

static void CreateInstance (ApplicationPtr applicationPtr)
 Creates this singleton instance.
 
static bool IsCreated (void)
 Determines if this singleton instance is created yet. More...
 
static void DisposeInstance (void)
 Disposes this singleton instance. More...
 
static InstanceGetInstance (void)
 Gets a reference of the singleton instance. More...
 
static InstanceGetCurrent (void)
 Gets the singleton instance of this class. More...
 
static void Assign (AppDomain &other)
 DEPRECATED. More...
 

Friends

class Impl
 

Detailed Description

This central singleton class provides access to main functionality.

The singleton instance of this class might be obtained from anywhere in the code by design. The following interfaces are accessible:

Member Function Documentation

◆ Assign()

void Arp::Base::Core::AppDomain::Assign ( AppDomain other)
static

DEPRECATED.

This operation is DEPRECATED and not required any more.

◆ DisposeInstance()

void Arp::Base::Core::AppDomain::DisposeInstance ( void  )
static

Disposes this singleton instance.

Deletes the singleton instance pointer.

◆ GetApplication()

AppDomain::Application & Arp::Base::Core::AppDomain::GetApplication ( void  )

Gets the Acf application object.

Returns
The Acf application object.

◆ GetCurrent()

AppDomain & Arp::Base::Core::AppDomain::GetCurrent ( void  )
static

Gets the singleton instance of this class.

This operation is DEPRECATED, use GetInstance instead.

◆ GetInstance()

AppDomain::Instance & Arp::Base::Core::AppDomain::GetInstance ( void  )
static

Gets a reference of the singleton instance.

Returns
The singleton instance as reference.
Exceptions
ExceptionIf this singleton instance was not created yet.

◆ IsCreated()

bool Arp::Base::Core::AppDomain::IsCreated ( void  )
static

Determines if this singleton instance is created yet.

Returns
true if this singleton was created yet, otherwise false.

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