Difference between revisions of "Extensions.DiagDataBrowsingPlus.GetParameterRadix"

From emotive
Jump to navigation Jump to search
(Created page with "{{DISPLAYTITLE:OTX '''GetParameterRadix'''}}Category:DiagDataBrowsingPlus == Classification == {{ClassificationActivity | GetParameterRadix| UPDATING... | Term | Ext...")
 
 
(5 intermediate revisions by the same user not shown)
Line 1: Line 1:
 
{{DISPLAYTITLE:OTX '''GetParameterRadix'''}}[[Category:DiagDataBrowsingPlus]]
 
{{DISPLAYTITLE:OTX '''GetParameterRadix'''}}[[Category:DiagDataBrowsingPlus]]
 
== Classification ==
 
== Classification ==
−
{{ClassificationActivity | GetParameterRadix| UPDATING... | [[Term]] | [[Extensions.DiagDataBrowsingPlus|OTX DiagDataBrowsingPlus extension]] | UPDATING... | UPDATING... | UPDATING... }}
+
{{ClassificationActivity | GetParameterRadix| Gets the radix of the [[Extensions.DiagCom.Parameter|Parameter]] | [[Term]] | [[Extensions.DiagDataBrowsingPlus|OTX DiagDataBrowsingPlus extension]] | [[Extensions.DiagDataBrowsingPlus#Terms|Parameter related terms]] | [[Extensions.DiagDataBrowsingPlus.InvalidTypeException|InvalidTypeException]] | - }}
  
 
== 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);
+
IntegerTerm DiagDataBrowsingPlus.GetParameterRadix(ParameterTerm parameter);
 
</syntaxhighlight>
 
</syntaxhighlight>
−
-->
 
  
 
== Description ==
 
== Description ==
−
UPDATING...<!--
+
'''GetParameterRadix''' returns the display radix of the [[Extensions.DiagCom.Parameter|parameter]]. The display radix shall be used by the Client to display a numeric parameter value in the format as defined in the data base (2 - ODX value BIN, 10 - ODX value DEC, 16 - ODX value HEX).
−
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}}
+
If the [[Extensions.DiagCom.Parameter|parameter]] is not a A_UINT or A_INT value, the [[Extensions.DiagDataBrowsingPlus.InvalidTypeException|InvalidTypeException]] exception will be thrown.
−
{{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!}}
+
 
−
-->
+
{{Note|The appropriate MVCI system operation is Operation MCDParameter::getRadix}}
 +
 
 +
{{Note|This term is introduced to complete the existing terms in the [[Extensions.DiagDataBrowsing|DiagDataBrowsing extension]] (ISO 13209 Part-3 [3]) that uses ParameterTerms. This completion primarily enables a generically interpretation of responses by using runtime [[Extensions.DiagCom.Parameter|parameters]] without using [[Extensions.DiagDataBrowsingPlus.DbParameter|DbParameters]].}}
 +
 
 +
{{TermReturnValue| [[Core.DataTypes.SimpleDataType.Integer|Integer]] | Returns the display radix of the [[Extensions.DiagCom.Parameter|parameter]].}}
  
 
== Properties ==
 
== Properties ==
−
UPDATING...<!--
 
 
{| {{TableHeader}}
 
{| {{TableHeader}}
 
{{TableRowPropertiesHeader}}
 
{{TableRowPropertiesHeader}}
−
{{TableRowPropertie1| ComChannel | [[Extensions.DiagCom.ComChannel|ComChannel]] | [[Variable]] | - | [1] | Communication Channel (Control unit).}}
+
{{TableRowPropertie2| Parameter|[[Extensions.DiagCom.Parameter|Parameter]] | [[Term]] | - | [1..1] |The element addresses the '''Parameter'''  (MCDParameter) which radix 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.Parameter Parameter;
 +
Integer MyInteger;
  
−
myComCannel = DiagCom.GetComChannel("DiagnosticsCan_ECU_1", null, false);
+
/// Flow
  
−
// Code example using the variable myComChannel
+
Parameter = DiagCom.GetParameterByPath(DiagCom.GetRequest(DiagCom.CreateDiagServiceByName(DiagCom.GetComChannel("LL_AllUDSSyste", "", false), "SinglJob_SubsyCodinWrite")), {"IPA_WorksNumbe"});
−
// ...
+
MyInteger = DiagDataBrowsingPlus.GetParameterRadix(Parameter);
−
DiagCom.CloseComChannel(myComCannel);</syntaxhighlight>
 
 
</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.DiagCom.GetParameterBySemantic|GetParameterBySemantic]] <br/>

Latest revision as of 08:20, 2 November 2018

Classification

Name GetParameterRadix
Short Description Gets the radix of the Parameter
Class Term
Extension OTX DiagDataBrowsingPlus extension
Group Parameter related terms
Exceptions InvalidTypeException
Checker Rules -
Standard Compliant Yes

OTL Syntax

IntegerTerm DiagDataBrowsingPlus.GetParameterRadix(ParameterTerm parameter);

Description

GetParameterRadix returns the display radix of the parameter. The display radix shall be used by the Client to display a numeric parameter value in the format as defined in the data base (2 - ODX value BIN, 10 - ODX value DEC, 16 - ODX value HEX).

If the parameter is not a A_UINT or A_INT value, the InvalidTypeException exception will be thrown.

Icons Note.png The appropriate MVCI system operation is Operation MCDParameter::getRadix
Icons Note.png This term is introduced to complete the existing terms in the DiagDataBrowsing extension (ISO 13209 Part-3 [3]) that uses ParameterTerms. This completion primarily enables a generically interpretation of responses by using runtime parameters without using DbParameters.

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
Integer Returns the display radix of the parameter.

Properties

Name Data Type Class Default Cardinality Description
Parameter Parameter Term - [1..1] The element addresses the Parameter (MCDParameter) which radix shall be returned.

OTL Examples

/// Local Declarations

DiagCom.Parameter Parameter;
Integer MyInteger;

/// Flow

Parameter = DiagCom.GetParameterByPath(DiagCom.GetRequest(DiagCom.CreateDiagServiceByName(DiagCom.GetComChannel("LL_AllUDSSyste", "", false), "SinglJob_SubsyCodinWrite")), {"IPA_WorksNumbe"});
MyInteger = DiagDataBrowsingPlus.GetParameterRadix(Parameter);

See also

GetComChannel
CreateDiagServiceByName
CreateDiagServiceBySemantic
ExecuteDiagService
GetFirstResponse
GetRequest
GetParameterByPath
GetParameterBySemantic

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