swmmx Documentation

Getter Reference: Links and Conveyance

Rendered from 11_all_get_functions.ipynb.

Links and conveyance

link

Kind: Object collection

GetterSourceDeclared typeDeclared sizeOutput note
m.get.link.capacity(ids=None, format=None)resultfloattime series × linkTime series; NumPy by default, or timestamp-indexed DataFrame with format='df'
m.get.link.count(ids=None, format=None)derivedintegersingleint scalar count
m.get.link.depth(ids=None, format=None)resultfloattime series × linkTime series; NumPy by default, or timestamp-indexed DataFrame with format='df'
m.get.link.flap_gate(ids=None, format=None)userboolseries by IDOne ID → scalar/structured value; many/all IDs → NumPy array or one-row DataFrame
m.get.link.flow(ids=None, format=None)resultfloattime series × linkTime series; NumPy by default, or timestamp-indexed DataFrame with format='df'
m.get.link.from_node(ids=None, format=None)refstrseries by IDOne ID → scalar/structured value; many/all IDs → NumPy array or one-row DataFrame
m.get.link.id(ids=None, format=None)userstrsingleOne ID → scalar/structured value; many/all IDs → NumPy array or one-row DataFrame
m.get.link.initial_flow(ids=None, format=None)userfloatseries by IDOne ID → scalar/structured value; many/all IDs → NumPy array or one-row DataFrame
m.get.link.inlet_offset(ids=None, format=None)userfloatseries by IDOne ID → scalar/structured value; many/all IDs → NumPy array or one-row DataFrame
m.get.link.maximum_flow(ids=None, format=None)userfloatseries by IDOne ID → scalar/structured value; many/all IDs → NumPy array or one-row DataFrame
m.get.link.outlet_offset(ids=None, format=None)userfloatseries by IDOne ID → scalar/structured value; many/all IDs → NumPy array or one-row DataFrame
m.get.link.pollutant_concentration(ids=None, format=None)resultfloattime series × link × pollutantTime series; NumPy by default, or timestamp-indexed DataFrame with format='df'
m.get.link.setting(ids=None, format=None)resultfloattime series × linkTime series; NumPy by default, or timestamp-indexed DataFrame with format='df'
m.get.link.tag(ids=None, format=None)userstrseries by IDOne ID → scalar/structured value; many/all IDs → NumPy array or one-row DataFrame
m.get.link.to_node(ids=None, format=None)refstrseries by IDOne ID → scalar/structured value; many/all IDs → NumPy array or one-row DataFrame
m.get.link.type(ids=None, format=None)derivedenumseries by IDOne ID → scalar/structured value; many/all IDs → NumPy array or one-row DataFrame
m.get.link.velocity(ids=None, format=None)resultfloattime series × linkTime series; NumPy by default, or timestamp-indexed DataFrame with format='df'
m.get.link.vertices(ids=None, format=None)usercoordinatessequence/listOne ID → scalar/structured value; many/all IDs → NumPy array or one-row DataFrame
m.get.link.volume(ids=None, format=None)resultfloattime series × linkTime series; NumPy by default, or timestamp-indexed DataFrame with format='df'

Copy-ready call list:

m.get.link.capacity(ids=None, format=None)
m.get.link.count(ids=None, format=None)
m.get.link.depth(ids=None, format=None)
m.get.link.flap_gate(ids=None, format=None)
m.get.link.flow(ids=None, format=None)
m.get.link.from_node(ids=None, format=None)
m.get.link.id(ids=None, format=None)
m.get.link.initial_flow(ids=None, format=None)
m.get.link.inlet_offset(ids=None, format=None)
m.get.link.maximum_flow(ids=None, format=None)
m.get.link.outlet_offset(ids=None, format=None)
m.get.link.pollutant_concentration(ids=None, format=None)
m.get.link.setting(ids=None, format=None)
m.get.link.tag(ids=None, format=None)
m.get.link.to_node(ids=None, format=None)
m.get.link.type(ids=None, format=None)
m.get.link.velocity(ids=None, format=None)
m.get.link.vertices(ids=None, format=None)
m.get.link.volume(ids=None, format=None)

conduit

Kind: Object collection

