Difference between revisions of "Extensions.Flash.StoreUploadData"
Jump to navigation
Jump to search
| (6 intermediate revisions by one other user not shown) | |||
| 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]] | [[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( | + | Flash.StoreUploadData(ByteFieldTerm data, StringTerm target, NumericTerm address, FlashFileFormatTerm format, Boolean append); |
</syntaxhighlight> | </syntaxhighlight> | ||
== Description == | == Description == | ||
| − | A '''StoreUploadData''' activity requests | + | A '''StoreUploadData''' activity requests an OTX runtime data to store data in a data-storage |
== Properties == | == Properties == | ||
{| {{TableHeader}} | {| {{TableHeader}} | ||
{{TableRowPropertiesHeader}} | {{TableRowPropertiesHeader}} | ||
| − | {{ | + | {{TableRowPropertie2| Append | [[Core.DataTypes.SimpleDataType.Boolean|Boolean]] | [[Value]] | FALSE | [1] | The truth-value set for this attribute defines whether data will be appended to existing data (true) or not (false). If not, the storage will be cleaned before write access.}} |
| − | {{TableRowPropertie2| Format | [[Extensions.Flash.FlashFileFormat|FlashFileFormat]] | [[ | + | {{TableRowPropertie1| Data | [[Core.DataTypes.ComplexDataType.ByteField|ByteField]] | [[Term]] | - | [1] | This element represents the data which will be stored.}} |
| − | {{TableRowPropertie1 | + | {{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>}} |
| − | + | {{TableRowPropertie1| Target | [[Core.DataTypes.SimpleDataType.String|String]] | [[Term]] | - | [1] | The element will provide a data storage. If the target is an URI that describes a file, the data is stored in that file.}} | |
| − | {{ | + | {{TableRowPropertie2| Address | [[Numeric]] | [[Term]] | - | [1] | This element will be used to define the base address of the to-be-stored data. [[Core.DataTypes.SimpleDataType.Float|Float]] values will be truncated.}} |
|} | |} | ||
== OTL Examples == | == OTL Examples == | ||
<syntaxhighlight lang="java" enclose="div" style="font-size: medium;"> | <syntaxhighlight lang="java" enclose="div" style="font-size: medium;"> | ||
| − | + | /// Local Declarations | |
| − | |||
| − | |||
| − | + | /// Flow | |
| − | + | ||
| − | + | Flash.StoreUploadData(&1234FFFF, "file:///E:/Data.txt", 0, @FlashFileFormat:BINARY, false); | |
| − | Flash.StoreUploadData( | ||
</syntaxhighlight> | </syntaxhighlight> | ||
Latest revision as of 01:39, 13 September 2019
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 data, StringTerm target, NumericTerm address, FlashFileFormatTerm format, Boolean append);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 will be appended to existing data (true) or not (false). If not, the storage will be cleaned before write access. |
| Data | ByteField | Term | - | [1] | This element represents the data which will 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 will 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 will be used to define the base address of the to-be-stored data. Float values will be truncated. |
OTL Examples
/// Local Declarations
/// Flow
Flash.StoreUploadData(&1234FFFF, "file:///E:/Data.txt", 0, @FlashFileFormat:BINARY, false);