ParameterAccessor

class ParameterAccessor

 Attributes

property argument: syside.Expression | None: The argument accessible by this parameter.

 Methods

extract_argument() → syside.Expression

Extract the argument while leaving parameter intact. Raises ValueError if there is no argument.

Note that it is up to the user to ensure that the returned orphan element is not leaked.

remove_argument() → None: Remove the argument while leaving parameter intact. Does nothing if there is no argument.

set_argument(expression: syside.ParameterAccessor.set_argument.M) → tuple[syside.FeatureValue, syside.ParameterAccessor.set_argument.M]

Set the argument to an owned expression. Ownership constraints apply. An empty parameter will be constructed if there is none.

Returns a pair of (feature_value, argument).

set_argument(expression: syside.ParameterAccessor.set_argument.M | None) → tuple[syside.FeatureValue, syside.ParameterAccessor.set_argument.M] | None: set_argument overload that will instead remove the argument if expression is None and return None. Otherwise behaviour is the same.

set_argument(expression: type[syside.ParameterAccessor.set_argument.M]) → tuple[syside.FeatureValue, syside.ParameterAccessor.set_argument.M]

Set the argument to an empty Expression with the corresponding type. An empty parameter will be constructed if there is none.

Returns a pair of (feature_value, argument).

set_member_element(element: syside.ParameterAccessor.set_member_element.M, name: syside.NameID = ...) → tuple[syside.ParameterMembership, syside.ParameterAccessor.set_member_element.M]

Set a new owned member_element, ownership constraints apply. Replaces the previous member_element, which may be reused by the model. name_id has no effect since the element is always taken ownership of.

Returns a pair of (membership, member_element) where member_element is element.

set_member_element(element: syside.ParameterAccessor.set_member_element.M | None, name: syside.NameID = ...) → tuple[syside.ParameterMembership, syside.ParameterAccessor.set_member_element.M] | None: set_member_element overload that will remove the member element if element is None, otherwise the behaviour is the same.

set_member_element(element: type[syside.ParameterAccessor.set_member_element.M]) → tuple[syside.ParameterMembership, syside.ParameterAccessor.set_member_element.M]

Constructs a new empty member_element with the provided type. Replaces the previous member_element. Because a new element is always constructed, ownership constraints do not apply.

Returns a pair of (membership, member_element).

	`member_element`	`R`	The `member_element` of this `member` if it is not empty.
	`membership`	`R`	The `membership` of this `member` if it is not empty.
	`__bool__`
	`extract_member_element`		Extract the `member_element` leaving this `member` empty. Note that not all empty `members` are valid textual syntax. This does not check that the model is left in a valid state.
	`remove_member_element`		Remove the `member_element` leaving this `member` empty. Note that not all empty `members` are valid textual syntax. This does not check that the model is left in a valid state.

ParameterAccessor

Feedback

Legal

Company

	`argument`	`R`	The `argument` accessible by this `parameter`.
	`extract_argument`		Extract the `argument` while leaving `parameter` intact. Raises `ValueError` if there is no `argument`.
	`remove_argument`		Remove the `argument` while leaving `parameter` intact. Does nothing if there is no `argument`.
	`set_argument`		Set the `argument` to an owned `expression`. Ownership constraints apply. An empty parameter will be constructed if there is none.
	`set_member_element`		Set a new owned `member_element`, ownership constraints apply. Replaces the previous `member_element`, which may be reused by the model. `name_id` has no effect since the `element` is always taken ownership of.