BuildingControlLib.BuildingControl.VDI3813.UsersGuide.Convention.DocumentationTemplate

# .BuildingControlLib.BuildingControl.VDI3813.UsersGuide.Convention.DocumentationTemplate

Template documentation of control functions implementation

## Information

#### Overview

Block that implements function "My Function Name" from VDI 3813 [1].

#### Functional Description

Here a brief description of the functional characteristic of the function implemented should be provided aligned with descriptions from the standard.

#### Input Variables

The following table presents the input variables of the function as specified in the standard.

#### Acronym | #### Datatype VDI3813 | #### Semantic data type | #### Signal flow direction | #### Description
T_XXX | Temp | SetpointTemperatureOperator | Input | Provide description
S_XXX | Jal | SetpointTemperatureUser | Input | Provide description
T_XXX | xxx | ValueTemperatureOutdoor | Input | Provide description

#### Output Variables

The following table presents the output variables of the function as specified in the standard.

#### Acronym | #### Datatype VDI3813 | #### Semantic data type | #### Signal flow direction | #### Description
T_SETPS | Temp[x] | SetpointSetpointHeatCoolEnergyModes | Output | Provide description

Parameter

The following table presents the parameter of the function as specified in the standard.

#### Acronym | #### Description
PAR_XXX | Provide description
PAR_XXX | Provide description

References

[1] | VDI 3813-2 - Gebäudeautomation (GA) - Blatt 2: Raumautomationsfunktionen (RA-Funktionen). Beuth Verlag GmbH, Berlin, 2011.

## Revisions

- March 07, 2017 by Georg Ferdinand Schneider & Georg Ambrosius Peßler:
  Implemented.

Generated at 2026-05-09T18:18:56Z by OpenModelicaOpenModelica 1.26.7 using GenerateDoc.mos