Difference between revisions of "Core.Declarations.GlobalDeclarations"
| Line 10: | Line 10: | ||
* Document Variables | * Document Variables | ||
| − | These elements have a global scope. That is, they can be used within the document in which they are declared, as well as in other documents, see [[OtxImports|Imports]]. | + | These elements have a global scope. That is, they can be used within the document in which they are declared, as well as in other documents, see [[Core.OtxImports|Imports]]. |
== Semantics == | == Semantics == | ||
=== Global Constant === | === Global Constant === | ||
| − | The value of a global constant is set at design-time and can not be changed at runtime. The global constants must have one of the following [[OtxVisibilities|Visibilities]]: | + | The value of a global constant is set at design-time and can not be changed at runtime. The global constants must have one of the following [[Core.OtxVisibilities|Visibilities]]: |
* Private (default) | * Private (default) | ||
| Line 20: | Line 20: | ||
* Public | * Public | ||
| − | A constant has a [[OtxDataTypes|Type]] and a value corresponding to the type. | + | A constant has a [[Core.OtxDataTypes|Type]] and a value corresponding to the type. |
=== Global Variable (Document Variable) === | === Global Variable (Document Variable) === | ||
| − | The value of a global variable can be changed at runtime. Global variables can only be used in the same document. Therefore, they only have one following [[OtxVisibilities|Visibility]]: | + | The value of a global variable can be changed at runtime. Global variables can only be used in the same document. Therefore, they only have one following [[Core.OtxVisibilities|Visibility]]: |
* Private (fixed) | * Private (fixed) | ||
| − | A variable has a [[OtxDataTypes|Type]] and an initial value (default value) corresponding to the type. | + | A variable has a [[Core.OtxDataTypes|Type]] and an initial value (default value) corresponding to the type. |
=== Environment Variable (Context Variable) === | === Environment Variable (Context Variable) === | ||
| − | Context variables behave like global constants. However, they have a special meaning. They represent environment-related data, such as vehicle type, name of workshop, user login name, etc., see the [[OtxPrinciples#ContextConcept|Context Concept]]. The context variables must have one of the following [[OtxVisibilities|Visibilities]]: | + | Context variables behave like global constants. However, they have a special meaning. They represent environment-related data, such as vehicle type, name of workshop, user login name, etc., see the [[General.OtxPrinciples#ContextConcept|Context Concept]]. The context variables must have one of the following [[Core.OtxVisibilities|Visibilities]]: |
* Private (default) | * Private (default) | ||
| Line 36: | Line 36: | ||
* Public | * Public | ||
| − | A context variable has a [[OtxDataTypes|Type]] and a default value corresponding to the type. | + | A context variable has a [[Core.OtxDataTypes|Type]] and a default value corresponding to the type. |
== Checker rules == | == Checker rules == | ||
| Line 46: | Line 46: | ||
== See also == | == See also == | ||
| − | [[OtxValidation|Validation (OTX-Checker)]] <br/> | + | [[Core.OtxValidation|Validation (OTX-Checker)]] <br/> |
| − | [[OtxNamingConventions|Naming Conventions]] <br/> | + | [[General.OtxNamingConventions|Naming Conventions]] <br/> |
| − | [[OtxImports|Imports]] <br/> | + | [[Core.OtxImports|Imports]] <br/> |
| − | [[OtxVisibilities|Visibilities]] <br/> | + | [[Core.OtxVisibilities|Visibilities]] <br/> |
| − | [[OtxValidities|Validities]] <br/> | + | [[Core.OtxValidities|Validities]] <br/> |
| − | [[OtxSignatures|Signatures]] <br/> | + | [[Core.OtxSignatures|Signatures]] <br/> |
| − | [[OtxParameters|Parameter Declarations]] <br/> | + | [[Core.OtxParameters|Parameter Declarations]] <br/> |
| − | [[OtxProcedures|Procedures]] <br/> | + | [[Core.OtxProcedures|Procedures]] <br/> |
| − | [[OtxComments|Comments]] | + | [[Core.OtxComments|Comments]] |
Revision as of 04:05, 16 February 2016
Contents
Classification
| Name | Global Declarations |
| Short Description | Global variables and constants |
| Class | OTX Core |
| Pre-Conditions | - |
| Specified by | ISO 13209-2 |
Introduction
The following elments can be declared in the global declaration block:
- Global Constants
- Context Variables
- Document Variables
These elements have a global scope. That is, they can be used within the document in which they are declared, as well as in other documents, see Imports.
Semantics
Global Constant
The value of a global constant is set at design-time and can not be changed at runtime. The global constants must have one of the following Visibilities:
- Private (default)
- Package
- Public
A constant has a Type and a value corresponding to the type.
Global Variable (Document Variable)
The value of a global variable can be changed at runtime. Global variables can only be used in the same document. Therefore, they only have one following Visibility:
- Private (fixed)
A variable has a Type and an initial value (default value) corresponding to the type.
Environment Variable (Context Variable)
Context variables behave like global constants. However, they have a special meaning. They represent environment-related data, such as vehicle type, name of workshop, user login name, etc., see the Context Concept. The context variables must have one of the following Visibilities:
- Private (default)
- Package
- Public
A context variable has a Type and a default value corresponding to the type.
Checker rules
| Core_Chk009 | Mandatory constant initialisation |
| Core_Chk051 | Immutability of constants, input parameters and context variables |
| Core_Chk052 | Identifier shadowing |
See also
Validation (OTX-Checker)
Naming Conventions
Imports
Visibilities
Validities
Signatures
Parameter Declarations
Procedures
Comments
