Contains methods which are not covered by the OTX standard More...

Inherited by OpenTestSystem.Otx.DiagManager.NoneOtxDiagApi.NoneOtxDiag.

Public Member Functions
void	CloseVciConnection ()
	Depending on the communication mode, UnprepareInterface or UnprepareVciAccessLayer is called and all resources, e.g. LogicalLinks are released More...

void	DeselectProject ()
	Deselects the currently selected project. The method call to this function is mutual exclusive to a call to MCDSystem::deselectProject(). More...

string	GetDbEcuMemOfFlashSession (string flashSessionName)
	Returns the ShortName of the MCDDbEcuMem of the related flash session. More...

string	GetDiagRuntimeSystemVersion ()
	Returns the version of the diagnostic runtime system as a string with format "Major.Minor.Revision". In case of an MVCI server the appropriate method is MCDSystem::getVersion. More...

string	GetInterfaceFirmwareName (string interfaceShortName)
	Returns the name of the interface firmware as a string. In case of an MVCI server the appropriate method is MCDInterface::getFirmwareName. More...

string	GetInterfaceFirmwareVersion (string interfaceShortName)
	Returns the version of the interface firmware as a string with format "Major.Minor.Revision". In case of an MVCI server the appropriate method is MCDInterface::getFirmwareVersion. More...

string	GetInterfaceHardwareName (string interfaceShortName)
	Returns the name of the interface hardware name (VCI) as a string. In case of an MVCI server the appropriate method is MCDInterface::getHardwareName. More...

uint	GetInterfaceHardwareSerialNumber (string interfaceShortName)
	Returns the serial number of the interface hardware (VCI) as an unsigned integer number. In case of an MVCI server the appropriate method is MCDInterface::getHardwareSerialNumber. More...

List< string >	GetPduApiNameList ()
	Returns the short names of installed D-PDU API's, see RDF file More...

void	PrepareInterface ()

void	PrepareVciAccessLayer ()
	Initializes and prepares the hardware interfaces of the diagnostic runtime system. This method is called if a client wants to perform any diagnostics and select the VCIs or VCI resources itself. The method call to this function is mutual exclusive to a call to MCDSystem::prepareInterface. More...

void	ReleaseDiagService (int diagServiceHandle, string diagServiceName, int comChannelHandle)
	Deletes the diagnostic service from the handle dictionary and releases all ressources. This method is used to release DiagService after the DiagService is executed asynchronously. DiagService is implicitly released when being executed synchronously. More...

void	ReleaseMonitoring (long handle)
	Deletes the bus monitoring link from the handle dictionary and releases all ressources More...

void	ResetDiagRuntimeSystem ()
	Reset the DiagRuntimeSystem More...

void	SetPreferredInterface (string shortName)
	With simple communication in extended mode, it is not clear which interface is to be used for communication. The command transfers the interface handle from the previously e.g. ComInterface.ConnectComInterface called at DoIP. More...

void	SetStaticInterfaceErrorHandler (StaticInterfaceErrorHandler handler)
	Sets static interface error handler. More...

void	StartDiagLoggging (string testObjectName, Dictionary< string, string > headerMap, bool isAsync, LogLevels logLevel, string logFolder)
	The StartDiagLogging command starts the so called DiagLogging. More...

void	StopDiagLogging ()
	The StopDiagLogging command stops the DiagLogging. More...

void	SwitchPduApi (string shortName)
	Switches between different, installed D-PDU API's More...

void	UnprepareInterface ()
	Uninitializes the Interfaces (drivers and hardware) of the diagnostic runtime system. The method call to this function is mutual exclusive to MCDSystem::unprepareVCIAccessLayer() More...

void	UnprepareVciAccessLayer ()
	Uninitializes the interfaces (drivers and hardware) of the diagnostic runtime system. The method call to this function is mutual exclusive to a call to MCDSystem::unprepareInterface. More...

Detailed Description

Contains methods which are not covered by the OTX standard

Member Function Documentation

◆ CloseVciConnection()

void OpenTestSystem.Otx.DiagManager.NoneOtxDiagApi.INoneOtxDiag.CloseVciConnection ( )

Depending on the communication mode, UnprepareInterface or UnprepareVciAccessLayer is called and all resources, e.g. LogicalLinks are released

◆ DeselectProject()

void OpenTestSystem.Otx.DiagManager.NoneOtxDiagApi.INoneOtxDiag.DeselectProject ( )

Deselects the currently selected project. The method call to this function is mutual exclusive to a call to MCDSystem::deselectProject().

◆ GetDbEcuMemOfFlashSession()

string OpenTestSystem.Otx.DiagManager.NoneOtxDiagApi.INoneOtxDiag.GetDbEcuMemOfFlashSession ( string flashSessionName )

Returns the ShortName of the MCDDbEcuMem of the related flash session.

◆ GetDiagRuntimeSystemVersion()

