Difference between revisions of "Extensions.Flash.GetDownloadData"

From emotive
Jump to navigation Jump to search
Line 24: Line 24:
 
== 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;
 
ByteField Data1;
 
ByteField Data1;

Revision as of 03:32, 25 October 2018

Classification

Name GetDownloadData
Short Description Fills a given otx:ByteField variable with data from the FlashSession context.
Class Action
Extension OTX Flash extension
Group Flash related actions
Exceptions OutOfBoundsException
Checker Rules -
Standard Compliant Yes

OTL Syntax

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

Description

GetDownloadData shall fill a given otx:ByteField variable with data from the FlashSession context.

Properties

Name Data Type Class Default Cardinality Description
Session FlashSession Term - [1] Represents the FlashSession which provides the data that shall be addressed.
Block Numeric Term - [1] By this element, a block in the FlashSession context shall be addressed. The value shall be in the range of the existing blocks. Float values shall be truncated.
Segment Numeric Term - [1] This element shall address a segment in the FlashSession context. The value shall be in the range of the existing segments in the block. Float values shall be truncated.
Size Numeric Term - [1] This element defines how much bytes of memory shall be read from the context. It shall be a positive value. Float values shall be truncated.
Position Numeric Term - [1] This element defines the first position which shall be read by the action. Position shall be greater than or equal to zero and not greater than the size of the segment minus one. Float values shall be truncated.
Data ByteField Variable - [1] This item sets the variable into which the read data should be stored. The size of the ByteField after execution of the action should be the number of bytes read from the context.

OTL Examples

/// Local Declarations

DiagCom.ComChannel ComChannel1;
ByteField Data1;
Flash.FlashSession FlashSession1;

/// Flow

ComChannel1 = DiagCom.GetComChannel("SCHEINWERFER_LED_RECHTS", NULL, false);
FlashSession1 = Flash.GetFlashSession("_7PP907357F_7520");
Flash.GetDownloadData(FlashSession1, 0, 0, 1, 0, Data1);

See also

StoreUploadData
SetFlashSession