Extensions.DiagCom.CreateDiagServiceBySemantic

From emotive
Jump to navigation Jump to search

Classification

Name CreateDiagServiceBySemantic
Short Description Creates a diagnostic service through its semantic attribute
Class Term
Extension OTX DiagCom extension
Group DiagService related terms
Exceptions AmbiguousSemanticException
Checker Rules DiagCom_Chk100
DiagCom_Chk101
DiagCom_Chk102
Standard Compliant Yes

OTL Syntax

DiagServiceTerm DiagCom.CreateDiagServiceBySemantic(ComChanneTerm comChannel, StringTerm semantic);

Description

The CreateDiagServiceBySemantic term creates a handle to a diagnostic service that can subsequently be used for configuring or executing that service. The diagnostic service to be created is identified by its semantic attribute. The term accepts a ComChannelTerm and the semantic value as an otx:StringTerm. As a result the term returns a DiagService handle. Please note that using this term can result in an AmbiguousSemanticException in case there are none or more than one diagnostic service with the desired semantic attribute value exists within this communication channel.

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 diagnostic service is created through its semantic attribute.

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.
Semantic String Term - [1] The semantic value of the to-be-created diagnostic service. (eg: "DEFAULT_FAULTREAD" or "IDENTIFICATION").

OTL Examples

/// Local Declarations

DiagCom.DiagService DiagService1;
DiagCom.ComChannel ComChannel1;

/// Flow

ComChannel1 = DiagCom.GetComChannel("LL_CentrElectUDS", "EV_BCMCONTI_009", false);
DiagService1 = DiagCom.CreateDiagServiceBySemantic(ComChannel1, "DEFAULT-FAULT-READ");

See also

GetDiagServiceListBySemantic
GetDiagServiceFromResult
GetDiagServiceFromException
GetDiagServiceName
ExecuteDiagService
GetComChannel