Files
UnrealEngineUWP/Engine/Source/Developer/TargetDeviceServices/Public/Interfaces/ITargetDeviceProxyManager.h
Ben Marsh 149375b14b Update copyright notices to 2015.
[CL 2379638 by Ben Marsh in Main branch]
2014-12-07 19:09:38 -05:00

80 lines
2.7 KiB
C++

// Copyright 1998-2015 Epic Games, Inc. All Rights Reserved.
#pragma once
/** Type definition for shared pointers to instances of ITargetDeviceProxyManager. */
typedef TSharedPtr<class ITargetDeviceProxyManager> ITargetDeviceProxyManagerPtr;
/** Type definition for shared references to instances of ITargetDeviceProxyManager. */
typedef TSharedRef<class ITargetDeviceProxyManager> ITargetDeviceProxyManagerRef;
/**
* Interface for device proxy managers.
*/
class ITargetDeviceProxyManager
{
public:
/**
* Finds or adds a device proxy for the specified device name.
*
* @param Name The name of the device to create the proxy for.
* @return The device proxy.
* @see FindProxy, FindProxyDeviceForTargetDevice, GetProxies
*/
virtual ITargetDeviceProxyRef FindOrAddProxy(const FString& Name) = 0;
/**
* Finds the device proxy for the specified device name.
*
* @param Name The name of the device to create the proxy for.
* @return The device proxy, or nullptr if it couldn't be found.
* @see FindOrAddProxy, FindProxyDeviceForTargetDevice, GetProxies
*/
virtual ITargetDeviceProxyPtr FindProxy(const FString& Name) = 0;
/**
* Finds the device proxy for the specified target device id.
*
* @param DeviceId The identifier of the target device to create the proxy for.
* @return The device proxy, or nullptr if it couldn't be found.
* @see FindOrAddProxy, FindProxy, GetProxies
*/
virtual ITargetDeviceProxyPtr FindProxyDeviceForTargetDevice(const FString& DeviceId) = 0;
/**
* Gets a list of devices found by the device discovery.
*
* @param PlatformName The the name of the target platform to get proxies for (or empty string for all proxies).
* @param IncludeUnshared Whether to include devices that are not being shared with the local user.
* @param OutProxies Will hold the list of devices found by the locator
* @see FindOrAddProxy, FindProxy, FindProxyDeviceForTargetDevice
*/
virtual void GetProxies(FName TargetPlatformName, bool IncludeUnshared, TArray<ITargetDeviceProxyPtr>& OutProxies) = 0;
public:
/**
* Gets an event delegate that is executed when a target device proxy was added.
*
* @return The event delegate.
*/
DECLARE_EVENT_OneParam(ITargetDeviceServiceManager, FOnTargetDeviceProxyAdded, const ITargetDeviceProxyRef& /*AddedProxy*/);
virtual FOnTargetDeviceProxyAdded& OnProxyAdded() = 0;
/**
* Gets an event delegate that is executed when a target device proxy was removed.
*
* @return The event delegate.
*/
DECLARE_EVENT_OneParam(ITargetDeviceServiceManager, FOnTargetDeviceProxyRemoved, const ITargetDeviceProxyRef& /*RemovedProxy*/);
virtual FOnTargetDeviceProxyRemoved& OnProxyRemoved() = 0;
public:
/** Virtual constructor. */
~ITargetDeviceProxyManager() { }
};