Difference between revisions of "Extensions.Flash.GetChecksum"

From emotive
Jump to navigation Jump to search
Line 1: Line 1:
 
{{DISPLAYTITLE:  ''' GetChecksum'''}}[[Category:Flash]]
 
{{DISPLAYTITLE:  ''' GetChecksum'''}}[[Category:Flash]]
 
== Classification ==
 
== Classification ==
{{ClassificationActivity | GetChecksum | Return the checksum information of a block or a session | [[Term]] | [[Extensions.Flash|OTX Flash extension]] | [[Security related terms]] | [[Core.Actions.Throw.Exception.OutOfBoundsException|OutOfBoundsException]] | - }}
+
{{ClassificationActivity | GetChecksum | Gets the checksum information of a block or a session. | [[Term]] | [[Extensions.Flash|OTX Flash extension]] | [[Extensions.Flash#Terms|Security 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 = Flash.GetChecksum(FlashSessionTerm, IntegerTerm);
+
StringTerm = Flash.GetChecksum(FlashSessionTerm, NumericTerm, NumericTerm);
 
</syntaxhighlight>
 
</syntaxhighlight>
  
 
== Description ==
 
== Description ==
The '''GetChecksum''' term is the checksum information of a block or a session.
+
The '''GetChecksum''' term returns the checksum information of a block or a session.
  
 
{{TermReturnValue| [[Core.DataTypes.SimpleDataType.String|String]] | The checksum information of a block or a session.}}
 
{{TermReturnValue| [[Core.DataTypes.SimpleDataType.String|String]] | The checksum information of a block or a session.}}
Line 16: Line 16:
 
{| {{TableHeader}}
 
{| {{TableHeader}}
 
{{TableRowPropertiesHeader}}
 
{{TableRowPropertiesHeader}}
{{TableRowPropertie1| FlashSession | [[Extensions.Flash.FlashSession|FlashSession]] | [[Term]] | - | [1] | This element represents the FlashSession in which the block containing the segment resides.}}
+
{{TableRowPropertie2| FlashSession | [[Extensions.Flash.FlashSession|FlashSession]] | [[Term]] | - | [1] | This element represents the '''FlashSession''' in which the block resides.}}
{{TableRowPropertie2| Block | [[Core.DataTypes.SimpleDataType.Integer|Integer]] | [[Term]] | - | [0..1] | This element represents the number of the block whose signature shall be returned.}}
+
{{TableRowPropertie1| Block | [[Numeric]] | [[Term]] | - | [0..1] | This element represents the number of the block whose checksum shall be returned. If the '''<block>''' element is omitted, the checksum of the flash session shall be returned instead. [[Core.DataTypes.SimpleDataType.Float|Float]] values shall be truncated.}}
{{TableRowPropertie1| Security | [[Core.DataTypes.SimpleDataType.Integer|Integer]] | [[Term]] | - | [1] | This element defines the number of the security on which the term execution is based.}}
+
{{TableRowPropertie2| Security | [[Numeric]] | [[Term]] | - | [1] | This element defines the number of the security on which the term execution is based. [[Core.DataTypes.SimpleDataType.Float|Float]] values shall be truncated.}}  
 
|}
 
|}
  
Line 24: Line 24:
 
<syntaxhighlight lang="java" enclose="div" style="font-size: medium;">
 
<syntaxhighlight lang="java" enclose="div" style="font-size: medium;">
 
DiagCom.ComChannel ComChannel1;
 
DiagCom.ComChannel ComChannel1;
 +
Flash.FlashSession FlashSession1;
 
List<String> List1;
 
List<String> List1;
Flash.FlashSession FlashSession1;
 
Integer Integer1;
 
 
String String1;
 
String String1;
  
ComChannel1 = DiagCom.GetComChannel("DiagnosticsCan_ECU_1", null, false);
+
/// Flow
List1 = Flash.GetListOfValidFlashSessions(@Directions:DOWNLOAD, ComChannel1, @Audiences:SUPPLIER);
+
 
FlashSession1 = Flash.GetFlashSession(List1[0]);
+
ComChannel1 = DiagCom.GetComChannel("SCHEINWERFER", "SCHEINWERFER_1", false);
String1 = Flash.GetChecksum(FlashSession1, 0, 0);
+
List1 = Flash.GetListOfValidFlashSessions(ComChannel1, @Audience:SUPPLIER, @Directions:DOWNLOAD);
 +
FlashSession1 = Flash.GetFlashSession(List1[2]);
 +
String1 = Flash.GetChecksum(FlashSession1, 1, 0);
 
</syntaxhighlight>
 
</syntaxhighlight>
  
Line 38: Line 39:
 
[[Extensions.Flash.GetSignature|GetSignature]] <br/>
 
[[Extensions.Flash.GetSignature|GetSignature]] <br/>
 
[[Extensions.Flash.GetValidity|GetValidity]] <br/>
 
[[Extensions.Flash.GetValidity|GetValidity]] <br/>
[[Extensions.Flash.GetSecurityMethod|GetSecurityMethod]]
+
<!--[[Extensions.Flash.GetChecksum|GetChecksum]] <br/>-->
 +
[[Extensions.Flash.GetSecurityMethod|GetSecurityMethod]]<br/>
 +
[[Extensions.Flash.GetListOfValidFlashSessions|GetListOfValidFlashSessions]] <br/>
 +
[[Extensions.Flash.GetFlashSession|GetFlashSession]] <br/>
 +
[[Extensions.DiagCom.GetComChannel|GetComChannel]]<br/>

Revision as of 04:34, 17 October 2018

Classification

Name GetChecksum
Short Description Gets the checksum information of a block or a session.
Class Term
Extension OTX Flash extension
Group Security related terms
Exceptions OutOfBoundsException
Checker Rules -
Standard Compliant Yes

OTL Syntax

StringTerm = Flash.GetChecksum(FlashSessionTerm, NumericTerm, NumericTerm);

Description

The GetChecksum term returns the checksum information of a block or a session.

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 checksum information of a block or a session.

Properties

Name Data Type Class Default Cardinality Description
FlashSession FlashSession Term - [1] This element represents the FlashSession in which the block resides.
Block Numeric Term - [0..1] This element represents the number of the block whose checksum shall be returned. If the <block> element is omitted, the checksum of the flash session shall be returned instead. Float values shall be truncated.
Security Numeric Term - [1] This element defines the number of the security on which the term execution is based. Float values shall be truncated.

OTL Examples

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

See also

GetSignature
GetValidity
GetSecurityMethod
GetListOfValidFlashSessions
GetFlashSession
GetComChannel