Difference between revisions of "Extensions.Flash.GetNumberOfOwnIdents"

From emotive
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;">
/// Local Declarations
+
IntegerTerm Flash.GetNumberOfOwnIdents(FlashSessionTerm session, NumericTerm block);
Integer IntegerVariable;
 
/// Flow
 
IntegerVariable = Flash.GetNumberOfOwnIdents(FlashSessionTerm, NumericTerm);
 
 
</syntaxhighlight>
 
</syntaxhighlight>
  
 
== Description ==
 
== Description ==
The '''GetNumberOfOwnIdents''' term  shall return the number of required and to-be-fulfilled identifications of a block.
+
The '''GetNumberOfOwnIdents''' term  will return the number of required and to-be-fulfilled identifications of a block.
  
 
{{TermReturnValue| [[Core.DataTypes.SimpleDataType.Integer|Integer]] | The number of identifications of a block.}}
 
{{TermReturnValue| [[Core.DataTypes.SimpleDataType.Integer|Integer]] | The number of identifications of 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 identifications shall be retrieved. [[Core.DataTypes.SimpleDataType.Float|Float]] values shall be truncated. }}
+
{{TableRowPropertie2| Block | [[Numeric]] | [[Term]] | - | [1] | This element provides the number of the block from which the number of identifications will be retrieved. [[Core.DataTypes.SimpleDataType.Float|Float]] values will be truncated. }}
 
|}
 
|}
  

Latest revision as of 02:17, 13 September 2019

Classification

Name GetNumberOfOwnIdents
Short Description Gets the number of identifications of a block
Class Term
Extension OTX Flash extension
Group Flash block related terms
Exceptions OutOfBoundsException
Checker Rules -
Standard Compliant Yes

OTL Syntax

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

Description

The GetNumberOfOwnIdents term will return the number of required and to-be-fulfilled identifications of a block.

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 identifications of 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 identifications 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.GetNumberOfOwnIdents(FlashSession1, 1);

See also

GetNumberOfSegments
GetNumberOfSecurities
GetLogicalBlockID
GetCompressionEncryption
GetType
BlockIsValidForAudience
GetListOfValidFlashSessions
GetFlashSession
GetComChannel