OTX Reference  
OpenTestSystem.Otx.Extensions.ComInterface.Terms.GetComInterfaceProperties Class Reference

Gets a map of interface properties More...

Inheritance diagram for OpenTestSystem.Otx.Extensions.ComInterface.Terms.GetComInterfaceProperties:
Inheritance graph

Public Attributes

ComInterfaceTerm comInterface
 Represents the handle of the communication interface of which the properties should be got. More...
 
- Public Attributes inherited from OpenTestSystem.Otx.Core.Terms.Term
MetaData metaData
 Cardinality [0..1]
The MetaData type allows tools to store additional, mainly tool-specific data. More...
 

Detailed Description

Gets a map of interface properties

The GetComInterfaceProperties term returns a map of interface properties as Map[String, String].

The Map contain the following information:

  • In case of a MVCI server, the application determines the properties of a DoIP module by evaluating the LONG-NAME [The information's are contained in concatenation of pVendorModuleName and pVendorAdditionalInfo, see ISO 22900-3 Chapter 8.27] of the corresponding MCDInterface object. The application adds each key value pair to the map. Only available values shall be added to the map. This is because battery voltage and clamp state are only available if the connection of the ComInterface is established or this functionality is supported by the VCI.
  • In case of another ComInterface the key value pairs are supplier specific.

Additionally keys can be returned in either case.

KeyValue
TypeMVCI_ISO_13400_DoIP_Entity
EID0A:1B:2C:3D:4E:5F
LA4096
IP192.168.1.255
VINABCDEFG1234567XYZ
GroupID12
ClampStatetrue
BatteryVoltage12.4

GetComInterfaceResourceNameList or GetComChannelFromComInterface realizes the connection to the ComInterface. After GetComInterface the connection can be realized, but is not required. The GetComInterfaceProperties are dependent on an available connection, this means in not connected mode less keys are contained.

Syntax
MapTerm = ComInterface.GetComInterfaceProperties(ComInterfaceTerm comInterface);
ComInterfaceTerm comInterface
Represents the handle of the communication interface of which the properties should be got.
Definition: ComInterface.cs:1021

Member Data Documentation

◆ comInterface

ComInterfaceTerm OpenTestSystem.Otx.Extensions.ComInterface.Terms.GetComInterfaceProperties.comInterface

Represents the handle of the communication interface of which the properties should be got.