Difference between revisions of "Extensions.Flash.CreateFlashJobByName"
Jump to navigation
Jump to search
| Line 1: | Line 1: | ||
{{DISPLAYTITLE: '''CreateFlashJobByName'''}}[[Category:Flash]] | {{DISPLAYTITLE: '''CreateFlashJobByName'''}}[[Category:Flash]] | ||
== Classification == | == Classification == | ||
| − | {{ClassificationActivity | CreateFlashJobByName | Create a new '''FlashJob''' for the specified '''ComChannel''' | [[Term]] | [[Extensions.Flash|OTX Flash extension]] | [[Flash jobs related terms]] | [[ | + | {{ClassificationActivity | CreateFlashJobByName | Create a new '''FlashJob''' for the specified '''ComChannel''' | [[Term]] | [[Extensions.Flash|OTX Flash extension]] | [[Extensions.Flash#Terms|Flash jobs related terms]] | [[Extensions.DiagCom.UnknownTargetException|UnknownTargetException]] | - }} |
== OTL Syntax == | == OTL Syntax == | ||
<syntaxhighlight lang="java" enclose="div" style="font-size: medium;"> | <syntaxhighlight lang="java" enclose="div" style="font-size: medium;"> | ||
| − | FlashJobTerm = Flash.CreateFlashJobByName(ComChannelTerm, StringTerm); | + | FlashJobTerm = Flash.CreateFlashJobByName(ComChannelTerm, StringTerm, FlashSessionTerm); |
</syntaxhighlight> | </syntaxhighlight> | ||
== Description == | == Description == | ||
| − | The '''CreateFlashJobByName''' term create a new '''FlashJob''' for the specified '''ComChannel'''. The '''FlashJob''' can subsequently be used for initiating an ECU reprogramming session. | + | The '''CreateFlashJobByName''' term create a new '''FlashJob''' for the specified '''ComChannel'''. The '''FlashJob''' can subsequently be used for initiating an ECU reprogramming session. Optionally a [[Extensions.Flash.FlashSession|FlashSession]] can be specified which will be used by the '''FlashJob''' for reprogramming (alternatively the [[Extensions.Flash.SetFlashSession|SetFlashSession]] action can be used to assign a different [[Extensions.Flash.FlashSession|FlashSession]] to an already existing '''FlashJob''' object). |
| + | |||
{{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 15: | 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| Name | [[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'''. |
| + | Th}} | ||
|} | |} | ||
| Line 23: | Line 25: | ||
<syntaxhighlight lang="java" enclose="div" style="font-size: medium;"> | <syntaxhighlight lang="java" enclose="div" style="font-size: medium;"> | ||
DiagCom.ComChannel ComChannel1; | DiagCom.ComChannel ComChannel1; | ||
| − | + | Flash.FlashSession FlashSession1; | |
Flash.FlashJob FlashJob1; | Flash.FlashJob FlashJob1; | ||
| − | ComChannel1 = DiagCom.GetComChannel(" | + | /// Flow |
| − | + | ||
| − | FlashJob1 = Flash.CreateFlashJobByName(ComChannel1, " | + | ComChannel1 = DiagCom.GetComChannel("SCHEINWERFER", NULL, false); |
| + | FlashSession1 = Flash.GetFlashSession("_7PP907357F_7520"); | ||
| + | FlashJob1 = Flash.CreateFlashJobByName(ComChannel1, "Flash Jobs FlashJob_UDS", FlashSession1); | ||
</syntaxhighlight> | </syntaxhighlight> | ||
| Line 34: | Line 38: | ||
[[Extensions.Flash.CreateFlashJob|CreateFlashJob]] <br/> | [[Extensions.Flash.CreateFlashJob|CreateFlashJob]] <br/> | ||
[[Extensions.Flash.CreateFlashJobBySemantic|CreateFlashJobBySemantic]] <br/> | [[Extensions.Flash.CreateFlashJobBySemantic|CreateFlashJobBySemantic]] <br/> | ||
| + | [[Extensions.Flash.GetFlashSession|GetFlashSession]] <br/> | ||
[[Extensions.DiagCom.GetComChannel|GetComChannel]] | [[Extensions.DiagCom.GetComChannel|GetComChannel]] | ||
Revision as of 07:59, 16 October 2018
Contents
Classification
| Name | CreateFlashJobByName |
| Short Description | Create a new FlashJob for the specified ComChannel |
| Class | Term |
| Extension | OTX Flash extension |
| Group | Flash jobs related terms |
| Exceptions | UnknownTargetException |
| Checker Rules | - |
| Standard Compliant | Yes |
OTL Syntax
FlashJobTerm = Flash.CreateFlashJobByName(ComChannelTerm, StringTerm, FlashSessionTerm);Description
The CreateFlashJobByName term create a new FlashJob for the specified ComChannel. The FlashJob can subsequently be used for initiating an ECU reprogramming session. Optionally a FlashSession can be specified which will be used by the FlashJob for reprogramming (alternatively the SetFlashSession action can be used to assign a different FlashSession to an already existing FlashJob object).
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 |
| Name | 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.
Th |
OTL Examples
DiagCom.ComChannel ComChannel1;
Flash.FlashSession FlashSession1;
Flash.FlashJob FlashJob1;
/// Flow
ComChannel1 = DiagCom.GetComChannel("SCHEINWERFER", NULL, false);
FlashSession1 = Flash.GetFlashSession("_7PP907357F_7520");
FlashJob1 = Flash.CreateFlashJobByName(ComChannel1, "Flash Jobs FlashJob_UDS", FlashSession1);See also
CreateFlashJob
CreateFlashJobBySemantic
GetFlashSession
GetComChannel
