Difference between revisions of "Extensions.Flash.GetNumberOfBlocks"
Jump to navigation
Jump to search
| (6 intermediate revisions by one other user not shown) | |||
| Line 1: | Line 1: | ||
{{DISPLAYTITLE: '''GetNumberOfBlocks'''}}[[Category:Flash]] | {{DISPLAYTITLE: '''GetNumberOfBlocks'''}}[[Category:Flash]] | ||
== Classification == | == Classification == | ||
| − | {{ClassificationActivity | GetNumberOfBlocks | | + | {{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 == | ||
<syntaxhighlight lang="java" enclose="div" style="font-size: medium;"> | <syntaxhighlight lang="java" enclose="div" style="font-size: medium;"> | ||
| − | IntegerTerm | + | IntegerTerm Flash.GetNumberOfBlocks(FlashSessionTerm session); |
</syntaxhighlight> | </syntaxhighlight> | ||
== Description == | == Description == | ||
| − | The '''GetNumberOfBlocks''' term | + | The '''GetNumberOfBlocks''' term will return the number of blocks in a '''FlashSession'''. If no blocks exist, the return value will be zero, otherwise it will 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}} | ||
| − | {{ | + | {{TableRowPropertie2| Session | [[Extensions.Flash.FlashSession|FlashSession]] | [[Term]] | - | [1] | This element represents the '''FlashSession''' from which the number of blocks will be returned.}} |
|} | |} | ||
== OTL Examples == | == OTL Examples == | ||
<syntaxhighlight lang="java" enclose="div" style="font-size: medium;"> | <syntaxhighlight lang="java" enclose="div" style="font-size: medium;"> | ||
| + | /// Local Declarations | ||
| + | |||
DiagCom.ComChannel ComChannel1; | DiagCom.ComChannel ComChannel1; | ||
| + | Flash.FlashSession FlashSession1; | ||
List<String> List1; | List<String> List1; | ||
| − | |||
Integer Integer1; | Integer Integer1; | ||
| − | ComChannel1 = DiagCom.GetComChannel(" | + | /// Flow |
| − | List1 = Flash.GetListOfValidFlashSessions(@ | + | |
| − | FlashSession1 = Flash.GetFlashSession(List1[ | + | 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 38: | ||
== 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. | + | <!--[[Extensions.Flash.GetNumberOfBlocks|GetNumberOfBlocks]]<br/>--> |
| + | [[Extensions.Flash.IsDownloadSession|IsDownloadSession]]<br/> | ||
| + | [[Extensions.DiagCom.GetComChannel|GetComChannel]]<br/> | ||
Latest revision as of 01:49, 13 September 2019
Contents
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 session);Description
The GetNumberOfBlocks term will return the number of blocks in a FlashSession. If no blocks 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 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 will be returned. |
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.GetNumberOfBlocks(FlashSession1);See also
GetListOfValidFlashSessions
GetFlashSession
GetSessionID
GetFlashKey
GetSessionPriority
IsDownloadSession
GetComChannel
