Difference between revisions of "Extensions.Flash.GetDownloadData"

From emotive
Jump to navigation Jump to search
Line 1: Line 1:
 
{{DISPLAYTITLE:  '''GetDownloadData'''}}[[Category:Flash]]
 
{{DISPLAYTITLE:  '''GetDownloadData'''}}[[Category:Flash]]
 
== Classification ==
 
== Classification ==
−
{{ClassificationActivity | GetDownloadData | Fills a [[Core.DataTypes.ComplexDataType.ByteField|ByteField]] variable with data about the context of a session from Flash | [[Action]]| [[Extensions.Flash|OTX Flash extension]] | [[Flash related actions]] | [[Core.Actions.Throw.Exception.OutOfBoundsException|OutOfBoundsException]] | - }}
+
{{ClassificationActivity | GetDownloadData | Fills a given '''otx:ByteField''' variable with data from the '''FlashSession''' context. | [[Action]]| [[Extensions.Flash|OTX Flash extension]] | [[Extensions.Flash#Actions|Flash related actions]] | [[Core.DataTypes.ComplexDataType.OutOfBoundsException|OutOfBoundsException]] | - }}
  
 
== OTL Syntax ==
 
== OTL Syntax ==
 
<syntaxhighlight lang="java" enclose="div" style="font-size: medium;">
 
<syntaxhighlight lang="java" enclose="div" style="font-size: medium;">
−
Flash.GetDownloadData(FlashSession, NumericTerm, NumericTerm, NumericTerm, NumericTerm, ByteFieldVariable);
+
Flash.GetDownloadData(FlashSessionTerm, NumericTerm, NumericTerm, NumericTerm, NumericTerm, ByteFieldVariable);
 
</syntaxhighlight>
 
</syntaxhighlight>
  
 
== Description ==
 
== Description ==
−
'''GetDownloadData''' fills a given '''otx:ByteField''' variable with data about the context of a session from Flash.
+
'''GetDownloadData''' shall fill a given [[Core.DataTypes.ComplexDataType.ByteField|otx:ByteField]] variable with data from the [[Extensions.Flash.FlashSession|FlashSession]] context.
  
 
== Properties ==
 
== Properties ==
 
{| {{TableHeader}}
 
{| {{TableHeader}}
 
{{TableRowPropertiesHeader}}
 
{{TableRowPropertiesHeader}}
−
{{TableRowPropertie1| Session | [[Extensions.Flash.FlashSession|FlashSession]] | [[Term]] | - | [1] | Flash session which provides data which are addressed.}}
+
{{TableRowPropertie1| Session | [[Extensions.Flash.FlashSession|FlashSession]] | [[Term]] | - | [1] | Represents the '''FlashSession''' which provides the data that shall be addressed.}}
−
{{TableRowPropertie2| Block | [[Core.DataTypes.SimpleDataType.Integer|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.}}
+
{{TableRowPropertie2| Block | [[Numeric]] | [[Term]] | - | [1] | By this element, a block in the [[Extensions.Flash.FlashSession|FlashSession]] context shall be addressed. The value shall be in the range of the existing blocks. [[Core.DataTypes.SimpleDataType.Float|Float]] values shall be truncated.}}
−
{{TableRowPropertie1| Segment | [[Core.DataTypes.SimpleDataType.Integer|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.}}
+
{{TableRowPropertie1| Segment | [[Numeric]] | [[Term]] | - | [1] |This element shall address a segment in the [[Extensions.Flash.FlashSession|FlashSession]] context. The value shall be in the range of the existing segments in the block. [[Core.DataTypes.SimpleDataType.Float|Float]] values shall be truncated.}}
−
{{TableRowPropertie2| Size | [[Core.DataTypes.SimpleDataType.Integer|Integer]] | [[Term]] | - | [1] | This element defines how much bytes of data from the context to be read. It should be a positive value.}}
+
{{TableRowPropertie2| Size | [[Numeric]] | [[Term]] | - | [1] | This element defines how much bytes of memory shall be read from the context. It shall be a positive value. [[Core.DataTypes.SimpleDataType.Float|Float]] values shall be truncated.}}
−
{{TableRowPropertie1| Position | [[Core.DataTypes.SimpleDataType.Integer|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.}}
+
{{TableRowPropertie1| 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. [[Core.DataTypes.SimpleDataType.Float|Float]] values shall be truncated.}}
−
{{TableRowPropertie2| Data | [[Core.DataTypes.ComplexDataType.ByteField|ByteField]] | [[Variable]] | - | [1] | This item sets the variable into which the read data should be stored.}}
+
{{TableRowPropertie2| Data | [[Core.DataTypes.ComplexDataType.ByteField|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.}}
 
|}
 
|}
  
Line 25: Line 25:
 
<syntaxhighlight lang="java" enclose="div" style="font-size: medium;">
 
<syntaxhighlight lang="java" enclose="div" style="font-size: medium;">
 
DiagCom.ComChannel ComChannel1;
 
DiagCom.ComChannel ComChannel1;
−
List<String> List1;
 
 
ByteField Data1;
 
ByteField Data1;
 
Flash.FlashSession FlashSession1;
 
Flash.FlashSession FlashSession1;
  
−
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_LED_RECHTS", NULL, false);
 +
FlashSession1 = Flash.GetFlashSession("_7PP907357F_7520");
 
Flash.GetDownloadData(FlashSession1, 0, 0, 1, 0, Data1);
 
Flash.GetDownloadData(FlashSession1, 0, 0, 1, 0, Data1);
 
</syntaxhighlight>
 
</syntaxhighlight>

Revision as of 04:47, 16 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

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

Retrieved from "http://emotive.de/wiki/index.php?title=Extensions.Flash.GetDownloadData&oldid=7822"