Setter Reference: Links and Conveyance
Rendered from 12_all_set_functions.ipynb.
Links and conveyance
link
Kind: Object collection
| Setter | Source | Declared type | Value input | Behavior |
|---|---|---|---|---|
m.set.link.capacity(value, ids=None) | result | float | Read-only; setter raises ReadOnlyParameterError | Read-only result parameter |
m.set.link.count(value, ids=None) | derived | integer | Read-only; setter raises ReadOnlyParameterError | Read-only derived parameter |
m.set.link.depth(value, ids=None) | result | float | Read-only; setter raises ReadOnlyParameterError | Read-only result parameter |
m.set.link.flap_gate(value, ids=None) | user | bool | bool scalar, or 1D vector/Series matching selected IDs | Writable; scalar inputs broadcast across selected IDs |
m.set.link.flow(value, ids=None) | result | float | Read-only; setter raises ReadOnlyParameterError | Read-only result parameter |
m.set.link.from_node(value, ids=None) | ref | str | str scalar, or 1D vector/Series matching selected IDs | Writable reference; target IDs are validated where possible |
m.set.link.id(value, ids=None) | user | str | str scalar, or 1D vector/Series matching selected IDs | Writable; scalar inputs broadcast across selected IDs |
m.set.link.initial_flow(value, ids=None) | user | float | float scalar, or 1D vector/Series matching selected IDs | Writable; scalar inputs broadcast across selected IDs |
m.set.link.inlet_offset(value, ids=None) | user | float | float scalar, or 1D vector/Series matching selected IDs | Writable; scalar inputs broadcast across selected IDs |
m.set.link.maximum_flow(value, ids=None) | user | float | float scalar, or 1D vector/Series matching selected IDs | Writable; scalar inputs broadcast across selected IDs |
m.set.link.outlet_offset(value, ids=None) | user | float | float scalar, or 1D vector/Series matching selected IDs | Writable; scalar inputs broadcast across selected IDs |
m.set.link.pollutant_concentration(value, ids=None) | result | float | Read-only; setter raises ReadOnlyParameterError | Read-only result parameter |
m.set.link.setting(value, ids=None) | result | float | Read-only; setter raises ReadOnlyParameterError | Read-only result parameter |
m.set.link.tag(value, ids=None) | user | str | str scalar, or 1D vector/Series matching selected IDs | Writable; scalar inputs broadcast across selected IDs |
m.set.link.to_node(value, ids=None) | ref | str | str scalar, or 1D vector/Series matching selected IDs | Writable reference; target IDs are validated where possible |
m.set.link.type(value, ids=None) | derived | enum | Read-only; setter raises ReadOnlyParameterError | Read-only derived parameter |
m.set.link.velocity(value, ids=None) | result | float | Read-only; setter raises ReadOnlyParameterError | Read-only result parameter |
m.set.link.vertices(value, ids=None) | user | coordinates | One coordinate pair per selected ID | Writable; scalar inputs broadcast across selected IDs |
m.set.link.volume(value, ids=None) | result | float | Read-only; setter raises ReadOnlyParameterError | Read-only result parameter |
Copy-ready call list:
m.set.link.capacity(value, ids=None) # read-only: raises ReadOnlyParameterError
m.set.link.count(value, ids=None) # read-only: raises ReadOnlyParameterError
m.set.link.depth(value, ids=None) # read-only: raises ReadOnlyParameterError
m.set.link.flap_gate(value, ids=None)
m.set.link.flow(value, ids=None) # read-only: raises ReadOnlyParameterError
m.set.link.from_node(value, ids=None)
m.set.link.id(value, ids=None)
m.set.link.initial_flow(value, ids=None)
m.set.link.inlet_offset(value, ids=None)
m.set.link.maximum_flow(value, ids=None)
m.set.link.outlet_offset(value, ids=None)
m.set.link.pollutant_concentration(value, ids=None) # read-only: raises ReadOnlyParameterError
m.set.link.setting(value, ids=None) # read-only: raises ReadOnlyParameterError
m.set.link.tag(value, ids=None)
m.set.link.to_node(value, ids=None)
m.set.link.type(value, ids=None) # read-only: raises ReadOnlyParameterError
m.set.link.velocity(value, ids=None) # read-only: raises ReadOnlyParameterError
m.set.link.vertices(value, ids=None)
m.set.link.volume(value, ids=None) # read-only: raises ReadOnlyParameterErrorconduit
Kind: Object collection
| Setter | Source | Declared type | Value input | Behavior |
|---|---|---|---|---|
m.set.conduit.average_loss(value, ids=None) | user | float | float scalar, or 1D vector/Series matching selected IDs | Writable; scalar inputs broadcast across selected IDs |
m.set.conduit.barrels(value, ids=None) | user | integer | integer scalar, or 1D vector/Series matching selected IDs | Writable; scalar inputs broadcast across selected IDs |
m.set.conduit.capacity(value, ids=None) | result | float | Read-only; setter raises ReadOnlyParameterError | Read-only result parameter |
m.set.conduit.count(value, ids=None) | derived | integer | Read-only; setter raises ReadOnlyParameterError | Read-only derived parameter |
m.set.conduit.critical_depth(value, ids=None) | derived | float | Read-only; setter raises ReadOnlyParameterError | Read-only derived parameter |
m.set.conduit.culvert_code(value, ids=None) | user | integer/enum | integer/enum scalar, or 1D vector/Series matching selected IDs | Writable; scalar inputs broadcast across selected IDs |
m.set.conduit.depth(value, ids=None) | result | float | Read-only; setter raises ReadOnlyParameterError | Read-only result parameter |
m.set.conduit.entry_loss(value, ids=None) | user | float | float scalar, or 1D vector/Series matching selected IDs | Writable; scalar inputs broadcast across selected IDs |
m.set.conduit.exit_loss(value, ids=None) | user | float | float scalar, or 1D vector/Series matching selected IDs | Writable; scalar inputs broadcast across selected IDs |
m.set.conduit.flap_gate(value, ids=None) | user | bool | bool scalar, or 1D vector/Series matching selected IDs | Writable; scalar inputs broadcast across selected IDs |
m.set.conduit.flow(value, ids=None) | result | float | Read-only; setter raises ReadOnlyParameterError | Read-only result parameter |
m.set.conduit.from_node(value, ids=None) | ref | str | str scalar, or 1D vector/Series matching selected IDs | Writable reference; target IDs are validated where possible |
m.set.conduit.full_area(value, ids=None) | derived | float | Read-only; setter raises ReadOnlyParameterError | Read-only derived parameter |
m.set.conduit.full_depth(value, ids=None) | derived | float | Read-only; setter raises ReadOnlyParameterError | Read-only derived parameter |
m.set.conduit.full_flow(value, ids=None) | derived | float | Read-only; setter raises ReadOnlyParameterError | Read-only derived parameter |
m.set.conduit.geometry(value, ids=None) | user | float/list | One structured float/list value per selected ID | Writable; scalar inputs broadcast across selected IDs |
m.set.conduit.hydraulic_radius(value, ids=None) | derived | float | Read-only; setter raises ReadOnlyParameterError | Read-only derived parameter |
m.set.conduit.id(value, ids=None) | user | str | str scalar, or 1D vector/Series matching selected IDs | Writable; scalar inputs broadcast across selected IDs |
m.set.conduit.initial_flow(value, ids=None) | user | float | float scalar, or 1D vector/Series matching selected IDs | Writable; scalar inputs broadcast across selected IDs |
m.set.conduit.inlet_offset(value, ids=None) | user | float | float scalar, or 1D vector/Series matching selected IDs | Writable; scalar inputs broadcast across selected IDs |
m.set.conduit.length(value, ids=None) | user | float | float scalar, or 1D vector/Series matching selected IDs | Writable; scalar inputs broadcast across selected IDs |
m.set.conduit.maximum_flow(value, ids=None) | user | float | float scalar, or 1D vector/Series matching selected IDs | Writable; scalar inputs broadcast across selected IDs |
m.set.conduit.normal_depth(value, ids=None) | derived | float | Read-only; setter raises ReadOnlyParameterError | Read-only derived parameter |
m.set.conduit.outlet_offset(value, ids=None) | user | float | float scalar, or 1D vector/Series matching selected IDs | Writable; scalar inputs broadcast across selected IDs |
m.set.conduit.roughness(value, ids=None) | user | float | float scalar, or 1D vector/Series matching selected IDs | Writable; scalar inputs broadcast across selected IDs |
m.set.conduit.seepage_rate(value, ids=None) | user | float | float scalar, or 1D vector/Series matching selected IDs | Writable; scalar inputs broadcast across selected IDs |
m.set.conduit.shape(value, ids=None) | ref/user | enum | enum scalar, or 1D vector/Series matching selected IDs | Writable reference; target IDs are validated where possible |
m.set.conduit.slope(value, ids=None) | derived | float | Read-only; setter raises ReadOnlyParameterError | Read-only derived parameter |
m.set.conduit.to_node(value, ids=None) | ref | str | str scalar, or 1D vector/Series matching selected IDs | Writable reference; target IDs are validated where possible |
m.set.conduit.velocity(value, ids=None) | result | float | Read-only; setter raises ReadOnlyParameterError | Read-only result parameter |
Copy-ready call list:
m.set.conduit.average_loss(value, ids=None)
m.set.conduit.barrels(value, ids=None)
m.set.conduit.capacity(value, ids=None) # read-only: raises ReadOnlyParameterError
m.set.conduit.count(value, ids=None) # read-only: raises ReadOnlyParameterError
m.set.conduit.critical_depth(value, ids=None) # read-only: raises ReadOnlyParameterError
m.set.conduit.culvert_code(value, ids=None)
m.set.conduit.depth(value, ids=None) # read-only: raises ReadOnlyParameterError
m.set.conduit.entry_loss(value, ids=None)
m.set.conduit.exit_loss(value, ids=None)
m.set.conduit.flap_gate(value, ids=None)
m.set.conduit.flow(value, ids=None) # read-only: raises ReadOnlyParameterError
m.set.conduit.from_node(value, ids=None)
m.set.conduit.full_area(value, ids=None) # read-only: raises ReadOnlyParameterError
m.set.conduit.full_depth(value, ids=None) # read-only: raises ReadOnlyParameterError
m.set.conduit.full_flow(value, ids=None) # read-only: raises ReadOnlyParameterError
m.set.conduit.geometry(value, ids=None)
m.set.conduit.hydraulic_radius(value, ids=None) # read-only: raises ReadOnlyParameterError
m.set.conduit.id(value, ids=None)
m.set.conduit.initial_flow(value, ids=None)
m.set.conduit.inlet_offset(value, ids=None)
m.set.conduit.length(value, ids=None)
m.set.conduit.maximum_flow(value, ids=None)
m.set.conduit.normal_depth(value, ids=None) # read-only: raises ReadOnlyParameterError
m.set.conduit.outlet_offset(value, ids=None)
m.set.conduit.roughness(value, ids=None)
m.set.conduit.seepage_rate(value, ids=None)
m.set.conduit.shape(value, ids=None)
m.set.conduit.slope(value, ids=None) # read-only: raises ReadOnlyParameterError
m.set.conduit.to_node(value, ids=None)
m.set.conduit.velocity(value, ids=None) # read-only: raises ReadOnlyParameterErrorcross_section
Kind: Object collection
| Setter | Source | Declared type | Value input | Behavior |
|---|---|---|---|---|
m.set.cross_section.barrels(value, ids=None) | user | integer | integer scalar, or 1D vector/Series matching selected IDs | Writable; scalar inputs broadcast across selected IDs |
m.set.cross_section.culvert_code(value, ids=None) | user | integer/enum | integer/enum scalar, or 1D vector/Series matching selected IDs | Writable; scalar inputs broadcast across selected IDs |
m.set.cross_section.geometry_1(value, ids=None) | user | float | float scalar, or 1D vector/Series matching selected IDs | Writable; scalar inputs broadcast across selected IDs |
m.set.cross_section.geometry_2(value, ids=None) | user | float | float scalar, or 1D vector/Series matching selected IDs | Writable; scalar inputs broadcast across selected IDs |
m.set.cross_section.geometry_3(value, ids=None) | user | float | float scalar, or 1D vector/Series matching selected IDs | Writable; scalar inputs broadcast across selected IDs |
m.set.cross_section.geometry_4(value, ids=None) | user | float | float scalar, or 1D vector/Series matching selected IDs | Writable; scalar inputs broadcast across selected IDs |
m.set.cross_section.height(value, ids=None) | derived/user | float | float scalar, or 1D vector/Series matching selected IDs | Writable; scalar inputs broadcast across selected IDs |
m.set.cross_section.link(value, ids=None) | ref | str | One structured str value per selected ID | Writable reference; target IDs are validated where possible |
m.set.cross_section.shape(value, ids=None) | user | enum | enum scalar, or 1D vector/Series matching selected IDs | Writable; scalar inputs broadcast across selected IDs |
m.set.cross_section.shape_curve(value, ids=None) | ref | str | str scalar, or 1D vector/Series matching selected IDs | Writable reference; target IDs are validated where possible |
m.set.cross_section.side_slope(value, ids=None) | derived/user | float | float scalar, or 1D vector/Series matching selected IDs | Writable; scalar inputs broadcast across selected IDs |
m.set.cross_section.width(value, ids=None) | derived/user | float | float scalar, or 1D vector/Series matching selected IDs | Writable; scalar inputs broadcast across selected IDs |
Copy-ready call list:
m.set.cross_section.barrels(value, ids=None)
m.set.cross_section.culvert_code(value, ids=None)
m.set.cross_section.geometry_1(value, ids=None)
m.set.cross_section.geometry_2(value, ids=None)
m.set.cross_section.geometry_3(value, ids=None)
m.set.cross_section.geometry_4(value, ids=None)
m.set.cross_section.height(value, ids=None)
m.set.cross_section.link(value, ids=None)
m.set.cross_section.shape(value, ids=None)
m.set.cross_section.shape_curve(value, ids=None)
m.set.cross_section.side_slope(value, ids=None)
m.set.cross_section.width(value, ids=None)pump
Kind: Object collection
| Setter | Source | Declared type | Value input | Behavior |
|---|---|---|---|---|
m.set.pump.count(value, ids=None) | derived | integer | Read-only; setter raises ReadOnlyParameterError | Read-only derived parameter |
m.set.pump.curve(value, ids=None) | ref | str | str scalar, or 1D vector/Series matching selected IDs | Writable reference; target IDs are validated where possible |
m.set.pump.energy(value, ids=None) | result | float | Read-only; setter raises ReadOnlyParameterError | Read-only result parameter |
m.set.pump.flow(value, ids=None) | result | float | Read-only; setter raises ReadOnlyParameterError | Read-only result parameter |
m.set.pump.from_node(value, ids=None) | ref | str | str scalar, or 1D vector/Series matching selected IDs | Writable reference; target IDs are validated where possible |
m.set.pump.id(value, ids=None) | user | str | str scalar, or 1D vector/Series matching selected IDs | Writable; scalar inputs broadcast across selected IDs |
m.set.pump.initial_status(value, ids=None) | user | enum/bool | enum/bool scalar, or 1D vector/Series matching selected IDs | Writable; scalar inputs broadcast across selected IDs |
m.set.pump.setting(value, ids=None) | result | float | Read-only; setter raises ReadOnlyParameterError | Read-only result parameter |
m.set.pump.shutoff_depth(value, ids=None) | user | float | float scalar, or 1D vector/Series matching selected IDs | Writable; scalar inputs broadcast across selected IDs |
m.set.pump.startup_depth(value, ids=None) | user | float | float scalar, or 1D vector/Series matching selected IDs | Writable; scalar inputs broadcast across selected IDs |
m.set.pump.status(value, ids=None) | result | bool/enum | Read-only; setter raises ReadOnlyParameterError | Read-only result parameter |
m.set.pump.to_node(value, ids=None) | ref | str | str scalar, or 1D vector/Series matching selected IDs | Writable reference; target IDs are validated where possible |
Copy-ready call list:
m.set.pump.count(value, ids=None) # read-only: raises ReadOnlyParameterError
m.set.pump.curve(value, ids=None)
m.set.pump.energy(value, ids=None) # read-only: raises ReadOnlyParameterError
m.set.pump.flow(value, ids=None) # read-only: raises ReadOnlyParameterError
m.set.pump.from_node(value, ids=None)
m.set.pump.id(value, ids=None)
m.set.pump.initial_status(value, ids=None)
m.set.pump.setting(value, ids=None) # read-only: raises ReadOnlyParameterError
m.set.pump.shutoff_depth(value, ids=None)
m.set.pump.startup_depth(value, ids=None)
m.set.pump.status(value, ids=None) # read-only: raises ReadOnlyParameterError
m.set.pump.to_node(value, ids=None)orifice
Kind: Object collection
| Setter | Source | Declared type | Value input | Behavior |
|---|---|---|---|---|
m.set.orifice.count(value, ids=None) | derived | integer | Read-only; setter raises ReadOnlyParameterError | Read-only derived parameter |
m.set.orifice.discharge_coefficient(value, ids=None) | user | float | float scalar, or 1D vector/Series matching selected IDs | Writable; scalar inputs broadcast across selected IDs |
m.set.orifice.flap_gate(value, ids=None) | user | bool | bool scalar, or 1D vector/Series matching selected IDs | Writable; scalar inputs broadcast across selected IDs |
m.set.orifice.flow(value, ids=None) | result | float | Read-only; setter raises ReadOnlyParameterError | Read-only result parameter |
m.set.orifice.from_node(value, ids=None) | ref | str | str scalar, or 1D vector/Series matching selected IDs | Writable reference; target IDs are validated where possible |
m.set.orifice.height(value, ids=None) | user | float | float scalar, or 1D vector/Series matching selected IDs | Writable; scalar inputs broadcast across selected IDs |
m.set.orifice.id(value, ids=None) | user | str | str scalar, or 1D vector/Series matching selected IDs | Writable; scalar inputs broadcast across selected IDs |
m.set.orifice.offset(value, ids=None) | user | float | float scalar, or 1D vector/Series matching selected IDs | Writable; scalar inputs broadcast across selected IDs |
m.set.orifice.open_close_time(value, ids=None) | user | float | float scalar, or 1D vector/Series matching selected IDs | Writable; scalar inputs broadcast across selected IDs |
m.set.orifice.setting(value, ids=None) | result | float | Read-only; setter raises ReadOnlyParameterError | Read-only result parameter |
m.set.orifice.shape(value, ids=None) | user | enum | enum scalar, or 1D vector/Series matching selected IDs | Writable; scalar inputs broadcast across selected IDs |
m.set.orifice.to_node(value, ids=None) | ref | str | str scalar, or 1D vector/Series matching selected IDs | Writable reference; target IDs are validated where possible |
m.set.orifice.type(value, ids=None) | user | enum | enum scalar, or 1D vector/Series matching selected IDs | Writable; scalar inputs broadcast across selected IDs |
m.set.orifice.width(value, ids=None) | user | float | float scalar, or 1D vector/Series matching selected IDs | Writable; scalar inputs broadcast across selected IDs |
Copy-ready call list:
m.set.orifice.count(value, ids=None) # read-only: raises ReadOnlyParameterError
m.set.orifice.discharge_coefficient(value, ids=None)
m.set.orifice.flap_gate(value, ids=None)
m.set.orifice.flow(value, ids=None) # read-only: raises ReadOnlyParameterError
m.set.orifice.from_node(value, ids=None)
m.set.orifice.height(value, ids=None)
m.set.orifice.id(value, ids=None)
m.set.orifice.offset(value, ids=None)
m.set.orifice.open_close_time(value, ids=None)
m.set.orifice.setting(value, ids=None) # read-only: raises ReadOnlyParameterError
m.set.orifice.shape(value, ids=None)
m.set.orifice.to_node(value, ids=None)
m.set.orifice.type(value, ids=None)
m.set.orifice.width(value, ids=None)weir
Kind: Object collection
| Setter | Source | Declared type | Value input | Behavior |
|---|---|---|---|---|
m.set.weir.count(value, ids=None) | derived | integer | Read-only; setter raises ReadOnlyParameterError | Read-only derived parameter |
m.set.weir.crest_height(value, ids=None) | user | float | float scalar, or 1D vector/Series matching selected IDs | Writable; scalar inputs broadcast across selected IDs |
m.set.weir.discharge_coefficient(value, ids=None) | user | float | float scalar, or 1D vector/Series matching selected IDs | Writable; scalar inputs broadcast across selected IDs |
m.set.weir.end_coefficient(value, ids=None) | user | float | float scalar, or 1D vector/Series matching selected IDs | Writable; scalar inputs broadcast across selected IDs |
m.set.weir.end_contractions(value, ids=None) | user | integer | integer scalar, or 1D vector/Series matching selected IDs | Writable; scalar inputs broadcast across selected IDs |
m.set.weir.flap_gate(value, ids=None) | user | bool | bool scalar, or 1D vector/Series matching selected IDs | Writable; scalar inputs broadcast across selected IDs |
m.set.weir.flow(value, ids=None) | result | float | Read-only; setter raises ReadOnlyParameterError | Read-only result parameter |
m.set.weir.from_node(value, ids=None) | ref | str | str scalar, or 1D vector/Series matching selected IDs | Writable reference; target IDs are validated where possible |
m.set.weir.id(value, ids=None) | user | str | str scalar, or 1D vector/Series matching selected IDs | Writable; scalar inputs broadcast across selected IDs |
m.set.weir.length(value, ids=None) | user | float | float scalar, or 1D vector/Series matching selected IDs | Writable; scalar inputs broadcast across selected IDs |
m.set.weir.road_surface(value, ids=None) | user | enum/str | enum/str scalar, or 1D vector/Series matching selected IDs | Writable; scalar inputs broadcast across selected IDs |
m.set.weir.road_width(value, ids=None) | user | float | float scalar, or 1D vector/Series matching selected IDs | Writable; scalar inputs broadcast across selected IDs |
m.set.weir.setting(value, ids=None) | result | float | Read-only; setter raises ReadOnlyParameterError | Read-only result parameter |
m.set.weir.side_slope(value, ids=None) | user | float | float scalar, or 1D vector/Series matching selected IDs | Writable; scalar inputs broadcast across selected IDs |
m.set.weir.surcharge(value, ids=None) | user | bool/enum | bool/enum scalar, or 1D vector/Series matching selected IDs | Writable; scalar inputs broadcast across selected IDs |
m.set.weir.to_node(value, ids=None) | ref | str | str scalar, or 1D vector/Series matching selected IDs | Writable reference; target IDs are validated where possible |
m.set.weir.type(value, ids=None) | user | enum | enum scalar, or 1D vector/Series matching selected IDs | Writable; scalar inputs broadcast across selected IDs |
Copy-ready call list:
m.set.weir.count(value, ids=None) # read-only: raises ReadOnlyParameterError
m.set.weir.crest_height(value, ids=None)
m.set.weir.discharge_coefficient(value, ids=None)
m.set.weir.end_coefficient(value, ids=None)
m.set.weir.end_contractions(value, ids=None)
m.set.weir.flap_gate(value, ids=None)
m.set.weir.flow(value, ids=None) # read-only: raises ReadOnlyParameterError
m.set.weir.from_node(value, ids=None)
m.set.weir.id(value, ids=None)
m.set.weir.length(value, ids=None)
m.set.weir.road_surface(value, ids=None)
m.set.weir.road_width(value, ids=None)
m.set.weir.setting(value, ids=None) # read-only: raises ReadOnlyParameterError
m.set.weir.side_slope(value, ids=None)
m.set.weir.surcharge(value, ids=None)
m.set.weir.to_node(value, ids=None)
m.set.weir.type(value, ids=None)outlet
Kind: Object collection
| Setter | Source | Declared type | Value input | Behavior |
|---|---|---|---|---|
m.set.outlet.coefficient(value, ids=None) | user | float | float scalar, or 1D vector/Series matching selected IDs | Writable; scalar inputs broadcast across selected IDs |
m.set.outlet.count(value, ids=None) | derived | integer | Read-only; setter raises ReadOnlyParameterError | Read-only derived parameter |
m.set.outlet.curve(value, ids=None) | ref | str | str scalar, or 1D vector/Series matching selected IDs | Writable reference; target IDs are validated where possible |
m.set.outlet.exponent(value, ids=None) | user | float | float scalar, or 1D vector/Series matching selected IDs | Writable; scalar inputs broadcast across selected IDs |
m.set.outlet.flap_gate(value, ids=None) | user | bool | bool scalar, or 1D vector/Series matching selected IDs | Writable; scalar inputs broadcast across selected IDs |
m.set.outlet.flow(value, ids=None) | result | float | Read-only; setter raises ReadOnlyParameterError | Read-only result parameter |
m.set.outlet.from_node(value, ids=None) | ref | str | str scalar, or 1D vector/Series matching selected IDs | Writable reference; target IDs are validated where possible |
m.set.outlet.id(value, ids=None) | user | str | str scalar, or 1D vector/Series matching selected IDs | Writable; scalar inputs broadcast across selected IDs |
m.set.outlet.offset(value, ids=None) | user | float | float scalar, or 1D vector/Series matching selected IDs | Writable; scalar inputs broadcast across selected IDs |
m.set.outlet.rating_type(value, ids=None) | user | enum | enum scalar, or 1D vector/Series matching selected IDs | Writable; scalar inputs broadcast across selected IDs |
m.set.outlet.setting(value, ids=None) | result | float | Read-only; setter raises ReadOnlyParameterError | Read-only result parameter |
m.set.outlet.to_node(value, ids=None) | ref | str | str scalar, or 1D vector/Series matching selected IDs | Writable reference; target IDs are validated where possible |
Copy-ready call list:
m.set.outlet.coefficient(value, ids=None)
m.set.outlet.count(value, ids=None) # read-only: raises ReadOnlyParameterError
m.set.outlet.curve(value, ids=None)
m.set.outlet.exponent(value, ids=None)
m.set.outlet.flap_gate(value, ids=None)
m.set.outlet.flow(value, ids=None) # read-only: raises ReadOnlyParameterError
m.set.outlet.from_node(value, ids=None)
m.set.outlet.id(value, ids=None)
m.set.outlet.offset(value, ids=None)
m.set.outlet.rating_type(value, ids=None)
m.set.outlet.setting(value, ids=None) # read-only: raises ReadOnlyParameterError
m.set.outlet.to_node(value, ids=None)