Set: Time & Map | swmmx Documentation

Setter Reference: Time, Map Data, Summaries, and Results

Rendered from 12_all_set_functions.ipynb.

Time, curves, controls, and inflows

`time_series`

Kind: Object collection

Setter	Source	Declared type	Value input	Behavior
`m.set.time_series.count(value, ids=None)`	derived	integer	Read-only; setter raises `ReadOnlyParameterError`	Read-only `derived` parameter
`m.set.time_series.datetime(value, ids=None)`	user	datetime	One structured `datetime` value per selected ID	Writable; scalar inputs broadcast across selected IDs
`m.set.time_series.description(value, ids=None)`	user	str	`str` scalar, or 1D vector/Series matching selected IDs	Writable; scalar inputs broadcast across selected IDs
`m.set.time_series.filename(value, ids=None)`	ref	path	`path` scalar, or 1D vector/Series matching selected IDs	Writable reference; target IDs are validated where possible
`m.set.time_series.id(value, ids=None)`	user	str	`str` scalar, or 1D vector/Series matching selected IDs	Writable; scalar inputs broadcast across selected IDs
`m.set.time_series.values(value, ids=None)`	user	float	One structured `float` value per selected ID	Writable; scalar inputs broadcast across selected IDs

Copy-ready call list:

m.set.time_series.count(value, ids=None)  # read-only: raises ReadOnlyParameterError
m.set.time_series.datetime(value, ids=None)
m.set.time_series.description(value, ids=None)
m.set.time_series.filename(value, ids=None)
m.set.time_series.id(value, ids=None)
m.set.time_series.values(value, ids=None)

`time_pattern`

Kind: Object collection

