PLCnext API Documentation 25.0.2.69
Public Types | Public Member Functions | List of all members
Arp::System::Commons::Runtime::ProcessConfiguration Class Reference

This class contains all information of the process configuration. More...

#include <ProcessConfiguration.hpp>

Public Types

using Capabilities = std::vector< Capability >
 

Public Member Functions

 ProcessConfiguration (void)=default
 The default constructor.
 
 ProcessConfiguration (const String &userName, const String &groupName, const Capabilities &capabilities)
 Constructs an instance of ProcessConfiguration with all members. More...
 
const StringGetUserName (void) const &
 Gets the user name of this configuration. More...
 
const StringGetUserName (void) const &&=delete
 
const StringGetGroupName (void) const &
 Gets the group name of this configuration. More...
 
const StringGetGroupName (void) const &&=delete
 
const Capabilities & GetCapabilities (void) const &
 Gets the capabilities of this configuration. More...
 
const Capabilities & GetCapabilities (void) const &&=delete
 

Detailed Description

This class contains all information of the process configuration.

Constructor & Destructor Documentation

◆ ProcessConfiguration()

Arp::System::Commons::Runtime::ProcessConfiguration::ProcessConfiguration ( const String userName,
const String groupName,
const Capabilities &  capabilities 
)

Constructs an instance of ProcessConfiguration with all members.

Parameters
userNameName of user the process shall start with.
groupNameName of group the process shall start with.
capabilitiesCapabilities that shall be set for the process.

Member Function Documentation

◆ GetCapabilities()

const ProcessConfiguration::Capabilities & Arp::System::Commons::Runtime::ProcessConfiguration::GetCapabilities ( void  ) const &

Gets the capabilities of this configuration.

Returns
The capabilities of this configuration.

◆ GetGroupName()

const String & Arp::System::Commons::Runtime::ProcessConfiguration::GetGroupName ( void  ) const &

Gets the group name of this configuration.

Returns
The group name of this configuration.

◆ GetUserName()

const String & Arp::System::Commons::Runtime::ProcessConfiguration::GetUserName ( void  ) const &

Gets the user name of this configuration.

Returns
The user name of this configuration.

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