Difference between revisions of "Extensions.Flash.StoreUploadData"
Jump to navigation
Jump to search
| Line 14: | Line 14: | ||
{| {{TableHeader}} | {| {{TableHeader}} | ||
{{TableRowPropertiesHeader}} | {{TableRowPropertiesHeader}} | ||
| − | {{TableRowPropertie2| Append | [[Core.DataTypes.SimpleDataType.Boolean|Boolean]] | [[Value]] | FALSE | [1] | The truth-value set for this attribute defines whether data | + | {{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.}} |
| − | {{TableRowPropertie1| Data | [[Core.DataTypes.ComplexDataType.ByteField|ByteField]] | [[Term]] | - | [1] | This element represents the data which | + | {{TableRowPropertie1| Data | [[Core.DataTypes.ComplexDataType.ByteField|ByteField]] | [[Term]] | - | [1] | This element represents the data which will 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| 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 | + | {{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 | + | {{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.}} |
|} | |} | ||
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);