GetterSourceDeclared typeDeclared sizeOutput note
m.get.conduit.average_loss(ids=None, format=None)userfloatseries by IDOne ID → scalar/structured value; many/all IDs → NumPy array or one-row DataFrame
m.get.conduit.barrels(ids=None, format=None)userintegerseries by IDOne ID → scalar/structured value; many/all IDs → NumPy array or one-row DataFrame
m.get.conduit.capacity(ids=None, format=None)resultfloattime series × conduitTime series; NumPy by default, or timestamp-indexed DataFrame with format='df'
m.get.conduit.count(ids=None, format=None)derivedintegersingleint scalar count
m.get.conduit.critical_depth(ids=None, format=None)derivedfloatseries by IDOne ID → scalar/structured value; many/all IDs → NumPy array or one-row DataFrame
m.get.conduit.culvert_code(ids=None, format=None)userinteger/enumseries by IDOne ID → scalar/structured value; many/all IDs → NumPy array or one-row DataFrame
m.get.conduit.depth(ids=None, format=None)resultfloattime series × conduitTime series; NumPy by default, or timestamp-indexed DataFrame with format='df'
m.get.conduit.entry_loss(ids=None, format=None)userfloatseries by IDOne ID → scalar/structured value; many/all IDs → NumPy array or one-row DataFrame
m.get.conduit.exit_loss(ids=None, format=None)userfloatseries by IDOne ID → scalar/structured value; many/all IDs → NumPy array or one-row DataFrame
m.get.conduit.flap_gate(ids=None, format=None)userboolseries by IDOne ID → scalar/structured value; many/all IDs → NumPy array or one-row DataFrame
m.get.conduit.flow(ids=None, format=None)resultfloattime series × conduitTime series; NumPy by default, or timestamp-indexed DataFrame with format='df'
m.get.conduit.from_node(ids=None, format=None)refstrseries by IDOne ID → scalar/structured value; many/all IDs → NumPy array or one-row DataFrame
m.get.conduit.full_area(ids=None, format=None)derivedfloatseries by IDOne ID → scalar/structured value; many/all IDs → NumPy array or one-row DataFrame
m.get.conduit.full_depth(ids=None, format=None)derivedfloatseries by IDOne ID → scalar/structured value; many/all IDs → NumPy array or one-row DataFrame
m.get.conduit.full_flow(ids=None, format=None)derivedfloatseries by IDOne ID → scalar/structured value; many/all IDs → NumPy array or one-row DataFrame
m.get.conduit.geometry(ids=None, format=None)userfloat/listseries/tableOne ID → scalar/structured value; many/all IDs → NumPy array or one-row DataFrame
m.get.conduit.hydraulic_radius(ids=None, format=None)derivedfloatseries by IDOne ID → scalar/structured value; many/all IDs → NumPy array or one-row DataFrame
m.get.conduit.id(ids=None, format=None)userstrsingleOne ID → scalar/structured value; many/all IDs → NumPy array or one-row DataFrame
m.get.conduit.initial_flow(ids=None, format=None)userfloatseries by IDOne ID → scalar/structured value; many/all IDs → NumPy array or one-row DataFrame
m.get.conduit.inlet_offset(ids=None, format=None)userfloatseries by IDOne ID → scalar/structured value; many/all IDs → NumPy array or one-row DataFrame
m.get.conduit.length(ids=None, format=None)userfloatseries by IDOne ID → scalar/structured value; many/all IDs → NumPy array or one-row DataFrame
m.get.conduit.maximum_flow(ids=None, format=None)userfloatseries by IDOne ID → scalar/structured value; many/all IDs → NumPy array or one-row DataFrame
m.get.conduit.normal_depth(ids=None, format=None)derivedfloatseries by IDOne ID → scalar/structured value; many/all IDs → NumPy array or one-row DataFrame
m.get.conduit.outlet_offset(ids=None, format=None)userfloatseries by IDOne ID → scalar/structured value; many/all IDs → NumPy array or one-row DataFrame
m.get.conduit.roughness(ids=None, format=None)userfloatseries by IDOne ID → scalar/structured value; many/all IDs → NumPy array or one-row DataFrame
m.get.conduit.seepage_rate(ids=None, format=None)userfloatseries by IDOne ID → scalar/structured value; many/all IDs → NumPy array or one-row DataFrame
m.get.conduit.shape(ids=None, format=None)ref/userenumseries by IDOne ID → scalar/structured value; many/all IDs → NumPy array or one-row DataFrame
m.get.conduit.slope(ids=None, format=None)derivedfloatseries by IDOne ID → scalar/structured value; many/all IDs → NumPy array or one-row DataFrame
m.get.conduit.to_node(ids=None, format=None)refstrseries by IDOne ID → scalar/structured value; many/all IDs → NumPy array or one-row DataFrame
m.get.conduit.velocity(ids=None, format=None)resultfloattime series × conduitTime series; NumPy by default, or timestamp-indexed DataFrame with format='df'

