IOperatingSystemExplorerInterface

#include <OperatingSystemSimulator/Public/Interfaces/OperatingSystemExplorerInterface.h>

class IOperatingSystemExplorerInterface

Defined in OperatingSystemExplorerInterface.h:27

Subclassed by: UOperatingSystemDirectory, UOperatingSystemPartition

Inheritance diagram

---
config:
  class:
    hideEmptyMembersBox: true
---
classDiagram
  class IOperatingSystemExplorerInterface["IOperatingSystemExplorerInterface"]
  class UOperatingSystemDirectory["UOperatingSystemDirectory"]
  IOperatingSystemExplorerInterface <|-- UOperatingSystemDirectory
  class UOperatingSystemPartition["UOperatingSystemPartition"]
  IOperatingSystemExplorerInterface <|-- UOperatingSystemPartition

Class detail

---
config:
  class:
    hideEmptyMembersBox: true
---
classDiagram
  class IOperatingSystemExplorerInterface {
    +GetChildDirectories() const =0 TArray< UOperatingSystemDirectory() * >
    +GetParentExplorerInterface(TScriptInterface< IOperatingSystemExplorerI
    +IsPartition() const =0 bool
    +GetInterfaceDisplayName() const =0 FText
    +FindDirectoryByTag(const FGameplayTag DirectoryTag, const bool bool
    +GetChildDirectory(const FString &TargetChildDirectoryName, co TScriptInterface< IOperatingSystemExplor
    +GetAllFiles(const FString &WithExtension="*") const =0 TArray< UOperatingSystemFile() * >
    +CanCreateNewFile() const =0 bool
    +HasEnoughSpace(const FOperatingSystemSizeInMB &TestSpace)  bool
    +GetOperatingSystem() const =0 UOperatingSystem() *
    +GetFullPath() const =0 TOptional< FString >
    +GetInterfaceFromPath(const FString &NewPath) const =0 TScriptInterface< IOperatingSystemExplor
  }

Interface for an operating system explorer.

This interface defines the functions that should be implemented by an operating system explorer class.

Public Methods

Return	Name	Description
`TArray< UOperatingSystemDirectory * >`	`GetChildDirectories` `virtual` `const`	This method retrieves an array of child directories of the current directory.
`void`	`GetParentExplorerInterface` `virtual` `const`	Retrieves the parent explorer interface. For partition classes, OutInterface will always be null since there is nothing above partition. For directories however OutInterface will either be a parent directory or the parent partition.
`bool`	`IsPartition` `virtual` `const`	Checks whether the object represents a partition or not.
`FText`	`GetInterfaceDisplayName` `virtual` `const`	Retrieves the display name of the interface.
`bool`	`FindDirectoryByTag` `virtual` `const`	Finds a directory by tag.
`TScriptInterface< IOperatingSystemExplorerInterface >`	`GetChildDirectory` `virtual` `const`	Retrieves the child directory with the specified name.
`TArray< UOperatingSystemFile * >`	`GetAllFiles` `virtual` `const`	Returns an array of UOperatingSystemFile objects containing all files in the operating system that match the specified extension.
`bool`	`CanCreateNewFile` `virtual` `const`	Checks whether the current directory can create new files.
`bool`	`HasEnoughSpace` `virtual` `const`	Checks whether the current directory has enough space to accommodate the specified test space.
`UOperatingSystem *`	`GetOperatingSystem` `virtual` `const`	Retrieves the operating system associated with the operating system explorer.
`TOptional< FString >`	`GetFullPath` `virtual` `const`	Retrieves the full path of the current directory.
`TScriptInterface< IOperatingSystemExplorerInterface >`	`GetInterfaceFromPath` `virtual` `const`	Retrieves an interface from a specified path.

GetChildDirectories

virtual const

virtual TArray< UOperatingSystemDirectory * > GetChildDirectories() const

Defined in OperatingSystemExplorerInterface.h:38 This method retrieves an array of child directories of the current directory.

Reimplemented by

GetParentExplorerInterface

virtual const

virtual void GetParentExplorerInterface(TScriptInterface< IOperatingSystemExplorerInterface > & OutInterface) const

Defined in OperatingSystemExplorerInterface.h:46 Retrieves the parent explorer interface. For partition classes, OutInterface will always be null since there is nothing above partition. For directories however OutInterface will either be a parent directory or the parent partition.

Parameters

OutInterface The output parameter to store the parent explorer interface.

Reimplemented by

IsPartition

virtual const

virtual bool IsPartition() const

Defined in OperatingSystemExplorerInterface.h:54 Checks whether the object represents a partition or not.

Returns

true if the object represents a partition, false otherwise.

Reimplemented by

GetInterfaceDisplayName

virtual const

virtual FText GetInterfaceDisplayName() const

Defined in OperatingSystemExplorerInterface.h:62 Retrieves the display name of the interface.

Returns

The display name of the interface as FText.

Reimplemented by

FindDirectoryByTag

virtual const

virtual bool FindDirectoryByTag(const FGameplayTag DirectoryTag, const bool bRecursive, UOperatingSystemDirectory *& OutDirectory) const

Defined in OperatingSystemExplorerInterface.h:73 Finds a directory by tag.

Parameters

DirectoryTag The gameplay tag used to identify the directory.
bRecursive Whether to search recursively in subdirectories.
OutDirectory The output parameter that will hold the found directory.

Returns

True if a directory with the specified tag was found, false otherwise.

Reimplemented by

GetChildDirectory

virtual const

virtual TScriptInterface< IOperatingSystemExplorerInterface > GetChildDirectory(const FString & TargetChildDirectoryName, const bool bRecursive = true) const

Defined in OperatingSystemExplorerInterface.h:84 Retrieves the child directory with the specified name.

Parameters

TargetChildDirectoryName The name of the child directory to retrieve.
bRecursive Indicates whether to search for the child directory recursively. Default is true.

Returns

The child directory with the specified name, if found. Otherwise, returns nullptr.

Reimplemented by

GetAllFiles

virtual const

virtual TArray< UOperatingSystemFile * > GetAllFiles(const FString & WithExtension = "*") const

Defined in OperatingSystemExplorerInterface.h:93 Returns an array of UOperatingSystemFile objects containing all files in the operating system that match the specified extension.

Parameters

WithExtension The extension filter to apply when retrieving files. Defaults to ”*” which retrieves all files.

Returns

An array of UOperatingSystemFile objects representing the files that match the specified extension.

Reimplemented by

CanCreateNewFile

virtual const

virtual bool CanCreateNewFile() const

Defined in OperatingSystemExplorerInterface.h:100 Checks whether the current directory can create new files.

Returns

True if the current directory can create new files, false otherwise.

Reimplemented by

HasEnoughSpace

virtual const

virtual bool HasEnoughSpace(const FOperatingSystemSizeInMB & TestSpace) const

Defined in OperatingSystemExplorerInterface.h:110 Checks whether the current directory has enough space to accommodate the specified test space.

This method checks whether the current directory has enough space to accommodate the specified test space.

Parameters

TestSpace The test space to check, specified as a FOperatingSystemSizeInMB object.

Returns

True if the current directory has enough space, false otherwise.

Reimplemented by

GetOperatingSystem

virtual const

virtual UOperatingSystem * GetOperatingSystem() const

Defined in OperatingSystemExplorerInterface.h:117 Retrieves the operating system associated with the operating system explorer.

Returns

A pointer to the operating system object. Returns nullptr if no operating system is associated.

Reimplemented by

GetFullPath

virtual const

virtual TOptional< FString > GetFullPath() const

Defined in OperatingSystemExplorerInterface.h:126 Retrieves the full path of the current directory.

This method retrieves the full path of the current directory.

Returns

An optional FString containing the full path of the current directory, if available. Otherwise, returns an empty optional.

Reimplemented by

GetInterfaceFromPath

virtual const

virtual TScriptInterface< IOperatingSystemExplorerInterface > GetInterfaceFromPath(const FString & NewPath) const

Defined in OperatingSystemExplorerInterface.h:136 Retrieves an interface from a specified path.

This method retrieves an interface from a specified path. The path is used to locate the desired interface in the operating system.

Parameters

NewPath The path to the interface.

Returns

The interface requested, represented as TScriptInterface<IOperatingSystemExplorerInterface>.