string OpenTestSystem.Otx.DiagManager.NoneOtxDiagApi.INoneOtxDiag.GetDiagRuntimeSystemVersion ( )

Returns the version of the diagnostic runtime system as a string with format "Major.Minor.Revision". In case of an MVCI server the appropriate method is MCDSystem::getVersion.

Returns: The version of the diagnostic runtime system

◆ GetInterfaceFirmwareName()

string OpenTestSystem.Otx.DiagManager.NoneOtxDiagApi.INoneOtxDiag.GetInterfaceFirmwareName ( string interfaceShortName )

Returns the name of the interface firmware as a string. In case of an MVCI server the appropriate method is MCDInterface::getFirmwareName.

Parameters

interfaceShortName Short name of the interface

Returns: The name of the interface firmware as a string

◆ GetInterfaceFirmwareVersion()

string OpenTestSystem.Otx.DiagManager.NoneOtxDiagApi.INoneOtxDiag.GetInterfaceFirmwareVersion ( string interfaceShortName )

Returns the version of the interface firmware as a string with format "Major.Minor.Revision". In case of an MVCI server the appropriate method is MCDInterface::getFirmwareVersion.

Parameters

interfaceShortName Short name of the interface

Returns: The version of the interface firmware

◆ GetInterfaceHardwareName()

string OpenTestSystem.Otx.DiagManager.NoneOtxDiagApi.INoneOtxDiag.GetInterfaceHardwareName ( string interfaceShortName )

Returns the name of the interface hardware name (VCI) as a string. In case of an MVCI server the appropriate method is MCDInterface::getHardwareName.

Parameters

interfaceShortName Short name of the interface

Returns: The name of the interface hardware name (VCI)

◆ GetInterfaceHardwareSerialNumber()

uint OpenTestSystem.Otx.DiagManager.NoneOtxDiagApi.INoneOtxDiag.GetInterfaceHardwareSerialNumber ( string interfaceShortName )

Returns the serial number of the interface hardware (VCI) as an unsigned integer number. In case of an MVCI server the appropriate method is MCDInterface::getHardwareSerialNumber.

Parameters

interfaceShortName Short name of the interface

Returns: The serial number of the interface hardware (VCI)

◆ GetPduApiNameList()

List<string> OpenTestSystem.Otx.DiagManager.NoneOtxDiagApi.INoneOtxDiag.GetPduApiNameList ( )

Returns the short names of installed D-PDU API's, see RDF file

Returns: Short names of all installed D-PDU API's as a list of String

◆ PrepareInterface()

void OpenTestSystem.Otx.DiagManager.NoneOtxDiagApi.INoneOtxDiag.PrepareInterface ( )

Initializes and prepares the hardware interfaces of the diagnostic runtime system. This method is called if a client wants to perform any diagnostics without manually selecting the VCIs or VCI resources itself. The method call to this function is mutual exclusive to a call to MCDSystem::prepareVCIAccessLayer.

◆ PrepareVciAccessLayer()

void OpenTestSystem.Otx.DiagManager.NoneOtxDiagApi.INoneOtxDiag.PrepareVciAccessLayer ( )

Initializes and prepares the hardware interfaces of the diagnostic runtime system. This method is called if a client wants to perform any diagnostics and select the VCIs or VCI resources itself. The method call to this function is mutual exclusive to a call to MCDSystem::prepareInterface.

◆ ReleaseDiagService()

void OpenTestSystem.Otx.DiagManager.NoneOtxDiagApi.INoneOtxDiag.ReleaseDiagService	(	int	diagServiceHandle,
		string	diagServiceName,
		int	comChannelHandle
	)

Deletes the diagnostic service from the handle dictionary and releases all ressources. This method is used to release DiagService after the DiagService is executed asynchronously. DiagService is implicitly released when being executed synchronously.

Parameters

diagServiceHandle	Handle of DiagService
diagServiceName	Short name of DiagService
comChannelHandle	Handle of ComChannel

◆ ReleaseMonitoring()

void OpenTestSystem.Otx.DiagManager.NoneOtxDiagApi.INoneOtxDiag.ReleaseMonitoring ( long handle )

Deletes the bus monitoring link from the handle dictionary and releases all ressources

Parameters

handle Handle of MonitoringLink

◆ ResetDiagRuntimeSystem()

void OpenTestSystem.Otx.DiagManager.NoneOtxDiagApi.INoneOtxDiag.ResetDiagRuntimeSystem ( )

Reset the DiagRuntimeSystem

◆ SetPreferredInterface()

void OpenTestSystem.Otx.DiagManager.NoneOtxDiagApi.INoneOtxDiag.SetPreferredInterface ( string shortName )

With simple communication in extended mode, it is not clear which interface is to be used for communication. The command transfers the interface handle from the previously e.g. ComInterface.ConnectComInterface called at DoIP.

Parameters

shortName Short name of the selected interface

