UOperatingSystemSettingsData

#include <OperatingSystemSimulator/Public/Core/OperatingSystemSettingsData.h>

class UOperatingSystemSettingsData

Defined in OperatingSystemSettingsData.h:19

Inherits: UOperatingSystemDataObject

Inheritance diagram

---
config:
  class:
    hideEmptyMembersBox: true
---
classDiagram
  class UOperatingSystemSettingsData["UOperatingSystemSettingsData"]
  class UOperatingSystemDataObject["UOperatingSystemDataObject"]
  UOperatingSystemDataObject <|-- UOperatingSystemSettingsData

Collaboration diagram

---
config:
  class:
    hideEmptyMembersBox: true
---
classDiagram
  class UOperatingSystemSettingsData["UOperatingSystemSettingsData"]
  class FOperatingSystemSettingModuleInfo["FOperatingSystemSettingModuleInfo"]
  UOperatingSystemSettingsData *-- FOperatingSystemSettingModuleInfo
  class UOperatingSystemSettingModule["UOperatingSystemSettingModule"]
  UOperatingSystemSettingsData *-- UOperatingSystemSettingModule

Class detail

---
config:
  class:
    hideEmptyMembersBox: true
---
classDiagram
  class UOperatingSystemSettingsData {
    +bIsUsingCustomWallpaper : bool
    +WallpaperPath : FString
    +FindSettingModuleFromName(const FText SettingName) const UOperatingSystemSettingModule() *
    +FindSettingModuleFromClass(const TSoftClassPtr< UOperatingSystemSettin UOperatingSystemSettingModule() *
    +FindSettingModuleFromClass() T *
    +GetModuleClasses() const const TMap< FOperatingSystemSettingModul
    +OnValidate(FGenericError &OutError) override
    +ModuleClasses : TMap< FOperatingSystemSettingModuleInfo(
    +Modules : TMap< FString, TObjectPtr< UOperatingSys
  }

This class represents the settings data for the operating system. It contains information about the modules and their settings.

Public Attributes

Return	Name	Description
`bool`	`bIsUsingCustomWallpaper`	Boolean flag indicating whether the user is using a custom wallpaper.
`FString`	`WallpaperPath`	String variable representing the path to the wallpaper.

bIsUsingCustomWallpaper

bool bIsUsingCustomWallpaper

Defined in OperatingSystemSettingsData.h:47 Boolean flag indicating whether the user is using a custom wallpaper.

This variable represents whether the user has set a custom wallpaper for the operating system. If the value is true, the operating system will use the wallpaper specified in the ‘WallpaperPath’ variable. If the value is false, the operating system will use the default wallpaper.

Referenced by

WallpaperPath

FString WallpaperPath

Defined in OperatingSystemSettingsData.h:56 String variable representing the path to the wallpaper.

This variable holds the file path of the wallpaper that the user has set for the operating system. It is used when the user chooses to use a custom wallpaper instead of the default wallpaper. The operating system will use this path to locate and display the custom wallpaper.

Referenced by

Public Methods

Return	Name	Description
`UOperatingSystemSettingModule *`	`FindSettingModuleFromName` `const`	Returns the setting module if it exists for the given name.
`UOperatingSystemSettingModule *`	`FindSettingModuleFromClass` `const`	Returns the setting module if it exists for the given class.
`T *`	`FindSettingModuleFromClass` `inline`	Template method that finds and returns the setting module instance for the given class.
`const TMap< FOperatingSystemSettingModuleInfo, TSoftClassPtr< UOperatingSystemSettingModule > > &`	`GetModuleClasses` `const` `inline`	Returns the map of module classes and their corresponding info.

FindSettingModuleFromName

const

UOperatingSystemSettingModule * FindSettingModuleFromName(const FText SettingName) const

Defined in OperatingSystemSettingsData.h:81 Returns the setting module if it exists for the given name.

Parameters

SettingName Name of the setting module you want to get.

Returns

Valid setting module if it exists or nullptr.

References

Modules

FindSettingModuleFromClass

const

UOperatingSystemSettingModule * FindSettingModuleFromClass(const TSoftClassPtr< UOperatingSystemSettingModule > TestClass) const

Defined in OperatingSystemSettingsData.h:89 Returns the setting module if it exists for the given class.

Parameters

TestClass Class to search for.

Returns

Valid setting module if it exists or nullptr.

Referenced by

Internal_LoadSettings

References

Modules

FindSettingModuleFromClass

inline

template<class T> inline T * FindSettingModuleFromClass()

Defined in OperatingSystemSettingsData.h:103 Template method that finds and returns the setting module instance for the given class.

This method finds and returns the instance of the setting module for the specified class. It is a template method that takes the class type as the template parameter.

Compile will fail if T is not derived from UOperatingSystemSettingModule.

Preconditions

The template parameter T must be derived from UOperatingSystemSettingModule.

Parameters

T The class type of the setting module.

Returns

A pointer to the instance of the setting module if found, or nullptr if not found.

GetModuleClasses

const inline

inline const TMap< FOperatingSystemSettingModuleInfo, TSoftClassPtr< UOperatingSystemSettingModule > > & GetModuleClasses() const

Defined in OperatingSystemSettingsData.h:117 Returns the map of module classes and their corresponding info.

This method returns the map of module classes and their corresponding info. The map is represented by a constant reference to a TMap, where the key is FOperatingSystemSettingModuleInfo and the value is TSoftClassPtr<UOperatingSystemSettingModule>.

Returns

The map of module classes and their corresponding info.

Protected Methods

Return	Name	Description
`void`	`OnValidate` `virtual` `override`	Validates the settings data for the operating system.

OnValidate

virtual override

virtual void OnValidate(FGenericError & OutError) override

Defined in OperatingSystemSettingsData.h:71 Validates the settings data for the operating system.

This method is responsible for validating the settings data for the operating system. It checks if all the required information for each module is provided and if the module classes are valid. If any validation fails, an error is set in the OutError object.

Parameters

OutError Reference to the FGenericError object which holds any error information if validation fails.

References

Reimplements

OnValidate

Private Attributes

Return	Name	Description
`TMap< FOperatingSystemSettingModuleInfo, TSoftClassPtr< UOperatingSystemSettingModule > >`	`ModuleClasses`	Map of modules and their info
`TMap< FString, TObjectPtr< UOperatingSystemSettingModule > >`	`Modules`	Map of modules and their information.

ModuleClasses

TMap< FOperatingSystemSettingModuleInfo, TSoftClassPtr< UOperatingSystemSettingModule > > ModuleClasses

Defined in OperatingSystemSettingsData.h:25 Map of modules and their info

Referenced by

OnValidate

Modules

TMap< FString, TObjectPtr< UOperatingSystemSettingModule > > Modules

Defined in OperatingSystemSettingsData.h:37 Map of modules and their information.

This map stores the modules associated with their corresponding names. Each module is represented by its name and a pointer to UOperatingSystemSettingModule. It is a transient member of UOperatingSystemSettingsData class.

See also: UOperatingSystemSettingModule