OTX Reference  
OpenTestSystem.Otx.Core.Variables.Variable Class Reference

Base type for all variables More...

Inherits OpenTestSystem.Otx.Core.UniversalTypes.ExtensionInterface.

Inherited by OpenTestSystem.Otx.Core.Variables.BooleanVariable, OpenTestSystem.Otx.Core.Variables.ByteFieldVariable, OpenTestSystem.Otx.Core.Variables.ExceptionVariable, OpenTestSystem.Otx.Core.Variables.FloatVariable, OpenTestSystem.Otx.Core.Variables.IntegerVariable, OpenTestSystem.Otx.Core.Variables.ListVariable, OpenTestSystem.Otx.Core.Variables.MapVariable, OpenTestSystem.Otx.Core.Variables.StringVariable, OpenTestSystem.Otx.Extensions.BlackBox.Variables.BlackBoxVariable, OpenTestSystem.Otx.Extensions.BusMonitoring.Variables.BusFrameVariable, OpenTestSystem.Otx.Extensions.BusMonitoring.Variables.BusMonitorModeVariable, OpenTestSystem.Otx.Extensions.BusMonitoring.Variables.BusMonitorVariable, OpenTestSystem.Otx.Extensions.ComInterface.Variables.ComInterfaceVariable, OpenTestSystem.Otx.Extensions.ComInterface.Variables.ConnectionStatusVariable, OpenTestSystem.Otx.Extensions.DataType.Variables.EnumerationVariable, OpenTestSystem.Otx.Extensions.DataType.Variables.ResourceLocationVariable, OpenTestSystem.Otx.Extensions.DataType.Variables.StructureVariable, OpenTestSystem.Otx.Extensions.DiagCom.Variables.ComChannelVariable, OpenTestSystem.Otx.Extensions.DiagCom.Variables.DiagServiceVariable, OpenTestSystem.Otx.Extensions.DiagCom.Variables.ParameterVariable, OpenTestSystem.Otx.Extensions.DiagCom.Variables.RequestVariable, OpenTestSystem.Otx.Extensions.DiagCom.Variables.ResponseStateVariable, OpenTestSystem.Otx.Extensions.DiagCom.Variables.ResponseVariable, OpenTestSystem.Otx.Extensions.DiagCom.Variables.ResultStateVariable, OpenTestSystem.Otx.Extensions.DiagCom.Variables.ResultVariable, OpenTestSystem.Otx.Extensions.DiagComPlus.Variables.ComChannelStateVariable, OpenTestSystem.Otx.Extensions.DiagDataBrowsing.Variables.ComChannelCategoryVariable, OpenTestSystem.Otx.Extensions.DiagDataBrowsingPlus.Variables.DbComChannelVariable, OpenTestSystem.Otx.Extensions.DiagDataBrowsingPlus.Variables.DbDiagServiceVariable, OpenTestSystem.Otx.Extensions.DiagDataBrowsingPlus.Variables.DbDiagTroubleCodeVariable, OpenTestSystem.Otx.Extensions.DiagDataBrowsingPlus.Variables.DbEnvDataDescVariable, OpenTestSystem.Otx.Extensions.DiagDataBrowsingPlus.Variables.DbFaultMemoryVariable, OpenTestSystem.Otx.Extensions.DiagDataBrowsingPlus.Variables.DbMatchingParameterVariable, OpenTestSystem.Otx.Extensions.DiagDataBrowsingPlus.Variables.DbParameterVariable, OpenTestSystem.Otx.Extensions.DiagDataBrowsingPlus.Variables.DbRequestVariable, OpenTestSystem.Otx.Extensions.DiagDataBrowsingPlus.Variables.DbResponseVariable, OpenTestSystem.Otx.Extensions.DiagDataBrowsingPlus.Variables.DbSpecialDataElementVariable, OpenTestSystem.Otx.Extensions.DiagDataBrowsingPlus.Variables.DbSpecialDataGroupVariable, OpenTestSystem.Otx.Extensions.DiagDataBrowsingPlus.Variables.DbSubComponentVariable, OpenTestSystem.Otx.Extensions.DiagDataBrowsingPlus.Variables.DbTableVariable, OpenTestSystem.Otx.Extensions.DiagDataBrowsingPlus.Variables.IntervalVariable, OpenTestSystem.Otx.Extensions.DiagDataBrowsingPlus.Variables.McdDataTypeVariable, OpenTestSystem.Otx.Extensions.DiagDataBrowsingPlus.Variables.McdParameterTypeVariable, OpenTestSystem.Otx.Extensions.DiagDataBrowsingPlus.Variables.McdResponseTypeVariable, OpenTestSystem.Otx.Extensions.DiagDataBrowsingPlus.Variables.TextTableElementVariable, OpenTestSystem.Otx.Extensions.EcuConfiguration.Variables.ConfigurationRecordVariable, OpenTestSystem.Otx.Extensions.EcuConfiguration.Variables.DbConfigurationDataVariable, OpenTestSystem.Otx.Extensions.EcuConfiguration.Variables.DbConfigurationRecordVariable, OpenTestSystem.Otx.Extensions.EcuConfiguration.Variables.DbDataRecordVariable, OpenTestSystem.Otx.Extensions.EcuConfiguration.Variables.DbItemValueVariable, OpenTestSystem.Otx.Extensions.EcuConfiguration.Variables.DbOptionItemVariable, OpenTestSystem.Otx.Extensions.EcuConfiguration.Variables.OptionItemVariable, OpenTestSystem.Otx.Extensions.EventHandling.Variables.EventSourceVariable, OpenTestSystem.Otx.Extensions.EventHandling.Variables.EventVariable, OpenTestSystem.Otx.Extensions.ExternalServiceProvider.Variables.PropertyFlagVariable, OpenTestSystem.Otx.Extensions.ExternalServiceProvider.Variables.ServiceProviderVariable, OpenTestSystem.Otx.Extensions.ExternalServiceProvider.Variables.ServiceVariable, OpenTestSystem.Otx.Extensions.File.Variables.FileHandleVariable, OpenTestSystem.Otx.Extensions.Flash.Variables.AudienceVariable, OpenTestSystem.Otx.Extensions.Flash.Variables.FlashFileFormatVariable, OpenTestSystem.Otx.Extensions.Flash.Variables.FlashJobVariable, OpenTestSystem.Otx.Extensions.Flash.Variables.FlashSessionVariable, OpenTestSystem.Otx.Extensions.HMI.Variables.ConfirmationTypeVariable, OpenTestSystem.Otx.Extensions.HMI.Variables.MessageTypeVariable, OpenTestSystem.Otx.Extensions.HMI.Variables.ScreenVariable, OpenTestSystem.Otx.Extensions.Logging.Variables.LogLevelVariable, OpenTestSystem.Otx.Extensions.Logging.Variables.SeverityLevelVariable, OpenTestSystem.Otx.Extensions.Measure.Variables.MeasurementVariable, OpenTestSystem.Otx.Extensions.Quantities.Variables.QuantityVariable, OpenTestSystem.Otx.Extensions.Quantities.Variables.UnitVariable, OpenTestSystem.Otx.Extensions.SQL.Variables.ConnectionVariable, OpenTestSystem.Otx.Extensions.SQL.Variables.ResultSetVariable, OpenTestSystem.Otx.Extensions.StringUtil.Variables.EncodingVariable, OpenTestSystem.Otx.Extensions.TestResultHandling.Variables.TestResultContainerVariable, OpenTestSystem.Otx.Extensions.TestResultHandling.Variables.TestResultHandlingLevelVariable, OpenTestSystem.Otx.Extensions.TestResultHandling.Variables.TestResultSessionVariable, OpenTestSystem.Otx.Extensions.TestResultHandling.Variables.TestResultSeverityVariable, OpenTestSystem.Otx.Extensions.TestResultHandling.Variables.TestResultStateVariable, OpenTestSystem.Otx.Extensions.VehicleInfo.Variables.GatewayModeVariable, OpenTestSystem.Otx.Extensions.XML.Variables.XmlDocumentVariable, OpenTestSystem.Otx.Extensions.XML.Variables.XmlElementVariable, and OpenTestSystem.Otx.Extensions.i18n.Variables.TranslationKeyVariable.

