Difference between revisions of "Extensions.Flash.GetDownloadData"
Jump to navigation
Jump to search
| Line 9: | Line 9: | ||
== Description == | == Description == | ||
| − | '''GetDownloadData''' | + | '''GetDownloadData''' will 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] | Represents the '''FlashSession''' which provides the data that | + | {{TableRowPropertie1| Session | [[Extensions.Flash.FlashSession|FlashSession]] | [[Term]] | - | [1] | Represents the '''FlashSession''' which provides the data that will be addressed.}} |
| − | {{TableRowPropertie2| Block | [[Numeric]] | [[Term]] | - | [1] | By this element, a block in the [[Extensions.Flash.FlashSession|FlashSession]] context | + | {{TableRowPropertie2| Block | [[Numeric]] | [[Term]] | - | [1] | By this element, a block in the [[Extensions.Flash.FlashSession|FlashSession]] context will be addressed. The value will be in the range of the existing blocks. [[Core.DataTypes.SimpleDataType.Float|Float]] values will be truncated.}} |
| − | {{TableRowPropertie1| Segment | [[Numeric]] | [[Term]] | - | [1] |This element | + | {{TableRowPropertie1| Segment | [[Numeric]] | [[Term]] | - | [1] |This element will address a segment in the [[Extensions.Flash.FlashSession|FlashSession]] context. The value will be in the range of the existing segments in the block. [[Core.DataTypes.SimpleDataType.Float|Float]] values will be truncated.}} |
| − | {{TableRowPropertie2| Size | [[Numeric]] | [[Term]] | - | [1] | This element defines how much bytes of memory | + | {{TableRowPropertie2| Size | [[Numeric]] | [[Term]] | - | [1] | This element defines how much bytes of memory will be read from the context. It will be a positive value. [[Core.DataTypes.SimpleDataType.Float|Float]] values will be truncated.}} |
| − | {{TableRowPropertie1| Position | [[Numeric]] | [[Term]] | - | [1] | This element defines the first position which | + | {{TableRowPropertie1| Position | [[Numeric]] | [[Term]] | - | [1] | This element defines the first position which will be read by the action. Position will be greater than or equal to zero and not greater than the size of the segment minus one. [[Core.DataTypes.SimpleDataType.Float|Float]] values will be truncated.}} |
| − | {{TableRowPropertie2| Data | [[Core.DataTypes.ComplexDataType.ByteField|ByteField]] | [[Variable]] | - | [1] | This item sets the variable into which the read data | + | {{TableRowPropertie2| Data | [[Core.DataTypes.ComplexDataType.ByteField|ByteField]] | [[Variable]] | - | [1] | This item sets the variable into which the read data will be stored. The size of the ByteField after execution of the action will be the number of bytes read from the context.}} |
|} | |} | ||
Latest revision as of 10:43, 12 September 2019
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 session, NumericTerm block, NumericTerm segment, NumericTerm position, NumericTerm size, ByteFieldVariable data);Description
GetDownloadData will 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 will be addressed. |
| Block | Numeric | Term | - | [1] | By this element, a block in the FlashSession context will be addressed. The value will be in the range of the existing blocks. Float values will be truncated. |
| Segment | Numeric | Term | - | [1] | This element will address a segment in the FlashSession context. The value will be in the range of the existing segments in the block. Float values will be truncated. |
| Size | Numeric | Term | - | [1] | This element defines how much bytes of memory will be read from the context. It will be a positive value. Float values will be truncated. |
| Position | Numeric | Term | - | [1] | This element defines the first position which will be read by the action. Position will be greater than or equal to zero and not greater than the size of the segment minus one. Float values will be truncated. |
| Data | ByteField | Variable | - | [1] | This item sets the variable into which the read data will be stored. The size of the ByteField after execution of the action will 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);