FOperatingSystemVersion
#include <OperatingSystemSimulator/Public/OperatingSystemVersion.h>Class detail
Section titled “Class detail”---
config:
class:
hideEmptyMembersBox: true
---
classDiagram
class FOperatingSystemVersion {
+IsValid() const bool
+ToString() const FString
+ToString(const bool bIgnorePatch) const FString
+operator==(const FOperatingSystemVersion &Other) const bool
+operator<(const FOperatingSystemVersion &Other) const bool
+operator>(const FOperatingSystemVersion &Other) const bool
+FOperatingSystemVersion()
+FOperatingSystemVersion(const uint8 Major)
+FOperatingSystemVersion(const uint8 Major, const uint8 Minor)
+FOperatingSystemVersion(const uint8 Major, const uint8 Minor, const
+Major : uint8
+Minor : int32
+Patch : int32
+Internal_IsSameVersion(const FOperatingSystemVersion &VersionOne, bool
+Internal_IsVersionOneSmaller(const FOperatingSystemVersion &VersionOne, bool
+Internal_IsVersionTwoSmaller(const FOperatingSystemVersion &VersionOne, bool
+Internal_VersionCompare(const FOperatingSystemVersion &VersionOne, FORCEINLINE_DEBUGGABLE int32
}
Caller impact — ToString
Section titled “Caller impact — ToString”Documented call sites inside the plugin (3):
flowchart LR FOperatingSystemVersion__ToString["FOperatingSystemVersion::ToString"] FOperatingSystemVersion__Internal_VersionCompare["FOperatingSystemVersion::Internal_VersionCompare"] FOperatingSystemVersion__Internal_VersionCompare --> FOperatingSystemVersion__ToString UOperatingSystemSaveGame__SaveGame["UOperatingSystemSaveGame::SaveGame"] UOperatingSystemSaveGame__SaveGame --> FOperatingSystemVersion__ToString UOperatingSystemStatics__VersionToString["UOperatingSystemStatics::VersionToString"] UOperatingSystemStatics__VersionToString --> FOperatingSystemVersion__ToString
struct FOperatingSystemVersionDefined in OperatingSystemVersion.h:14 Represents an operating system version containing major, minor, and patch numbers.
Public Methods
Section titled “Public Methods”| Return | Name | Description |
|---|---|---|
bool | IsValid const inline | Checks if this version is valid. |
FString | ToString const inline | Returns a string representation of the operating system version in the format “MAJOR.MINOR.PATCH”. |
FString | ToString const inline | Returns a string representation of the operating system version. |
bool | operator== const inline | |
bool | operator< const inline | |
bool | operator> const inline | |
FOperatingSystemVersion inline | ||
FOperatingSystemVersion inline explicit | ||
FOperatingSystemVersion inline | ||
FOperatingSystemVersion inline |
IsValid
Section titled “IsValid”const inline
inline bool IsValid() constDefined in OperatingSystemVersion.h:50 Checks if this version is valid.
A version is considered valid if any of the following conditions are met:
-
Major number is greater than 0
-
Minor number is greater than 0
-
Patch number is greater than 0
Returns
Section titled “Returns”True if the version is valid, false otherwise.
Referenced by
Section titled “Referenced by”ToString
Section titled “ToString”const inline
inline FString ToString() constDefined in OperatingSystemVersion.h:75 Returns a string representation of the operating system version in the format “MAJOR.MINOR.PATCH”.
Returns
Section titled “Returns”A string representing the operating system version.
Referenced by
Section titled “Referenced by”ToString
Section titled “ToString”const inline
inline FString ToString(const bool bIgnorePatch) constDefined in OperatingSystemVersion.h:89 Returns a string representation of the operating system version.
This method returns a string representation of the operating system version. If the optional parameter bIgnorePatch is set to true, the patch number will be omitted from the string. The string format is “MAJOR.MINOR.PATCH”.
Parameters
Section titled “Parameters”bIgnorePatch(optional) Whether to ignore the patch number in the string representation. Default isfalse.
Returns
Section titled “Returns”A string representing the operating system version.
operator==
Section titled “operator==”const inline
inline bool operator==(const FOperatingSystemVersion & Other) constDefined in OperatingSystemVersion.h:99
Section titled “Defined in OperatingSystemVersion.h:99”operator<
Section titled “operator<”const inline
inline bool operator<(const FOperatingSystemVersion & Other) constDefined in OperatingSystemVersion.h:104
Section titled “Defined in OperatingSystemVersion.h:104”operator>
Section titled “operator>”const inline
inline bool operator>(const FOperatingSystemVersion & Other) constDefined in OperatingSystemVersion.h:109
Section titled “Defined in OperatingSystemVersion.h:109”FOperatingSystemVersion
Section titled “FOperatingSystemVersion”inline
inline FOperatingSystemVersion()Defined in OperatingSystemVersion.h:171
Section titled “Defined in OperatingSystemVersion.h:171”FOperatingSystemVersion
Section titled “FOperatingSystemVersion”inline explicit
inline explicit FOperatingSystemVersion(const uint8 Major)Defined in OperatingSystemVersion.h:178
Section titled “Defined in OperatingSystemVersion.h:178”FOperatingSystemVersion
Section titled “FOperatingSystemVersion”inline
inline FOperatingSystemVersion(const uint8 Major, const uint8 Minor)Defined in OperatingSystemVersion.h:185
Section titled “Defined in OperatingSystemVersion.h:185”FOperatingSystemVersion
Section titled “FOperatingSystemVersion”inline
inline FOperatingSystemVersion(const uint8 Major, const uint8 Minor, const uint8 Patch)Defined in OperatingSystemVersion.h:192
Private Attributes
Section titled “Private Attributes”| Return | Name | Description |
|---|---|---|
uint8 | Major | The major number represents significant updates or changes. |
int32 | Minor | Represents smaller updates or changes. |
int32 | Patch | An integer value that indicates minor updates. |
uint8 MajorDefined in OperatingSystemVersion.h:24 The major number represents significant updates or changes.
int32 MinorDefined in OperatingSystemVersion.h:30 Represents smaller updates or changes.
int32 PatchDefined in OperatingSystemVersion.h:36 An integer value that indicates minor updates.
Private Static Methods
Section titled “Private Static Methods”| Return | Name | Description |
|---|---|---|
bool | Internal_IsSameVersion static inline | |
bool | Internal_IsVersionOneSmaller static inline | |
bool | Internal_IsVersionTwoSmaller static inline | |
FORCEINLINE_DEBUGGABLE int32 | Internal_VersionCompare static inline |
Internal_IsSameVersion
Section titled “Internal_IsSameVersion”static inline
static inline bool Internal_IsSameVersion(const FOperatingSystemVersion & VersionOne, const FOperatingSystemVersion & VersionTwo)Defined in OperatingSystemVersion.h:116
Section titled “Defined in OperatingSystemVersion.h:116”Internal_IsVersionOneSmaller
Section titled “Internal_IsVersionOneSmaller”static inline
static inline bool Internal_IsVersionOneSmaller(const FOperatingSystemVersion & VersionOne, const FOperatingSystemVersion & VersionTwo)Defined in OperatingSystemVersion.h:121
Section titled “Defined in OperatingSystemVersion.h:121”Internal_IsVersionTwoSmaller
Section titled “Internal_IsVersionTwoSmaller”static inline
static inline bool Internal_IsVersionTwoSmaller(const FOperatingSystemVersion & VersionOne, const FOperatingSystemVersion & VersionTwo)Defined in OperatingSystemVersion.h:126
Section titled “Defined in OperatingSystemVersion.h:126”Internal_VersionCompare
Section titled “Internal_VersionCompare”static inline
static inline FORCEINLINE_DEBUGGABLE int32 Internal_VersionCompare(const FOperatingSystemVersion & VersionOne, const FOperatingSystemVersion & VersionTwo)Defined in OperatingSystemVersion.h:131