finesse.parameter.Parameter

Overview

class finesse.parameter.Parameter(parameter_info, owner)

Bases: object

Properties

Parameter.changeable_during_simulation	True if this parameter cannot be changed during a simulation.
Parameter.datatype	The underlying C datatype of this parameter.
Parameter.description
Parameter.eval_string	Whether to cal 'eval' on the parameter value in the string representation
Parameter.full_name
Parameter.is_changing	True if this parameter will be changing during a simulation.
Parameter.is_default_for_owner	Whether this parameter is the default for the owning model element.
Parameter.is_externally_controlled	Whether this parameter is being externally controlled by another element.
Parameter.is_symbolic	True if this parameter's value is symbolic.
Parameter.is_tunable	True if this parameter will be directly changed during a simulation.
Parameter.locked	If locked, this parameters value cannot be changed.
Parameter.name
Parameter.owner	The component/element this parameter is associated with, this could be a finesse.element.ModelElement or a finesse.model.Model.
Parameter.ref	Returns a reference to this parameter's value to be used in symbolic expressions.
Parameter.units
Parameter.value

Methods

Parameter.__init__(*args, **kwargs)
Parameter.datatype_cast(self, value[, ...])	Casts a value into the datatype of this parameter.
Parameter.eval(self, ...)	Evaluates the value of this parameter.
Parameter.lambdify(self, *args)	Returns a lambda function that returns the value of this parameter.
Parameter.remove_external_setter(self, element)	Stops an element from being an external setter.
Parameter.resolve(self)	When this parameters value has some dependency whose value has not yet been set, like during parsing, its value will be a callable object, this method will call this function to return the value.
Parameter.set_external_setter(self, element, ...)	Sets an element as an external controller of the value of this parameter.