Difference between revisions of "Extensions.Flash.CreateFlashJob"
Jump to navigation
Jump to search
| (6 intermediate revisions by the same user not shown) | |||
| Line 1: | Line 1: | ||
| − | [[Category:Flash]] | + | {{DISPLAYTITLE: '''CreateFlashJob'''}}[[Category:Flash]] |
== Classification == | == Classification == | ||
| − | {{ClassificationActivity | CreateFlashJob | Create a new '''FlashJob | + | {{ClassificationActivity | CreateFlashJob | Create a new '''FlashJob''' | [[Term]] | [[Extensions.Flash|OTX Flash extension]] | [[Extensions.Flash#Terms|Flash jobs related terms]] | - | - }} |
== 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.CreateFlashJob(ComChannelTerm comChannel, FlashSessionTerm session); |
</syntaxhighlight> | </syntaxhighlight> | ||
== Description == | == Description == | ||
| − | The '''CreateFlashJob''' term | + | The '''CreateFlashJob''' term creates a new '''FlashJob''' for the specified '''FlashSession'''. The '''FlashJob''' can subsequently be used for initiating an ECU reprogramming session. |
| − | {{TermReturnValue| [[FlashJob]] | A new FlashJob for the specified FlashSession.}} | + | {{TermReturnValue| [[Extensions.Flash.FlashJob|FlashJob]] | A new FlashJob for the specified FlashSession.}} |
== Properties == | == Properties == | ||
{| {{TableHeader}} | {| {{TableHeader}} | ||
{{TableRowPropertiesHeader}} | {{TableRowPropertiesHeader}} | ||
| − | {{TableRowPropertie1| ComChannel | [[ComChannel]] | [[Term]] | - | [0..1] | | + | {{TableRowPropertie1| ComChannel | [[Extensions.DiagCom.ComChannel|ComChannel]] | [[Term]] | - | [0..1] | This optionally specifies the '''diag:ComChannel''' object to which the to-be-created '''FlashJob''' belongs to and will be executed on when the [[Extensions.DiagCom.ExecuteDiagService|diag:ExecuteDiagService]] action is used}} |
| − | {{TableRowPropertie2| Session | [[FlashSession]] | [[Term]] | - | [1] | This element represents the FlashSession to be programmed by the FlashJob.}} | + | {{TableRowPropertie2| Session | [[Extensions.Flash.FlashSession|FlashSession]] | [[Term]] | - | [1] | This 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.FlashSession FlashSession1; | ||
Flash.FlashJob FlashJob1; | Flash.FlashJob FlashJob1; | ||
| − | ComChannel1 = DiagCom.GetComChannel(" | + | /// Flow |
| − | + | ||
| − | FlashSession1 = Flash.GetFlashSession( | + | ComChannel1 = DiagCom.GetComChannel("SCHEINWERFER_LED_LINKS", "Scheinwerfer_LED_DK2F_001", false); |
| + | FlashSession1 = Flash.GetFlashSession("_7PP941472D_7500"); | ||
FlashJob1 = Flash.CreateFlashJob(ComChannel1, FlashSession1); | FlashJob1 = Flash.CreateFlashJob(ComChannel1, FlashSession1); | ||
</syntaxhighlight> | </syntaxhighlight> | ||
== See also == | == See also == | ||
| − | [[CreateFlashJobByName]] <br/> | + | [[Extensions.Flash.CreateFlashJobByName|CreateFlashJobByName]] <br/> |
| − | [[CreateFlashJobBySemantic]] <br/> | + | [[Extensions.Flash.CreateFlashJobBySemantic|CreateFlashJobBySemantic]] <br/> |
| − | [[GetComChannel]] | + | [[Extensions.Flash.GetFlashSession|GetFlashSession]] <br/> |
| + | [[Extensions.DiagCom.GetComChannel|GetComChannel]] | ||
Latest revision as of 03:50, 5 November 2018
Contents
Classification
| Name | CreateFlashJob |
| Short Description | Create a new FlashJob |
| Class | Term |
| Extension | OTX Flash extension |
| Group | Flash jobs related terms |
| Exceptions | - |
| Checker Rules | - |
| Standard Compliant | Yes |
OTL Syntax
FlashJobTerm Flash.CreateFlashJob(ComChannelTerm comChannel, FlashSessionTerm session);Description
The CreateFlashJob term creates a new FlashJob for the specified FlashSession. 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 FlashSession. |
Properties
| Name | Data Type | Class | Default | Cardinality | Description |
| ComChannel | ComChannel | Term | - | [0..1] | This optionally 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 |
| Session | FlashSession | Term | - | [1] | This 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_LED_LINKS", "Scheinwerfer_LED_DK2F_001", false);
FlashSession1 = Flash.GetFlashSession("_7PP941472D_7500");
FlashJob1 = Flash.CreateFlashJob(ComChannel1, FlashSession1);See also
CreateFlashJobByName
CreateFlashJobBySemantic
GetFlashSession
GetComChannel
