NDEVR
API Documentation
ModuleConfiguration

Stores all information relating to a particular feature or resource included by a Module. More...

Inheritance diagram for ModuleConfiguration:
[legend]
Collaboration diagram for ModuleConfiguration:
[legend]

Public Member Functions

 ModuleConfiguration ()
 Constructs a ModuleConfiguration supporting all OS, config, and platform types.
 ModuleConfiguration (const StringView &os_type, const StringView &config_type, const StringView &platform_type)
 Constructs a ModuleConfiguration with specific OS, config, and platform types.
bool neededForConfig (const StringView &os) const
 Checks whether this configuration is needed for the given build configuration.
bool neededForOS (const StringView &os) const
 Checks whether this configuration is needed for the given operating system.
bool neededForPlatform (const StringView &os) const
 Checks whether this configuration is needed for the given CPU platform.

Static Public Member Functions

static String Combine (std::initializer_list< StringView > l)
 Combines multiple StringView values into a single pipe-delimited String.
static StringRemove (String &s, std::initializer_list< StringView > l)
 Removes specified values from a pipe-delimited configuration String.

Public Attributes

String config_type
 The supported build configuration types (pipe-delimited).
String os_type
 The supported operating system types (pipe-delimited).
String platform_type
 The supported CPU platform types (pipe-delimited).

Detailed Description

Stores all information relating to a particular feature or resource included by a Module.


Definition at line 70 of file ModuleResourceManager.h.

Constructor & Destructor Documentation

◆ ModuleConfiguration()

ModuleConfiguration::ModuleConfiguration ( const StringView & os_type,
const StringView & config_type,
const StringView & platform_type )
inline

Constructs a ModuleConfiguration with specific OS, config, and platform types.

Parameters
[in]os_typeThe supported operating system type string.
[in]config_typeThe supported build configuration type string.
[in]platform_typeThe supported CPU platform type string.

Definition at line 86 of file ModuleResourceManager.h.

References config_type, os_type, and platform_type.

Member Function Documentation

◆ Combine()

String ModuleConfiguration::Combine ( std::initializer_list< StringView > l)
static

Combines multiple StringView values into a single pipe-delimited String.

Parameters
[in]lThe list of StringView values to combine.
Returns
A pipe-delimited String containing all provided values.

◆ neededForConfig()

bool ModuleConfiguration::neededForConfig ( const StringView & os) const
inline

Checks whether this configuration is needed for the given build configuration.

Parameters
[in]osThe build configuration identifier to check against.
Returns
True if this configuration supports the specified build configuration.

Definition at line 106 of file ModuleResourceManager.h.

References config_type.

◆ neededForOS()

bool ModuleConfiguration::neededForOS ( const StringView & os) const
inline

Checks whether this configuration is needed for the given operating system.

Parameters
[in]osThe operating system identifier to check against.
Returns
True if this configuration supports the specified OS.

Definition at line 97 of file ModuleResourceManager.h.

References os_type.

◆ neededForPlatform()

bool ModuleConfiguration::neededForPlatform ( const StringView & os) const
inline

Checks whether this configuration is needed for the given CPU platform.

Parameters
[in]osThe platform identifier to check against.
Returns
True if this configuration supports the specified platform.

Definition at line 115 of file ModuleResourceManager.h.

References platform_type.

◆ Remove()

String & ModuleConfiguration::Remove ( String & s,
std::initializer_list< StringView > l )
static

Removes specified values from a pipe-delimited configuration String.

Parameters
[in]sThe String to remove values from.
[in]lThe list of StringView values to remove.
Returns
A reference to the modified String.

The documentation for this struct was generated from the following file: