Difference between revisions of "Extensions.DiagDataBrowsingPlus.GetDbMatchingParameterExpectedValueAsString"

From emotive
Jump to navigation Jump to search
(Created page with "{{DISPLAYTITLE:OTX '''GetDbMatchingParameterExpectedValueAsString'''}}Category:DiagDataBrowsingPlus == Classification == {{ClassificationActivity | GetDbMatchingParameterE...")
 
 
(6 intermediate revisions by the same user not shown)
Line 1: Line 1:
 
{{DISPLAYTITLE:OTX '''GetDbMatchingParameterExpectedValueAsString'''}}[[Category:DiagDataBrowsingPlus]]
 
{{DISPLAYTITLE:OTX '''GetDbMatchingParameterExpectedValueAsString'''}}[[Category:DiagDataBrowsingPlus]]
 
== Classification ==
 
== Classification ==
{{ClassificationActivity | GetDbMatchingParameterExpectedValueAsString | UPDATING... | [[Term]] | [[Extensions.DiagDataBrowsingPlus|OTX DiagDataBrowsingPlus extension]] | UPDATING... | UPDATING... | UPDATING... }}
+
{{ClassificationActivity | GetDbMatchingParameterExpectedValueAsString | Gets the expected value of the [[Extensions.DiagDataBrowsingPlus.DbMatchingParameter|DbMatchingParameter]] | [[Term]] | [[Extensions.DiagDataBrowsingPlus|OTX DiagDataBrowsingPlus extension]] | [[Extensions.DiagDataBrowsingPlus#Terms|DbMatchingParameter 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.GetDbMatchingParameterExpectedValueAsString(DbMatchingParameterTerm matchingParameter);
 
</syntaxhighlight>
 
</syntaxhighlight>
-->
 
  
 
== Description ==
 
== Description ==
UPDATING...<!--
+
'''GetDbMatchingParameterExpectedValueAsString''' returns the expected value of the matching parameter as a [[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 MCDDbMatchingParameter::getExpectedValue::getValueAsString}}
{{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 expected value of the matching parameter.}}
  
 
== Properties ==
 
== Properties ==
UPDATING...<!--
 
 
{| {{TableHeader}}
 
{| {{TableHeader}}
 
{{TableRowPropertiesHeader}}
 
{{TableRowPropertiesHeader}}
{{TableRowPropertie1| ComChannel | [[Extensions.DiagCom.ComChannel|ComChannel]] | [[Variable]] | - | [1] | Communication Channel (Control unit).}}
+
{{TableRowPropertie2| MatchingParameter | [[Extensions.DiagDataBrowsingPlus.DbMatchingParameter|DbMatchingParameter]] | [[Term]] | - | [1..1] |The element addresses the '''DbMatchingParameter''' which expected value 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
 +
 
 +
String MyString;
 +
DiagDataBrowsingPlus.DbComChannel DbComChannel;
 +
List<DiagDataBrowsingPlus.DbSubComponent> List_DbSubComponent;
 +
List<List<DiagDataBrowsingPlus.DbMatchingParameter>> List_List_DbMatchingParameter;
  
myComCannel = DiagCom.GetComChannel("DiagnosticsCan_ECU_1", null, false);
+
/// Flow
  
// Code example using the variable myComChannel
+
DbComChannel = DiagDataBrowsingPlus.GetDbComChannel(NULL, "LL_AerodContrUnitUDS");
// ...
+
List_DbSubComponent = DiagDataBrowsingPlus.GetDbComChannelDbSubComponents(DbComChannel);
DiagCom.CloseComChannel(myComCannel);</syntaxhighlight>
+
List_List_DbMatchingParameter = DiagDataBrowsingPlus.GetDbSubComponentDbMatchingParameters(List_DbSubComponent[0]);
 +
MyString = DiagDataBrowsingPlus.GetDbMatchingParameterExpectedValueAsString(List_List_DbMatchingParameter[0][0]);
 
</syntaxhighlight>
 
</syntaxhighlight>
-->
 
  
 
== See also ==
 
== See also ==
UPDATING...
+
[[Extensions.DiagDataBrowsingPlus.GetDbComChannel|GetDbComChannel]] <br/>
 +
[[Extensions.DiagDataBrowsingPlus.GetComChannelDbComChannel|GetComChannelDbComChannel]]<br/>
 +
[[Extensions.DiagDataBrowsingPlus.GetDbComChannelDbSubComponents|GetDbComChannelDbSubComponents]]<br/>
 +
[[Extensions.DiagDataBrowsingPlus.GetDbSubComponentDbMatchingParameters|GetDbSubComponentDbMatchingParameters]]

Latest revision as of 09:08, 2 November 2018

Classification

Name GetDbMatchingParameterExpectedValueAsString
Short Description Gets the expected value of the DbMatchingParameter
Class Term
Extension OTX DiagDataBrowsingPlus extension
Group DbMatchingParameter related terms
Exceptions NONE
Checker Rules -
Standard Compliant Yes

OTL Syntax

StringTerm DiagDataBrowsingPlus.GetDbMatchingParameterExpectedValueAsString(DbMatchingParameterTerm matchingParameter);

Description

GetDbMatchingParameterExpectedValueAsString returns the expected value of the matching parameter as a string.

Icons Note.png The appropriate MVCI system operation is MCDDbMatchingParameter::getExpectedValue::getValueAsString

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 expected value of the matching parameter.

Properties

Name Data Type Class Default Cardinality Description
MatchingParameter DbMatchingParameter Term - [1..1] The element addresses the DbMatchingParameter which expected value shall be returned.

OTL Examples

/// Local Declarations

String MyString;
DiagDataBrowsingPlus.DbComChannel DbComChannel;
List<DiagDataBrowsingPlus.DbSubComponent> List_DbSubComponent;
List<List<DiagDataBrowsingPlus.DbMatchingParameter>> List_List_DbMatchingParameter;

/// Flow

DbComChannel = DiagDataBrowsingPlus.GetDbComChannel(NULL, "LL_AerodContrUnitUDS");
List_DbSubComponent = DiagDataBrowsingPlus.GetDbComChannelDbSubComponents(DbComChannel);
List_List_DbMatchingParameter = DiagDataBrowsingPlus.GetDbSubComponentDbMatchingParameters(List_DbSubComponent[0]);
MyString = DiagDataBrowsingPlus.GetDbMatchingParameterExpectedValueAsString(List_List_DbMatchingParameter[0][0]);

See also

GetDbComChannel
GetComChannelDbComChannel
GetDbComChannelDbSubComponents
GetDbSubComponentDbMatchingParameters