Difference between revisions of "Extensions.Flash.CreateFlashJobBySemantic"

From emotive
Jump to navigation Jump to search
Line 1: Line 1:
[[Category:Flash]]
+
{{DISPLAYTITLE:  '''CreateFlashJobBySemantic'''}}[[Category:Flash]]
 
== Classification ==
 
== Classification ==
{{ClassificationActivity | CreateFlashJobBySemantic | Create a new '''FlashJob''' for the specified '''ComChannel''' | [[Term]] | [[Flash|OTX Flash extension]] | [[Flash jobs related terms]] | [[AmbiguousSemanticException]] | - }}
+
{{ClassificationActivity | CreateFlashJobBySemantic | Create a new '''FlashJob''' for the specified '''ComChannel''' | [[Term]] | [[Extensions.Flash|OTX Flash extension]] | [[Flash jobs related terms]] | [[Extensions.DiagCom.AmbiguousSemanticException|AmbiguousSemanticException]] | - }}
  
 
== OTL Syntax ==
 
== OTL Syntax ==
Line 11: Line 11:
 
The '''CreateFlashJobBySemantic''' term create 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.
 
The '''CreateFlashJobBySemantic''' term create 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| [[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.}}
+
{{TableRowPropertie1| ComChannel | [[Extensions.DiagCom.ComChannel|ComChannel]] | [[Term]] | - | [1] | Communication Channel.}}
{{TableRowPropertie2| Semantic | [[String]] | [[Term]] | - | [1] | Represents the name of the to-be-created FlashJob.}}
+
{{TableRowPropertie2| Semantic | [[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.}}
+
{{TableRowPropertie1| Session | [[Extensions.Flash.FlashSession|FlashSession]] | [[Term]] | - | [0..1] | This optional element represents the FlashSession to be programmed by the FlashJob.}}
 
|}
 
|}
  
Line 31: Line 31:
  
 
== See also ==
 
== See also ==
[[CreateFlashJob]] <br/>
+
[[Extensions.Flash.CreateFlashJob|CreateFlashJob]] <br/>
[[CreateFlashJobByName]] <br/>
+
[[Extensions.Flash.CreateFlashJobByName|CreateFlashJobByName]] <br/>
[[GetComChannel]]
+
[[Extensions.DiagCom.GetComChannel|GetComChannel]]

Revision as of 07:28, 15 February 2016

Classification

Name CreateFlashJobBySemantic
Short Description Create 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, StringTerm);

Description

The CreateFlashJobBySemantic term create 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.

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] Communication Channel.
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

DiagCom.ComChannel ComChannel1;
Flash.FlashJob FlashJob1;

ComChannel1 = DiagCom.GetComChannel("DiagnosticsCan_ECU_1", null, false);
FlashJob1 = Flash.CreateFlashJobBySemantic(ComChannel1, "SEMANTIC", null);

See also

CreateFlashJob
CreateFlashJobByName
GetComChannel