Difference between revisions of "Extensions.Flash.GetCompressionEncryption"

From emotive
Jump to navigation Jump to search
Line 1: Line 1:
 
{{DISPLAYTITLE:  '''GetCompressionEncryption'''}}[[Category:Flash]]
 
{{DISPLAYTITLE:  '''GetCompressionEncryption'''}}[[Category:Flash]]
 
== Classification ==
 
== Classification ==
−
{{ClassificationActivity | GetCompressionEncryption | Returns information compression and encryption from a block | [[Term]] | [[Extensions.Flash|OTX Flash extension]] | [[Flash block related terms]] | [[Core.Actions.Throw.Exception.OutOfBoundsException|OutOfBoundsException]] | - }}
+
{{ClassificationActivity | GetCompressionEncryption | Gets the compression and encryption information of a block | [[Term]] | [[Extensions.Flash|OTX Flash extension]] | [[Extensions.Flash#Terms|Flash block 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.GetCompressionEncryption(FlashSessionTerm, IntegerTerm);
+
StringTerm = Flash.GetCompressionEncryption(FlashSessionTerm, NumericTerm);
 
</syntaxhighlight>
 
</syntaxhighlight>
  
 
== Description ==
 
== Description ==
−
The '''GetCompressionEncryption''' term is information compression and encryption from a block.
+
The '''GetCompressionEncryption''' term returns the compression and encryption information of a block (e.g. AES encryption, LZSS compression, etc.).
  
−
{{TermReturnValue| [[Core.DataTypes.SimpleDataType.String|String]] | The information compression and encryption from a block.}}
+
{{TermReturnValue| [[Core.DataTypes.SimpleDataType.String|String]] | The compression and encryption information of a block.}}
  
 
== Properties ==
 
== Properties ==
 
{| {{TableHeader}}
 
{| {{TableHeader}}
 
{{TableRowPropertiesHeader}}
 
{{TableRowPropertiesHeader}}
−
{{TableRowPropertie1| Session | [[Extensions.Flash.FlashSession|FlashSession]] | [[Term]] | - | [1] | The Flash session in which the block is located.}}
+
{{TableRowPropertie1| Session | [[Extensions.Flash.FlashSession|FlashSession]] | [[Term]] | - | [1] | This element represents the '''FlashSession''' in which the block resides.}}
−
{{TableRowPropertie2| Block | [[Core.DataTypes.SimpleDataType.Integer|Integer]] | [[Term]] | - | [1] | The block number.}}
+
{{TableRowPropertie2| Block | [[Numeric]] | [[Term]] | - | [1] | This element represents the block number. [[Core.DataTypes.SimpleDataType.Float|Float]] values shall be truncated.}}
 
|}
 
|}
  
Line 23: Line 23:
 
<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;
+
String String1 = "";
−
String String1;
+
 
 +
/// Flow
  
−
ComChannel1 = DiagCom.GetComChannel("DiagnosticsCan_ECU_1", null, false);
+
ComChannel1 = DiagCom.GetComChannel("SCHEINWERFER", "SCHEINWERFER_1", false);
−
List1 = Flash.GetListOfValidFlashSessions(@Directions:DOWNLOAD, ComChannel1, @Audiences:SUPPLIER);
+
List1 = Flash.GetListOfValidFlashSessions(ComChannel1, @Audience:SUPPLIER, @Directions:DOWNLOAD);
−
FlashSession1 = Flash.GetFlashSession(List1[0]);
+
FlashSession1 = Flash.GetFlashSession(List1[2]);
 
String1 = Flash.GetCompressionEncryption(FlashSession1, 1);
 
String1 = Flash.GetCompressionEncryption(FlashSession1, 1);
 
</syntaxhighlight>
 
</syntaxhighlight>
Line 38: Line 40:
 
[[Extensions.Flash.GetNumberOfSecurities|GetNumberOfSecurities]] <br/>
 
[[Extensions.Flash.GetNumberOfSecurities|GetNumberOfSecurities]] <br/>
 
[[Extensions.Flash.GetLogicalBlockID|GetLogicalBlockID]] <br/>
 
[[Extensions.Flash.GetLogicalBlockID|GetLogicalBlockID]] <br/>
 +
<!--[[Extensions.Flash.GetCompressionEncryption|GetCompressionEncryption]] <br/>-->
 
[[Extensions.Flash.GetType|GetType]] <br/>
 
[[Extensions.Flash.GetType|GetType]] <br/>
−
[[Extensions.Flash.BlockIsValidForAudience|BlockIsValidForAudience]]
+
[[Extensions.Flash.BlockIsValidForAudience|BlockIsValidForAudience]]<br/>
 +
[[Extensions.Flash.GetListOfValidFlashSessions|GetListOfValidFlashSessions]]<br/>
 +
[[Extensions.Flash.GetFlashSession|GetFlashSession]]<br/>
 +
[[Extensions.DiagCom.GetComChannel|GetComChannel]]<br/>

Revision as of 02:44, 17 October 2018

Classification

Name GetCompressionEncryption
Short Description Gets the compression and encryption information of a block
Class Term
Extension OTX Flash extension
Group Flash block related terms
Exceptions OutOfBoundsException
Checker Rules -
Standard Compliant Yes

OTL Syntax

StringTerm = Flash.GetCompressionEncryption(FlashSessionTerm, NumericTerm);

Description

The GetCompressionEncryption term returns the compression and encryption information of a block (e.g. AES encryption, LZSS compression, etc.).

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 compression and encryption information of a block.

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

See also

GetNumberOfSegments
GetNumberOfOwnIdents
GetNumberOfSecurities
GetLogicalBlockID
GetType
BlockIsValidForAudience
GetListOfValidFlashSessions
GetFlashSession
GetComChannel

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