Difference between revisions of "Extensions.Flash.GetNumberOfBlocks"

From emotive
Jump to navigation Jump to search
Line 1: Line 1:
 
{{DISPLAYTITLE:  '''GetNumberOfBlocks'''}}[[Category:Flash]]
 
{{DISPLAYTITLE:  '''GetNumberOfBlocks'''}}[[Category:Flash]]
 
== Classification ==
 
== Classification ==
{{ClassificationActivity | GetNumberOfBlocks | Specifies the number of blocks in a flash session | [[Term]] | [[Extensions.Flash|OTX Flash extension]] | [[Flash session related terms]] | - | - }}
+
{{ClassificationActivity | GetNumberOfBlocks | Gets  the number of blocks in a FlashSession | [[Term]] | [[Extensions.Flash|OTX Flash extension]] | [[Extensions.Flash#Terms|Flash session related terms]] | - | - }}
  
 
== OTL Syntax ==
 
== OTL Syntax ==
Line 9: Line 9:
  
 
== Description ==
 
== Description ==
The '''GetNumberOfBlocks''' term specifies the number of blocks in a flash session. If no blocks are present, the return value is zero, otherwise a positive number will be.
+
The '''GetNumberOfBlocks''' term shall return the number of blocks in a '''FlashSession'''. If no blocks exist, the return value shall be zero, otherwise it shall be a positive number.
  
 
{{TermReturnValue| [[Core.DataTypes.SimpleDataType.Integer|Integer]] | The number of blocks in a flash session.}}
 
{{TermReturnValue| [[Core.DataTypes.SimpleDataType.Integer|Integer]] | The number of blocks in a flash session.}}
Line 16: Line 16:
 
{| {{TableHeader}}
 
{| {{TableHeader}}
 
{{TableRowPropertiesHeader}}
 
{{TableRowPropertiesHeader}}
{{TableRowPropertie1| Session | [[Extensions.Flash.FlashSession|FlashSession]] | [[Term]] | - | [1] | This element represent the FlashSession to be used.}}
+
{{TableRowPropertie2| Session | [[Extensions.Flash.FlashSession|FlashSession]] | [[Term]] | - | [1] | This element represents the '''FlashSession''' from which the number of blocks shall be returned.}}
 
|}
 
|}
  
Line 22: Line 22:
 
<syntaxhighlight lang="java" enclose="div" style="font-size: medium;">
 
<syntaxhighlight lang="java" enclose="div" style="font-size: medium;">
 
DiagCom.ComChannel ComChannel1;
 
DiagCom.ComChannel ComChannel1;
 +
Flash.FlashSession FlashSession1;
 
List<String> List1;
 
List<String> List1;
Flash.FlashSession FlashSession1;
 
 
Integer Integer1;
 
Integer Integer1;
  
ComChannel1 = DiagCom.GetComChannel("DiagnosticsCan_ECU_1", null, false);
+
/// Flow
List1 = Flash.GetListOfValidFlashSessions(@Directions:DOWNLOAD, ComChannel1, @Audiences:SUPPLIER);
+
 
FlashSession1 = Flash.GetFlashSession(List1[0]);
+
ComChannel1 = DiagCom.GetComChannel("SCHEINWERFER", "SCHEINWERFER_1", false);
 +
List1 = Flash.GetListOfValidFlashSessions(ComChannel1, @Audience:SUPPLIER, @Directions:DOWNLOAD);
 +
FlashSession1 = Flash.GetFlashSession(List1[2]);
 
Integer1 = Flash.GetNumberOfBlocks(FlashSession1);
 
Integer1 = Flash.GetNumberOfBlocks(FlashSession1);
 
</syntaxhighlight>
 
</syntaxhighlight>
Line 34: Line 36:
 
== See also ==
 
== See also ==
 
[[Extensions.Flash.GetListOfValidFlashSessions|GetListOfValidFlashSessions]] <br/>
 
[[Extensions.Flash.GetListOfValidFlashSessions|GetListOfValidFlashSessions]] <br/>
[[Extensions.Flash.GetFlashSession|GetFlashSession]] <br/>
+
[[Extensions.Flash.GetFlashSession|GetFlashSession]]<br/>
[[Extensions.Flash.GetSessionID|GetSessionID]] <br/>
+
[[Extensions.Flash.GetSessionID|GetSessionID]]<br/>
[[Extensions.Flash.GetSessionPriority|GetSessionPriority]] <br/>
+
[[Extensions.Flash.GetFlashKey|GetFlashKey]]<br/>
[[Extensions.Flash.IsDownloadSession|IsDownloadSession]] <br/>
+
[[Extensions.Flash.GetSessionPriority|GetSessionPriority]]<br/>
[[Extensions.Flash.GetFlashKey|GetFlashKey]]
+
<!--[[Extensions.Flash.GetNumberOfBlocks|GetNumberOfBlocks]]<br/>-->
 +
[[Extensions.Flash.IsDownloadSession|IsDownloadSession]]<br/>
 +
[[Extensions.DiagCom.GetComChannel|GetComChannel]]<br/>

Revision as of 10:23, 16 October 2018

Classification

Name GetNumberOfBlocks
Short Description Gets the number of blocks in a FlashSession
Class Term
Extension OTX Flash extension
Group Flash session related terms
Exceptions -
Checker Rules -
Standard Compliant Yes

OTL Syntax

IntegerTerm = Flash.GetNumberOfBlocks(FlashSessionTerm);

Description

The GetNumberOfBlocks term shall return the number of blocks in a FlashSession. If no blocks 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 blocks in a flash session.

Properties

Name Data Type Class Default Cardinality Description
Session FlashSession Term - [1] This element represents the FlashSession from which the number of blocks shall be returned.

OTL Examples

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.GetNumberOfBlocks(FlashSession1);

See also

GetListOfValidFlashSessions
GetFlashSession
GetSessionID
GetFlashKey
GetSessionPriority
IsDownloadSession
GetComChannel