Difference between revisions of "Extensions.Flash.GetCompressedSize"

From emotive
Jump to navigation Jump to search
(Created page with "Category:Flash == Classification == {{ClassificationActivity | GetCompressedSize | Indicates the number of bytes of the compressed data in a segment | Term | Flash|O...")
 
 
(9 intermediate revisions by 2 users not shown)
Line 1: Line 1:
−
[[Category:Flash]]
+
{{DISPLAYTITLE:  '''GetCompressedSize'''}}[[Category:Flash]]
 
== Classification ==
 
== Classification ==
−
{{ClassificationActivity | GetCompressedSize | Indicates the number of bytes of the compressed data in a segment | [[Term]] | [[Flash|OTX Flash extension]] | [[Flash block segment related terms]] | [[OutOfBoundsException]] | - }}
+
{{ClassificationActivity | GetCompressedSize | Gets the number of bytes constituting the compressed data contained by a segment.| [[Term]] | [[Extensions.Flash|OTX Flash extension]] | [[Extensions.Flash#Terms|Flash block segment 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;">
−
Integer GetCompressedSize(FlashSession session, Integer block, Integer segment);
+
IntegerTerm Flash.GetCompressedSize(FlashSessionTerm session, NumericTerm block, NumericTerm segment);
 
</syntaxhighlight>
 
</syntaxhighlight>
  
 
== Description ==
 
== Description ==
−
The '''GetCompressedSize''' returns the number of bytes that contain the compressed data in a segment.
+
The '''GetCompressedSize''' term returns the number of bytes constituting the compressed data contained by a segment.
  
−
{{TermReturnValue| [[Integer]] | The number of bytes of the compressed data in a segment.}}
+
{{TermReturnValue| [[Core.DataTypes.SimpleDataType.Integer|Integer]] | The number of bytes constituting the compressed data contained by a segment}}
  
 
== Properties ==
 
== Properties ==
 
{| {{TableHeader}}
 
{| {{TableHeader}}
 
{{TableRowPropertiesHeader}}
 
{{TableRowPropertiesHeader}}
−
{{TableRowPropertie1| FlashSession | [[FlashSession]] | [[Term]] | - | [1] | This element represents the FlashSession in which the block containing the segment resides.}}
+
{{TableRowPropertie2| Session | [[Extensions.Flash.FlashSession|FlashSession]] | [[Term]] | - | [1] | This element represents the '''FlashSession''' in which the block containing the segment resides.}}
−
{{TableRowPropertie2| Block | [[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 will be truncated.}}
−
{{TableRowPropertie1| Segment | [[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 will be truncated.}}
 
|}
 
|}
  
−
== Examples ==
+
== OTL Examples ==
 
<syntaxhighlight lang="java" enclose="div" style="font-size: medium;">
 
<syntaxhighlight lang="java" enclose="div" style="font-size: medium;">
−
Integer result = GetCompressedSize(flashSession, 0, 0);
+
/// Local Declarations
 +
 
 +
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.GetCompressedSize(FlashSession1, 1, 0);
 
</syntaxhighlight>
 
</syntaxhighlight>
  
 
== See also ==
 
== See also ==
−
[[GetStartAddress]] <br/>
+
[[Extensions.Flash.GetStartAddress|GetStartAddress]] <br/>
−
[[GetUncompressedSize]]
+
<!--[[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/>

Latest revision as of 02:22, 13 September 2019

Classification

Name GetCompressedSize
Short Description Gets the number of bytes constituting the compressed 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.GetCompressedSize(FlashSessionTerm session, NumericTerm block, NumericTerm segment);

Description

The GetCompressedSize term returns the number of bytes constituting the compressed 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 compressed data contained by a segment

Properties

Name Data Type Class Default Cardinality Description
Session 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 will be truncated.
Segment Numeric Term - [1] This element provides the segment number. Floatvalues will be truncated.

OTL Examples

/// Local Declarations

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

See also

GetStartAddress
GetUncompressedSize
GetListOfValidFlashSessions
GetFlashSession
GetComChannel

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