Difference between revisions of "Extensions.Flash.GetCompressionEncryption"
Jump to navigation
Jump to search
| (4 intermediate revisions by one other user not shown) | |||
| Line 1: | Line 1: | ||
{{DISPLAYTITLE: '''GetCompressionEncryption'''}}[[Category:Flash]] | {{DISPLAYTITLE: '''GetCompressionEncryption'''}}[[Category:Flash]] | ||
== Classification == | == Classification == | ||
| − | {{ClassificationActivity | GetCompressionEncryption | | + | {{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 | + | StringTerm Flash.GetCompressionEncryption(FlashSessionTerm session, NumericTerm block); |
</syntaxhighlight> | </syntaxhighlight> | ||
== Description == | == Description == | ||
| − | The '''GetCompressionEncryption''' term | + | 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 | + | {{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] | | + | {{TableRowPropertie1| Session | [[Extensions.Flash.FlashSession|FlashSession]] | [[Term]] | - | [1] | This element represents the '''FlashSession''' in which the block resides.}} |
| − | {{TableRowPropertie2| Block | [[ | + | {{TableRowPropertie2| Block | [[Numeric]] | [[Term]] | - | [1] | This element represents the block 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; | + | |
| + | /// Flow | ||
| − | ComChannel1 = DiagCom.GetComChannel(" | + | ComChannel1 = DiagCom.GetComChannel("SCHEINWERFER", "SCHEINWERFER_1", false); |
| − | List1 = Flash.GetListOfValidFlashSessions(@ | + | List1 = Flash.GetListOfValidFlashSessions(ComChannel1, @Audience:SUPPLIER, @Directions:DOWNLOAD); |
| − | FlashSession1 = Flash.GetFlashSession(List1[ | + | FlashSession1 = Flash.GetFlashSession(List1[2]); |
String1 = Flash.GetCompressionEncryption(FlashSession1, 1); | String1 = Flash.GetCompressionEncryption(FlashSession1, 1); | ||
</syntaxhighlight> | </syntaxhighlight> | ||
| Line 38: | Line 42: | ||
[[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/> | ||
Latest revision as of 02:27, 13 September 2019
Contents
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 session, NumericTerm block);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.
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 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.GetCompressionEncryption(FlashSession1, 1);See also
GetNumberOfSegments
GetNumberOfOwnIdents
GetNumberOfSecurities
GetLogicalBlockID
GetType
BlockIsValidForAudience
GetListOfValidFlashSessions
GetFlashSession
GetComChannel
