UOperatingSystemBaseHardware

#include <OperatingSystemSimulator/Public/Hardware/OperatingSystemBaseHardware.h>

class UOperatingSystemBaseHardware

Defined in OperatingSystemBaseHardware.h:19

Inherits: UObject Subclassed by: UOperatingSystemCPU, UOperatingSystemGPU, UOperatingSystemHDD, UOperatingSystemMBB, UOperatingSystemPSU, UOperatingSystemRAM

Inheritance diagram

---
config:
  class:
    hideEmptyMembersBox: true
---
classDiagram
  class UOperatingSystemBaseHardware["UOperatingSystemBaseHardware"]
  class UObject["UObject"]
  UObject <|-- UOperatingSystemBaseHardware
  class UOperatingSystemCPU["UOperatingSystemCPU"]
  UOperatingSystemBaseHardware <|-- UOperatingSystemCPU
  class UOperatingSystemGPU["UOperatingSystemGPU"]
  UOperatingSystemBaseHardware <|-- UOperatingSystemGPU
  class UOperatingSystemHDD["UOperatingSystemHDD"]
  UOperatingSystemBaseHardware <|-- UOperatingSystemHDD
  class UOperatingSystemMBB["UOperatingSystemMBB"]
  UOperatingSystemBaseHardware <|-- UOperatingSystemMBB
  class UOperatingSystemPSU["UOperatingSystemPSU"]
  UOperatingSystemBaseHardware <|-- UOperatingSystemPSU
  class UOperatingSystemRAM["UOperatingSystemRAM"]
  UOperatingSystemBaseHardware <|-- UOperatingSystemRAM

Class detail

---
config:
  class:
    hideEmptyMembersBox: true
---
classDiagram
  class UOperatingSystemBaseHardware {
    +UOperatingSystemBaseHardware()
    +GetHardwareName() const FText
    +GetHardwareMadeBy() const FText
    +GetModelNumber() const FText
    +GetHardwareNameAsString() const FString
    +GetHardwareTag() const FGameplayTag
    +Name : FText
    +MadeBy : FText
    +ModelNumber : FText
    +HardwareTag : FGameplayTag
    +bHasBlueprintValidateFunction : bool
    +Validate(FGenericError &OutError) const bool
    +OnValidate(FGenericError &OutError) const bool
    +K2_OnValidate(FGenericError &OutError) const bool
    +K2_OnValidate_Implementation(FGenericError &OutError) const bool
  }

Base class for operating system hardware.

This class represents a base class for operating system hardware objects. It contains properties and methods that are common for all types of hardware.

Public Methods

Return	Name	Description
	`UOperatingSystemBaseHardware`
`FText`	`GetHardwareName` `const` `inline`	Returns the name of the hardware.
`FText`	`GetHardwareMadeBy` `const` `inline`	Retrieves the manufacturer of the hardware.
`FText`	`GetModelNumber` `const` `inline`	This method returns the model number of the hardware.
`FString`	`GetHardwareNameAsString` `const` `inline`	Returns the name of the hardware as a string.
`FGameplayTag`	`GetHardwareTag` `const` `inline`	Returns the hardware tag associated with the hardware object.

UOperatingSystemBaseHardware

UOperatingSystemBaseHardware()

Defined in OperatingSystemBaseHardware.h:45

GetHardwareName

const inline

inline FText GetHardwareName() const

Defined in OperatingSystemBaseHardware.h:95 Returns the name of the hardware.

Returns

The name of the hardware as a FText object.

GetHardwareMadeBy

const inline

inline FText GetHardwareMadeBy() const

Defined in OperatingSystemBaseHardware.h:103 Retrieves the manufacturer of the hardware.

Returns

The manufacturer of the hardware as a text string.

GetModelNumber

const inline

inline FText GetModelNumber() const

Defined in OperatingSystemBaseHardware.h:111 This method returns the model number of the hardware.

Returns

The model number of the hardware as a FText object.

GetHardwareNameAsString

const inline

inline FString GetHardwareNameAsString() const