◆ SetStaticInterfaceErrorHandler()

void OpenTestSystem.Otx.DiagManager.NoneOtxDiagApi.INoneOtxDiag.SetStaticInterfaceErrorHandler ( StaticInterfaceErrorHandler handler )

Sets static interface error handler.

Parameters

handler The callback will be called if the MVCI server fires a MCDEventHandler::onStaticInterfaceError event, which invokes whenever the interface receives an error from the D-PDU-API.

◆ StartDiagLoggging()

void OpenTestSystem.Otx.DiagManager.NoneOtxDiagApi.INoneOtxDiag.StartDiagLoggging	(	string	testObjectName,
		Dictionary< string, string >	headerMap,
		bool	isAsync,
		LogLevels	logLevel,
		string	logFolder
	)

The StartDiagLogging command starts the so called DiagLogging.

The DiagLogging logs the complete diagnostic communication (VIS, Requests, Responses, Parameters, ShortNames, PDUs etc.) in a structured format into a file. Each start of the logging creates a new file. The DiagLogging can be closed using the StopDiagLogging command.

Filename Format

DiagLogging_<testObjectName>_<timestampOfFirstEntry:YYYYMMDDHHmmss>.log

Header Format

-------------------------------------------------------------------------------------------------------------------------------------
********************************************* Start of Diag-Logging of OTX DiagManager **********************************************
-------------------------------------------------------------------------------------------------------------------------------------
Time of creation:                                  | 2020.04.23 12:28:30
Test object:                                       | Name1
HeaderMapInfoKey1                                  | HeaderMapInfoValue1
HeaderMapInfoKey2                                  | HeaderMapInfoValue2
HeaderMapInfoKey3                                  | HeaderMapInfoValue3
HeaderMapInfoKey4                                  | HeaderMapInfoValue4
-------------------------------------------------------------------------------------------------------------------------------------
Timestamp    ClientName            Description
------------------------------------------------------------------------------------------------------------------------------------- 

Parameters

testObjectName	Free name for the test object. It is written in the header of the log file, see header format above. It can also be empty.
headerMap	Additional user defined header information which are written into the header of the log file, see header format above. The list can be empty. In this case no additional header information will be written into the header.
isAsync	The logger can work synchronously or asynchronously. Synchronous means the logger writes directly to the file. Asynchronously means the logger writes to a buffer and the content of the buffer is written to the file via an own thread. Synchronous is slower than asynchronous but requires fewer resources.
logLevel	Sets the log level for diagnostic logging, see LogLevels.
logFolder	Sets the directory for all log files.

See also: INoneOtxDiag::StopDiagLogging

◆ StopDiagLogging()

void OpenTestSystem.Otx.DiagManager.NoneOtxDiagApi.INoneOtxDiag.StopDiagLogging ( )

The StopDiagLogging command stops the DiagLogging.

The recording is stopped and the log file is closed.

Note: The log file is also closed when the DiagManager is closed without calling this command.

◆ SwitchPduApi()

void OpenTestSystem.Otx.DiagManager.NoneOtxDiagApi.INoneOtxDiag.SwitchPduApi ( string shortName )

Switches between different, installed D-PDU API's

Parameters

shortName Short name of selected D-PDU API

◆ UnprepareInterface()

void OpenTestSystem.Otx.DiagManager.NoneOtxDiagApi.INoneOtxDiag.UnprepareInterface ( )

Uninitializes the Interfaces (drivers and hardware) of the diagnostic runtime system. The method call to this function is mutual exclusive to MCDSystem::unprepareVCIAccessLayer()

◆ UnprepareVciAccessLayer()

void OpenTestSystem.Otx.DiagManager.NoneOtxDiagApi.INoneOtxDiag.UnprepareVciAccessLayer ( )

Uninitializes the interfaces (drivers and hardware) of the diagnostic runtime system. The method call to this function is mutual exclusive to a call to MCDSystem::unprepareInterface.

The documentation for this interface was generated from the following file:

INoneOtxDiag.cs

Public Member Functions

Detailed Description

Member Function Documentation

◆ CloseVciConnection()

◆ DeselectProject()

◆ GetDbEcuMemOfFlashSession()

◆ GetDiagRuntimeSystemVersion()

◆ GetInterfaceFirmwareName()

◆ GetInterfaceFirmwareVersion()

◆ GetInterfaceHardwareName()

◆ GetInterfaceHardwareSerialNumber()

◆ GetPduApiNameList()

◆ PrepareInterface()

◆ PrepareVciAccessLayer()

◆ ReleaseDiagService()

◆ ReleaseMonitoring()

◆ ResetDiagRuntimeSystem()

◆ SetPreferredInterface()

◆ SetStaticInterfaceErrorHandler()

◆ StartDiagLoggging()

◆ StopDiagLogging()

◆ SwitchPduApi()

◆ UnprepareInterface()

◆ UnprepareVciAccessLayer()