Click or drag to resize

RuntimeManager Class

Runs an OTX/PTX file directly. It supports executing the startup procedure (main), getting packages, documents, procedures and validating OTX documents
Inheritance Hierarchy
SystemObject
  OpenTestSystem.Otx.Runtime.ApiRuntimeManager

Namespace:  OpenTestSystem.Otx.Runtime.Api
Assembly:  OpenTestSystem.Otx.Runtime.Api (in OpenTestSystem.Otx.Runtime.Api.dll) Version: 5.5.0.0 (6.1.0.31040)
Syntax
public class RuntimeManager : IRuntimeManager

The RuntimeManager type exposes the following members.

Constructors
  NameDescription
Public methodCode exampleRuntimeManager
Initializes a new instance of the Runtime Manager.
Top
Properties
  NameDescription
Public propertyDiagRuntimeSystem
Gets or sets Runtime System.
Public propertyDiagRuntimeSystems
Gets available Runtime Systems.
Public propertyDoipActivationLineDelayTime
Delay time in milliseconds after the ActivationLine has been set.
Public propertyDoipSelectedInterface
Selected interface in case of Diagnostics over Internet Protocol (DoIP)
Public propertyDoipSetImpliciteActivationLine
The ActivationLine can be set before a detection, which is necessary for some VCI Ethernet controllers.
Public propertyExternalAppPath
Gets or sets external application path. ExternalAppPath leads to a directory and must be an absolute Path. If ExternalAppPath is not null or empty, all OTX-Mapping will search assemblies in this path; Otherwise, OTX-Mapping will use their assemblies.
Public propertyFileSystem
Public propertyCode exampleHmiScreenHandle
Gets or set a windows handle (HWND) to display custom screens of the HMI extension.
Public propertyIsCommunicationTrace
Gets or sets if the creation of communication trace items is ON or OFF. The default value is ON (True).
Public propertyIsDoipSupport
Returns true if a valid interface is selected
Public propertyIsVariablesTrace
Gets or sets if the creation of variables trace items is ON or OFF. The default value is ON (True).
Public propertyIsWriteTraceFile Obsolete.
Gets or sets OTX-Runtime Tracing status.This switches ON/OFF (true/false) the tracing of OTX-Runtime, which is useful for error detection inside OTX Runtime. Default value: true. This property is obsolete, please use TraceLevel instead.
Public propertyJavaRuntimeParameters
Gets or sets the command line options to start a Java Virtual Maschine (JVM)
Public propertyJavaVM
Gets or sets the path to the Java VM.
Public propertyMaxExecutionMemory
Gets or sets Maximal number of megabytes used by a runner process. The default value is 200
Public propertyMaxIdleExecutionCount
Gets or sets if the number of maximal existing free runner processes. The default value is 5.
Public propertyMinBinVersion
Gets minimum version of the binary file that the OTX Runtime can handle. Is in the OTX Runtime.
Public propertyOutputFolder
Gets or sets directory where all temporary, by the OTX-Runtime created files are stored. Default value: "[CurrentUser]\AppData\Local\Temp\emotive\OTX-Runtime\".
Public propertyCode examplePackages
Gets top packages
Public propertyPlayerProject
Gets information from loaded PPX
Public propertyProjectName
Gets the project name.
Public propertyProjects
Gets project names.
Public propertyProjectSettings
Gets the project setting.
Public propertyProjectVersion
Gets the project version.
Public propertyRdfPath
Gets or sets the path to the MVCI-Server configuration file (MVCI-Server.rdf).
Public propertyRemoteTimeout
Gets or sets Timeout for each remote communication in milliseconds.
Public propertyRuntimeImplementation
Gets or sets the runtime platform which doesn't depend on the design flatform.
Public propertySearchPath
Gets or sets base directory for all relative path specifications.
Public propertySelectedProject
Gets or sets selected project.
Public propertyTraceFileFolder
Gets or sets directory where the trace files are stored. Default value: "[CurrentUser]\AppData\Roaming\emotive\OTX-Runtime\Tracing\".
Public propertyTraceLevel
Gets or sets OTX-Runtime Tracing Level. Default value: ERROR.
Public propertyTypeCode Obsolete.
Sets type code, 0 is C++, != 0 is not C++ - This property is obsolete. It has no functionality! The runtime manage it automatically.
Public propertyUseExternalAppPath
Gets or sets external application path is used.

