UOperatingSystemCmdCollection

#include <OperatingSystemSimulator/Public/Misc/OperatingSystemCmdCollection.h>

class UOperatingSystemCmdCollection

Defined in OperatingSystemCmdCollection.h:21

Inherits: UDataAsset

Inheritance diagram

---
config:
  class:
    hideEmptyMembersBox: true
---
classDiagram
  class UOperatingSystemCmdCollection["UOperatingSystemCmdCollection"]
  class UDataAsset["UDataAsset"]
  UDataAsset <|-- UOperatingSystemCmdCollection

Collaboration diagram

---
config:
  class:
    hideEmptyMembersBox: true
---
classDiagram
  class UOperatingSystemCmdCollection["UOperatingSystemCmdCollection"]
  class UOperatingSystemTerminalCommand["UOperatingSystemTerminalCommand"]
  UOperatingSystemCmdCollection *-- UOperatingSystemTerminalCommand

Class detail

---
config:
  class:
    hideEmptyMembersBox: true
---
classDiagram
  class UOperatingSystemCmdCollection {
    +UOperatingSystemCmdCollection()
    +Validate(FGenericError &OutError) const
    +GetCommandClasses() const const TSet< TSoftClassPtr< UOperatingSys
    +Commands : TSet< TSoftClassPtr< UOperatingSystemTer
  }

Data asset that represents a collection of terminal commands for an operating system.

This class is a data asset that stores a collection of terminal command objects for an operating system. Each command object is of type UOperatingSystemTerminalCommand and is represented as a soft class pointer. The collection can be accessed to retrieve the set of command classes.

Public Methods

Return	Name	Description
	`UOperatingSystemCmdCollection`
`void`	`Validate` `const`	Validates the UOperatingSystemCmdCollection object.
`const TSet< TSoftClassPtr< UOperatingSystemTerminalCommand > > &`	`GetCommandClasses` `const`	Returns the set of command classes in the UOperatingSystemCmdCollection object.

UOperatingSystemCmdCollection

UOperatingSystemCmdCollection()

Defined in OperatingSystemCmdCollection.h:38

Validate

const

void Validate(FGenericError & OutError) const

Defined in OperatingSystemCmdCollection.h:54 Validates the UOperatingSystemCmdCollection object.

This method checks if the Commands property of the UOperatingSystemCmdCollection object is empty. If it is empty, an error message is generated and stored in the OutError parameter. This error message indicates that the commands are missing.

Next, this method checks if the Commands property contains any null entries. If it does, an error message is generated and stored in the OutError parameter. This error message indicates that one or more entries in the Commands property is null.

Parameters

OutError The object that holds the error information.

References

Commands
MAKE_ERROR

GetCommandClasses

const

const TSet< TSoftClassPtr< UOperatingSystemTerminalCommand > > & GetCommandClasses() const

Defined in OperatingSystemCmdCollection.h:66 Returns the set of command classes in the UOperatingSystemCmdCollection object.

This method retrieves the command classes from the Commands property of the UOperatingSystemCmdCollection object. The command classes are represented as soft class pointers of type UOperatingSystemTerminalCommand. The method returns a const reference to the set of command classes.

Returns

The set of command classes stored in the Commands property of the UOperatingSystemCmdCollection object.

References

Commands

Protected Attributes

Return	Name	Description
`TSet< TSoftClassPtr< UOperatingSystemTerminalCommand > >`	`Commands`	A set of terminal commands for the operating system.

Commands

TSet< TSoftClassPtr< UOperatingSystemTerminalCommand > > Commands

Defined in OperatingSystemCmdCollection.h:34 A set of terminal commands for the operating system.

This property is used to store a collection of terminal command objects for the operating system. These objects are of type UOperatingSystemTerminalCommand and utilize soft class pointers.