Extensions.DiagCom.CreateDiagServiceByName

From emotive
Revision as of 11:08, 12 September 2019 by Nb (talk | contribs)
(diff) ← Older revision | Latest revision (diff) | Newer revision → (diff)
Jump to navigation Jump to search

Classification

Name CreateDiagServiceByName
Short Description Creates a handle to a diagnostic service
Class Term
Extension OTX DiagCom extension
Group DiagService related terms
Exceptions UnknownTargetException
Checker Rules DiagCom_Chk100
DiagCom_Chk101
DiagCom_Chk102
Standard Compliant Yes

OTL Syntax

DiagServiceTerm DiagCom.CreateDiagServiceByName(ComChannelTerm comChannel, StringTerm name);

Description

The CreateDiagServiceByName term creates a handle to a diagnostic service that can subsequently be used for parameterizing or executing that service. The diagnostic service to be created is identified by its name. The CreateDiagServiceByName term accepts a ComChannelTerm and the name of the desired diagnostic service as an otx:StringTerm. As a result the term returns a DiagService handle.

Icons Note.png In case a MVCI/ODX system is used, the name passed into the CreateDiagServiceByName term will be the SHORT-NAME of the associated MCDDiagComPrimitive object.

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
DiagService The handle to a diagnostic service.

Properties

Name Data Type Class Default Cardinality Description
ComChannel ComChannel Term - [1] The ComChannelTerm to which the to-be-created diagnostic service belongs to and will be executed on when the ExecuteDiagService action is used.
Name String Term - [1] Name of the to-be-created diagnostic service.

OTL Examples

/// Local Declarations

DiagCom.DiagService DiagService1;
DiagCom.ComChannel ComChannel1;

/// Flow

ComChannel1 = DiagCom.GetComChannel("LL_CentrElectUDS", "EV_BCMCONTI_009", false);
DiagService1 = DiagCom.CreateDiagServiceByName(ComChannel1, "DiagnServi_WriteMemorByAddreMCD20001");

See also

CreateDiagServiceBySemantic
GetDiagServiceListBySemantic
GetDiagServiceFromResult
GetDiagServiceFromException
GetDiagServiceName
ExecuteDiagService
GetComChannel