Defined in OperatingSystemBaseHardware.h:120 Returns the name of the hardware as a string.

This method returns the name of the hardware object as a string. It converts the FText value of the name property to a string and returns it.

Returns

The name of the hardware as a string.

GetHardwareTag

const inline

inline FGameplayTag GetHardwareTag() const

Defined in OperatingSystemBaseHardware.h:131 Returns the hardware tag associated with the hardware object.

This method returns the hardware tag associated with the hardware object. The hardware tag is a unique identifier that can be used to distinguish between different types of hardware. It is represented as a FGameplayTag object.

Returns

The hardware tag associated with the hardware object.

Protected Attributes

Return	Name	Description
`FText`	`Name`	Name of this hardware.
`FText`	`MadeBy`	Which company made this?
`FText`	`ModelNumber`	A model number.
`FGameplayTag`	`HardwareTag`	A tag that identifies this hardware
`bool`	`bHasBlueprintValidateFunction`

Name

FText Name

Defined in OperatingSystemBaseHardware.h:27 Name of this hardware.

Referenced by

MadeBy

FText MadeBy

Defined in OperatingSystemBaseHardware.h:31 Which company made this?

ModelNumber

FText ModelNumber

Defined in OperatingSystemBaseHardware.h:35 A model number.

HardwareTag

FGameplayTag HardwareTag

Defined in OperatingSystemBaseHardware.h:39 A tag that identifies this hardware

Referenced by

bHasBlueprintValidateFunction

bool bHasBlueprintValidateFunction

Defined in OperatingSystemBaseHardware.h:41

Referenced by

UOperatingSystemBaseHardware
Validate

Protected Methods

Return	Name	Description
`bool`	`Validate` `const`	Validates the current state of the operating system hardware object.
`bool`	`OnValidate` `virtual` `const`	This method is called to validate the current state of the object.
`bool`	`K2_OnValidate` `const`	This method is called to validate the current state of the object. It is a BlueprintNativeEvent, which means that it can be overridden in Blueprint subclasses. You must NOT call super (or parent in Blueprint) on this event since native event will always return false.

Validate

const

bool Validate(FGenericError & OutError) const

Defined in OperatingSystemBaseHardware.h:61 Validates the current state of the operating system hardware object.

This method is called to validate the current state of the operating system hardware object. It checks if the name and tag of the hardware are valid, and optionally calls the K2_On Validate or OnValidate method to perform additional validation.

You must NOT call super (or parent in Blueprint) on this event since native event will always return false.

Parameters

OutError A reference to a FGenericError object to receive any error messages if the validation fails.

Returns

true if the object’s state is valid, false otherwise.

References

bHasBlueprintValidateFunction
HardwareTag
IsOperatingSystemTagValid
K2_OnValidate
MAKE_ERROR
Name
OnValidate

OnValidate

virtual const

virtual bool OnValidate(FGenericError & OutError) const

Defined in OperatingSystemBaseHardware.h:69 This method is called to validate the current state of the object.

Parameters

OutError A reference to a FGenericError object to receive any error messages if the validation fails.

Returns

true if the object’s state is valid, false otherwise.

Referenced by

K2_OnValidate_Implementation
Validate

References

MAKE_ERROR

Reimplemented by

K2_OnValidate

const

bool K2_OnValidate(FGenericError & OutError) const

Defined in OperatingSystemBaseHardware.h:80 This method is called to validate the current state of the object. It is a BlueprintNativeEvent, which means that it can be overridden in Blueprint subclasses. You must NOT call super (or parent in Blueprint) on this event since native event will always return false.

Parameters

OutError A reference to a FGenericError object to receive any error messages if the validation fails.

Returns

true if the object’s state is valid, false otherwise.

Referenced by

UOperatingSystemBaseHardware
Validate

Private Methods

Return	Name	Description
`bool`	`K2_OnValidate_Implementation` `const`

K2_OnValidate_Implementation

const

bool K2_OnValidate_Implementation(FGenericError & OutError) const

Defined in OperatingSystemBaseHardware.h:85

References

OnValidate