Difference between revisions of "Extensions.Flash.CreateFlashJobBySemantic"
Jump to navigation
Jump to search
| (4 intermediate revisions by the same user not shown) | |||
| Line 1: | Line 1: | ||
{{DISPLAYTITLE: '''CreateFlashJobBySemantic'''}}[[Category:Flash]] | {{DISPLAYTITLE: '''CreateFlashJobBySemantic'''}}[[Category:Flash]] | ||
== Classification == | == Classification == | ||
| − | {{ClassificationActivity | CreateFlashJobBySemantic | | + | {{ClassificationActivity | CreateFlashJobBySemantic | Creates a new '''FlashJob''' for the specified '''ComChannel''' | [[Term]] | [[Extensions.Flash|OTX Flash extension]] | [[Extensions.Flash#Terms|Flash jobs related terms]] | [[Extensions.DiagCom.AmbiguousSemanticException|AmbiguousSemanticException]] | - }} |
== OTL Syntax == | == OTL Syntax == | ||
<syntaxhighlight lang="java" enclose="div" style="font-size: medium;"> | <syntaxhighlight lang="java" enclose="div" style="font-size: medium;"> | ||
| − | FlashJobTerm | + | FlashJobTerm Flash.CreateFlashJobBySemantic(ComChannelTerm comChannel, StringTerm semantic, FlashSessionTerm session); |
</syntaxhighlight> | </syntaxhighlight> | ||
== Description == | == Description == | ||
| − | The '''CreateFlashJobBySemantic''' term | + | The '''CreateFlashJobBySemantic''' term creates a new '''FlashJob''' for the specified '''ComChannel''' with the semantic attribute provided as an argument. The '''FlashJob''' can subsequently be used for initiating an ECU reprogramming session. |
{{TermReturnValue| [[Extensions.Flash.FlashJob|FlashJob]] | A new FlashJob for the specified ComChannel.}} | {{TermReturnValue| [[Extensions.Flash.FlashJob|FlashJob]] | A new FlashJob for the specified ComChannel.}} | ||
| Line 16: | Line 16: | ||
{| {{TableHeader}} | {| {{TableHeader}} | ||
{{TableRowPropertiesHeader}} | {{TableRowPropertiesHeader}} | ||
| − | {{ | + | {{TableRowPropertie2| ComChannel | [[Extensions.DiagCom.ComChannel|ComChannel]] | [[Term]] | - | [1] |This specifies the '''diag:ComChannel''' object to which the to-be-created [[Extensions.Flash.FlashJob|FlashJob]] belongs to and will be executed on when the [[Extensions.DiagCom.ExecuteDiagService|diag:ExecuteDiagService]] action is used.}} |
| − | {{ | + | {{TableRowPropertie1| Semantic | [[Core.DataTypes.SimpleDataType.String|String]] | [[Term]] | - | [1] | Represents the name of the to-be-created '''FlashJob'''.}} |
| − | {{ | + | {{TableRowPropertie2| Session | [[Extensions.Flash.FlashSession|FlashSession]] | [[Term]] | - | [0..1] | This optional element represents the '''FlashSession''' to be programmed by the '''FlashJob'''.}} |
|} | |} | ||
== OTL Examples == | == OTL Examples == | ||
<syntaxhighlight lang="java" enclose="div" style="font-size: medium;"> | <syntaxhighlight lang="java" enclose="div" style="font-size: medium;"> | ||
| + | /// Local Declarations | ||
| + | |||
DiagCom.ComChannel ComChannel1; | DiagCom.ComChannel ComChannel1; | ||
| + | Flash.FlashSession FlashSession1; | ||
Flash.FlashJob FlashJob1; | Flash.FlashJob FlashJob1; | ||
| − | ComChannel1 = DiagCom.GetComChannel(" | + | /// Flow |
| − | FlashJob1 = Flash.CreateFlashJobBySemantic(ComChannel1, " | + | |
| + | ComChannel1 = DiagCom.GetComChannel("SCHEINWERFER", "SCHEINWERFER_1", false); | ||
| + | FlashSession1 = Flash.GetFlashSession("_7PP907357F_7520"); | ||
| + | FlashJob1 = Flash.CreateFlashJobBySemantic(ComChannel1, "FLASHJOB", FlashSession1); | ||
</syntaxhighlight> | </syntaxhighlight> | ||
| Line 33: | Line 39: | ||
[[Extensions.Flash.CreateFlashJob|CreateFlashJob]] <br/> | [[Extensions.Flash.CreateFlashJob|CreateFlashJob]] <br/> | ||
[[Extensions.Flash.CreateFlashJobByName|CreateFlashJobByName]] <br/> | [[Extensions.Flash.CreateFlashJobByName|CreateFlashJobByName]] <br/> | ||
| + | [[Extensions.Flash.GetFlashSession|GetFlashSession]] <br/> | ||
[[Extensions.DiagCom.GetComChannel|GetComChannel]] | [[Extensions.DiagCom.GetComChannel|GetComChannel]] | ||
Latest revision as of 04:04, 5 November 2018
Contents
Classification
| Name | CreateFlashJobBySemantic |
| Short Description | Creates a new FlashJob for the specified ComChannel |
| Class | Term |
| Extension | OTX Flash extension |
| Group | Flash jobs related terms |
| Exceptions | AmbiguousSemanticException |
| Checker Rules | - |
| Standard Compliant | Yes |
OTL Syntax
FlashJobTerm Flash.CreateFlashJobBySemantic(ComChannelTerm comChannel, StringTerm semantic, FlashSessionTerm session);Description
The CreateFlashJobBySemantic term creates a new FlashJob for the specified ComChannel with the semantic attribute provided as an argument. The FlashJob can subsequently be used for initiating an ECU reprogramming session.
Return Value
The Term returns the value, see table below.
In OTX, Terms are categorized according to its return data type!
| Data Type | Description |
| FlashJob | A new FlashJob for the specified ComChannel. |
Properties
| Name | Data Type | Class | Default | Cardinality | Description |
| ComChannel | ComChannel | Term | - | [1] | This specifies the diag:ComChannel object to which the to-be-created FlashJob belongs to and will be executed on when the diag:ExecuteDiagService action is used. |
| Semantic | String | Term | - | [1] | Represents the name of the to-be-created FlashJob. |
| Session | FlashSession | Term | - | [0..1] | This optional element represents the FlashSession to be programmed by the FlashJob. |
OTL Examples
/// Local Declarations
DiagCom.ComChannel ComChannel1;
Flash.FlashSession FlashSession1;
Flash.FlashJob FlashJob1;
/// Flow
ComChannel1 = DiagCom.GetComChannel("SCHEINWERFER", "SCHEINWERFER_1", false);
FlashSession1 = Flash.GetFlashSession("_7PP907357F_7520");
FlashJob1 = Flash.CreateFlashJobBySemantic(ComChannel1, "FLASHJOB", FlashSession1);See also
CreateFlashJob
CreateFlashJobByName
GetFlashSession
GetComChannel
