Difference between revisions of "Extensions.DiagDataBrowsingPlus.GetDbParameterSemantic"

From emotive
Jump to navigation Jump to search
(Created page with "{{DISPLAYTITLE:OTX '''GetDbParameterSemantic'''}}Category:DiagDataBrowsingPlus == Classification == {{ClassificationActivity | GetDbParameterSemantic | UPDATING... | Ter...")
 
 
(5 intermediate revisions by the same user not shown)
Line 1: Line 1:
 
{{DISPLAYTITLE:OTX '''GetDbParameterSemantic'''}}[[Category:DiagDataBrowsingPlus]]
 
{{DISPLAYTITLE:OTX '''GetDbParameterSemantic'''}}[[Category:DiagDataBrowsingPlus]]
 
== Classification ==
 
== Classification ==
−
{{ClassificationActivity | GetDbParameterSemantic | UPDATING... | [[Term]] | [[Extensions.DiagDataBrowsingPlus|OTX DiagDataBrowsingPlus extension]] | UPDATING... | UPDATING... | UPDATING... }}
+
{{ClassificationActivity | GetDbParameterSemantic| Gets the semantic of the [[Extensions.DiagDataBrowsingPlus.DbParameter|DbParameter]] | [[Term]] | [[Extensions.DiagDataBrowsingPlus|OTX DiagDataBrowsingPlus extension]] | [[Extensions.DiagDataBrowsingPlus#Terms|DbParameter related terms]] | NONE | - }}
  
 
== OTL Syntax ==
 
== OTL Syntax ==
−
UPDATING...<!--
 
 
<syntaxhighlight lang="java" enclose="div" style="font-size: medium;">
 
<syntaxhighlight lang="java" enclose="div" style="font-size: medium;">
−
DiagCom.CloseComChannel(ComChannelVariable);
+
StringTerm DiagDataBrowsingPlus.GetDbParameterSemantic(DbParameterTerm dbParameter);
 
</syntaxhighlight>
 
</syntaxhighlight>
−
-->
 
  
 
== Description ==
 
== Description ==
−
UPDATING...<!--
+
'''GetDbParameterSemantic''' returns the semantic attribute defined in ODX as a [[Core.DataTypes.SimpleDataType.String|string]]. In case of MUX the method returns an empty [[Core.DataTypes.SimpleDataType.String|string]].
−
OTX CloseComChannel activity is used for the [[Diagnosis Runtime System]] to announce that an open communication channel that all relevant resources can be released and closed.
+
 
−
{{ComChannelMemoryUsageNote}}
+
{{Note|The appropriate MVCI system operation is MCDDbParameter::getSemantic}}
−
{{Important|Please note that the use of a shared '''ComChannel''' can bring the OTX runtime system in an undefined state and that is this case is not validated at design time!}}
+
 
−
-->
+
{{TermReturnValue| [[Core.DataTypes.SimpleDataType.String|String]] | Returns the semantic attribute defined in ODX of the [[Extensions.DiagDataBrowsingPlus.DbParameter|DbParameter]].}}
  
 
== Properties ==
 
== Properties ==
−
UPDATING...<!--
 
 
{| {{TableHeader}}
 
{| {{TableHeader}}
 
{{TableRowPropertiesHeader}}
 
{{TableRowPropertiesHeader}}
−
{{TableRowPropertie1| ComChannel | [[Extensions.DiagCom.ComChannel|ComChannel]] | [[Variable]] | - | [1] | Communication Channel (Control unit).}}
+
{{TableRowPropertie2| DbParameter | [[Extensions.DiagDataBrowsingPlus.DbParameter|DbParameter]] | [[Term]] | - | [1..1] |The element addresses the '''DbParameter''' (MCDDbParameter) which semantic shall be returned.}}
 
|}
 
|}
−
-->
 
  
 
== OTL Examples ==
 
== OTL Examples ==
−
UPDATING...<!--
 
 
<syntaxhighlight lang="java" enclose="div" style="font-size: medium;">
 
<syntaxhighlight lang="java" enclose="div" style="font-size: medium;">
−
DiagCom.ComChannel myComCannel;
+
/// Local Declarations
 +
 
 +
DiagCom.Request Request;
 +
DiagDataBrowsingPlus.DbParameter DbParameter;
 +
DiagCom.Parameter Parameter;
 +
String MyString;
  
−
myComCannel = DiagCom.GetComChannel("DiagnosticsCan_ECU_1", null, false);
+
/// Flow
  
−
// Code example using the variable myComChannel
+
Request = DiagCom.GetRequest(DiagCom.CreateDiagServiceByName(DiagCom.GetComChannel("LL_GatewUDS", "", false), "DiagnServi_ReadDataByIdentGenerServi"));
−
// ...
+
Parameter = DiagCom.GetParameterByPath(Request, {"Param_RecorDataIdent"});
−
DiagCom.CloseComChannel(myComCannel);</syntaxhighlight>
+
DbParameter = DiagDataBrowsingPlus.GetParameterDbParameter(Parameter);
 +
MyString = DiagDataBrowsingPlus.GetDbParameterSemantic(DbParameter);
 
</syntaxhighlight>
 
</syntaxhighlight>
−
-->
 
  
 
== See also ==
 
== See also ==
−
UPDATING...
+
[[Extensions.DiagCom.GetComChannel|GetComChannel]] <br/>
 +
[[Extensions.DiagCom.CreateDiagServiceByName|CreateDiagServiceByName]] <br/>
 +
[[Extensions.DiagCom.CreateDiagServiceBySemantic|CreateDiagServiceBySemantic]] <br/>
 +
[[Extensions.DiagCom.ExecuteDiagService|ExecuteDiagService]] <br/>
 +
[[Extensions.DiagCom.GetFirstResponse|GetFirstResponse]] <br/>
 +
[[Extensions.DiagCom.GetRequest|GetRequest]] <br/>
 +
[[Extensions.DiagCom.GetParameterByPath|GetParameterByPath]] <br/>
 +
[[Extensions.DiagDataBrowsingPlus.GetParameterDbParameter|GetParameterDbParameter]]

Latest revision as of 08:55, 2 November 2018

Classification

Name GetDbParameterSemantic
Short Description Gets the semantic of the DbParameter
Class Term
Extension OTX DiagDataBrowsingPlus extension
Group DbParameter related terms
Exceptions NONE
Checker Rules -
Standard Compliant Yes

OTL Syntax

StringTerm DiagDataBrowsingPlus.GetDbParameterSemantic(DbParameterTerm dbParameter);

Description

GetDbParameterSemantic returns the semantic attribute defined in ODX as a string. In case of MUX the method returns an empty string.

Icons Note.png The appropriate MVCI system operation is MCDDbParameter::getSemantic

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
String Returns the semantic attribute defined in ODX of the DbParameter.

Properties

Name Data Type Class Default Cardinality Description
DbParameter DbParameter Term - [1..1] The element addresses the DbParameter (MCDDbParameter) which semantic shall be returned.

OTL Examples

/// Local Declarations

DiagCom.Request Request;
DiagDataBrowsingPlus.DbParameter DbParameter;
DiagCom.Parameter Parameter;
String MyString;

/// Flow

Request = DiagCom.GetRequest(DiagCom.CreateDiagServiceByName(DiagCom.GetComChannel("LL_GatewUDS", "", false), "DiagnServi_ReadDataByIdentGenerServi"));
Parameter = DiagCom.GetParameterByPath(Request, {"Param_RecorDataIdent"});
DbParameter = DiagDataBrowsingPlus.GetParameterDbParameter(Parameter);
MyString = DiagDataBrowsingPlus.GetDbParameterSemantic(DbParameter);

See also

GetComChannel
CreateDiagServiceByName
CreateDiagServiceBySemantic
ExecuteDiagService
GetFirstResponse
GetRequest
GetParameterByPath
GetParameterDbParameter

Retrieved from "http://emotive.de/wiki/index.php?title=Extensions.DiagDataBrowsingPlus.GetDbParameterSemantic&oldid=8950"