Copy-ready call list:

m.get.conduit.average_loss(ids=None, format=None)
m.get.conduit.barrels(ids=None, format=None)
m.get.conduit.capacity(ids=None, format=None)
m.get.conduit.count(ids=None, format=None)
m.get.conduit.critical_depth(ids=None, format=None)
m.get.conduit.culvert_code(ids=None, format=None)
m.get.conduit.depth(ids=None, format=None)
m.get.conduit.entry_loss(ids=None, format=None)
m.get.conduit.exit_loss(ids=None, format=None)
m.get.conduit.flap_gate(ids=None, format=None)
m.get.conduit.flow(ids=None, format=None)
m.get.conduit.from_node(ids=None, format=None)
m.get.conduit.full_area(ids=None, format=None)
m.get.conduit.full_depth(ids=None, format=None)
m.get.conduit.full_flow(ids=None, format=None)
m.get.conduit.geometry(ids=None, format=None)
m.get.conduit.hydraulic_radius(ids=None, format=None)
m.get.conduit.id(ids=None, format=None)
m.get.conduit.initial_flow(ids=None, format=None)
m.get.conduit.inlet_offset(ids=None, format=None)
m.get.conduit.length(ids=None, format=None)
m.get.conduit.maximum_flow(ids=None, format=None)
m.get.conduit.normal_depth(ids=None, format=None)
m.get.conduit.outlet_offset(ids=None, format=None)
m.get.conduit.roughness(ids=None, format=None)
m.get.conduit.seepage_rate(ids=None, format=None)
m.get.conduit.shape(ids=None, format=None)
m.get.conduit.slope(ids=None, format=None)
m.get.conduit.to_node(ids=None, format=None)
m.get.conduit.velocity(ids=None, format=None)

cross_section

Kind: Object collection

GetterSourceDeclared typeDeclared sizeOutput note
m.get.cross_section.barrels(ids=None, format=None)userintegerseries by linkOne ID → scalar/structured value; many/all IDs → NumPy array or one-row DataFrame
m.get.cross_section.culvert_code(ids=None, format=None)userinteger/enumseries by linkOne ID → scalar/structured value; many/all IDs → NumPy array or one-row DataFrame
m.get.cross_section.geometry_1(ids=None, format=None)userfloatseries by linkOne ID → scalar/structured value; many/all IDs → NumPy array or one-row DataFrame
m.get.cross_section.geometry_2(ids=None, format=None)userfloatseries by linkOne ID → scalar/structured value; many/all IDs → NumPy array or one-row DataFrame
m.get.cross_section.geometry_3(ids=None, format=None)userfloatseries by linkOne ID → scalar/structured value; many/all IDs → NumPy array or one-row DataFrame
m.get.cross_section.geometry_4(ids=None, format=None)userfloatseries by linkOne ID → scalar/structured value; many/all IDs → NumPy array or one-row DataFrame
m.get.cross_section.height(ids=None, format=None)derived/userfloatseries by linkOne ID → scalar/structured value; many/all IDs → NumPy array or one-row DataFrame
m.get.cross_section.link(ids=None, format=None)refstrseries/tableOne ID → scalar/structured value; many/all IDs → NumPy array or one-row DataFrame
m.get.cross_section.shape(ids=None, format=None)userenumseries by linkOne ID → scalar/structured value; many/all IDs → NumPy array or one-row DataFrame
m.get.cross_section.shape_curve(ids=None, format=None)refstrseries by linkOne ID → scalar/structured value; many/all IDs → NumPy array or one-row DataFrame
m.get.cross_section.side_slope(ids=None, format=None)derived/userfloatseries by linkOne ID → scalar/structured value; many/all IDs → NumPy array or one-row DataFrame
m.get.cross_section.width(ids=None, format=None)derived/userfloatseries by linkOne ID → scalar/structured value; many/all IDs → NumPy array or one-row DataFrame

