Operating System Simulator Plugin  3.5.1
Unreal Engine plugin that simulates an Operating System Environment
Loading...
Searching...
No Matches
UOperatingSystemCmdCollection Class Reference

#include "OperatingSystemCmdCollection.h"

Inheritance diagram for UOperatingSystemCmdCollection:
[legend]
Collaboration diagram for UOperatingSystemCmdCollection:
[legend]

Public Member Functions

 UOperatingSystemCmdCollection ()
 
void Validate (FGenericError &OutError) const
 Validates the UOperatingSystemCmdCollection object.
 
const TSet< TSoftClassPtr< UOperatingSystemTerminalCommand > > & GetCommandClasses () const
 Returns the set of command classes in the UOperatingSystemCmdCollection object.
 

Protected Attributes

TSet< TSoftClassPtr< UOperatingSystemTerminalCommand > > Commands
 

Detailed Description

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.

Constructor & Destructor Documentation

◆ UOperatingSystemCmdCollection()

UOperatingSystemCmdCollection::UOperatingSystemCmdCollection ( )

Member Function Documentation

◆ GetCommandClasses()

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

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.
See also
UOperatingSystemCmdCollection, UOperatingSystemTerminalCommand

◆ Validate()

void UOperatingSystemCmdCollection::Validate ( FGenericError & OutError) const

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
OutErrorThe object that holds the error information.
See also
UOperatingSystemCmdCollection, FGenericError

Member Data Documentation

◆ Commands

TSet<TSoftClassPtr<UOperatingSystemTerminalCommand> > UOperatingSystemCmdCollection::Commands
protected

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.


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