FOperatingSystemCommandFlag Class Reference

Represents a command flag for the operating system. A command flag must be prefixed by "-" or "--". Examples include "-a", "--info", etc. More...

#include "OperatingSystemTerminalCommand.h"

Public Member Functions
FORCEINLINE bool	operator== (const FOperatingSystemCommandFlag &Other) const
FORCEINLINE bool	IsValid (FString &ErrorReason) const
	Checks if the command flag is valid.
	FOperatingSystemCommandFlag ()

Public Attributes
FName	Flag
bool	bIsRequired
FText	Description

Friends
FORCEINLINE friend uint32	GetTypeHash (const FOperatingSystemCommandFlag &Other)
	Calculates the hash value for a given FOperatingSystemCommandFlag object.

Detailed Description

Represents a command flag for the operating system. A command flag must be prefixed by "-" or "--". Examples include "-a", "--info", etc.

Constructor & Destructor Documentation

FOperatingSystemCommandFlag()

FOperatingSystemCommandFlag::FOperatingSystemCommandFlag ( )

inline

Member Function Documentation

IsValid()

FORCEINLINE bool FOperatingSystemCommandFlag::IsValid ( FString & ErrorReason ) const

inline

Checks if the command flag is valid.

Parameters

ErrorReason

[out] A reference to a FString that stores the reason why the command flag is not valid.

Returns

True if the command flag is valid, false otherwise.

operator==()

FORCEINLINE bool FOperatingSystemCommandFlag::operator== ( const FOperatingSystemCommandFlag & Other ) const

inline

Friends And Related Symbol Documentation

GetTypeHash

FORCEINLINE friend uint32 GetTypeHash ( const FOperatingSystemCommandFlag & Other )

friend

Calculates the hash value for a given FOperatingSystemCommandFlag object.

Parameters

Other

The FOperatingSystemCommandFlag object for which to calculate the hash value.

Returns

The calculated hash value.

Member Data Documentation

bIsRequired

bool FOperatingSystemCommandFlag::bIsRequired

True if this flag is required. Command will not process if this flag is missing.

Description

FText FOperatingSystemCommandFlag::Description

Help description.

Flag

FName FOperatingSystemCommandFlag::Flag

Command flag. Must be prefixed by - or –. Example -a, –info etc.

---

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

• Source/OperatingSystemSimulator/Public/Programs/Terminal/OperatingSystemTerminalCommand.h