Setter	Source	Declared type	Value input	Behavior
`m.set.time_pattern.count(value, ids=None)`	derived	integer	Read-only; setter raises `ReadOnlyParameterError`	Read-only `derived` parameter
`m.set.time_pattern.id(value, ids=None)`	user	str	`str` scalar, or 1D vector/Series matching selected IDs	Writable; scalar inputs broadcast across selected IDs
`m.set.time_pattern.multipliers(value, ids=None)`	user	float	One structured `float` value per selected ID	Writable; scalar inputs broadcast across selected IDs
`m.set.time_pattern.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.time_pattern.count(value, ids=None)  # read-only: raises ReadOnlyParameterError
m.set.time_pattern.id(value, ids=None)
m.set.time_pattern.multipliers(value, ids=None)
m.set.time_pattern.type(value, ids=None)

`curve`

Kind: Object collection

Setter	Source	Declared type	Value input	Behavior
`m.set.curve.count(value, ids=None)`	derived	integer	Read-only; setter raises `ReadOnlyParameterError`	Read-only `derived` parameter
`m.set.curve.id(value, ids=None)`	user	str	`str` scalar, or 1D vector/Series matching selected IDs	Writable; scalar inputs broadcast across selected IDs
`m.set.curve.points(value, ids=None)`	user	tuple/list	One structured `tuple/list` value per selected ID	Writable; scalar inputs broadcast across selected IDs
`m.set.curve.type(value, ids=None)`	user	enum	`enum` scalar, or 1D vector/Series matching selected IDs	Writable; scalar inputs broadcast across selected IDs
`m.set.curve.x(value, ids=None)`	user	float	One structured `float` value per selected ID	Writable; scalar inputs broadcast across selected IDs
`m.set.curve.y(value, ids=None)`	user	float	One structured `float` value per selected ID	Writable; scalar inputs broadcast across selected IDs

Copy-ready call list:

m.set.curve.count(value, ids=None)  # read-only: raises ReadOnlyParameterError
m.set.curve.id(value, ids=None)
m.set.curve.points(value, ids=None)
m.set.curve.type(value, ids=None)
m.set.curve.x(value, ids=None)
m.set.curve.y(value, ids=None)

`control_rule`

Kind: Object collection

Setter	Source	Declared type	Value input	Behavior
`m.set.control_rule.action_log(value, ids=None)`	result	table	Read-only; setter raises `ReadOnlyParameterError`	Read-only `result` parameter
`m.set.control_rule.actions(value, ids=None)`	user/derived	expression/table	One structured `expression/table` value per selected ID	Writable; scalar inputs broadcast across selected IDs
`m.set.control_rule.conditions(value, ids=None)`	user/derived	expression/table	One structured `expression/table` value per selected ID	Writable; scalar inputs broadcast across selected IDs
`m.set.control_rule.count(value, ids=None)`	derived	integer	Read-only; setter raises `ReadOnlyParameterError`	Read-only `derived` parameter
`m.set.control_rule.enabled(value, ids=None)`	user	bool	`bool` scalar, or 1D vector/Series matching selected IDs	Writable; scalar inputs broadcast across selected IDs
`m.set.control_rule.id(value, ids=None)`	user	str	`str` scalar, or 1D vector/Series matching selected IDs	Writable; scalar inputs broadcast across selected IDs
`m.set.control_rule.priority(value, ids=None)`	user	integer/float	`integer/float` scalar, or 1D vector/Series matching selected IDs	Writable; scalar inputs broadcast across selected IDs
`m.set.control_rule.text(value, ids=None)`	user	str/list	One structured `str/list` value per selected ID	Writable; scalar inputs broadcast across selected IDs

Copy-ready call list:

m.set.control_rule.action_log(value, ids=None)  # read-only: raises ReadOnlyParameterError
m.set.control_rule.actions(value, ids=None)
m.set.control_rule.conditions(value, ids=None)
m.set.control_rule.count(value, ids=None)  # read-only: raises ReadOnlyParameterError
m.set.control_rule.enabled(value, ids=None)
m.set.control_rule.id(value, ids=None)
m.set.control_rule.priority(value, ids=None)
m.set.control_rule.text(value, ids=None)

`external_inflow`

Kind: Object collection

Setter	Source	Declared type	Value input	Behavior
`m.set.external_inflow.baseline(value, ids=None)`	user	float	One structured `float` value per selected ID	Writable; scalar inputs broadcast across selected IDs
`m.set.external_inflow.constituent(value, ids=None)`	ref/user	str/enum	One structured `str/enum` value per selected ID	Writable reference; target IDs are validated where possible
`m.set.external_inflow.node(value, ids=None)`	ref	str	One structured `str` value per selected ID	Writable reference; target IDs are validated where possible
`m.set.external_inflow.pattern(value, ids=None)`	ref	str	One structured `str` value per selected ID	Writable reference; target IDs are validated where possible
`m.set.external_inflow.scale_factor(value, ids=None)`	user	float	One structured `float` value per selected ID	Writable; scalar inputs broadcast across selected IDs
`m.set.external_inflow.time_series(value, ids=None)`	ref	str	One structured `str` value per selected ID	Writable reference; target IDs are validated where possible
`m.set.external_inflow.type(value, ids=None)`	user	enum	One structured `enum` value per selected ID	Writable; scalar inputs broadcast across selected IDs
`m.set.external_inflow.units_factor(value, ids=None)`	user	float	One structured `float` value per selected ID	Writable; scalar inputs broadcast across selected IDs

Copy-ready call list:

m.set.external_inflow.baseline(value, ids=None)
m.set.external_inflow.constituent(value, ids=None)
m.set.external_inflow.node(value, ids=None)
m.set.external_inflow.pattern(value, ids=None)
m.set.external_inflow.scale_factor(value, ids=None)
m.set.external_inflow.time_series(value, ids=None)
m.set.external_inflow.type(value, ids=None)
m.set.external_inflow.units_factor(value, ids=None)

`dry_weather_flow`

Kind: Object collection

Setter	Source	Declared type	Value input	Behavior
`m.set.dry_weather_flow.average_value(value, ids=None)`	user	float	One structured `float` value per selected ID	Writable; scalar inputs broadcast across selected IDs
`m.set.dry_weather_flow.constituent(value, ids=None)`	ref/user	str/enum	One structured `str/enum` value per selected ID	Writable reference; target IDs are validated where possible
`m.set.dry_weather_flow.daily_pattern(value, ids=None)`	ref	str	One structured `str` value per selected ID	Writable reference; target IDs are validated where possible
`m.set.dry_weather_flow.hourly_pattern(value, ids=None)`	ref	str	One structured `str` value per selected ID	Writable reference; target IDs are validated where possible
`m.set.dry_weather_flow.monthly_pattern(value, ids=None)`	ref	str	One structured `str` value per selected ID	Writable reference; target IDs are validated where possible
`m.set.dry_weather_flow.node(value, ids=None)`	ref	str	One structured `str` value per selected ID	Writable reference; target IDs are validated where possible
`m.set.dry_weather_flow.weekend_pattern(value, ids=None)`	ref	str	One structured `str` value per selected ID	Writable reference; target IDs are validated where possible

Copy-ready call list:

m.set.dry_weather_flow.average_value(value, ids=None)
m.set.dry_weather_flow.constituent(value, ids=None)
m.set.dry_weather_flow.daily_pattern(value, ids=None)
m.set.dry_weather_flow.hourly_pattern(value, ids=None)
m.set.dry_weather_flow.monthly_pattern(value, ids=None)
m.set.dry_weather_flow.node(value, ids=None)
m.set.dry_weather_flow.weekend_pattern(value, ids=None)

`rdii`

Kind: Object collection

Setter	Source	Declared type	Value input	Behavior
`m.set.rdii.node(value, ids=None)`	ref	str	One structured `str` value per selected ID	Writable reference; target IDs are validated where possible
`m.set.rdii.sewer_area(value, ids=None)`	user	float	One structured `float` value per selected ID	Writable; scalar inputs broadcast across selected IDs
`m.set.rdii.unit_hydrograph(value, ids=None)`	ref	str	One structured `str` value per selected ID	Writable reference; target IDs are validated where possible

Copy-ready call list:

m.set.rdii.node(value, ids=None)
m.set.rdii.sewer_area(value, ids=None)
m.set.rdii.unit_hydrograph(value, ids=None)

`interface_file`

Kind: Model-level category

Setter	Source	Declared type	Value input	Behavior
`m.set.interface_file.hotstart(value)`	ref	path	One model-level `path` value	Writable reference; target IDs are validated where possible
`m.set.interface_file.inflow(value)`	ref	path	One model-level `path` value	Writable reference; target IDs are validated where possible
`m.set.interface_file.outflow(value)`	ref	path	One model-level `path` value	Writable reference; target IDs are validated where possible
`m.set.interface_file.rainfall(value)`	ref	path	One model-level `path` value	Writable reference; target IDs are validated where possible
`m.set.interface_file.rdii(value)`	ref	path	One model-level `path` value	Writable reference; target IDs are validated where possible
`m.set.interface_file.runoff(value)`	ref	path	One model-level `path` value	Writable reference; target IDs are validated where possible
`m.set.interface_file.save_file(value)`	user	bool	One model-level `bool` value	Writable model-level value
`m.set.interface_file.use_file(value)`	user	bool	One model-level `bool` value	Writable model-level value

Copy-ready call list:

m.set.interface_file.hotstart(value)
m.set.interface_file.inflow(value)
m.set.interface_file.outflow(value)
m.set.interface_file.rainfall(value)
m.set.interface_file.rdii(value)
m.set.interface_file.runoff(value)
m.set.interface_file.save_file(value)
m.set.interface_file.use_file(value)

Map data, summaries, and system results

`coordinate`

Kind: Model-level category

Setter	Source	Declared type	Value input	Behavior
`m.set.coordinate.labels(value)`	user	coordinates	One model-level `coordinates` value	Writable model-level value
`m.set.coordinate.link_vertices(value)`	user	coordinates	One model-level `coordinates` value	Writable model-level value
`m.set.coordinate.map_dimensions(value)`	user/derived	coordinates	One model-level `coordinates` value	Writable model-level value
`m.set.coordinate.map_units(value)`	user	enum/str	One model-level `enum/str` value	Writable model-level value
`m.set.coordinate.node_coordinates(value)`	user	coordinates	One model-level `coordinates` value	Writable model-level value
`m.set.coordinate.polygons(value)`	user	coordinates	One model-level `coordinates` value	Writable model-level value
`m.set.coordinate.subcatchment_coordinates(value)`	user	coordinates	One model-level `coordinates` value	Writable model-level value

Copy-ready call list:

m.set.coordinate.labels(value)
m.set.coordinate.link_vertices(value)
m.set.coordinate.map_dimensions(value)
m.set.coordinate.map_units(value)
m.set.coordinate.node_coordinates(value)
m.set.coordinate.polygons(value)
m.set.coordinate.subcatchment_coordinates(value)

`summary`

Kind: Model-level category

Setter	Source	Declared type	Value input	Behavior
`m.set.summary.conduit_surcharge(value)`	result	table	Read-only; setter raises `ReadOnlyParameterError`	Read-only `result` parameter
`m.set.summary.counts(value)`	derived	table/dict	Read-only; setter raises `ReadOnlyParameterError`	Read-only `derived` parameter
`m.set.summary.flow_routing_continuity(value)`	result	table/dict	Read-only; setter raises `ReadOnlyParameterError`	Read-only `result` parameter
`m.set.summary.lid_performance(value)`	result	table	Read-only; setter raises `ReadOnlyParameterError`	Read-only `result` parameter
`m.set.summary.link_flow(value)`	result	table	Read-only; setter raises `ReadOnlyParameterError`	Read-only `result` parameter
`m.set.summary.link_velocity(value)`	result	table	Read-only; setter raises `ReadOnlyParameterError`	Read-only `result` parameter
`m.set.summary.model(value)`	derived/result	table/dict	Read-only; setter raises `ReadOnlyParameterError`	Read-only `mixed` parameter
`m.set.summary.node_depth(value)`	result	table	Read-only; setter raises `ReadOnlyParameterError`	Read-only `result` parameter
`m.set.summary.node_flooding(value)`	result	table	Read-only; setter raises `ReadOnlyParameterError`	Read-only `result` parameter
`m.set.summary.node_inflow(value)`	result	table	Read-only; setter raises `ReadOnlyParameterError`	Read-only `result` parameter
`m.set.summary.node_surcharge(value)`	result	table	Read-only; setter raises `ReadOnlyParameterError`	Read-only `result` parameter
`m.set.summary.options(value)`	derived/user	table/dict	One model-level `table/dict` value	Writable model-level value
`m.set.summary.outfall_loading(value)`	result	table	Read-only; setter raises `ReadOnlyParameterError`	Read-only `result` parameter
`m.set.summary.pump_operation(value)`	result	table	Read-only; setter raises `ReadOnlyParameterError`	Read-only `result` parameter
`m.set.summary.quality_routing_continuity(value)`	result	table/dict	Read-only; setter raises `ReadOnlyParameterError`	Read-only `result` parameter
`m.set.summary.runoff_continuity(value)`	result	table/dict	Read-only; setter raises `ReadOnlyParameterError`	Read-only `result` parameter
`m.set.summary.storage_volume(value)`	result	table	Read-only; setter raises `ReadOnlyParameterError`	Read-only `result` parameter
`m.set.summary.subcatchment_runoff(value)`	result	table	Read-only; setter raises `ReadOnlyParameterError`	Read-only `result` parameter
`m.set.summary.subcatchment_washoff(value)`	result	table	Read-only; setter raises `ReadOnlyParameterError`	Read-only `result` parameter
`m.set.summary.validation_issues(value)`	derived	table	Read-only; setter raises `ReadOnlyParameterError`	Read-only `derived` parameter

Copy-ready call list:

m.set.summary.conduit_surcharge(value)  # read-only: raises ReadOnlyParameterError
m.set.summary.counts(value)  # read-only: raises ReadOnlyParameterError
m.set.summary.flow_routing_continuity(value)  # read-only: raises ReadOnlyParameterError
m.set.summary.lid_performance(value)  # read-only: raises ReadOnlyParameterError
m.set.summary.link_flow(value)  # read-only: raises ReadOnlyParameterError
m.set.summary.link_velocity(value)  # read-only: raises ReadOnlyParameterError
m.set.summary.model(value)  # read-only: raises ReadOnlyParameterError
m.set.summary.node_depth(value)  # read-only: raises ReadOnlyParameterError
m.set.summary.node_flooding(value)  # read-only: raises ReadOnlyParameterError
m.set.summary.node_inflow(value)  # read-only: raises ReadOnlyParameterError
m.set.summary.node_surcharge(value)  # read-only: raises ReadOnlyParameterError
m.set.summary.options(value)
m.set.summary.outfall_loading(value)  # read-only: raises ReadOnlyParameterError
m.set.summary.pump_operation(value)  # read-only: raises ReadOnlyParameterError
m.set.summary.quality_routing_continuity(value)  # read-only: raises ReadOnlyParameterError
m.set.summary.runoff_continuity(value)  # read-only: raises ReadOnlyParameterError
m.set.summary.storage_volume(value)  # read-only: raises ReadOnlyParameterError
m.set.summary.subcatchment_runoff(value)  # read-only: raises ReadOnlyParameterError
m.set.summary.subcatchment_washoff(value)  # read-only: raises ReadOnlyParameterError
m.set.summary.validation_issues(value)  # read-only: raises ReadOnlyParameterError

`system_result`

Kind: Model-level category

Setter	Source	Declared type	Value input	Behavior
`m.set.system_result.air_temperature(value)`	result	float	Read-only; setter raises `ReadOnlyParameterError`	Read-only `result` parameter
`m.set.system_result.direct_inflow(value)`	result	float	Read-only; setter raises `ReadOnlyParameterError`	Read-only `result` parameter
`m.set.system_result.dry_weather_inflow(value)`	result	float	Read-only; setter raises `ReadOnlyParameterError`	Read-only `result` parameter
`m.set.system_result.evaporation(value)`	result	float	Read-only; setter raises `ReadOnlyParameterError`	Read-only `result` parameter
`m.set.system_result.flooding(value)`	result	float	Read-only; setter raises `ReadOnlyParameterError`	Read-only `result` parameter
`m.set.system_result.groundwater_inflow(value)`	result	float	Read-only; setter raises `ReadOnlyParameterError`	Read-only `result` parameter
`m.set.system_result.infiltration(value)`	result	float	Read-only; setter raises `ReadOnlyParameterError`	Read-only `result` parameter
`m.set.system_result.outfall_flow(value)`	result	float	Read-only; setter raises `ReadOnlyParameterError`	Read-only `result` parameter
`m.set.system_result.pollutant_loading(value)`	result	float	Read-only; setter raises `ReadOnlyParameterError`	Read-only `result` parameter
`m.set.system_result.rainfall(value)`	result	float	Read-only; setter raises `ReadOnlyParameterError`	Read-only `result` parameter
`m.set.system_result.rdii_inflow(value)`	result	float	Read-only; setter raises `ReadOnlyParameterError`	Read-only `result` parameter
`m.set.system_result.runoff(value)`	result	float	Read-only; setter raises `ReadOnlyParameterError`	Read-only `result` parameter
`m.set.system_result.snow_depth(value)`	result	float	Read-only; setter raises `ReadOnlyParameterError`	Read-only `result` parameter
`m.set.system_result.storage_volume(value)`	result	float	Read-only; setter raises `ReadOnlyParameterError`	Read-only `result` parameter
`m.set.system_result.total_lateral_inflow(value)`	result	float	Read-only; setter raises `ReadOnlyParameterError`	Read-only `result` parameter

Copy-ready call list:

m.set.system_result.air_temperature(value)  # read-only: raises ReadOnlyParameterError
m.set.system_result.direct_inflow(value)  # read-only: raises ReadOnlyParameterError
m.set.system_result.dry_weather_inflow(value)  # read-only: raises ReadOnlyParameterError
m.set.system_result.evaporation(value)  # read-only: raises ReadOnlyParameterError
m.set.system_result.flooding(value)  # read-only: raises ReadOnlyParameterError
m.set.system_result.groundwater_inflow(value)  # read-only: raises ReadOnlyParameterError
m.set.system_result.infiltration(value)  # read-only: raises ReadOnlyParameterError
m.set.system_result.outfall_flow(value)  # read-only: raises ReadOnlyParameterError
m.set.system_result.pollutant_loading(value)  # read-only: raises ReadOnlyParameterError
m.set.system_result.rainfall(value)  # read-only: raises ReadOnlyParameterError
m.set.system_result.rdii_inflow(value)  # read-only: raises ReadOnlyParameterError
m.set.system_result.runoff(value)  # read-only: raises ReadOnlyParameterError
m.set.system_result.snow_depth(value)  # read-only: raises ReadOnlyParameterError
m.set.system_result.storage_volume(value)  # read-only: raises ReadOnlyParameterError
m.set.system_result.total_lateral_inflow(value)  # read-only: raises ReadOnlyParameterError