sysc::Parameter Class Reference
Last update: 17.07.2025Provide a class for a System Coupling parameter. More...
#include <Parameter.hpp>
Public Member Functions | |
| Parameter (ParameterName name) | |
| Provide a constructor for the Parameter class. More... | |
| Parameter (ParameterName name, DisplayName displayName) | |
| Provide a constructor for the Parameter class. More... | |
| const ParameterName & | getName () const noexcept |
| Get the Parameter's name. More... | |
| const DisplayName & | getDisplayName () const noexcept |
| Get the Parameter's display name. More... | |
Detailed Description
Provide a class for a System Coupling parameter.
Definition at line 18 of file Parameter.hpp.
Constructor & Destructor Documentation
◆ Parameter() [1/2]
|
explicit |
Provide a constructor for the Parameter class.
- Parameters
-
name Unique name for this parameter.
Display name will default to the same as name.
◆ Parameter() [2/2]
| sysc::Parameter::Parameter | ( | ParameterName | name, |
| DisplayName | displayName | ||
| ) |
Provide a constructor for the Parameter class.
- Parameters
-
name - Unique name for this parameter. displayName - parameter display name.
Member Function Documentation
◆ getDisplayName()
|
noexcept |
Get the Parameter's display name.
- Returns
- Return is the display name of this parameter (string).
◆ getName()
|
noexcept |
Get the Parameter's name.
- Returns
- Return is the name of this parameter (string).