Copy-ready call list:

m.get.cross_section.barrels(ids=None, format=None)
m.get.cross_section.culvert_code(ids=None, format=None)
m.get.cross_section.geometry_1(ids=None, format=None)
m.get.cross_section.geometry_2(ids=None, format=None)
m.get.cross_section.geometry_3(ids=None, format=None)
m.get.cross_section.geometry_4(ids=None, format=None)
m.get.cross_section.height(ids=None, format=None)
m.get.cross_section.link(ids=None, format=None)
m.get.cross_section.shape(ids=None, format=None)
m.get.cross_section.shape_curve(ids=None, format=None)
m.get.cross_section.side_slope(ids=None, format=None)
m.get.cross_section.width(ids=None, format=None)

pump

Kind: Object collection

GetterSourceDeclared typeDeclared sizeOutput note
m.get.pump.count(ids=None, format=None)derivedintegersingleint scalar count
m.get.pump.curve(ids=None, format=None)refstrseries by IDOne ID → scalar/structured value; many/all IDs → NumPy array or one-row DataFrame
m.get.pump.energy(ids=None, format=None)resultfloatsummary/time seriesTime series; NumPy by default, or timestamp-indexed DataFrame with format='df'
m.get.pump.flow(ids=None, format=None)resultfloattime series × pumpTime series; NumPy by default, or timestamp-indexed DataFrame with format='df'
m.get.pump.from_node(ids=None, format=None)refstrseries by IDOne ID → scalar/structured value; many/all IDs → NumPy array or one-row DataFrame
m.get.pump.id(ids=None, format=None)userstrsingleOne ID → scalar/structured value; many/all IDs → NumPy array or one-row DataFrame
m.get.pump.initial_status(ids=None, format=None)userenum/boolseries by IDOne ID → scalar/structured value; many/all IDs → NumPy array or one-row DataFrame
m.get.pump.setting(ids=None, format=None)resultfloattime series × pumpTime series; NumPy by default, or timestamp-indexed DataFrame with format='df'
m.get.pump.shutoff_depth(ids=None, format=None)userfloatseries by IDOne ID → scalar/structured value; many/all IDs → NumPy array or one-row DataFrame
m.get.pump.startup_depth(ids=None, format=None)userfloatseries by IDOne ID → scalar/structured value; many/all IDs → NumPy array or one-row DataFrame
m.get.pump.status(ids=None, format=None)resultbool/enumtime series × pumpTime series; NumPy by default, or timestamp-indexed DataFrame with format='df'
m.get.pump.to_node(ids=None, format=None)refstrseries by IDOne ID → scalar/structured value; many/all IDs → NumPy array or one-row DataFrame

Copy-ready call list:

m.get.pump.count(ids=None, format=None)
m.get.pump.curve(ids=None, format=None)
m.get.pump.energy(ids=None, format=None)
m.get.pump.flow(ids=None, format=None)
m.get.pump.from_node(ids=None, format=None)
m.get.pump.id(ids=None, format=None)
m.get.pump.initial_status(ids=None, format=None)
m.get.pump.setting(ids=None, format=None)
m.get.pump.shutoff_depth(ids=None, format=None)
m.get.pump.startup_depth(ids=None, format=None)
m.get.pump.status(ids=None, format=None)
m.get.pump.to_node(ids=None, format=None)

orifice

Kind: Object collection

