Difference between revisions of "Extensions.Flash.StoreUploadData"

From emotive
Jump to navigation Jump to search
Line 1: Line 1:
 
{{DISPLAYTITLE:  '''StoreUploadData '''}}[[Category:Flash]]
 
{{DISPLAYTITLE:  '''StoreUploadData '''}}[[Category:Flash]]
 
== Classification ==
 
== Classification ==
−
{{ClassificationActivity | StoreUploadData | Requests a OTX runtime to store data in a data storage | [[Action]]| [[Extensions.Flash|OTX Flash extension]] | [[Flash related actions]] | [[Core.Actions.Throw.Exception.InvalidReferenceException|InvalidReferenceException]] <br/> [[Extensions.Flash.UnsupportedFormatException|UnsupportedFormatException]] | - }}
+
{{ClassificationActivity | StoreUploadData | Requests a OTX runtime to store data in a data storage | [[Action]]| [[Extensions.Flash|OTX Flash extension]] | [[Extensions.Flash#Actions|Flash related actions]] | [[Core.DataTypes.ComplexDataType.InvalidReferenceException|InvalidReferenceException]] <br/> [[Extensions.Flash.UnsupportedFormatException|UnsupportedFormatException]] | - }}
  
 
== OTL Syntax ==
 
== OTL Syntax ==
 
<syntaxhighlight lang="java" enclose="div" style="font-size: medium;">
 
<syntaxhighlight lang="java" enclose="div" style="font-size: medium;">
−
Flash.StoreUploadData(BooleanTerm, ByteFieldTerm, StringTerm, NumericTerm, FlashFileFormat);
+
Flash.StoreUploadData(ByteFieldTerm, StringTerm, NumericTerm, FlashFileFormatTerm, Boolean);
 
</syntaxhighlight>
 
</syntaxhighlight>
  
 
== Description ==
 
== Description ==
−
A '''StoreUploadData'''  activity requests a OTX runtime data in a ''data storage'' to store.
+
A '''StoreUploadData'''  activity requests an OTX runtime data to store data in a data-storage
  
 
== Properties ==
 
== Properties ==
 
{| {{TableHeader}}
 
{| {{TableHeader}}
 
{{TableRowPropertiesHeader}}
 
{{TableRowPropertiesHeader}}
−
{{TableRowPropertie1| Append | [[Core.DataTypes.SimpleDataType.Boolean|Boolean]] | [[Value]] | FALSE | [1] | The Boolean value of this attribute specifies whether data is appended to existing data (true) or not (false). If not, the storage is cleaned before write access.}}
+
{{TableRowPropertie2| Append | [[Core.DataTypes.SimpleDataType.Boolean|Boolean]] | [[Value]] | FALSE | [1] | The truth-value set for this attribute defines whether data shall be appended to existing data (true) or not (false). If not, the storage shall be cleaned before write access.}}
−
{{TableRowPropertie2| Format | [[Extensions.Flash.FlashFileFormat|FlashFileFormat]] | [[Value]] | @FlashFileFormat:BINARY | [1] | <nowiki>This attribute defines the format of the file. FlashFileFormat == {INTEL|SREC|BINARY}.</nowiki>}}
+
{{TableRowPropertie1| Data | [[Core.DataTypes.ComplexDataType.ByteField|ByteField]] | [[Term]] | - | [1] | This element represents the data which shall be stored.}}
−
{{TableRowPropertie1| Data | [[Core.DataTypes.ComplexDataType.ByteField|ByteField]] | [[Term]] | - | [1] | This element provides the data to be stored.}}
+
{{TableRowPropertie2| Format | [[Extensions.Flash.FlashFileFormat|FlashFileFormat]] | [[Term]] | @FlashFileFormat:BINARY | [1] | <nowiki>This element defines the format of the flash data file. FlashFileFormat == {INTEL|SREC|BINARY}.</nowiki>}}
−
{{TableRowPropertie2| Target | [[Core.DataTypes.SimpleDataType.String|String]] | [[Term]] | - | [1] | The element comprises a data store. If the target is a URI, which describes a file, the data is stored in this file.}}
+
{{TableRowPropertie1| Target | [[Core.DataTypes.SimpleDataType.String|String]] | [[Term]] | - | [1] | The element shall provide a data storage. If the target is an URI that describes a file, the data is stored in that file.}}
−
{{TableRowPropertie1| Address | [[Core.DataTypes.SimpleDataType.Integer|Integer]] | [[Term]] | - | [1] | This element is used to store address information in the memory.}}
+
{{TableRowPropertie2| Address | [[Numeric]] | [[Term]] | - | [1] | This element shall be used to define the base address of the to-be-stored data. [[Core.DataTypes.SimpleDataType.Float|Float]] values shall be truncated.}}
 
|}
 
|}
  
 
== OTL Examples ==
 
== OTL Examples ==
 
<syntaxhighlight lang="java" enclose="div" style="font-size: medium;">
 
<syntaxhighlight lang="java" enclose="div" style="font-size: medium;">
−
DiagCom.ComChannel ComChannel1;
+
Flash.StoreUploadData(&1234FFFF, "file:///E:/Data.txt", 0, @FlashFileFormat:BINARY, false);
−
List<String> List1;
 
−
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.StoreUploadData(false, &1234FFFF, "file:///E:/Data.txt", 0, @FlashFileFormats:BINARY);
 
 
</syntaxhighlight>
 
</syntaxhighlight>
  

Revision as of 06:57, 16 October 2018

Classification

Name StoreUploadData
Short Description Requests a OTX runtime to store data in a data storage
Class Action
Extension OTX Flash extension
Group Flash related actions
Exceptions InvalidReferenceException
UnsupportedFormatException
Checker Rules -
Standard Compliant Yes

OTL Syntax

Flash.StoreUploadData(ByteFieldTerm, StringTerm, NumericTerm, FlashFileFormatTerm, Boolean);

Description

A StoreUploadData activity requests an OTX runtime data to store data in a data-storage

Properties

Name Data Type Class Default Cardinality Description
Append Boolean Value FALSE [1] The truth-value set for this attribute defines whether data shall be appended to existing data (true) or not (false). If not, the storage shall be cleaned before write access.
Data ByteField Term - [1] This element represents the data which shall be stored.
Format FlashFileFormat Term @FlashFileFormat:BINARY [1] This element defines the format of the flash data file. FlashFileFormat == {INTEL|SREC|BINARY}.
Target String Term - [1] The element shall provide a data storage. If the target is an URI that describes a file, the data is stored in that file.
Address Numeric Term - [1] This element shall be used to define the base address of the to-be-stored data. Float values shall be truncated.

OTL Examples

Flash.StoreUploadData(&1234FFFF, "file:///E:/Data.txt", 0, @FlashFileFormat:BINARY, false);

See also

GetDownloadData
SetFlashSession

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