register_location_as_parameter

abstract IntegrationNode.register_location_as_parameter(location: Any, name: str | None = None, reference_value: Any | None = None) → str

Register the given location as a parameter.

Parameters:

locationAny

Location to be registered.

nameOptional[str], optional

Name of the registered parameter, by default None.

reference_valueOptional[Any], optional

Reference value of the registered parameter, by default None.

Returns:

str

Name of the actual created parameter.

Raises:

OslCommunicationError

Raised when an error occurs while communicating with the server.

OslCommandError

Raised when a command or query fails.

TimeoutError

Raised when the timeout float value expires.