Extensions.ComInterface.GetComInterfaceProperties

From emotive
Jump to navigation Jump to search

Classification

Name GetComInterfaceProperties
Short Description A map of interface properties as Map[[[String]], String]
Class Term
Extension OTX ComInterface extension
Group ComInterface related Terms
Exceptions
Checker Rules
Standard Compliant Yes

OTL Syntax

MapTerm ComInterface.GetComInterfaceProperties(ComInterfaceTerm comInterface);

Description

This 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 LongName [The information's are contained in concatenation of pVendorModuleName and pVendorAdditionalInfo, see ISO 22900-3 Chapter HandlingDoIPEntities] of the corresponding MCDInterface object. The application adds each key value pair to the map. Only available values will 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.

Key Value
Type MVCI_ISO_13400_DoIP_Entity
EID 0A:1B:2C:3D:4E:5F
LA 4096
IP 192.168.1.255
VIN ABCDEFG1234567XYZ
GroupID 12
ClampState true
BatteryVoltage 12.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 from an available connection, this means in not connected modus less keys are contained.

Return Value

The Term returns the value, see table below.

Icons Note.png In OTX, Terms are categorized according to its return data type!
Data Type Description
Map A map of interface properties as Map[ String, String].

Properties

Name Data Type Class Default Cardinality Description
comInterface ComInterface Term - [1..1] Represents the handle of the communication interface of which the properties will be got.


See also

ActivateEthernet
CloseComInterface
ConnectComInterface
DeactivateEthernet
CreateComChannelFromComInterface
GetBatteryVoltageFromComInterface
GetComChannelFromComInterface
GetComInterface
GetComInterfaceNameListFromEthernet
GetComInterfaceResourceNameList
GetIgnitionStateFromComInterface
IsEthernetActivated
IsInterfaceConnected
GetComInterfaceNameList
GetDefaultComInterfaceName