GetterSourceDeclared typeDeclared sizeOutput note
m.get.orifice.count(ids=None, format=None)derivedintegersingleint scalar count
m.get.orifice.discharge_coefficient(ids=None, format=None)userfloatseries by IDOne ID → scalar/structured value; many/all IDs → NumPy array or one-row DataFrame
m.get.orifice.flap_gate(ids=None, format=None)userboolseries by IDOne ID → scalar/structured value; many/all IDs → NumPy array or one-row DataFrame
m.get.orifice.flow(ids=None, format=None)resultfloattime series × orificeTime series; NumPy by default, or timestamp-indexed DataFrame with format='df'
m.get.orifice.from_node(ids=None, format=None)refstrseries by IDOne ID → scalar/structured value; many/all IDs → NumPy array or one-row DataFrame
m.get.orifice.height(ids=None, format=None)userfloatseries by IDOne ID → scalar/structured value; many/all IDs → NumPy array or one-row DataFrame
m.get.orifice.id(ids=None, format=None)userstrsingleOne ID → scalar/structured value; many/all IDs → NumPy array or one-row DataFrame
m.get.orifice.offset(ids=None, format=None)userfloatseries by IDOne ID → scalar/structured value; many/all IDs → NumPy array or one-row DataFrame
m.get.orifice.open_close_time(ids=None, format=None)userfloatseries by IDOne ID → scalar/structured value; many/all IDs → NumPy array or one-row DataFrame
m.get.orifice.setting(ids=None, format=None)resultfloattime series × orificeTime series; NumPy by default, or timestamp-indexed DataFrame with format='df'
m.get.orifice.shape(ids=None, format=None)userenumseries by IDOne ID → scalar/structured value; many/all IDs → NumPy array or one-row DataFrame
m.get.orifice.to_node(ids=None, format=None)refstrseries by IDOne ID → scalar/structured value; many/all IDs → NumPy array or one-row DataFrame
m.get.orifice.type(ids=None, format=None)userenumseries by IDOne ID → scalar/structured value; many/all IDs → NumPy array or one-row DataFrame
m.get.orifice.width(ids=None, format=None)userfloatseries by IDOne ID → scalar/structured value; many/all IDs → NumPy array or one-row DataFrame

Copy-ready call list:

m.get.orifice.count(ids=None, format=None)
m.get.orifice.discharge_coefficient(ids=None, format=None)
m.get.orifice.flap_gate(ids=None, format=None)
m.get.orifice.flow(ids=None, format=None)
m.get.orifice.from_node(ids=None, format=None)
m.get.orifice.height(ids=None, format=None)
m.get.orifice.id(ids=None, format=None)
m.get.orifice.offset(ids=None, format=None)
m.get.orifice.open_close_time(ids=None, format=None)
m.get.orifice.setting(ids=None, format=None)
m.get.orifice.shape(ids=None, format=None)
m.get.orifice.to_node(ids=None, format=None)
m.get.orifice.type(ids=None, format=None)
m.get.orifice.width(ids=None, format=None)

weir

Kind: Object collection

GetterSourceDeclared typeDeclared sizeOutput note
m.get.weir.count(ids=None, format=None)derivedintegersingleint scalar count
m.get.weir.crest_height(ids=None, format=None)userfloatseries by IDOne ID → scalar/structured value; many/all IDs → NumPy array or one-row DataFrame
m.get.weir.discharge_coefficient(ids=None, format=None)userfloatseries by IDOne ID → scalar/structured value; many/all IDs → NumPy array or one-row DataFrame
m.get.weir.end_coefficient(ids=None, format=None)userfloatseries by IDOne ID → scalar/structured value; many/all IDs → NumPy array or one-row DataFrame
m.get.weir.end_contractions(ids=None, format=None)userintegerseries by IDOne ID → scalar/structured value; many/all IDs → NumPy array or one-row DataFrame
m.get.weir.flap_gate(ids=None, format=None)userboolseries by IDOne ID → scalar/structured value; many/all IDs → NumPy array or one-row DataFrame
m.get.weir.flow(ids=None, format=None)resultfloattime series × weirTime series; NumPy by default, or timestamp-indexed DataFrame with format='df'
m.get.weir.from_node(ids=None, format=None)refstrseries by IDOne ID → scalar/structured value; many/all IDs → NumPy array or one-row DataFrame
m.get.weir.id(ids=None, format=None)userstrsingleOne ID → scalar/structured value; many/all IDs → NumPy array or one-row DataFrame
m.get.weir.length(ids=None, format=None)userfloatseries by IDOne ID → scalar/structured value; many/all IDs → NumPy array or one-row DataFrame
m.get.weir.road_surface(ids=None, format=None)userenum/strseries by IDOne ID → scalar/structured value; many/all IDs → NumPy array or one-row DataFrame
m.get.weir.road_width(ids=None, format=None)userfloatseries by IDOne ID → scalar/structured value; many/all IDs → NumPy array or one-row DataFrame
m.get.weir.setting(ids=None, format=None)resultfloattime series × weirTime series; NumPy by default, or timestamp-indexed DataFrame with format='df'
m.get.weir.side_slope(ids=None, format=None)userfloatseries by IDOne ID → scalar/structured value; many/all IDs → NumPy array or one-row DataFrame
m.get.weir.surcharge(ids=None, format=None)userbool/enumseries by IDOne ID → scalar/structured value; many/all IDs → NumPy array or one-row DataFrame
m.get.weir.to_node(ids=None, format=None)refstrseries by IDOne ID → scalar/structured value; many/all IDs → NumPy array or one-row DataFrame
m.get.weir.type(ids=None, format=None)userenumseries by IDOne ID → scalar/structured value; many/all IDs → NumPy array or one-row DataFrame

