Skip to content

Ref

QuantConnect.Util.Ref

Ref(
    getter: Callable[[], QuantConnect_Util_Ref_T],
    setter: Callable[[QuantConnect_Util_Ref_T], Any],
)

Bases: Generic[QuantConnect_Util_Ref_T], Object, IReadOnlyRef[QuantConnect_Util_Ref_T]

Represents a reference to any value, T

Initializes a new instance of the Ref{T} class

Parameters:

Name Type Description Default
getter Callable[[], QuantConnect_Util_Ref_T]

A function delegate to get the current value

required
setter Callable[[QuantConnect_Util_Ref_T], Any]

A function delegate to set the current value

required

value

value: QuantConnect_Util_Ref_T

Gets or sets the value of this reference

as_read_only

as_read_only() -> IReadOnlyRef[QuantConnect_Util_Ref_T]

Returns a read-only version of this instance

Returns:

Type Description
IReadOnlyRef[QuantConnect_Util_Ref_T]

A new instance with read-only semantics/gaurantees.