UOperatingSystemSimulatedNetworkSubsystem

#include <OperatingSystemSimulator/Public/Subsystems/OperatingSystemSimulatedNetworkSubsystem.h>

class UOperatingSystemSimulatedNetworkSubsystem

Defined in OperatingSystemSimulatedNetworkSubsystem.h:19

Inherits: UWorldSubsystem

Inheritance diagram

---
config:
  class:
    hideEmptyMembersBox: true
---
classDiagram
  class UOperatingSystemSimulatedNetworkSubsystem["UOperatingSystemSimulatedNetworkSubsystem"]
  class UWorldSubsystem["UWorldSubsystem"]
  UWorldSubsystem <|-- UOperatingSystemSimulatedNetworkSubsystem

Collaboration diagram

---
config:
  class:
    hideEmptyMembersBox: true
---
classDiagram
  class UOperatingSystemSimulatedNetworkSubsystem["UOperatingSystemSimulatedNetworkSubsystem"]
  class FOperatingSystemSimulatedNetworkProxy["FOperatingSystemSimulatedNetworkProxy"]
  UOperatingSystemSimulatedNetworkSubsystem *-- FOperatingSystemSimulatedNetworkProxy
  class FOperatingSystemSimulatedNetwork["FOperatingSystemSimulatedNetwork"]
  UOperatingSystemSimulatedNetworkSubsystem *-- FOperatingSystemSimulatedNetwork

Class detail

---
config:
  class:
    hideEmptyMembersBox: true
