Difference between revisions of "Extensions.Flash.CreateFlashJobByName"

From emotive
Jump to navigation Jump to search
 
(9 intermediate revisions by 2 users not shown)
Line 1: Line 1:
−
[[Category:Flash]]
+
{{DISPLAYTITLE:  '''CreateFlashJobByName'''}}[[Category:Flash]]
 
== Classification ==
 
== Classification ==
−
{{ClassificationActivity | CreateFlashJobByName | Create a new '''FlashJob''' for the specified '''ComChannel''' | [[Term]] | [[Flash|OTX Flash extension]] | [[Flash jobs related terms]] | [[UnknownTargetException]] | - }}
+
{{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]] | - }}
  
−
== Pseudo-Code Syntax ==
+
== OTL Syntax ==
 
<syntaxhighlight lang="java" enclose="div" style="font-size: medium;">
 
<syntaxhighlight lang="java" enclose="div" style="font-size: medium;">
−
FlashJob CreateFlashJobByName(ComChannel myComChannel, String name);
+
FlashJobTerm Flash.CreateFlashJobByName(ComChannelTerm comChannel, StringTerm name, FlashSessionTerm session);
 
</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 creates a new '''FlashJob''' for the specified '''ComChannel'''. The '''FlashJob''' can subsequently be used for initiating an ECU reprogramming session.  
−
{{TermReturnValue| [[FlashJob]] | A new FlashJob for the specified ComChannel.}}
+
 
 +
{{TermReturnValue| [[Extensions.Flash.FlashJob|FlashJob]] | A new FlashJob for the specified ComChannel.}}
  
 
== Properties ==
 
== Properties ==
 
{| {{TableHeader}}
 
{| {{TableHeader}}
 
{{TableRowPropertiesHeader}}
 
{{TableRowPropertiesHeader}}
−
{{TableRowPropertie1| ComChannel | [[ComChannel]] | [[Term]] | - | [1] | Communication Channel.}}
+
{{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}}
−
{{TableRowPropertie2| Name | [[String]] | [[Term]] | - | [1] | Represents the name of the to-be-created FlashJob.}}
+
{{TableRowPropertie1| Name | [[Core.DataTypes.SimpleDataType.String|String]] | [[Term]] | - | [1] | Represents the name of the to-be-created '''FlashJob'''.}}
−
{{TableRowPropertie1| Session | [[FlashSession]] | [[Term]] | - | [0..1] | This optional element represents the FlashSession to be programmed by the FlashJob.}}
+
{{TableRowPropertie2| Session | [[Extensions.Flash.FlashSession|FlashSession]] | [[Term]] | - | [0..1] | This optional element represents the '''FlashSession''' to be programmed by the '''FlashJob'''.}}
 
|}
 
|}
  
−
== Examples ==
+
== OTL Examples ==
 
<syntaxhighlight lang="java" enclose="div" style="font-size: medium;">
 
<syntaxhighlight lang="java" enclose="div" style="font-size: medium;">
−
ComChannel myComCannel = GetComChannel("LL_AirbaUDS", "", false);
+
/// Local Declarations
−
FlashJob result = CreateFlashJobByName(myComCannel, "flashJobName");
+
 
 +
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, "FlashJobs_FlashJob_UDS", FlashSession1);
 
</syntaxhighlight>
 
</syntaxhighlight>
  
 
== See also ==
 
== See also ==
−
[[CreateFlashJob]] <br/>
+
[[Extensions.Flash.CreateFlashJob|CreateFlashJob]] <br/>
−
[[CreateFlashJobBySemantic]] <br/>
+
[[Extensions.Flash.CreateFlashJobBySemantic|CreateFlashJobBySemantic]] <br/>
−
[[GetComChannel]]
+
[[Extensions.Flash.GetFlashSession|GetFlashSession]] <br/>
 +
[[Extensions.DiagCom.GetComChannel|GetComChannel]]

Latest revision as of 03:52, 5 November 2018

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 comChannel, StringTerm name, FlashSessionTerm session);

Description

The CreateFlashJobByName term creates a new FlashJob for the specified ComChannel. The FlashJob can subsequently be used for initiating an ECU reprogramming session.

Return Value

The Term returns the value, see table below.

Icons Note.png 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.

OTL Examples

/// Local Declarations

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, "FlashJobs_FlashJob_UDS", FlashSession1);

See also

CreateFlashJob
CreateFlashJobBySemantic
GetFlashSession
GetComChannel

Retrieved from "http://emotive.de/wiki/index.php?title=Extensions.Flash.CreateFlashJobByName&oldid=9047"