Class IRemoteRuntimeManager¶
ClassList > IRemoteRuntimeManager
#include <SimulationRuntimeApi.h>
Inherits the following classes: IBaseRuntimeManager
Public Functions¶
| Type | Name |
|---|---|
| virtual ERuntimeErrorCode | Disconnect () = 0 Closes the connection to the remote Runtime Manager. |
| virtual UIP | GetIP () = 0 Returns the IP of the PC the remote Runtime Manager is running on. Returns 0 if the function fails. |
| virtual ERuntimeErrorCode | GetRemoteComputerName (WCHAR * inout_Name, UINT32 in_ArrayLength) = 0 Returns the name of the PC the remote Runtime Manager is running on. |
| virtual void | RegisterOnConnectionLostCallback (EventCallback_IRRTM in_CallbackFunction) = 0 When receiving the event the registered callback function will be called. The callback function runs in a separate thread. More callback functions can be registered to the event. |
| virtual void | RegisterOnConnectionLostEvent () = 0 When receiving the event, the registered event object is set to signaled state. There can be only one event object registered to the event. Registering a new one will automatically unregister the previous one. |
| virtual void | RegisterOnConnectionLostEvent (HANDLE * in_Event) = 0 When receiving the event, the registered event object is set to signaled state. There can be only one event object registered to the event. Registering a new one will automatically unregister the previous one. |
| virtual void | UnregisterOnConnectionLostCallback (EventCallback_IRRTM in_CallbackFunction=nullptr) = 0 Unregisters the callback function. When receiving the event no callback function will be called. |
| virtual void | UnregisterOnConnectionLostEvent () = 0 Unregisters the event object. |
| virtual bool | WaitForOnConnectionLostEvent () = 0 The function will block until the registered event object is in the signaled state or the timeout interval elapses. |
| virtual bool | WaitForOnConnectionLostEvent (UINT32 in_Time_ms) = 0 The function will block until the registered event object is in the signaled state or the timeout interval elapses. |
| virtual | ~IRemoteRuntimeManager () |
Public Functions inherited from IBaseRuntimeManager¶
| Type | Name |
|---|---|
| virtual ERuntimeErrorCode | CreateInterface (INT32 in_InstanceID, IInstance ** out_InstanceInterface) = 0 Creates and returns an interface of an already registered virtual controller instance. |
| virtual ERuntimeErrorCode | CreateInterface (WCHAR * in_InstanceName, IInstance ** out_InstanceInterface) = 0 Creates and returns an interface of an already registered virtual controller instance. |
| virtual ERuntimeErrorCode | GetDefaultStoragePath (WCHAR * out_DefaultStoragePath) = 0 Get default storage path for instances. |
| virtual ERuntimeErrorCode | GetNetInterfaces (SNetInterfaceInfo * inout_InterfaceInfo, UINT * inout_InterfaceCount) = 0 Retrieve info about computer network interfaces, which can be used by the SetInterfaceMapping function |
| virtual ERuntimeErrorCode | GetNetworkMode (ENetworkMode * out_mode) = 0 Get the current network mode setting that will be used on the network adapter for distributed communication. |
| virtual UINT16 | GetPort () = 0 Returns the open port. Returns 0 if no port is open or if the function fails. |
| virtual ERuntimeErrorCode | GetRegisteredInstanceInfoAt (UINT32 in_Index, SInstanceInfo * out_InstanceInfo) = 0 Returns the info about an already registered instance. You can use its ID or name to create an interface of this instance. |
| virtual UINT32 | GetRegisteredInstancesCount () = 0 Returns the number of instances registered at the RuntimeManager. Returns 0 if the function fails. |
| virtual enum ERuntimeErrorCode | GetStrictMotionTiming (bool * enabled) = 0 Get the current default strict motion timing setting for newly created instances. |
| virtual UINT32 | GetVersion () = 0 Returns the version of the Runtime Manager. If the function fails, the version returned is 0. |
| virtual ERuntimeErrorCode | RegisterCustomInstance (WCHAR * in_VplcDll, IInstance ** out_InstanceInterface) = 0 Registers a new instance of a virtual controller at the Runtime Manager. Also creates and returns an interface of this instance. |
| virtual ERuntimeErrorCode | RegisterCustomInstance (WCHAR * in_VplcDll, WCHAR * in_InstanceName, IInstance ** out_InstanceInterface) = 0 Registers a new instance of a virtual controller at the Runtime Manager. Also creates and returns an interface of this instance. |
| virtual ERuntimeErrorCode | RegisterInstance (IInstance ** out_InstanceInterface) = 0 Registers a new instance of a virtual controller at the Runtime Manager. Also creates and returns an interface of this instance. |
| virtual ERuntimeErrorCode | RegisterInstance (WCHAR * in_InstanceName, IInstance ** out_InstanceInterface) = 0 Registers a new instance of a virtual controller at the Runtime Manager. Also creates and returns an interface of this instance. |
| virtual ERuntimeErrorCode | RegisterInstance (ECPUType in_CPUType, IInstance ** out_InstanceInterface) = 0 Registers a new instance of a virtual controller at the Runtime Manager. Also creates and returns an interface of this instance. |
| virtual ERuntimeErrorCode | RegisterInstance (ECPUType in_CPUType, WCHAR * in_InstanceName, IInstance ** out_InstanceInterface) = 0 Registers a new instance of a virtual controller at the Runtime Manager. Also creates and returns an interface of this instance. |
| virtual ERuntimeErrorCode | RegisterInstance (const WCHAR * in_ArticleNumber, const WCHAR * in_InstanceName, IInstance ** out_InstanceInterface) = 0 Registers a new instance of a virtual controller at the Runtime Manager. Also creates and returns an interface of this instance. |
| virtual ERuntimeErrorCode | ResetNetInterfaceBindings () = 0 Resets bindings to the default state. |
| virtual ERuntimeErrorCode | SetDefaultStoragePath (const WCHAR * in_DefaultStoragePath) = 0 Set the default storage path. |
| virtual ERuntimeErrorCode | SetNetInterfaceBindings (DWORD in_PCInterfaceIndex=0) = 0 Sets bindings of PLCSIM Virtual Switch to PC interfaces according to networking mode and network interface mapping configuration for the instance. This function must be called from an elevated session (admin mode). |
| virtual ERuntimeErrorCode | SetNetworkMode (const ENetworkMode in_mode) = 0 Set the network mode that will be used on the network adapter for distributed communication. User has to check if bindings on network interfaces are correct. |
| virtual enum ERuntimeErrorCode | SetStrictMotionTiming (bool enable) = 0 Enable or disable default strict motion timing for newly created instances. |
| virtual | ~IBaseRuntimeManager () |
Public Functions inherited from IBaseInterface¶
See IBaseInterface
| Type | Name |
|---|---|
| virtual | ~IBaseInterface () |
Public Functions Documentation¶
function Disconnect¶
Closes the connection to the remote Runtime Manager.
virtual ERuntimeErrorCode IRemoteRuntimeManager::Disconnect () = 0
function GetIP¶
Returns the IP of the PC the remote Runtime Manager is running on. Returns 0 if the function fails.
virtual UIP IRemoteRuntimeManager::GetIP () = 0
function GetRemoteComputerName¶
Returns the name of the PC the remote Runtime Manager is running on.
virtual ERuntimeErrorCode IRemoteRuntimeManager::GetRemoteComputerName (
WCHAR * inout_Name,
UINT32 in_ArrayLength
) = 0
Parameters:
inout_NameA user allocated array to receive the computer name.in_ArrayLengthThe length of the array. The array should be bigger than MAX_COMPUTERNAME_LENGTH (Windows.h define).
function RegisterOnConnectionLostCallback¶
When receiving the event the registered callback function will be called. The callback function runs in a separate thread. More callback functions can be registered to the event.
virtual void IRemoteRuntimeManager::RegisterOnConnectionLostCallback (
EventCallback_IRRTM in_CallbackFunction
) = 0
Parameters:
in_CallbackFunctionA callback function to subscribe to the event.
function RegisterOnConnectionLostEvent [½]¶
When receiving the event, the registered event object is set to signaled state. There can be only one event object registered to the event. Registering a new one will automatically unregister the previous one.
virtual void IRemoteRuntimeManager::RegisterOnConnectionLostEvent () = 0
function RegisterOnConnectionLostEvent [2/2]¶
When receiving the event, the registered event object is set to signaled state. There can be only one event object registered to the event. Registering a new one will automatically unregister the previous one.
virtual void IRemoteRuntimeManager::RegisterOnConnectionLostEvent (
HANDLE * in_Event
) = 0
Parameters:
in_EventThe handle to a user created event object. The event object will be registered.
function UnregisterOnConnectionLostCallback¶
Unregisters the callback function. When receiving the event no callback function will be called.
virtual void IRemoteRuntimeManager::UnregisterOnConnectionLostCallback (
EventCallback_IRRTM in_CallbackFunction=nullptr
) = 0
function UnregisterOnConnectionLostEvent¶
Unregisters the event object.
virtual void IRemoteRuntimeManager::UnregisterOnConnectionLostEvent () = 0
function WaitForOnConnectionLostEvent [½]¶
The function will block until the registered event object is in the signaled state or the timeout interval elapses.
virtual bool IRemoteRuntimeManager::WaitForOnConnectionLostEvent () = 0
function WaitForOnConnectionLostEvent [2/2]¶
The function will block until the registered event object is in the signaled state or the timeout interval elapses.
virtual bool IRemoteRuntimeManager::WaitForOnConnectionLostEvent (
UINT32 in_Time_ms
) = 0
Parameters:
in_Time_msThe value for the timeout limit in milliseconds.
function ~IRemoteRuntimeManager¶
inline virtual IRemoteRuntimeManager::~IRemoteRuntimeManager ()