Difference between revisions of "Extensions.Logging.SeverityLevel"

From emotive
Jump to navigation Jump to search
 
(5 intermediate revisions by one other user not shown)
Line 1: Line 1:
 
{{DISPLAYTITLE:Data Type '''SeverityLevel'''}}[[Category:DataType]][[Category:Logging]]
 
{{DISPLAYTITLE:Data Type '''SeverityLevel'''}}[[Category:DataType]][[Category:Logging]]
 
== Classification ==
 
== Classification ==
{{ClassificationDataType | SeverityLevel | Describing the severity of a log message written by a [[WriteLog]] action | [[Simple Data Type]] | - | DefaultValue=TRACE | Literal=Yes }}
+
{{ClassificationDataType | SeverityLevel | Describing the severity of a log message written by a [[Extensions.Logging.WriteLog|WriteLog]] action | [[Core.DataTypes.SimpleDataType|Simple Data Type]] | [[Core.DataTypes.SimpleDataType.SimpleType|SimpleType]] | DefaultValue=TRACE | Literal=Yes }}
  
 
== Description ==
 
== Description ==
'''SeverityLevel''' is an enumeration type describing the severity of a log message written by a [[WriteLog]] action.
+
'''SeverityLevel''' is an enumeration type describing the severity of a log message written by a [[Extensions.Logging.WriteLog|WriteLog]] action.
  
The list of allowed enumeration values is defined in (see) [[Logging]].
+
The list of allowed enumeration values is defined in (see) [[Extensions.Logging|Logging]].
  
 
==Order Relation==
 
==Order Relation==
Line 16: Line 16:
  
 
==Literal==
 
==Literal==
The syntax for [[Literals| Literals for complex data types]] should be used, where the '''member value''' is one of the values in the list.
+
The syntax for [[Literals| Literals for complex data types]] will be used, where the '''member value''' is one of the values in the list.
  
 
<syntaxhighlight lang="java" enclose="div" style="font-size: medium;">
 
<syntaxhighlight lang="java" enclose="div" style="font-size: medium;">
SeverityLevels={TRACE|DEBUG|INFO|WARN|ERROR|FATAL}
+
@SeverityLevel:TRACE|DEBUG|INFO|WARN|ERROR|FATAL
 
</syntaxhighlight>
 
</syntaxhighlight>
  
 
{{ConversionTable |
 
{{ConversionTable |
Integer=Returns the index of the value in the ResultStates enumeration (smallest index is 0) | IntegerSample=<tt>Integer val = ToInteger(@SeverityLevel:TRACE); // Returns 0</tt> |
+
Integer=Returns the index of the value in the SeverityLevels enumeration (smallest index is 0) | IntegerSample=<tt>Integer val = ToInteger(@SeverityLevel:TRACE); // Returns 0</tt> |
 
String=Returns the name of the enumeration value | StringSample=<tt>String s = ToString(@SeverityLevel:TRACE); // Returns "TRACE"</tt>
 
String=Returns the name of the enumeration value | StringSample=<tt>String s = ToString(@SeverityLevel:TRACE); // Returns "TRACE"</tt>
 
}}
 
}}
Line 29: Line 29:
 
==Sample==
 
==Sample==
 
<syntaxhighlight lang="java" enclose="div" style="font-size: medium;">
 
<syntaxhighlight lang="java" enclose="div" style="font-size: medium;">
SeverityLevel MySeverityLevelVariable = @SeverityLevel:TRACE;
+
Logging.SeverityLevel SeverityLevelVariable = @SeverityLevel:TRACE;
 
</syntaxhighlight>
 
</syntaxhighlight>

Latest revision as of 02:46, 13 September 2019

Classification

Name SeverityLevel
Short Description Describing the severity of a log message written by a WriteLog action
Class Simple Data Type
Base Data Type SimpleType
Default Value TRACE
Provide a Literal Yes
SpecifiedBy ISO 13209-3
Standard Compliant Yes

Description

SeverityLevel is an enumeration type describing the severity of a log message written by a WriteLog action.

The list of allowed enumeration values is defined in (see) Logging.

Order Relation

SeverityLevel values may occur as operands of comparisons. For this case, the following order relation is defined. Started with the lowest value TRACE = 0:

TRACE < DEBUG < INFO < WARN < ERROR < FATAL

Literal

The syntax for Literals for complex data types will be used, where the member value is one of the values in the list.

@SeverityLevel:TRACE|DEBUG|INFO|WARN|ERROR|FATAL

Core Conversion

The following table shows the rules for conversion to another data type:

Conversion Result Sample
ToBoolean Undefined (should not be used)
ToInteger Returns the index of the value in the SeverityLevels enumeration (smallest index is 0) Integer val = ToInteger(@SeverityLevel:TRACE); // Returns 0
ToFloat Undefined (should not be used)
ToString Returns the name of the enumeration value String s = ToString(@SeverityLevel:TRACE); // Returns "TRACE"
ToByteField Undefined (should not be used)

Sample

Logging.SeverityLevel SeverityLevelVariable = @SeverityLevel:TRACE;