Interface Siemens::Simatic::Simulation::Runtime::IRemoteRuntimeManager¶
ClassList > Siemens > Simatic > Simulation > Runtime > IRemoteRuntimeManager
#include <SimulationRuntimeApiNet.h>
Inherits the following classes: Siemens::Simatic::Simulation::Runtime::IBaseRuntimeManager
Public Attributes¶
| Type | Name |
|---|---|
| property SIP | IP = { SIP get()Returns the IP of the PC the remote Runtime Manager is running on. Returns 0 if the function fails. |
| event Delegate_IRRTM | OnConnectionLost The event will be fired when the connection to the remote Runtime Manager is lost. |
| property UINT16 | Port = { UINT16 get()Returns the open port of the PC the remote Runtime Manager is running on. Returns 0 if the function fails. |
| property System::String | RemoteComputerName = { System::String^ get()Returns the name of the PC the remote Runtime Manager is running on. |
Public Attributes inherited from Siemens::Simatic::Simulation::Runtime::IBaseRuntimeManager¶
See Siemens::Simatic::Simulation::Runtime::IBaseRuntimeManager
| Type | Name |
|---|---|
| property System::String | DefaultStoragePath = { System::String^ get() |
| property array< SNetInterfaceInfo > | NetInterfaces = { array<[**SNetInterfaceInfo**](structSNetInterfaceInfo.md)>^ get() |
| property ENetworkMode | NetworkMode = {[**ENetworkMode**](SimulationRuntimeApi_8h.md#enum-enetworkmode) get() |
| property UINT16 | Port = { UINT16 get() |
| property array< SInstanceInfo > | RegisteredInstanceInfo = { array<[**SInstanceInfo**](structSInstanceInfo.md)>^ get() |
| property bool | StrictMotionTiming = { bool get() |
| property UINT32 | Version = { UINT32 get() |
Public Functions¶
| Type | Name |
|---|---|
| virtual void | Disconnect () Closes the connection to the remote Runtime Manager. |
| virtual void | 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 | SetNetInterfaceBindings () 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 void | UnregisterOnConnectionLostEvent () Unregisters the event object. |
| virtual bool | WaitForOnConnectionLostEvent () 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) The function will block until the registered event object is in the signaled state or the timeout interval elapses. |
Public Functions inherited from Siemens::Simatic::Simulation::Runtime::IBaseRuntimeManager¶
See Siemens::Simatic::Simulation::Runtime::IBaseRuntimeManager
| Type | Name |
|---|---|
| virtual IInstance | CreateInterface (INT32 in_InstanceID) |
| virtual IInstance | CreateInterface (System::String^ in_InstanceName) |
| virtual IInstance | RegisterCustomInstance (System::String^ in_VplcDll) |
| virtual IInstance | RegisterCustomInstance (System::String^ in_VplcDll, System::String^ in_InstanceName) |
| virtual IInstance | RegisterInstance () |
| virtual IInstance | RegisterInstance (System::String^ in_InstanceName) |
| virtual IInstance | RegisterInstance (ECPUType in_CPUType) |
| virtual IInstance | RegisterInstance (ECPUType in_CPUType, System::String^ in_InstanceName) |
| virtual IInstance | RegisterInstance (System::String^ in_ArticleNumber, System::String^ in_InstanceName) |
| virtual void | ResetNetInterfaceBindings () |
| virtual void | SetNetInterfaceBindings () |
| virtual void | SetNetInterfaceBindings (DWORD in_PCInterfaceIndex) |
| void | set (bool) |
| void | set (System::String^) |
| void | set (ENetworkMode) |
Public Attributes Documentation¶
variable IP¶
Returns the IP of the PC the remote Runtime Manager is running on. Returns 0 if the function fails.
virtual property SIP Siemens::Simatic::Simulation::Runtime::IRemoteRuntimeManager::IP;
variable OnConnectionLost¶
The event will be fired when the connection to the remote Runtime Manager is lost.
virtual event Delegate_IRRTM Siemens::Simatic::Simulation::Runtime::IRemoteRuntimeManager::OnConnectionLost;
variable Port¶
Returns the open port of the PC the remote Runtime Manager is running on. Returns 0 if the function fails.
virtual property UINT16 Siemens::Simatic::Simulation::Runtime::IRemoteRuntimeManager::Port;
variable RemoteComputerName¶
Returns the name of the PC the remote Runtime Manager is running on.
virtual property System::String Siemens::Simatic::Simulation::Runtime::IRemoteRuntimeManager::RemoteComputerName;
Public Functions Documentation¶
function Disconnect¶
Closes the connection to the remote Runtime Manager.
virtual void Siemens::Simatic::Simulation::Runtime::IRemoteRuntimeManager::Disconnect ()
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 Siemens::Simatic::Simulation::Runtime::IRemoteRuntimeManager::RegisterOnConnectionLostEvent ()
function SetNetInterfaceBindings¶
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 void Siemens::Simatic::Simulation::Runtime::IRemoteRuntimeManager::SetNetInterfaceBindings ()
Implements Siemens::Simatic::Simulation::Runtime::IBaseRuntimeManager::SetNetInterfaceBindings
function UnregisterOnConnectionLostEvent¶
Unregisters the event object.
virtual void Siemens::Simatic::Simulation::Runtime::IRemoteRuntimeManager::UnregisterOnConnectionLostEvent ()
function WaitForOnConnectionLostEvent [½]¶
The function will block until the registered event object is in the signaled state or the timeout interval elapses.
virtual bool Siemens::Simatic::Simulation::Runtime::IRemoteRuntimeManager::WaitForOnConnectionLostEvent ()
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 Siemens::Simatic::Simulation::Runtime::IRemoteRuntimeManager::WaitForOnConnectionLostEvent (
UINT32 in_Time_ms
)
Parameters:
in_Time_msThe value for the timeout limit in milliseconds.