Public Attributes

OtxLink name
 Name of the related declaration More...
 
Path path
 The element addresses parts of complex structures like List or Map. It is built out of a series of index and name-steps which allow navigate into the structure. More...
 

Detailed Description

Base type for all variables

The variable types represent the counterpart of the dereferencing terms (e.g. BooleanValue, IntegerValue, FloatValue, StringValue, ByteFieldValue, ListValue, MapValue, ExceptionValue) which are used to read the actual value stored in a declaration. By contrast, variable types are used by OTX nodes and actions when the variable container itself is of primary interest, not the value stored in it. This is the case e.g. in an Assignment action: The calculated value given by the term will be assigned to the variable identified by result. Another example is the Loop (ForLoop configuration) node with its counter element, which identifies the Integer variable which shall contain the current iteration number at runtime. In all of these cases, the current value of the variable is not relevant.

Note
Since all Variable subtypes have uniform syntax and semantics, a general description applying to all types is provided hereby.
Checker rules
CheckerRule.Core_Chk053 – No dangling OtxLink associations
CheckerRule.Core_Chk050 – Type-safe variable and constant usage
CheckerRule.Core_Chk051 – Immutability of constants, input parameters and context variables
Exceptions
Exceptions.OutOfBoundsExceptionOnly if there is a path: If the path points to a location which has not been allocated (like a list index exceeding list length, or a map key which is not part of the map).

Member Data Documentation

◆ name

OtxLink OpenTestSystem.Otx.Core.Variables.Variable.name

Name of the related declaration

Contains the OtxLink to the declaration which is of interest. For getting access to data which resides deeper within a complex data structure like a List or Map, the path element will be utilized which points to the data inside of the structure.

◆ path

Path OpenTestSystem.Otx.Core.Variables.Variable.path

The element addresses parts of complex structures like List or Map. It is built out of a series of index and name-steps which allow navigate into the structure.