Difference between revisions of "Extensions.Flash.GetOwnIdent"

From emotive
Jump to navigation Jump to search
(Created page with "Category:Flash == Classification == {{ClassificationActivity | GetOwnIdent | Return an identification string which is read from the download data.| Term | Flash|OTX...")
 
 
(8 intermediate revisions by 2 users not shown)
Line 1: Line 1:
−
[[Category:Flash]]
+
{{DISPLAYTITLE:  '''GetOwnIdent'''}}[[Category:Flash]]
 
== Classification ==
 
== Classification ==
−
{{ClassificationActivity | GetOwnIdent | Return an identification string which is read from the download data.| [[Term]] | [[Flash|OTX Flash extension]] | [[Own ident related terms]] | [[OutOfBoundsException]] | - }}
+
{{ClassificationActivity | GetOwnIdent | Gets an identification string which is read from the download data.| [[Term]] | [[Extensions.Flash|OTX Flash extension]] | [[Extensions.Flash#Terms|Own ident related terms]] | [[Core.DataTypes.ComplexDataType.OutOfBoundsException|OutOfBoundsException]] | - }}
  
−
== Pseudo-Code Syntax ==
+
== OTL Syntax ==
 
<syntaxhighlight lang="java" enclose="div" style="font-size: medium;">
 
<syntaxhighlight lang="java" enclose="div" style="font-size: medium;">
−
String GetOwnIdent(FlashSession session, Integer block, Integer number);
+
StringTerm Flash.GetOwnIdent(FlashSessionTerm session, NumericTerm block, NumericTerm number);
 
</syntaxhighlight>
 
</syntaxhighlight>
  
 
== Description ==
 
== Description ==
−
The '''GetOwnIdent''' term return an identification string which is read from the download data.
+
The '''GetOwnIdent''' term returns an identification string which is read from the download data.
  
−
{{TermReturnValue| [[String]] | The identification string which is read from the download data.}}
+
{{TermReturnValue| [[Core.DataTypes.SimpleDataType.String|String]] | The identification string which is read from the download data.}}
  
 
== Properties ==
 
== Properties ==
 
{| {{TableHeader}}
 
{| {{TableHeader}}
 
{{TableRowPropertiesHeader}}
 
{{TableRowPropertiesHeader}}
−
{{TableRowPropertie1| FlashSession | [[FlashSession]] | [[Term]] | - | [1] | This element represents the FlashSession in which the block resides.}}
+
{{TableRowPropertie2| Session | [[Extensions.Flash.FlashSession|FlashSession]] | [[Term]] | - | [1] | This element represents the '''FlashSession''' in which the block resides.}}
−
{{TableRowPropertie2| Block | [[Integer]] | [[Term]] | - | [1] | This element represents the block number.}}
+
{{TableRowPropertie1| Block | [[Numeric]] | [[Term]] | - | [1] | This element represents the block number. [[Core.DataTypes.SimpleDataType.Float|Float]] values will be truncated.}}
−
{{TableRowPropertie1| Number | [[Integer]] | [[Term]] | - | [1] | This element represents the own identification number.}}
+
{{TableRowPropertie2| Number| [[Numeric]] | [[Term]] | - | [1] | This element represents the own identification number. [[Core.DataTypes.SimpleDataType.Float|Float]] values will be truncated.}}
 
|}
 
|}
  
−
== Examples ==
+
== OTL Examples ==
 
<syntaxhighlight lang="java" enclose="div" style="font-size: medium;">
 
<syntaxhighlight lang="java" enclose="div" style="font-size: medium;">
−
String result = GetOwnIdent(flashSession, 0, 0);
+
/// 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.GetOwnIdent(FlashSession1, 1, 0);
 
</syntaxhighlight>
 
</syntaxhighlight>
  
 
== See also ==
 
== See also ==
−
[[GetOwnIdentFromEcu]]
+
[[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

Classification

Name GetOwnIdent
Short Description Gets an identification string which is read from the download data.
Class Term
Extension OTX Flash extension
Group Own ident related terms
Exceptions OutOfBoundsException
Checker Rules -
Standard Compliant Yes

OTL Syntax

StringTerm Flash.GetOwnIdent(FlashSessionTerm session, NumericTerm block, NumericTerm number);

Description

The GetOwnIdent term returns an identification string which is read from the download data.

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
String The identification string which is read from the download data.

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.GetOwnIdent(FlashSession1, 1, 0);

See also

GetOwnIdentFromEcu
GetListOfValidFlashSessions
GetFlashSession
GetComChannel

Retrieved from "http://emotive.de/wiki/index.php?title=Extensions.Flash.GetOwnIdent&oldid=9758"