This section describes the naming conventions used in the VehicleInterfaces Library. The naming convention used throughout this library is also recommended as the naming convention to be used within compatible Automotive libraries but the user should refer to the documentation of the libraries they are using to confirm that this naming convention is used.
The convention on the naming of bus signals is the most important aspect of the convention that needs to be followed to ensure compatibility between libraries.
Classes (for packages, models, records, etc.) are written with initial capital letters for each word, like in "DriverEnvironments".
Instances are written with a lower-case initial letter and then initial capital letters for each word, like in "driverEnvironment".
Variables and parameters that are derived from atomic types (Boolean, Integer, Real, String) names are written with a lower-case initial letter and then initial capital letters for each word, like in "engineSpeed". Abbreviated variable/parameter names are written with lower case letters, unless there is a strong convention, e.g. temperature is normally written "T".
Indices are denoted with an underscore, like in "r_x".
Class instances normally have names that refer to the function/position of the instances, rather than the class name, like in "leftLinkage" for an instance of a "TrailingArm" linkage.
Parameters and variables have descriptive names, like in "engineSpeed", when it is practical. Short (single-letter) names or abbreviations are used when that is considered more natural, and are then named after the property they describe, like in "v_x". For short names, indices are separated by underscore.
Parameters that represent initial values for simulation experiments are denoted with the index start, like "v_start".
Physical properties are named according to the standards established in the Modelica Standard Library:
| Symbol | Quantity / Property |
|---|---|
| r | Position |
| v | Velocity |
| a | Acceleration |
| phi | Rotation angle |
| w | Angular velocity |
| z | Angular acceleration |
| f | Force |
| tau | Torque |
| n | Direction of rotation or translation |
| m | Mass |
| c | Stiffness |
| d | Damping |
| J | Inertia element, (gear) ratio |
| k | Amplification/gain |
| s | Distance |
Wheels are identified by numbers from front left towards rear right. Those are, typically, used as indices in parameter or variable names. E.g., for a four-wheel car the front left wheel is "1", front right is "2", rear left "3", and rear right "4".