Skip to content

Namespaces

arnoldfuetterer edited this page Jun 7, 2023 · 16 revisions

General

Class, instance and constant names are written in upper and lower case letters and may contain numbers, e.g., ElectricCurrent. An underscore is only used at the end of a name to characterize a lower or upper index, e.g., pin_a.

Class Names

Class names start always with an upper case letter.

Instance Names

Instance names, i.e., names of component instances and of variables (with the exception of constants), start usually with a lower case letter with only a few exceptions if this is common sense (such as T for a temperature variable).

Constant Names

Constant names, i.e., names of variables declared with the constant prefix, start usually with a upper case letter with only a few exceptions if this is common sense e.g. pi, cp.

Parameter and Variable Names

Parameter and variables names are usually a character, such as T for temperature and p for pressure, or a combination of the first three characters of a word, such as higPreSetPoi for high pressure set point. In Addition see chapter Variable Naming.

Model, Block and Package Names

Names of models, blocks and packages should start with an upper-case letter and be a noun or a noun with a combination of adjectives and nouns. Use camel-case notation to combine multiple words, such as HeatTransfer.

Displayed Names

The instance name of a component is always displayed in its icon (= text string "%name") in blue colour. A connector class has the instance name definition in the diagram layer and not in the icon layer. If displayed, parameter values, e.g. resistance, mass, gear ratio, are displayed in the icon in black colour in a smaller font size as the instance name.

Sensor Names

Sensors are named in the following format: Sen<Measurement><FlowDirection>. Measurement and flow direction are used as explained above. The resulting sensor names for instances of temperature sensors in both flow directions (supply and return) would be senTSup and senTRet


Architecture

Clone this wiki locally