A9 — Object Property Index

What you'll do

Find which chapter documents a given object's properties, which adapter drives them, and which .inp sections they are written to.

This is a router, not a second copy of the property tables. Every property row SWMMVis shows is documented once, in the chapter that owns the object; duplicating those rows here would give you two descriptions to keep in step. What this page adds is the single place to start looking, plus the .inp mapping.

The completeness of the chapters it points at is enforced, not asserted: scripts/manual_docs_audit.py property-labels extracts every user-visible label from the property adapters and fails if one appears nowhere in the manual.

Where to find it

Properties appear in three places, and all three are views of the same adapter:

• the Properties panel, for the object selected on the map or in the Object Browser
• the Attribute Table, one row per object and one column per property
• the compound editors reached from a property row's … button

Because they share one adapter, an edit in any of them is the same edit — the other two update immediately, and one undo step reverses it. See 10 — Object Browser, Properties and Section View and 11 — Attribute Tables and the Attribute Calculator.

Step-by-step

Visual objects

Object	Adapter	Documented in	Writes
Rain Gage	SWMMRainGagePropertyAdapter	13 — Hydrology: Rain Gages, Subcatchments, LID, Snow, Groundwater and RDII → Rain gages	[RAINGAGES] [SYMBOLS]
Subcatchment	SWMMSubcatchPropertyAdapter	13 — Hydrology: Rain Gages, Subcatchments, LID, Snow, Groundwater and RDII → Subcatchment properties; Infiltration models	[SUBCATCHMENTS] [SUBAREAS] [INFILTRATION] [POLYGONS]
Junction	SWMMNodePropertyAdapter	14 — Hydraulics: Nodes, Links, Cross-Sections, Streets, Inlets and Controls → Node types and their properties	[JUNCTIONS] [COORDINATES]
Virtual Junction	SWMMNodePropertyAdapter	14 — Hydraulics: Nodes, Links, Cross-Sections, Streets, Inlets and Controls → Node types and their properties	[VIRTUAL_JUNCTIONS] [COORDINATES]
Inlet Junction	SWMMNodePropertyAdapter	14 — Hydraulics: Nodes, Links, Cross-Sections, Streets, Inlets and Controls → Node types and their properties	[INLET_JUNCTIONS] [COORDINATES]
Outfall	SWMMNodePropertyAdapter	14 — Hydraulics: Nodes, Links, Cross-Sections, Streets, Inlets and Controls → Node types and their properties	[OUTFALLS] [COORDINATES]
Flow Divider	SWMMNodePropertyAdapter	14 — Hydraulics: Nodes, Links, Cross-Sections, Streets, Inlets and Controls → Node types and their properties	[DIVIDERS] [COORDINATES]
Storage Unit	SWMMNodePropertyAdapter	14 — Hydraulics: Nodes, Links, Cross-Sections, Streets, Inlets and Controls → Node types and their properties	[STORAGE] [COORDINATES]
Conduit	SWMMLinkPropertyAdapter	14 — Hydraulics: Nodes, Links, Cross-Sections, Streets, Inlets and Controls → Link types and their properties	[CONDUITS] [XSECTIONS] [LOSSES] [VERTICES]
Pump	SWMMLinkPropertyAdapter	14 — Hydraulics: Nodes, Links, Cross-Sections, Streets, Inlets and Controls → Link types and their properties	[PUMPS] [VERTICES]
Orifice	SWMMLinkPropertyAdapter	14 — Hydraulics: Nodes, Links, Cross-Sections, Streets, Inlets and Controls → Link types and their properties	[ORIFICES] [XSECTIONS] [VERTICES]
Weir	SWMMLinkPropertyAdapter	14 — Hydraulics: Nodes, Links, Cross-Sections, Streets, Inlets and Controls → Link types and their properties	[WEIRS] [XSECTIONS] [VERTICES]
Outlet	SWMMLinkPropertyAdapter	14 — Hydraulics: Nodes, Links, Cross-Sections, Streets, Inlets and Controls → Link types and their properties	[OUTLETS] [VERTICES]
Map Label	retired	—	[LABELS] is parsed and discarded

Two entries from the legacy manual's catalogue no longer exist as objects:

• Map Label. SWMMVis reads [LABELS] and drops it (see A2 — File Formats). Text on the map is an annotation stored in the .oswp project, not a model object — see 12 — Editing the Network on the Map.
• Backdrop. A backdrop was an unreferenced bitmap stretched to fit. Its replacement is a georeferenced raster, WMS/WMTS or XYZ basemap layer, which is a layer rather than a property of the model — see 07 — Layers and Data Sources.

Node and link compound editors

Some properties are edited through a dialog rather than a single cell. They are still the same adapter and the same undo step.

Editor	Reached from	Documented in	Writes
Inflows — Direct; Dry Weather; RDII	a node's Inflows row	14 — Hydraulics: Nodes, Links, Cross-Sections, Streets, Inlets and Controls → Node compound editors	[INFLOWS] [DWF] [RDII]
Treatment	a node's Treatment row	14 — Hydraulics: Nodes, Links, Cross-Sections, Streets, Inlets and Controls → Node compound editors	[TREATMENT]
Cross-Section	a link's Cross-Section row	14 — Hydraulics: Nodes, Links, Cross-Sections, Streets, Inlets and Controls → Cross-section editor and the Section View	[XSECTIONS]
Inlet usage	a conduit's Inlet row	14 — Hydraulics: Nodes, Links, Cross-Sections, Streets, Inlets and Controls → Inlet usage on a conduit	[INLET_USAGE]
Infiltration	a subcatchment's Infiltration row	13 — Hydrology: Rain Gages, Subcatchments, LID, Snow, Groundwater and RDII → Infiltration models	[INFILTRATION]
Groundwater exchange	a subcatchment's Groundwater row	13 — Hydrology: Rain Gages, Subcatchments, LID, Snow, Groundwater and RDII → Groundwater Exchange editor	[GROUNDWATER] [GWF]
LID usage	a subcatchment's LID row	13 — Hydrology: Rain Gages, Subcatchments, LID, Snow, Groundwater and RDII → LID Control editor	[LID_USAGE]
Land use assignment	a subcatchment's Land Uses row	16 — Water Quality, Reaction Systems, Water Age and Heat	[COVERAGES] [LOADINGS]