If true, using external application path (central directory). Otherwise, using applications for the OTX mapping locally (within the project).

Public propertyVersion
Gets the file version of OTX-Runtime API.
Top
Methods
  NameDescription
Public methodActivateHmiScreen
Activate the top window.
Public methodChangeDefaultLanguage
Change default language.
Public methodCode exampleCheckConnection
Checks if the client connected to a host.
Public methodCode exampleConnect
Connects to a host with the given IP address and port.
Public methodCode exampleConvertStringToValue(String, IDataType)
Converts a string representation to value of the given dataType independent from the given target system.
Public methodCode exampleConvertStringToValue(String, String) Obsolete.
Converts a string representation to value of the given dataType independent from the given target system.
Public methodCode exampleConvertValueToString
Converts a value from a Parameter or a Variable to the string representation of that value independent from the given target system.
Public methodCode exampleDisconnect
Disconnects from the connected host.
Public methodDoipDetectInterfaces
Performs a Diagnostics over Internet Protocol (DoIP) vehicle identification request
Public methodCode exampleDownload
Downloads all runtime related data from host to client. - Content of Output folder to ClientOutputFolder/Host/ - Content of External applications to ClientAppsFolder/Host/ - Content of Trace file folder to ClientTraceFileFolder/Host/
Public methodEquals
Determines whether the specified Object is equal to the current Object.
(Inherited from Object.)
Public methodGetHashCode
Serves as a hash function for a particular type.
(Inherited from Object.)
Public methodCode exampleGetMainProcedure
Gets the main procedure. The main procedure is the procedure with the name "main" (case sensitive).
Public methodCode exampleGetStartUpDocument
Gets the document which is marked as startup. It should include a main procedure.
Public methodGetType
Gets the Type of the current instance.
(Inherited from Object.)
Public methodCode exampleHostClean
Cleans up all runtime related files at the host. - Content of Output folder. - Content of FileSystem. - Content of External applications. - Content of Trace file folder.
Public methodCode exampleIsProtected
Checks if a PTX is signed and/or encrypted.
Public methodCode exampleLoad(String)
Loads a PTX or an OTX file.
Public methodCode exampleLoad(String, String)
Loads a protected PTX file.
Public methodRaiseDeviceEvent Obsolete.
The method is not used anymore. Each change of a DeviceServiceOutParameter will directly reflected to the runtime and can add events to the DeviceEventSource.
Public methodRaiseScreenClosedEvent
Signals the OTX-Runtime that a screen was closed and a ScreenClosedEvent should be raised.
Public methodRefreshHmiScreen
Redraws all screens.
Public methodScreenIsClosed Obsolete.
Signals the OTX-Runtime that a screen was closed - This method is obsolete, please use RaiseScreenClosedEvent!
Public methodStopExecution
Stops running procedure if existing. It is effective only the procedure is running synchronously.
Public methodToString
Returns a String that represents the current Object.
(Inherited from Object.)
Public methodCode exampleUpload
Uploads all necessary data from client to host.
Public methodCode exampleValidate
Validates the current project and its references and returns a list of errors and warnings.
Public methodVciDisconnect
This method disconnects the VCI from the ECU.
Top
Events
  NameDescription
