Difference between revisions of "Extensions.Flash.IsDownloadSession"

From emotive
Jump to navigation Jump to search
Line 1: Line 1:
 
{{DISPLAYTITLE:  '''IsDownloadSession'''}}[[Category:Flash]]
 
{{DISPLAYTITLE:  '''IsDownloadSession'''}}[[Category:Flash]]
 
== Classification ==
 
== Classification ==
{{ClassificationActivity | IsDownloadSession | Check if the flash session's direction is '''DOWNLOAD''' | [[Term]] | [[Extensions.Flash|OTX Flash extension]] | [[Flash session related terms]] | - | - }}
+
{{ClassificationActivity | IsDownloadSession | Checks whether the flash session's direction is '''DOWNLOAD''' or not. | [[Term]] | [[Extensions.Flash|OTX Flash extension]] | [[Extensions.Flash#Terms|Flash session related terms]] | - | - }}
  
 
== OTL Syntax ==
 
== OTL Syntax ==
Line 9: Line 9:
  
 
== Description ==
 
== Description ==
The '''IsDownloadSession''' term return true if and only if the flash session's direction is '''DOWNLOAD'''. If the session's direction is '''UPLOAD''', false shall be returned.
+
The '''IsDownloadSession''' term shall return '''True''' if and only if the flash session's direction is '''DOWNLOAD'''. If the session's direction is '''UPLOAD''', '''false''' shall be returned.
  
 
{{TermReturnValue| [[Core.DataTypes.SimpleDataType.Boolean|Boolean]] | Return true if the flash session's direction is '''DOWNLOAD''', otherwise return false.}}
 
{{TermReturnValue| [[Core.DataTypes.SimpleDataType.Boolean|Boolean]] | Return true if the flash session's direction is '''DOWNLOAD''', otherwise return false.}}
Line 16: Line 16:
 
{| {{TableHeader}}
 
{| {{TableHeader}}
 
{{TableRowPropertiesHeader}}
 
{{TableRowPropertiesHeader}}
{{TableRowPropertie1| Session | [[Extensions.Flash.FlashSession|FlashSession]] | [[Term]] | - | [1] | This element shall represent the FlashSession from which the direction shall be determined. }}
+
{{TableRowPropertie1| Session | [[Extensions.Flash.FlashSession|FlashSession]] | [[Term]] | - | [1] | This element shall represent the '''FlashSession''' from which the direction shall be determined.}}
 
|}
 
|}
  
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;
 
 
Boolean Boolean1 = false;
 
Boolean Boolean1 = false;
  
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]);
 
Boolean1 = Flash.IsDownloadSession(FlashSession1);
 
Boolean1 = Flash.IsDownloadSession(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.GetNumberOfBlocks|GetNumberOfBlocks]] <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:37, 16 October 2018

Classification

Name IsDownloadSession
Short Description Checks whether the flash session's direction is DOWNLOAD or not.
Class Term
Extension OTX Flash extension
Group Flash session related terms
Exceptions -
Checker Rules -
Standard Compliant Yes

OTL Syntax

BooleanTerm = Flash.IsDownloadSession(FlashSessionTerm);

Description

The IsDownloadSession term shall return True if and only if the flash session's direction is DOWNLOAD. If the session's direction is UPLOAD, false shall be returned.

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
Boolean Return true if the flash session's direction is DOWNLOAD, otherwise return false.

Properties

Name Data Type Class Default Cardinality Description
Session FlashSession Term - [1] This element shall represent the FlashSession from which the direction shall be determined.

OTL Examples

DiagCom.ComChannel ComChannel1;
Flash.FlashSession FlashSession1;
List<String> List1;
Boolean Boolean1 = false;

/// Flow

ComChannel1 = DiagCom.GetComChannel("SCHEINWERFER", "SCHEINWERFER_1", false);
List1 = Flash.GetListOfValidFlashSessions(ComChannel1, @Audience:SUPPLIER, @Directions:DOWNLOAD);
FlashSession1 = Flash.GetFlashSession(List1[2]);
Boolean1 = Flash.IsDownloadSession(FlashSession1);

See also

GetListOfValidFlashSessions
GetFlashSession
GetSessionID
GetFlashKey
GetSessionPriority
GetNumberOfBlocks
GetComChannel