GetNumberOfSegments

From emotive
Jump to: navigation, search

Classification

Name GetNumberOfSegments
Short Description Gets the number of data segments in a block
Class Term
Extension OTX Flash extension
Group OFlash block related terms
Exceptions OutOfBoundsException
Checker Rules -
Standard Compliant Yes

OTL Syntax

IntegerTerm Flash.GetNumberOfSegments(FlashSessionTerm session, NumericTerm block);

Description

The GetNumberOfSegments term shall return the number of data segments in a block. If no segments exist, the return value shall be zero, otherwise it shall be a positive number.

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 data segments in a block.

Properties

Name Data Type Class Default Cardinality Description
Session FlashSession Term - [1] This element represents the FlashSession in which the block of interest resides.
Block Numeric Term - [1] This element provides the number of the block from which the number of data segments shall be retrieved. Float values shall 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.GetNumberOfSegments(FlashSession1, 1);

See also

GetNumberOfOwnIdents
GetNumberOfSecurities
GetLogicalBlockID
GetCompressionEncryption
GetType
BlockIsValidForAudience
GetListOfValidFlashSessions
GetFlashSession
GetComChannel