Difference between revisions of "Extensions.Flash.GetUncompressedSize"

From emotive
Jump to navigation Jump to search
Line 1: Line 1:
 
{{DISPLAYTITLE:  '''GetUncompressedSize'''}}[[Category:Flash]]
 
{{DISPLAYTITLE:  '''GetUncompressedSize'''}}[[Category:Flash]]
 
== Classification ==
 
== Classification ==
{{ClassificationActivity | GetUncompressedSize | Indicates the number of bytes of uncompressed data back into a segment | [[Term]] | [[Extensions.Flash|OTX Flash extension]] | [[Flash block segment related terms]] | [[Core.Actions.Throw.Exception.OutOfBoundsException|OutOfBoundsException]] | - }}
+
{{ClassificationActivity | GetUncompressedSize | Gets the number of bytes constituting the uncompressed data contained by a segment | [[Term]] | [[Extensions.Flash|OTX Flash extension]] | [[Extensions.Flash#Tems|Flash block segment 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;">
IntegerTerm = Flash.GetUncompressedSize(FlashSessionTerm, IntegerTerm, IntegerTerm);
+
IntegerTerm = Flash.GetUncompressedSize(FlashSessionTerm, NumericTerm, NumericTerm);
 
</syntaxhighlight>
 
</syntaxhighlight>
  
 
== Description ==
 
== Description ==
The '''GetUncompressedSize''' returns the number of bytes that contain the uncompressed data in a segment.
+
The '''GetUncompressedSize''' returns the number of bytes constituting the uncompressed data contained by a segment.
  
{{TermReturnValue| [[Core.DataTypes.SimpleDataType.Integer|Integer]] | The number of bytes of the uncompressed data in a segment.}}
+
{{TermReturnValue| [[Core.DataTypes.SimpleDataType.Integer|Integer]] | The number of bytes constituting the uncompressed data contained by a segment.}}
  
 
== Properties ==
 
== Properties ==
 
{| {{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 containing the segment resides.}}
{{TableRowPropertie2| Block | [[Core.DataTypes.SimpleDataType.Integer|Integer]] | [[Term]] | - | [1] | This element represents the block in which the segment resides.}}
+
{{TableRowPropertie1| Block | [[Numeric]] | [[Term]] | - | [1] | This element represents the block in which the segment resides. [[Core.DataTypes.SimpleDataType.Float|Float]] values shall be truncated.}}
{{TableRowPropertie1| Segment | [[Core.DataTypes.SimpleDataType.Integer|Integer]] | [[Term]] | - | [1] | This element provides the segment number.}}
+
{{TableRowPropertie2| Segment | [[Numeric]] | [[Term]] | - | [1] | This element provides the segment number. [[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;
 
Integer Integer1;
  
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);
Integer1 = Flash.GetUncompressedSize(FlashSession1, 0, 0);
+
List1 = Flash.GetListOfValidFlashSessions(ComChannel1, @Audience:SUPPLIER, @Directions:DOWNLOAD);
 +
FlashSession1 = Flash.GetFlashSession(List1[2]);
 +
Integer1 = Flash.GetUncompressedSize(FlashSession1, 1, 0);
 
</syntaxhighlight>
 
</syntaxhighlight>
  
 
== See also ==
 
== See also ==
 
[[Extensions.Flash.GetStartAddress|GetStartAddress]] <br/>
 
[[Extensions.Flash.GetStartAddress|GetStartAddress]] <br/>
[[Extensions.Flash.GetCompressedSize|GetCompressedSize]]
+
[[Extensions.Flash.GetCompressedSize|GetCompressedSize]] <br/>
 +
<!--[[Extensions.Flash.GetUncompressedSize|GetUncompressedSize]]<br/>-->
 +
[[Extensions.Flash.GetListOfValidFlashSessions|GetListOfValidFlashSessions]]<br/>
 +
[[Extensions.Flash.GetFlashSession|GetFlashSession]]<br/>
 +
[[Extensions.DiagCom.GetComChannel|GetComChannel]]<br/>

Revision as of 04:05, 17 October 2018

Classification

Name GetUncompressedSize
Short Description Gets the number of bytes constituting the uncompressed data contained by a segment
Class Term
Extension OTX Flash extension
Group Flash block segment related terms
Exceptions OutOfBoundsException
Checker Rules -
Standard Compliant Yes

OTL Syntax

IntegerTerm = Flash.GetUncompressedSize(FlashSessionTerm, NumericTerm, NumericTerm);

Description

The GetUncompressedSize returns the number of bytes constituting the uncompressed data contained by a segment.

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
Integer The number of bytes constituting the uncompressed data contained by a segment.

Properties

Name Data Type Class Default Cardinality Description
FlashSession FlashSession Term - [1] This element represents the FlashSession in which the block containing the segment resides.
Block Numeric Term - [1] This element represents the block in which the segment resides. Float values shall be truncated.
Segment Numeric Term - [1] This element provides the segment number. Float values shall be truncated.

OTL Examples

DiagCom.ComChannel ComChannel1;
Flash.FlashSession FlashSession1;
List<String> List1;
Integer Integer1;

/// Flow

ComChannel1 = DiagCom.GetComChannel("SCHEINWERFER", "SCHEINWERFER_1", false);
List1 = Flash.GetListOfValidFlashSessions(ComChannel1, @Audience:SUPPLIER, @Directions:DOWNLOAD);
FlashSession1 = Flash.GetFlashSession(List1[2]);
Integer1 = Flash.GetUncompressedSize(FlashSession1, 1, 0);

See also

GetStartAddress
GetCompressedSize
GetListOfValidFlashSessions
GetFlashSession
GetComChannel