---
classDiagram
  class UOperatingSystemSimulatedNetworkSubsystem {
    +OnOperatingSystemSimulatedNetworkCreated : FOnOperatingSystemSimulatedNetworkCreate
    +OnOperatingSystemSimulatedNetworkDeviceConnected : FOnOperatingSystemSimulatedNetworkDevice
    +OnOperatingSystemSimulatedNetworkDeviceDisconnected : FOnOperatingSystemSimulatedNetworkDevice
    +OnOperatingSystemSimulatedNetworkDeviceForget : FOnOperatingSystemSimulatedNetworkDevice
    +OnOperatingSystemSimulatedNetworkLocationUpdated : FOnOperatingSystemSimulatedNetworkLocati
    +OnOperatingSystemSimulatedNetworkRemoved : FOnOperatingSystemSimulatedNetworkRemove
    +DoesSupportWorldType(const EWorldType::Type WorldType) const ove bool
    +UpdateNetworkLocation(const FOperatingSystemSimulatedNetwork &Tar bool
    +GetAllSimulatedNetworks() const const TArray< FOperatingSystemSimulatedN
    +AddSimulatedNetworks(UOperatingSystemSimulatedNetworkProviderCom
    +RemoveSimulatedNetworks(UOperatingSystemSimulatedNetworkProviderCom
    +ConnectDeviceToNetwork(UOperatingSystemBaseDevice *TargetDevice, c bool
    +DisconnectDeviceFromNetwork(UOperatingSystemBaseDevice *TargetDevice) c bool
    +ForgetNetwork(UOperatingSystemBaseDevice *TargetDevice, c bool
    +Get(const UObject *WorldContextObject) UOperatingSystemSimulatedNetworkSubsyste
    +IsSameNetwork(const FOperatingSystemSimulatedNetwork &A,  bool
    +IsDeviceConnectedToNetwork(UOperatingSystemBaseDevice *TargetDevice, F bool
    +SimulatedNetworks : TSet< FOperatingSystemSimulatedNetworkPr
    +Networks : TArray< FOperatingSystemSimulatedNetwork
  }

Caller impact — Get

Documented call sites inside the plugin (9):

flowchart LR
  UOperatingSystemSimulatedNetworkSubsystem__Get["UOperatingSystemSimulatedNetworkSubsystem::Get"]
  UOperatingSystemSimulatedNetworkProviderComponent__Activate["UOperatingSystemSimulatedNetworkProviderComponent::Activate"]
  UOperatingSystemSimulatedNetworkProviderComponent__Activate --> UOperatingSystemSimulatedNetworkSubsystem__Get
  UOperatingSystemBaseDevice__ConnectToNetwork["UOperatingSystemBaseDevice::ConnectToNetwork"]
  UOperatingSystemBaseDevice__ConnectToNetwork --> UOperatingSystemSimulatedNetworkSubsystem__Get
  UOperatingSystemSimulatedNetworkProviderComponent__Deactivate["UOperatingSystemSimulatedNetworkProviderComponent::Deactivate"]
  UOperatingSystemSimulatedNetworkProviderComponent__Deactivate --> UOperatingSystemSimulatedNetworkSubsystem__Get
  UOperatingSystemBaseDevice__DisconnectFromNetwork["UOperatingSystemBaseDevice::DisconnectFromNetwork"]
  UOperatingSystemBaseDevice__DisconnectFromNetwork --> UOperatingSystemSimulatedNetworkSubsystem__Get
  UOperatingSystemBaseDevice__Internal_DestroyDevice["UOperatingSystemBaseDevice::Internal_DestroyDevice"]
  UOperatingSystemBaseDevice__Internal_DestroyDevice --> UOperatingSystemSimulatedNetworkSubsystem__Get
  UOperatingSystemBaseDevice__Internal_OnNetworkLocationUpdated["UOperatingSystemBaseDevice::Internal_OnNetworkLocationUpdated"]
  UOperatingSystemBaseDevice__Internal_OnNetworkLocationUpdated --> UOperatingSystemSimulatedNetworkSubsystem__Get
  UOperatingSystemBaseDevice__Internal_OnNetworkRemoved["UOperatingSystemBaseDevice::Internal_OnNetworkRemoved"]
  UOperatingSystemBaseDevice__Internal_OnNetworkRemoved --> UOperatingSystemSimulatedNetworkSubsystem__Get
  UOperatingSystemBaseDevice__SetCanConnectToNetwork["UOperatingSystemBaseDevice::SetCanConnectToNetwork"]
  UOperatingSystemBaseDevice__SetCanConnectToNetwork --> UOperatingSystemSimulatedNetworkSubsystem__Get
  UOperatingSystemSimulatedNetworkProviderComponent__UpdateAllNetworkLocations["UOperatingSystemSimulatedNetworkProviderComponent::UpdateAllNetworkLocations"]
  UOperatingSystemSimulatedNetworkProviderComponent__UpdateAllNetworkLocations --> UOperatingSystemSimulatedNetworkSubsystem__Get

Public Attributes

Return	Name	Description
FOnOperatingSystemSimulatedNetworkCreated	OnOperatingSystemSimulatedNetworkCreated	Broadcasted when a new simulated network is created
FOnOperatingSystemSimulatedNetworkDeviceConnected	OnOperatingSystemSimulatedNetworkDeviceConnected	Broadcasted when a device is connected to a simulated network
FOnOperatingSystemSimulatedNetworkDeviceDisconnected	OnOperatingSystemSimulatedNetworkDeviceDisconnected	Broadcasted when a device is disconnected from a simulated network
FOnOperatingSystemSimulatedNetworkDeviceForget	OnOperatingSystemSimulatedNetworkDeviceForget	Broadcasted when a device forgets a simulated network
FOnOperatingSystemSimulatedNetworkLocationUpdated	OnOperatingSystemSimulatedNetworkLocationUpdated	Broadcasted when a simulated network’s location is updated
FOnOperatingSystemSimulatedNetworkRemoved	OnOperatingSystemSimulatedNetworkRemoved	Broadcasted when a simulated network is removed

---

OnOperatingSystemSimulatedNetworkCreated

FOnOperatingSystemSimulatedNetworkCreated OnOperatingSystemSimulatedNetworkCreated

Defined in OperatingSystemSimulatedNetworkSubsystem.h:33 Broadcasted when a new simulated network is created

Referenced by

• AddSimulatedNetworks

---

OnOperatingSystemSimulatedNetworkDeviceConnected

FOnOperatingSystemSimulatedNetworkDeviceConnected OnOperatingSystemSimulatedNetworkDeviceConnected

Defined in OperatingSystemSimulatedNetworkSubsystem.h:37 Broadcasted when a device is connected to a simulated network

Referenced by

• ConnectDeviceToNetwork

---

OnOperatingSystemSimulatedNetworkDeviceDisconnected

FOnOperatingSystemSimulatedNetworkDeviceDisconnected OnOperatingSystemSimulatedNetworkDeviceDisconnected

Defined in OperatingSystemSimulatedNetworkSubsystem.h:41 Broadcasted when a device is disconnected from a simulated network

Referenced by

• DisconnectDeviceFromNetwork
• ForgetNetwork

---

OnOperatingSystemSimulatedNetworkDeviceForget

FOnOperatingSystemSimulatedNetworkDeviceForget OnOperatingSystemSimulatedNetworkDeviceForget

Defined in OperatingSystemSimulatedNetworkSubsystem.h:45 Broadcasted when a device forgets a simulated network

Referenced by

• ForgetNetwork

---

OnOperatingSystemSimulatedNetworkLocationUpdated

FOnOperatingSystemSimulatedNetworkLocationUpdated OnOperatingSystemSimulatedNetworkLocationUpdated

Defined in OperatingSystemSimulatedNetworkSubsystem.h:49 Broadcasted when a simulated network’s location is updated

Referenced by

• UpdateNetworkLocation

---

OnOperatingSystemSimulatedNetworkRemoved

FOnOperatingSystemSimulatedNetworkRemoved OnOperatingSystemSimulatedNetworkRemoved

Defined in OperatingSystemSimulatedNetworkSubsystem.h:53 Broadcasted when a simulated network is removed

Referenced by

• RemoveSimulatedNetworks

Public Methods

Return	Name	Description
bool	DoesSupportWorldType virtual const override
bool	UpdateNetworkLocation
const TArray< FOperatingSystemSimulatedNetwork > &	GetAllSimulatedNetworks const	Get the list of all simulated networks in the subsystem.
void	AddSimulatedNetworks	Add a new simulated network to the subsystem.
void	RemoveSimulatedNetworks	Remove simulated networks provided by a specific network provider component from the subsystem.
bool	ConnectDeviceToNetwork	Connect a device to a simulated network.
bool	DisconnectDeviceFromNetwork const	Disconnect a device from its currently connected simulated network.
bool	ForgetNetwork const	Forget a previously saved network for a device.

---

DoesSupportWorldType

virtual const override

virtual bool DoesSupportWorldType(const EWorldType::Type WorldType) const override

Defined in OperatingSystemSimulatedNetworkSubsystem.h:57

UpdateNetworkLocation

bool UpdateNetworkLocation(const FOperatingSystemSimulatedNetwork & Target, const FVector & NewLocation)

Defined in OperatingSystemSimulatedNetworkSubsystem.h:59

References

• IsValid
• OnOperatingSystemSimulatedNetworkLocationUpdated
• SimulatedNetworks

---

GetAllSimulatedNetworks

const

const TArray< FOperatingSystemSimulatedNetwork > & GetAllSimulatedNetworks() const

Defined in OperatingSystemSimulatedNetworkSubsystem.h:73 Get the list of all simulated networks in the subsystem.

This method returns a constant reference to an array containing all the simulated networks managed by the subsystem. The returned array is read-only and should not be modified directly.

Returns

A constant reference to an array of FOperatingSystemSimulatedNetwork representing all simulated networks.

References

• Networks

---

AddSimulatedNetworks

void AddSimulatedNetworks(UOperatingSystemSimulatedNetworkProviderComponent * NetworkProviderComponent)

Defined in OperatingSystemSimulatedNetworkSubsystem.h:83 Add a new simulated network to the subsystem.

This method adds a new simulated network to the subsystem’s list of networks. If a network with the same name already exists, it will not be added again.

Parameters

• NetworkProviderComponent The UOperatingSystemSimulatedNetworkProviderComponent that provides the new network to be added.

References

• GetSimulatedNetworks
• Networks
• OnOperatingSystemSimulatedNetworkCreated
• SimulatedNetworks

---

RemoveSimulatedNetworks

void RemoveSimulatedNetworks(UOperatingSystemSimulatedNetworkProviderComponent * NetworkProviderComponent)

Defined in OperatingSystemSimulatedNetworkSubsystem.h:92 Remove simulated networks provided by a specific network provider component from the subsystem.

This method removes all simulated networks added by the specified UOperatingSystemSimulatedNetworkProviderComponent from the subsystem’s list of networks.

Parameters

• NetworkProviderComponent The UOperatingSystemSimulatedNetworkProviderComponent whose networks should be removed.

References

• Networks
• OnOperatingSystemSimulatedNetworkRemoved
• SimulatedNetworks

---

ConnectDeviceToNetwork

bool ConnectDeviceToNetwork(UOperatingSystemBaseDevice * TargetDevice, const FText & NetworkName, const FText & Password)

Defined in OperatingSystemSimulatedNetworkSubsystem.h:105 Connect a device to a simulated network.

This method attempts to connect the specified device to a simulated network with the given name and password.

Parameters

• TargetDevice The device to connect to the network.

• NetworkName The name of the network to connect to.

• Password The password for the network.

Returns

True if the connection was successful, false otherwise.

References

• ConnectToNetwork
• OnOperatingSystemSimulatedNetworkDeviceConnected
• SimulatedNetworks

---

DisconnectDeviceFromNetwork

const

bool DisconnectDeviceFromNetwork(UOperatingSystemBaseDevice * TargetDevice) const

Defined in OperatingSystemSimulatedNetworkSubsystem.h:116 Disconnect a device from its currently connected simulated network.

This method attempts to disconnect the specified device from its currently connected simulated network.

Parameters

• TargetDevice The device to disconnect from the network.

Returns

True if the disconnection was successful, false otherwise.

References

• DisconnectFromNetwork
• IsConnectedToNetwork
• OnOperatingSystemSimulatedNetworkDeviceDisconnected

---

ForgetNetwork

const

bool ForgetNetwork(UOperatingSystemBaseDevice * TargetDevice, const FOperatingSystemSimulatedNetwork & NetworkToForget) const

Defined in OperatingSystemSimulatedNetworkSubsystem.h:128 Forget a previously saved network for a device.

This method attempts to remove a previously saved network from the specified device’s list of saved networks.

Parameters

• TargetDevice The device to forget the network.

• NetworkToForget The network to be forgotten.

Returns

True if the network was successfully forgotten, false otherwise.

References

• DisconnectFromNetwork
• ForgetNetwork
• IsConnectedToNetwork
• OnOperatingSystemSimulatedNetworkDeviceDisconnected
• OnOperatingSystemSimulatedNetworkDeviceForget

Public Static Methods

Return	Name	Description
UOperatingSystemSimulatedNetworkSubsystem *	Get static
bool	IsSameNetwork static
bool	IsDeviceConnectedToNetwork static	Check if a device is connected to a simulated network.

---

Get

static

static UOperatingSystemSimulatedNetworkSubsystem * Get(const UObject * WorldContextObject)

Defined in OperatingSystemSimulatedNetworkSubsystem.h:55

Referenced by

• Activate
• ConnectToNetwork
• Deactivate
• DisconnectFromNetwork
• Internal_DestroyDevice
• Internal_OnNetworkLocationUpdated
• Internal_OnNetworkRemoved
• SetCanConnectToNetwork
• UpdateAllNetworkLocations

---

IsSameNetwork

static

static bool IsSameNetwork(const FOperatingSystemSimulatedNetwork & A, const FOperatingSystemSimulatedNetwork & B)

Defined in OperatingSystemSimulatedNetworkSubsystem.h:62

IsDeviceConnectedToNetwork

static

static bool IsDeviceConnectedToNetwork(UOperatingSystemBaseDevice * TargetDevice, FOperatingSystemSimulatedNetwork & OutNetwork)

Defined in OperatingSystemSimulatedNetworkSubsystem.h:140 Check if a device is connected to a simulated network.

This method checks if the specified device is currently connected to a simulated network.

Parameters

• TargetDevice The device to check for network connection.

• OutNetwork The network the device is connected to, if any.

Returns

True if the device is connected to a network, false otherwise.

References

• IsConnectedToNetwork

Private Attributes

Return	Name	Description
TSet< FOperatingSystemSimulatedNetworkProxy >	SimulatedNetworks
TArray< FOperatingSystemSimulatedNetwork >	Networks

---

SimulatedNetworks

TSet< FOperatingSystemSimulatedNetworkProxy > SimulatedNetworks

Defined in OperatingSystemSimulatedNetworkSubsystem.h:24

Referenced by

• AddSimulatedNetworks
• ConnectDeviceToNetwork
• RemoveSimulatedNetworks
• UpdateNetworkLocation

---

Networks

TArray< FOperatingSystemSimulatedNetwork > Networks

Defined in OperatingSystemSimulatedNetworkSubsystem.h:27

Referenced by

• AddSimulatedNetworks
• GetAllSimulatedNetworks
• RemoveSimulatedNetworks