Non-visual objects

These have no map geometry; they are edited from the Object Browser and the Attribute Table.

Object	Adapter	Documented in	Writes
Aquifer	SWMMAquiferPropertyAdapter	13 — Hydrology: Rain Gages, Subcatchments, LID, Snow, Groundwater and RDII → Aquifer editor	[AQUIFERS]
Snow Pack	SWMMSnowpackPropertyAdapter	13 — Hydrology: Rain Gages, Subcatchments, LID, Snow, Groundwater and RDII → Snow pack editor	[SNOWPACKS]
LID Control	SWMMLIDControlPropertyAdapter	13 — Hydrology: Rain Gages, Subcatchments, LID, Snow, Groundwater and RDII → LID Control editor	[LID_CONTROLS]
Unit Hydrograph	SWMMHydrographPropertyAdapter	13 — Hydrology: Rain Gages, Subcatchments, LID, Snow, Groundwater and RDII → Unit hydrographs and RDII	[HYDROGRAPHS]
Pollutant	SWMMPollutantPropertyAdapter	16 — Water Quality, Reaction Systems, Water Age and Heat	[POLLUTANTS]
Land Use	SWMMLandUsePropertyAdapter	16 — Water Quality, Reaction Systems, Water Age and Heat	[LANDUSES] [BUILDUP] [WASHOFF]
Transect	SWMMTransectPropertyAdapter	14 — Hydraulics: Nodes, Links, Cross-Sections, Streets, Inlets and Controls → Transect editor	[TRANSECTS]
Street	SWMMStreetPropertyAdapter	14 — Hydraulics: Nodes, Links, Cross-Sections, Streets, Inlets and Controls → Street editor	[STREETS]
Inlet	SWMMInletPropertyAdapter	14 — Hydraulics: Nodes, Links, Cross-Sections, Streets, Inlets and Controls → Inlet editor	[INLETS]
Control Rule	SWMMControlRulePropertyAdapter	14 — Hydraulics: Nodes, Links, Cross-Sections, Streets, Inlets and Controls → Control rules editor	[CONTROLS]
Time Series	SWMMTimeSeriesPropertyAdapter	17 — Time Series, Curves, Patterns and Calibration Data → The time series editor	[TIMESERIES]
Curve	SWMMCurvePropertyAdapter	17 — Time Series, Curves, Patterns and Calibration Data → The curve editor	[CURVES]
Time Pattern	SWMMPatternPropertyAdapter	17 — Time Series, Curves, Patterns and Calibration Data → The time pattern editor	[PATTERNS]

2D mesh objects

Object	Adapter	Documented in	Writes
Mesh triangle or quad	MeshTrianglePropertyAdapter	19 — 2D Overland Flow: Meshes, Cell Parameters, Boundary Conditions and 1D–2D Coupling → Cell parameters	inline 2D sections or .2dm
Mesh edge	MeshEdgePropertyAdapter	19 — 2D Overland Flow: Meshes, Cell Parameters, Boundary Conditions and 1D–2D Coupling → Boundary conditions	inline 2D sections or .2dm
Mesh vertex	MeshVertexPropertyAdapter	19 — 2D Overland Flow: Meshes, Cell Parameters, Boundary Conditions and 1D–2D Coupling → Preparing the terrain	inline 2D sections or .2dm

Tips and gotchas

• One adapter, three views. The Properties panel, the Attribute Table and the compound editors are views of the same model. An edit in any of them is the same edit and one undo reverses it — they never hold divergent values.
• Labels carry live unit suffixes. A row reads Invert Elev. (ft) or Invert Elev. (m) depending on [OPTIONS] FLOW_UNITS. Only the suffix changes; the property is the same. See A7 — Reference Tables.
• Read-only rows are of two kinds. Geometry derived from the map (a conduit's length when it follows its vertices) and post-run statistics (peak flow, total volume) are both shown greyed. The first becomes editable if you detach it from the geometry; the second never does.
• A node's type is a property, not a separate object. Converting a junction to a storage unit rewrites which .inp section it lands in. See 12 — Editing the Network on the Map.
• The .inp sections named here are where the property is written, not necessarily the only place it is read. The engine's own documentation describes each section's fields and their numerical meaning.

Related

• 10 — Object Browser, Properties and Section View — the Object Browser, Properties panel and Section View
• 11 — Attribute Tables and the Attribute Calculator — one row per object; bulk edits
• 14 — Hydraulics: Nodes, Links, Cross-Sections, Streets, Inlets and Controls — node and link properties in full
• 13 — Hydrology: Rain Gages, Subcatchments, LID, Snow, Groundwater and RDII — rain gage, subcatchment, LID, snow and groundwater properties
• 16 — Water Quality, Reaction Systems, Water Age and Heat — pollutants, land uses and treatment
• 17 — Time Series, Curves, Patterns and Calibration Data — time series, curves and patterns
• 19 — 2D Overland Flow: Meshes, Cell Parameters, Boundary Conditions and 1D–2D Coupling — mesh cell, edge and vertex parameters
• A7 — Reference Tables — starting values for the numbers these rows take
• A2 — File Formats — what each .inp section holds