Difference between revisions of "Extensions.Flash.GetOwnIdentFromEcu"
Jump to navigation
Jump to search
(4 intermediate revisions by one other user not shown) | |||
Line 1: | Line 1: | ||
{{DISPLAYTITLE: '''GetOwnIdentFromEcu'''}}[[Category:Flash]] | {{DISPLAYTITLE: '''GetOwnIdentFromEcu'''}}[[Category:Flash]] | ||
== Classification == | == Classification == | ||
− | {{ClassificationActivity | GetOwnIdentFromEcu | | + | {{ClassificationActivity | GetOwnIdentFromEcu | Gets an identification string which will be read from an ECU | [[Term]] | [[Extensions.Flash|OTX Flash extension]] | [[Extensions.Flash#Terms|Own ident related terms]] | [[Core.DataTypes.ComplexDataType.OutOfBoundsException|OutOfBoundsException]] | - }} |
== OTL Syntax == | == OTL Syntax == | ||
<syntaxhighlight lang="java" enclose="div" style="font-size: medium;"> | <syntaxhighlight lang="java" enclose="div" style="font-size: medium;"> | ||
− | StringTerm | + | StringTerm Flash.GetOwnIdentFromEcu(FlashSessionTerm session, NumericTerm block, NumericTerm number); |
</syntaxhighlight> | </syntaxhighlight> | ||
== Description == | == Description == | ||
− | The '''GetOwnIdentFromEcu''' term | + | The '''GetOwnIdentFromEcu''' term returns an identification string which will be read from an [[ECU]]. The environment will store the information to access this string. The empty string will be returned, if the identification string can not be determined, e.g. because the [[ECU]] is unknown. |
− | {{TermReturnValue| [[Core.DataTypes.SimpleDataType.String|String]] | The identification string which | + | {{TermReturnValue| [[Core.DataTypes.SimpleDataType.String|String]] | The identification string which will be read from an [[ECU]].}} |
== Properties == | == Properties == | ||
{| {{TableHeader}} | {| {{TableHeader}} | ||
{{TableRowPropertiesHeader}} | {{TableRowPropertiesHeader}} | ||
− | {{ | + | {{TableRowPropertie2| Session | [[Extensions.Flash.FlashSession|FlashSession]] | [[Term]] | - | [1] | This element represents the '''FlashSession''' in which the block resides.}} |
− | {{ | + | {{TableRowPropertie1| Block | [[Numeric]] | [[Term]] | - | [1] | This element represents the block number. [[Core.DataTypes.SimpleDataType.Float|Float]] values will be truncated.}} |
− | {{ | + | {{TableRowPropertie2| Number| [[Numeric]] | [[Term]] | - | [1] | This element represents the own identification number. [[Core.DataTypes.SimpleDataType.Float|Float]] values will be truncated.}} |
|} | |} | ||
== OTL Examples == | == OTL Examples == | ||
<syntaxhighlight lang="java" enclose="div" style="font-size: medium;"> | <syntaxhighlight lang="java" enclose="div" style="font-size: medium;"> | ||
+ | /// Local Declarations | ||
+ | |||
DiagCom.ComChannel ComChannel1; | DiagCom.ComChannel ComChannel1; | ||
+ | Flash.FlashSession FlashSession1; | ||
List<String> List1; | List<String> List1; | ||
− | |||
− | |||
String String1; | String String1; | ||
− | ComChannel1 = DiagCom.GetComChannel(" | + | /// Flow |
− | List1 = Flash.GetListOfValidFlashSessions(@ | + | |
− | FlashSession1 = Flash.GetFlashSession(List1[ | + | ComChannel1 = DiagCom.GetComChannel("SCHEINWERFER", "SCHEINWERFER_1", false); |
− | String1 = Flash.GetOwnIdentFromEcu(FlashSession1, | + | List1 = Flash.GetListOfValidFlashSessions(ComChannel1, @Audience:SUPPLIER, @Directions:DOWNLOAD); |
+ | FlashSession1 = Flash.GetFlashSession(List1[2]); | ||
+ | String1 = Flash.GetOwnIdentFromEcu(FlashSession1, 1, 0); | ||
</syntaxhighlight> | </syntaxhighlight> | ||
== See also == | == See also == | ||
− | [[Extensions.Flash.GetOwnIdent|GetOwnIdent]] | + | <!--[[Extensions.Flash.GetOwnIdentFromEcu|GetOwnIdentFromEcu]]<br/>--> |
+ | [[Extensions.Flash.GetOwnIdent|GetOwnIdent]]<br/> | ||
+ | [[Extensions.Flash.GetListOfValidFlashSessions|GetListOfValidFlashSessions]]<br/> | ||
+ | [[Extensions.Flash.GetFlashSession|GetFlashSession]]<br/> | ||
+ | [[Extensions.DiagCom.GetComChannel|GetComChannel]]<br/> |
Latest revision as of 02:29, 13 September 2019
Contents
Classification
Name | GetOwnIdentFromEcu |
Short Description | Gets an identification string which will be read from an ECU |
Class | Term |
Extension | OTX Flash extension |
Group | Own ident related terms |
Exceptions | OutOfBoundsException |
Checker Rules | - |
Standard Compliant | Yes |
OTL Syntax
StringTerm Flash.GetOwnIdentFromEcu(FlashSessionTerm session, NumericTerm block, NumericTerm number);
Description
The GetOwnIdentFromEcu term returns an identification string which will be read from an ECU. The environment will store the information to access this string. The empty string will be returned, if the identification string can not be determined, e.g. because the ECU is unknown.
Return Value
The Term returns the value, see table below.
![]()
In OTX, Terms are categorized according to its return data type!
Data Type | Description |
String | The identification string which will be read from an ECU. |
Properties
Name | Data Type | Class | Default | Cardinality | Description |
Session | FlashSession | Term | - | [1] | This element represents the FlashSession in which the block resides. |
Block | Numeric | Term | - | [1] | This element represents the block number. Float values will be truncated. |
Number | Numeric | Term | - | [1] | This element represents the own identification number. Float values will be truncated. |
OTL Examples
/// Local Declarations
DiagCom.ComChannel ComChannel1;
Flash.FlashSession FlashSession1;
List<String> List1;
String String1;
/// Flow
ComChannel1 = DiagCom.GetComChannel("SCHEINWERFER", "SCHEINWERFER_1", false);
List1 = Flash.GetListOfValidFlashSessions(ComChannel1, @Audience:SUPPLIER, @Directions:DOWNLOAD);
FlashSession1 = Flash.GetFlashSession(List1[2]);
String1 = Flash.GetOwnIdentFromEcu(FlashSession1, 1, 0);
See also
GetOwnIdent
GetListOfValidFlashSessions
GetFlashSession
GetComChannel