Difference between revisions of "Extensions.Flash.GetNumberOfSegments"

From emotive
Jump to navigation Jump to search
Line 1: Line 1:
[[Category:Flash]]
+
{{DISPLAYTITLE:  '''GetNumberOfSegments'''}}[[Category:Flash]]
 
== Classification ==
 
== Classification ==
{{ClassificationActivity | GetNumberOfSegments | Specifies the number of data segments in a block | [[Term]] | [[Flash|OTX Flash extension]] | [[Flash block related terms]] | [[OutOfBoundsException]] | - }}
+
{{ClassificationActivity | GetNumberOfSegments | Specifies the number of data segments in a block | [[Term]] | [[Extensions.Flash|OTX Flash extension]] | [[Flash block related terms]] | [[OutOfBoundsException]] | - }}
  
 
== OTL Syntax ==
 
== OTL Syntax ==
Line 11: Line 11:
 
The '''GetNumberOfSegments''' term specifies the number of data segments in a return block. If there are no segments, the return value is zero, otherwise a positive number will be.
 
The '''GetNumberOfSegments''' term specifies the number of data segments in a return block. If there are no segments, the return value is zero, otherwise a positive number will be.
  
{{TermReturnValue| [[Integer]] | The number of data segments in a block.}}
+
{{TermReturnValue| [[Core.DataTypes.SimpleDataType.Integer|Integer]] | The number of data segments in a block.}}
  
 
== Properties ==
 
== Properties ==
 
{| {{TableHeader}}
 
{| {{TableHeader}}
 
{{TableRowPropertiesHeader}}
 
{{TableRowPropertiesHeader}}
{{TableRowPropertie1| Session | [[FlashSession]] | [[Term]] | - | [1] | This element represents the FlashSession in which the block of interest resides.}}
+
{{TableRowPropertie1| Session | [[Extensions.Flash.FlashSession|FlashSession]] | [[Term]] | - | [1] | This element represents the FlashSession in which the block of interest resides.}}
{{TableRowPropertie2| Block | [[Integer]] | [[Term]] | - | [1] | The number of the block from which the number of data segments to be accessed.}}
+
{{TableRowPropertie2| Block | [[Core.DataTypes.SimpleDataType.Integer|Integer]] | [[Term]] | - | [1] | The number of the block from which the number of data segments to be accessed.}}
 
|}
 
|}
  
Line 34: Line 34:
  
 
== See also ==
 
== See also ==
[[GetNumberOfOwnIdents]] <br/>
+
[[Extensions.Flash.GetNumberOfSegments|GetNumberOfSegments]] <br/>
[[GetNumberOfSecurities]] <br/>
+
[[Extensions.Flash.GetNumberOfOwnIdents|GetNumberOfOwnIdents]] <br/>
[[GetLogicalBlockID]] <br/>
+
[[Extensions.Flash.GetNumberOfSecurities|GetNumberOfSecurities]] <br/>
[[GetCompressionEncryption]] <br/>
+
[[Extensions.Flash.GetLogicalBlockID|GetLogicalBlockID]] <br/>
[[GetType]] <br/>
+
[[Extensions.Flash.GetCompressionEncryption|GetCompressionEncryption]] <br/>
[[BlockIsValidForAudience]]
+
[[Extensions.Flash.GetType|GetType]] <br/>
 +
[[Extensions.Flash.BlockIsValidForAudience|BlockIsValidForAudience]]

Revision as of 07:45, 15 February 2016

Classification

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

OTL Syntax

IntegerTerm = Flash.GetNumberOfSegments(FlashSessionTerm, IntegerTerm);

Description

The GetNumberOfSegments term specifies the number of data segments in a return block. If there are no segments, the return value is zero, otherwise a positive number will be.

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 Integer Term - [1] The number of the block from which the number of data segments to be accessed.

OTL Examples

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

ComChannel1 = DiagCom.GetComChannel("DiagnosticsCan_ECU_1", null, false);
List1 = Flash.GetListOfValidFlashSessions(@Directions:DOWNLOAD, ComChannel1, @Audiences:SUPPLIER);
FlashSession1 = Flash.GetFlashSession(List1[0]);
Integer1 = Flash.GetNumberOfSegments(FlashSession1, 1);

See also

GetNumberOfSegments
GetNumberOfOwnIdents
GetNumberOfSecurities
GetLogicalBlockID
GetCompressionEncryption
GetType
BlockIsValidForAudience