Class sysc::Parameter
Definition: Parameter.hpp (line 18)
Provide a class for a System Coupling parameter.
Members
Private attributes
Variable m_name
Definition: Parameter.hpp (line 53)
ParameterName sysc::Parameter::m_name
Unique name for this parameter.
Type: ParameterName
Variable m_displayName
Definition: Parameter.hpp (line 54)
DisplayName sysc::Parameter::m_displayName
User-friendly name.
Type: DisplayName
Public functions
Function Parameter
sysc::Parameter::Parameter(ParameterName name)
Provide a constructor for the Parameter class.
Parameters:
- name: Unique name for this parameter.
Display name will default to the same as name.
Parameters:
- ParameterName name
Return type:
Function Parameter
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.
Parameters:
- ParameterName name
- DisplayName displayName
Return type:
Function getName
const ParameterName& sysc::Parameter::getName() const noexcept
Get the Parameter's name.
Returns:
Return is the name of this parameter (string).
Return type: const ParameterName &
Function getDisplayName
const DisplayName& sysc::Parameter::getDisplayName() const noexcept
Get the Parameter's display name.
Returns:
Return is the display name of this parameter (string).
Return type: const DisplayName &