Skip to content

feat: add get_parameters to CustomFunction - #352

Open
abhilash-kumar-nair wants to merge 1 commit into
betafrom
akn/feat/add-display-name
Open

feat: add get_parameters to CustomFunction#352
abhilash-kumar-nair wants to merge 1 commit into
betafrom
akn/feat/add-display-name

Conversation

@abhilash-kumar-nair

Copy link
Copy Markdown
Contributor

No description provided.

A custom function's signature gives each parameter a human-readable display name
and a description, and both were dropped when the signature was parsed: only the
name, value, type and enumeration values survived. A caller presenting parameters
to someone was left with the raw name, which is not what Modelon Impact shows —
the 'dynamic' function's stop time is named 'final_time' and displayed as
'Stop Time', a difference no reformatting of the name recovers.

Keep both on the parameter, and add get_parameters() to reach them.
parameter_values stays a dict of names to values and is unchanged, so nothing
that reads values behaves differently; get_parameters() is for the cases that
need to describe a parameter rather than evaluate it.

_Parameter becomes CustomFunctionParameter now that it is returned from a public
method rather than held internally. display_name falls back to the name when the
signature declares none, so a caller can use it unconditionally.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant