Extensions.Flash.GetCompressedSize

From emotive
Jump to navigation Jump to search

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