Difference between revisions of "Extensions.Flash.GetNumberOfSegments"
Jump to navigation
Jump to search
| (One intermediate revision by one other user not shown) | |||
| Line 5: | Line 5: | ||
== OTL Syntax == | == OTL Syntax == | ||
<syntaxhighlight lang="java" enclose="div" style="font-size: medium;"> | <syntaxhighlight lang="java" enclose="div" style="font-size: medium;"> | ||
| − | + | IntegerTerm Flash.GetNumberOfSegments(FlashSessionTerm session, NumericTerm block); | |
| − | |||
| − | |||
| − | |||
</syntaxhighlight> | </syntaxhighlight> | ||
== Description == | == Description == | ||
| − | The '''GetNumberOfSegments''' term | + | The '''GetNumberOfSegments''' term will return the number of data segments in a block. If no segments exist, the return value will be zero, otherwise it will be a positive number. |
{{TermReturnValue| [[Core.DataTypes.SimpleDataType.Integer|Integer]] | The number of data segments in a block.}} | {{TermReturnValue| [[Core.DataTypes.SimpleDataType.Integer|Integer]] | The number of data segments in a block.}} | ||
| Line 20: | Line 17: | ||
{{TableRowPropertiesHeader}} | {{TableRowPropertiesHeader}} | ||
{{TableRowPropertie1| Session | [[Extensions.Flash.FlashSession|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 | [[Numeric]] | [[Term]] | - | [1] | This element provides the number of the block from which the number of data segments | + | {{TableRowPropertie2| Block | [[Numeric]] | [[Term]] | - | [1] | This element provides the number of the block from which the number of data segments will be retrieved. [[Core.DataTypes.SimpleDataType.Float|Float]] values will be truncated.}} |
|} | |} | ||
Latest revision as of 02:16, 13 September 2019
Contents
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 will return the number of data segments in a block. If no segments exist, the return value will be zero, otherwise it will be a positive number.
Return Value
The Term returns the value, see table below.
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 will be retrieved. Float values 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.GetNumberOfSegments(FlashSession1, 1);See also
GetNumberOfOwnIdents
GetNumberOfSecurities
GetLogicalBlockID
GetCompressionEncryption
GetType
BlockIsValidForAudience
GetListOfValidFlashSessions
GetFlashSession
GetComChannel
