FGenericError

#include <OperatingSystemSimulator/Public/OperatingSystemGenericError.h>

Class detail

---
config:
  class:
    hideEmptyMembersBox: true
---
classDiagram
  class FGenericError {
    +ErrorCode : FText
    +ErrorExceptionDescription : FText
    +IsValid() const bool
    +Reset()
    +FGenericError()
    +FGenericError(const FText &ErrorCode)
    +FGenericError(const FText &ErrorCode, const FText &ErrorE
    +bIsValid : bool
  }

Caller impact — IsValid

Documented call sites inside the plugin (31):

flowchart LR
  FGenericError__IsValid["FGenericError::IsValid"]
  UOperatingSystemHDD__AllocatePartition["UOperatingSystemHDD::AllocatePartition"]
  UOperatingSystemHDD__AllocatePartition --> FGenericError__IsValid
  AOperatingSystemPortableDeviceActor__BeginChargingBattery["AOperatingSystemPortableDeviceActor::BeginChargingBattery"]
  AOperatingSystemPortableDeviceActor__BeginChargingBattery --> FGenericError__IsValid
  UOperatingSystemBaseDevice__CheckHardware["UOperatingSystemBaseDevice::CheckHardware"]
  UOperatingSystemBaseDevice__CheckHardware --> FGenericError__IsValid
  UOperatingSystemTerminalCommand__CreateCommand["UOperatingSystemTerminalCommand::CreateCommand"]
  UOperatingSystemTerminalCommand__CreateCommand --> FGenericError__IsValid
  UOperatingSystemDataObject__CreateDataObj["UOperatingSystemDataObject::CreateDataObj"]
  UOperatingSystemDataObject__CreateDataObj --> FGenericError__IsValid
  AOperatingSystemDeviceActor__CreateDevice["AOperatingSystemDeviceActor::CreateDevice"]
  AOperatingSystemDeviceActor__CreateDevice --> FGenericError__IsValid
  UOperatingSystemDirectory__CreateDirectory["UOperatingSystemDirectory::CreateDirectory"]
  UOperatingSystemDirectory__CreateDirectory --> FGenericError__IsValid
  UOperatingSystemFile__CreateFile["UOperatingSystemFile::CreateFile"]
  UOperatingSystemFile__CreateFile --> FGenericError__IsValid
  UOperatingSystemBaseDevice__DeviceCreated["UOperatingSystemBaseDevice::DeviceCreated"]
  UOperatingSystemBaseDevice__DeviceCreated --> FGenericError__IsValid
  UOperatingSystemTerminalCommand__FinishCommand["UOperatingSystemTerminalCommand::FinishCommand"]
  UOperatingSystemTerminalCommand__FinishCommand --> FGenericError__IsValid
  UOperatingSystemMailManager__Internal_SendEmailToUser["UOperatingSystemMailManager::Internal_SendEmailToUser"]
  UOperatingSystemMailManager__Internal_SendEmailToUser --> FGenericError__IsValid
  UOperatingSystemStatics__IsProgramClassCompatibleWithOS["UOperatingSystemStatics::IsProgramClassCompatibleWithOS"]
  UOperatingSystemStatics__IsProgramClassCompatibleWithOS --> FGenericError__IsValid
  AOperatingSystemDeviceActor__K2_CreateDevice["AOperatingSystemDeviceActor::K2_CreateDevice"]
  AOperatingSystemDeviceActor__K2_CreateDevice --> FGenericError__IsValid
  UOperatingSystemBiosWidget__NativeConstruct["UOperatingSystemBiosWidget::NativeConstruct"]
  UOperatingSystemBiosWidget__NativeConstruct --> FGenericError__IsValid
  UOperatingSystemBaseDevice__OnDeviceStartRunning["UOperatingSystemBaseDevice::OnDeviceStartRunning"]
  UOperatingSystemBaseDevice__OnDeviceStartRunning --> FGenericError__IsValid
  UOperatingSystemBiosWidget__OnHardwareError["UOperatingSystemBiosWidget::OnHardwareError"]
  UOperatingSystemBiosWidget__OnHardwareError --> FGenericError__IsValid
  UOperatingSystemSettingsData__OnValidate["UOperatingSystemSettingsData::OnValidate"]
  UOperatingSystemSettingsData__OnValidate --> FGenericError__IsValid
  AOperatingSystemPortableDeviceActor__OnValidate["AOperatingSystemPortableDeviceActor::OnValidate"]
  AOperatingSystemPortableDeviceActor__OnValidate --> FGenericError__IsValid
  UOperatingSystemFile__OpenFile["UOperatingSystemFile::OpenFile"]
  UOperatingSystemFile__OpenFile --> FGenericError__IsValid
  UOperatingSystemStatics__OpenFile["UOperatingSystemStatics::OpenFile"]
  UOperatingSystemStatics__OpenFile --> FGenericError__IsValid
  UOperatingSystemTerminalCommand__ProcessCommand["UOperatingSystemTerminalCommand::ProcessCommand"]
  UOperatingSystemTerminalCommand__ProcessCommand --> FGenericError__IsValid
  UOperatingSystemBankManager__RegisterNewBankAccount["UOperatingSystemBankManager::RegisterNewBankAccount"]
  UOperatingSystemBankManager__RegisterNewBankAccount --> FGenericError__IsValid
  UOperatingSystemMailManager__RegisterNewMailAccount["UOperatingSystemMailManager::RegisterNewMailAccount"]
  UOperatingSystemMailManager__RegisterNewMailAccount --> FGenericError__IsValid
  UOperatingSystemMailManager__ReplyToEmail["UOperatingSystemMailManager::ReplyToEmail"]
  UOperatingSystemMailManager__ReplyToEmail --> FGenericError__IsValid
  UOperatingSystemGameSubsystem__RequestFundsFromBank["UOperatingSystemGameSubsystem::RequestFundsFromBank"]
  UOperatingSystemGameSubsystem__RequestFundsFromBank --> FGenericError__IsValid
  UOperatingSystemMailManager__SendEmail["UOperatingSystemMailManager::SendEmail"]
  UOperatingSystemMailManager__SendEmail --> FGenericError__IsValid
  UOperatingSystemMailManager__SendEmailFromDataTable["UOperatingSystemMailManager::SendEmailFromDataTable"]
  UOperatingSystemMailManager__SendEmailFromDataTable --> FGenericError__IsValid
  AOperatingSystemPortableDeviceActor__SetBattery["AOperatingSystemPortableDeviceActor::SetBattery"]
  AOperatingSystemPortableDeviceActor__SetBattery --> FGenericError__IsValid
  UOperatingSystemBaseDevice__StartOperatingSystem["UOperatingSystemBaseDevice::StartOperatingSystem"]
  UOperatingSystemBaseDevice__StartOperatingSystem --> FGenericError__IsValid
  UOperatingSystemBankManager__TransferFundsToAccount["UOperatingSystemBankManager::TransferFundsToAccount"]
  UOperatingSystemBankManager__TransferFundsToAccount --> FGenericError__IsValid
  UOperatingSystemBankManager__TransferFundsToAnotherAccount["UOperatingSystemBankManager::TransferFundsToAnotherAccount"]
  UOperatingSystemBankManager__TransferFundsToAnotherAccount --> FGenericError__IsValid

Caller impact — Reset

Documented call sites inside the plugin (18):

flowchart LR
  FGenericError__Reset["FGenericError::Reset"]
  UOperatingSystemHDD__AllocatePartition["UOperatingSystemHDD::AllocatePartition"]
  UOperatingSystemHDD__AllocatePartition --> FGenericError__Reset
  UOperatingSystemSettingModule__ConstructSettingModule["UOperatingSystemSettingModule::ConstructSettingModule"]
  UOperatingSystemSettingModule__ConstructSettingModule --> FGenericError__Reset
  AOperatingSystemDeviceActor__CreateDevice["AOperatingSystemDeviceActor::CreateDevice"]
  AOperatingSystemDeviceActor__CreateDevice --> FGenericError__Reset
  UOperatingSystemDirectory__CreateDirectory["UOperatingSystemDirectory::CreateDirectory"]
  UOperatingSystemDirectory__CreateDirectory --> FGenericError__Reset
  UOperatingSystemFile__CreateFile["UOperatingSystemFile::CreateFile"]
  UOperatingSystemFile__CreateFile --> FGenericError__Reset
  UOperatingSystemMailManager__Internal_SendEmailToUser["UOperatingSystemMailManager::Internal_SendEmailToUser"]
  UOperatingSystemMailManager__Internal_SendEmailToUser --> FGenericError__Reset
  UOperatingSystemSettingsData__OnValidate["UOperatingSystemSettingsData::OnValidate"]
  UOperatingSystemSettingsData__OnValidate --> FGenericError__Reset
  UOperatingSystemBankManager__RegisterNewBankAccount["UOperatingSystemBankManager::RegisterNewBankAccount"]
  UOperatingSystemBankManager__RegisterNewBankAccount --> FGenericError__Reset
  UOperatingSystemMailManager__RegisterNewMailAccount["UOperatingSystemMailManager::RegisterNewMailAccount"]
  UOperatingSystemMailManager__RegisterNewMailAccount --> FGenericError__Reset
  UOperatingSystemMailManager__ReplyToEmail["UOperatingSystemMailManager::ReplyToEmail"]
  UOperatingSystemMailManager__ReplyToEmail --> FGenericError__Reset
  UOperatingSystemGameSubsystem__RequestFundsFromBank["UOperatingSystemGameSubsystem::RequestFundsFromBank"]
  UOperatingSystemGameSubsystem__RequestFundsFromBank --> FGenericError__Reset
  UOperatingSystemStatics__RestartOperatingSystem["UOperatingSystemStatics::RestartOperatingSystem"]
  UOperatingSystemStatics__RestartOperatingSystem --> FGenericError__Reset
  UOperatingSystemMailManager__SendEmailFromDataTable["UOperatingSystemMailManager::SendEmailFromDataTable"]
  UOperatingSystemMailManager__SendEmailFromDataTable --> FGenericError__Reset
  AOperatingSystemPortableDeviceActor__SetBattery["AOperatingSystemPortableDeviceActor::SetBattery"]
  AOperatingSystemPortableDeviceActor__SetBattery --> FGenericError__Reset
  UOperatingSystemStatics__ShutdownOperatingSystem["UOperatingSystemStatics::ShutdownOperatingSystem"]
  UOperatingSystemStatics__ShutdownOperatingSystem --> FGenericError__Reset
  UOperatingSystemBaseDevice__StartOperatingSystem["UOperatingSystemBaseDevice::StartOperatingSystem"]
  UOperatingSystemBaseDevice__StartOperatingSystem --> FGenericError__Reset
  UOperatingSystemBankManager__TransferFundsToAccount["UOperatingSystemBankManager::TransferFundsToAccount"]
  UOperatingSystemBankManager__TransferFundsToAccount --> FGenericError__Reset
  UOperatingSystemBankManager__TransferFundsToAnotherAccount["UOperatingSystemBankManager::TransferFundsToAnotherAccount"]
  UOperatingSystemBankManager__TransferFundsToAnotherAccount --> FGenericError__Reset

struct FGenericError

Defined in OperatingSystemGenericError.h:12 Represents a generic error with an error code and an optional exception description.

Public Attributes

Return	Name	Description
FText	ErrorCode	Typically an error code like ERR_SOMETHING_HAPPENED or 0x77000111 etc.
FText	ErrorExceptionDescription	Optional exception description.

---

ErrorCode

FText ErrorCode

Defined in OperatingSystemGenericError.h:18 Typically an error code like ERR_SOMETHING_HAPPENED or 0x77000111 etc.

---

ErrorExceptionDescription

FText ErrorExceptionDescription

Defined in OperatingSystemGenericError.h:22 Optional exception description.

Referenced by

• AllocatePartition
• BeginChargingBattery
• CreateDevice
• CreateFile
• Internal_SendEmailToUser
• RegisterNewBankAccount
• RegisterNewMailAccount
• ReplyToEmail
• RequestFundsFromBank
• SendEmailFromDataTable
• SetBattery
• TransferFundsToAccount
• TransferFundsToAnotherAccount

Public Methods

Return	Name	Description
bool	IsValid const inline	Checks if the struct is valid.
void	Reset inline	Resets the ErrorCode, ErrorExceptionDescription, and bIsValid members of the FGenericError struct.
	FGenericError inline	Default constructor for FGenericError. Initializes the ErrorCode, ErrorExceptionDescription, and bIsValid members.
	FGenericError inline explicit	Constructs a FGenericError object with the given error code.
	FGenericError inline	Constructs a FGenericError object with the given error code and exception description.

---

IsValid

const inline

inline bool IsValid() const

Defined in OperatingSystemGenericError.h:36 Checks if the struct is valid.

Returns

True if the struct is valid, false otherwise.

Referenced by

• AllocatePartition
• BeginChargingBattery
• CheckHardware
• CreateCommand
• CreateDataObj
• CreateDevice
• CreateDirectory
• CreateFile
• DeviceCreated
• FinishCommand
• Internal_SendEmailToUser
• IsProgramClassCompatibleWithOS
• K2_CreateDevice
• NativeConstruct
• OnDeviceStartRunning
• OnHardwareError
• OnValidate
• OnValidate
• OpenFile
• OpenFile
• ProcessCommand
• RegisterNewBankAccount
• RegisterNewMailAccount
• ReplyToEmail
• RequestFundsFromBank
• SendEmail
• SendEmailFromDataTable
• SetBattery
• StartOperatingSystem
• TransferFundsToAccount
• TransferFundsToAnotherAccount

---

Reset

inline

inline void Reset()

Defined in OperatingSystemGenericError.h:41 Resets the ErrorCode, ErrorExceptionDescription, and bIsValid members of the FGenericError struct.

Referenced by

• AllocatePartition
• ConstructSettingModule
• CreateDevice
• CreateDirectory
• CreateFile
• Internal_SendEmailToUser
• OnValidate
• RegisterNewBankAccount
• RegisterNewMailAccount
• ReplyToEmail
• RequestFundsFromBank
• RestartOperatingSystem
• SendEmailFromDataTable
• SetBattery
• ShutdownOperatingSystem
• StartOperatingSystem
• TransferFundsToAccount
• TransferFundsToAnotherAccount

---

FGenericError

inline

inline FGenericError()

Defined in OperatingSystemGenericError.h:51 Default constructor for FGenericError. Initializes the ErrorCode, ErrorExceptionDescription, and bIsValid members.

---

FGenericError

inline explicit

inline explicit FGenericError(const FText & ErrorCode)

Defined in OperatingSystemGenericError.h:67 Constructs a FGenericError object with the given error code.

Parameters

• ErrorCode The error code to set for the FGenericError object.

This constructor initializes the ErrorCode, ErrorExceptionDescription, and bIsValid members of the FGenericError struct. The bIsValid member is set to true if the ErrorCode is not empty or whitespace, and false otherwise. It also ensures that the ErrorCode is not empty and raises an error if it is.

---

FGenericError

inline

inline FGenericError(const FText & ErrorCode, const FText & ErrorExceptionDescription)

Defined in OperatingSystemGenericError.h:85 Constructs a FGenericError object with the given error code and exception description.

Parameters

• ErrorCode The error code to set for the FGenericError object.

• ErrorExceptionDescription The exception description to set for the FGenericError object.

This constructor initializes the ErrorCode, ErrorExceptionDescription, and bIsValid members of the FGenericError struct. The bIsValid member is set to true if the ErrorCode is not empty or whitespace, and false otherwise. It also ensures that both the ErrorCode and ErrorExceptionDescription are not empty, and raises an error if either of them is empty.

Private Attributes

Return	Name	Description
bool	bIsValid

---

bIsValid

bool bIsValid

Defined in OperatingSystemGenericError.h:27