Difference between revisions of "Extensions.Flash.GetDownloadData"

From emotive
Jump to navigation Jump to search
Line 3: Line 3:
 
{{ClassificationActivity | GetDownloadData | Fills a [[ByteField]] variable with data about the context of a session from Flash | [[Action]]| [[Flash|OTX Flash extension]] | [[Flash related actions]] | [[OutOfBoundsException]] | - }}
 
{{ClassificationActivity | GetDownloadData | Fills a [[ByteField]] variable with data about the context of a session from Flash | [[Action]]| [[Flash|OTX Flash extension]] | [[Flash related actions]] | [[OutOfBoundsException]] | - }}
  
== Pseudo-Code Syntax ==
+
== OTL Syntax ==
 
<syntaxhighlight lang="java" enclose="div" style="font-size: medium;">
 
<syntaxhighlight lang="java" enclose="div" style="font-size: medium;">
GetDownloadData(FlashSession session, Numeric block, Numeric segment, Numeric size, Numeric position, ByteFieldVariable data);
+
Flash.GetDownloadData(FlashSession, NumericTerm, NumericTerm, NumericTerm, NumericTerm, ByteFieldVariable);
 
</syntaxhighlight>
 
</syntaxhighlight>
  
Line 22: Line 22:
 
|}
 
|}
  
== Examples ==
+
== OTL Examples ==
 
<syntaxhighlight lang="java" enclose="div" style="font-size: medium;">
 
<syntaxhighlight lang="java" enclose="div" style="font-size: medium;">
GetDownloadData(flashSession, 0, 0, 0, 0, byteFieldVariable);
+
DiagCom.ComChannel ComChannel1;
 +
List<String> List1;
 +
ByteField Data1;
 +
Flash.FlashSession FlashSession1;
 +
 
 +
ComChannel1 = DiagCom.GetComChannel("DiagnosticsCan_ECU_1", null, false);
 +
List1 = Flash.GetListOfValidFlashSessions(@Directions:DOWNLOAD, ComChannel1, @Audiences:SUPPLIER);
 +
FlashSession1 = Flash.GetFlashSession(List1[0]);
 +
Flash.GetDownloadData(FlashSession1, 0, 0, 1, 0, Data1);
 
</syntaxhighlight>
 
</syntaxhighlight>
  

Revision as of 09:52, 6 February 2015

Classification

Name GetDownloadData
Short Description Fills a ByteField variable with data about the context of a session from Flash
Class Action
Extension OTX Flash extension
Group Flash related actions
Exceptions OutOfBoundsException
Checker Rules -
Standard Compliant Yes

OTL Syntax

Flash.GetDownloadData(FlashSession, NumericTerm, NumericTerm, NumericTerm, NumericTerm, ByteFieldVariable);

Description

GetDownloadData fills a given otx:ByteField variable with data about the context of a session from Flash.

Properties

Name Data Type Class Default Cardinality Description
Session FlashSession Term - [1] Flash session which provides data which are addressed.
Block Integer Term - [1] By this element, a block in the context of Flash session is considered. This value should be in the range of the existing blocks.
Segment Integer Term - [1] By this element, a segment in the context of Flash session is considered. This value should be in the range of existing segments.
Size Integer Term - [1] This element defines how much bytes of data from the context to be read. It should be a positive value.
Position Integer Term - [1] This element defines the first position, to be read by the activity. Position must be greater than or equal to zero and not greater than the size of the segment minus one.
Data ByteField Variable - [1] This item sets the variable into which the read data should be stored.

OTL Examples

DiagCom.ComChannel ComChannel1;
List<String> List1;
ByteField Data1;
Flash.FlashSession FlashSession1;

ComChannel1 = DiagCom.GetComChannel("DiagnosticsCan_ECU_1", null, false);
List1 = Flash.GetListOfValidFlashSessions(@Directions:DOWNLOAD, ComChannel1, @Audiences:SUPPLIER);
FlashSession1 = Flash.GetFlashSession(List1[0]);
Flash.GetDownloadData(FlashSession1, 0, 0, 1, 0, Data1);

See also

StoreUploadData
SetFlashSession