Copy-ready call list:

m.get.weir.count(ids=None, format=None)
m.get.weir.crest_height(ids=None, format=None)
m.get.weir.discharge_coefficient(ids=None, format=None)
m.get.weir.end_coefficient(ids=None, format=None)
m.get.weir.end_contractions(ids=None, format=None)
m.get.weir.flap_gate(ids=None, format=None)
m.get.weir.flow(ids=None, format=None)
m.get.weir.from_node(ids=None, format=None)
m.get.weir.id(ids=None, format=None)
m.get.weir.length(ids=None, format=None)
m.get.weir.road_surface(ids=None, format=None)
m.get.weir.road_width(ids=None, format=None)
m.get.weir.setting(ids=None, format=None)
m.get.weir.side_slope(ids=None, format=None)
m.get.weir.surcharge(ids=None, format=None)
m.get.weir.to_node(ids=None, format=None)
m.get.weir.type(ids=None, format=None)

outlet

Kind: Object collection

GetterSourceDeclared typeDeclared sizeOutput note
m.get.outlet.coefficient(ids=None, format=None)userfloatseries by IDOne ID → scalar/structured value; many/all IDs → NumPy array or one-row DataFrame
m.get.outlet.count(ids=None, format=None)derivedintegersingleint scalar count
m.get.outlet.curve(ids=None, format=None)refstrseries by IDOne ID → scalar/structured value; many/all IDs → NumPy array or one-row DataFrame
m.get.outlet.exponent(ids=None, format=None)userfloatseries by IDOne ID → scalar/structured value; many/all IDs → NumPy array or one-row DataFrame
m.get.outlet.flap_gate(ids=None, format=None)userboolseries by IDOne ID → scalar/structured value; many/all IDs → NumPy array or one-row DataFrame
m.get.outlet.flow(ids=None, format=None)resultfloattime series × outletTime series; NumPy by default, or timestamp-indexed DataFrame with format='df'
m.get.outlet.from_node(ids=None, format=None)refstrseries by IDOne ID → scalar/structured value; many/all IDs → NumPy array or one-row DataFrame
m.get.outlet.id(ids=None, format=None)userstrsingleOne ID → scalar/structured value; many/all IDs → NumPy array or one-row DataFrame
m.get.outlet.offset(ids=None, format=None)userfloatseries by IDOne ID → scalar/structured value; many/all IDs → NumPy array or one-row DataFrame
m.get.outlet.rating_type(ids=None, format=None)userenumseries by IDOne ID → scalar/structured value; many/all IDs → NumPy array or one-row DataFrame
m.get.outlet.setting(ids=None, format=None)resultfloattime series × outletTime series; NumPy by default, or timestamp-indexed DataFrame with format='df'
m.get.outlet.to_node(ids=None, format=None)refstrseries by IDOne ID → scalar/structured value; many/all IDs → NumPy array or one-row DataFrame

Copy-ready call list:

m.get.outlet.coefficient(ids=None, format=None)
m.get.outlet.count(ids=None, format=None)
m.get.outlet.curve(ids=None, format=None)
m.get.outlet.exponent(ids=None, format=None)
m.get.outlet.flap_gate(ids=None, format=None)
m.get.outlet.flow(ids=None, format=None)
m.get.outlet.from_node(ids=None, format=None)
m.get.outlet.id(ids=None, format=None)
m.get.outlet.offset(ids=None, format=None)
m.get.outlet.rating_type(ids=None, format=None)
m.get.outlet.setting(ids=None, format=None)
m.get.outlet.to_node(ids=None, format=None)