Public eventChoiceDialogOccurred
Occurs when a ChoiceDialog occurs. If this event is register, the user is responsible for the handling and the OTX runtime does nothing.
Public eventCode exampleClientConnected
Occurs when a host accepted the client's connection.
Public eventCode exampleClientDisconnected
Occurs when the client was disconnected.
Public eventCloseComChannelOccurred
Event CloseComChannel
Public eventCloseScreenOccurred
Occurs when a CloseScreen occurs. If this event is register, the user is responsible for the handling and the OTX runtime does nothing.
Public eventCode exampleCommunicationTraceItemAdded
Occurs when the runtime system writes data to the communication trace.
Public eventConfirmDialogOccurred
Occurs when a ConfirmDialog occurs. If this event is register, the user is responsible for the handling and the OTX runtime does nothing.
Public eventCode exampleContextVariableRead
Occurs when a context variable reads its value.
Public eventCreateDiagServiceByNameOccurred
Event CreateDiagServiceByName
Public eventCreateDiagServiceBySemanticOccurred
Event CreateDiagServiceBySemantic
Public eventExecuteDeviceServiceOccurred
Occurs when an ExecuteDeviceService occurs. If this event is register, the user is responsible for the handling of that DeviceService (e.g. calling a method in a external DLL) and the OTX runtime does nothing.
Public eventExecuteDiagServiceOccurred
Event ExecuteDiagService
Public eventExecuteHexDiagServiceOccurred
Event ExecuteHexDiagService
Public eventExecutionStopped
Occurs when execution stopped.
Public eventGetAllResponsesOccurred
Event GetAllResponses
Public eventGetAllResultsAndClearOccurred
Event GetAllResultsAndClear
Public eventGetAllResultsOccurred
Event GetAllResults
Public eventGetComChannelOccurred
Event GetComChannel
Public eventGetComParameterValueOccurred
Event GetComParameterValue
Public eventGetComplexComParameterOccurred
Event GetComplexComParameter
Public eventGetDefaultComParameterValueOccurred
Event GetDefaultComParameterValue
Public eventGetDefaultComplexComParameterOccurred
Event GetDefaultComplexComParameter
Public eventGetDiagServiceListBySemanticOccurred
Event GetDiagServiceListBySemantic
Public eventGetFirstResponseOccurred
Event GetFirstResponse
Public eventGetFirstResultOccurred
Event GetFirstResult
Public eventGetParameterAsListOccurred
Event GetParameterAsList
Public eventGetParameterByPathOccurred
Event GetParameterByPath
Public eventGetParameterBySemanticOccurred
Event GetParameterBySemantic
Public eventGetParameterValueOccurred
Event GetParameterValue
Public eventGetPduOccurred
Event GetPdu
Public eventGetRepetitionTimeOccurred
Event GetRepetitionTime
Public eventGetRequestOccurred
Event GetRequest
Public eventHighlightScreenOccurred
Occurs when a HighlightScreen occurs. If this event is register, the user is responsible for the handling and the OTX runtime does nothing.
Public eventIdentifyAndSelectVariantOccurred
Event IdentifyAndSelectVariant
Public eventInputDialogOccurred
Occurs when a InputDialog occurs. If this event is register, the user is responsible for the handling and the OTX runtime does nothing.
Public eventKeyDown
Occurs when a key is pressed in runtime when a screen is active.
Public eventOpenScreenOccurred
Occurs when an OpenScreen occurs. If this event is register, the user is responsible for the handling and the OTX runtime does nothing.
Public eventCode exampleParameterValueChanged
Occurs when a parameter value changed.
Public eventCode exampleProcedureFinished
Occurs when a procedure completed running.
Public eventProcedureStarted
Occurs when a Procedure was started.
Public eventProcedureStopped
Occurs when a Procedure was stopped.
Public eventCode exampleRuntimeExceptionOccured
Occurs when a runtime exception occurs.
Public eventScreenIsOpenOccurred
Occurs when a ScreenIsOpen occurs. If this event is register, the user is responsible for the handling and the OTX runtime does nothing.
Public eventScreenParameterValueChanged
Occurs when an a ScreenInParameter or ScreenInOutParameter is changed from Otx runtime and the OpenScreenOccurred event is already registered. If this event is register, the user is responsible for the handling and the OTX runtime does nothing.
Public eventSetComParameterOccurred
Event SetComParameter
Public eventSetComplexComParameterOccurred
Event SetComplexComParameter
Public eventSetParameterValueBySemanticOccurred
Event SetParameterValueBySemantic
Public eventSetParameterValueOccurred
Event SetParameterValue
Public eventSetPduOccurred
Event SetPdu
Public eventSetRepetitionTimeOccurred
Event SetRepetitionTime
Public eventShowDocumentDialogOccurred
Occurs when a ShowDocumentDialog occurs. If this event is register, the user is responsible for the handling and the OTX runtime does nothing.
Public eventStartRepeatedExecutionOccurred
Event StartRepeatedExecution
Public eventCode exampleStatusVariableChanged
Occurs when value of a state variable changed.
Public eventStopRepeatedExecutionOccurred
Event StopRepeatedExecution
Public eventCode exampleVariableTraceItemAdded
Occurs when the runtime system writes data to the variable trace.
Public eventWriteLogPerformed
Occurs when an explicit write via WriteLog activity or an implicit write via some implicit log messages like Communication-Trace or OTX-ID. If the event is registered, the user is responsible for writting into a log resource and the OTX runtime does not write anything into a log file.
Top
Fields
  NameDescription
Public fieldStatic memberOwnMvciServerName
Top
See Also