FOperatingSystemCommandFlag

#include <OperatingSystemSimulator/Public/Programs/Terminal/OperatingSystemTerminalCommand.h>

Class detail

---
config:
  class:
    hideEmptyMembersBox: true
---
classDiagram
  class FOperatingSystemCommandFlag {
    +Flag : FName
    +bIsRequired : bool
    +Description : FText
    +operator==(const FOperatingSystemCommandFlag &Other) c bool
    +IsValid(FString &ErrorReason) const bool
    +FOperatingSystemCommandFlag()
  }

class FOperatingSystemCommandFlag

Defined in OperatingSystemTerminalCommand.h:21 Represents a command flag for the operating system. A command flag must be prefixed by ”-” or ”—”. Examples include “-a”, “—info”, etc.

Friends

Name	Description
`GetTypeHash` `inline`	Calculates the hash value for a given FOperatingSystemCommandFlag object.

GetTypeHash

inline

friend inline uint32 GetTypeHash(const FOperatingSystemCommandFlag & Other)

Defined in OperatingSystemTerminalCommand.h:69 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.

Public Attributes

Return	Name	Description
`FName`	`Flag`	Command flag. Must be prefixed by - or –. Example -a, –info etc.
`bool`	`bIsRequired`	True if this flag is required. Command will not process if this flag is missing.
`FText`	`Description`	Help description.

Flag

FName Flag

Defined in OperatingSystemTerminalCommand.h:27 Command flag. Must be prefixed by - or –. Example -a, –info etc.

Referenced by

operator==

bIsRequired

bool bIsRequired

Defined in OperatingSystemTerminalCommand.h:31 True if this flag is required. Command will not process if this flag is missing.

Description

FText Description

Defined in OperatingSystemTerminalCommand.h:35 Help description.

Public Methods

Return	Name	Description
`bool`	`operator==` `const` `inline`
`bool`	`IsValid` `const` `inline`	Checks if the command flag is valid.
	`FOperatingSystemCommandFlag` `inline`

operator==

const inline

inline bool operator==(const FOperatingSystemCommandFlag & Other) const

Defined in OperatingSystemTerminalCommand.h:37

References

IsValid

const inline

inline bool IsValid(FString & ErrorReason) const

Defined in OperatingSystemTerminalCommand.h:45 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.

References

FOperatingSystemCommandFlag

inline

inline FOperatingSystemCommandFlag()

Defined in OperatingSystemTerminalCommand.h:74