Difference between revisions of "Extensions.DiagCom.GetComParameterValueAsQuantity"

From emotive
Jump to navigation Jump to search
Line 1: Line 1:
 
{{DISPLAYTITLE:OTX '''GetComParameterValueAsQuantity '''}}[[Category:DiagCom]]
 
{{DISPLAYTITLE:OTX '''GetComParameterValueAsQuantity '''}}[[Category:DiagCom]]
 
== Classification ==
 
== Classification ==
{{ClassificationActivity | GetComParameterValueAsQuantity | The current value of a [[Quantity]] communication parameter | [[Term]] | [[Extensions.DiagCom|OTX DiagCom extension]] | [[ComParam related terms]] | [[Extensions.DiagCom.UnknownTargetException|UnknownTargetException]] <br/> [[TypeMismatchException]] | - }}
+
{{ClassificationActivity | GetComParameterValueAsQuantity | The current value of a [[Extensions.Quantities.Quantity|Quantity]] communication parameter | [[Term]] | [[Extensions.DiagCom|OTX DiagCom extension]] | [[ComParam related terms]] | [[Extensions.DiagCom.UnknownTargetException|UnknownTargetException]] <br/> [[TypeMismatchException]] | - }}
  
 
== OTL Syntax ==
 
== OTL Syntax ==
Line 9: Line 9:
  
 
== Description ==
 
== Description ==
The '''GetComParameterValueAsQuantity''' term return the current value of a [[Quantity]] communication parameter.
+
The '''GetComParameterValueAsQuantity''' term return the current value of a [[Extensions.Quantities.Quantity|Quantity]] communication parameter.
  
{{TermReturnValue| [[Quantity]] | The current value of a [[Quantity]] communication parameter.}}
+
{{TermReturnValue| [[Extensions.Quantities.Quantity|Quantity]] | The current value of a [[Extensions.Quantities.Quantity|Quantity]] communication parameter.}}
  
 
== Properties ==
 
== Properties ==

Revision as of 10:01, 15 February 2016

Classification

Name GetComParameterValueAsQuantity
Short Description The current value of a Quantity communication parameter
Class Term
Extension OTX DiagCom extension
Group ComParam related terms
Exceptions UnknownTargetException
TypeMismatchException
Checker Rules -
Standard Compliant Yes

OTL Syntax

QuantityTerm = DiagCom.GetComParameterValueAsQuantity(ComChannelTerm, StringTerm);

Description

The GetComParameterValueAsQuantity term return the current value of a Quantity communication parameter.

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
Quantity The current value of a Quantity communication parameter.

Properties

Name Data Type Class Default Cardinality Description
ComChannel ComChannel Term - [1] Communication channel.
ComParameterName String Term - [1] Name of communication channel.

OTL Examples

DiagCom.ComChannel myComCannel;
DiagCom.DiagService DiagService1;
Quantities.Quantity Quantity1;

myComCannel = DiagCom.GetComChannel("LL_AirbaUDS", null, false);
DiagService1 = DiagCom.CreateDiagServiceByName(myComCannel, "DiagnServi_ReadDataByIdentBasicSettiStatu");
Quantity1 = DiagCom.GetComParameterValueAsQuantity(myComCannel, "CP_CanTransmissionTime");

See also

GetComParameterValueAsBoolean
GetComParameterValueAsString
GetComParameterValueAsInteger
GetComParameterValueAsFloat
GetComParameterValueAsByteField