Skip to content

Enumerations

Use these public string enums for lifecycle states, project units, object kinds, hydraulic states, and stable solver error categories. They give each choice a name you can look up and check.

Category Enums
Lifecycle and diagnostics SimulationState, SolverErrorCode
Units and project policy UnitSystem, FlowUnits, InfilKind, InertiaDamping, NormalFlowLimit, SurchargeMethod ,CustomEllipseModel
Object and result kinds NodeKind, LinkKind, FlowClass, OutKind
Typed link configuration OrificeKind, WeirKind, OutletHeadBasis, RoadSurface, StandardCrossSectionShape

Typed string enumerations used by the public SWMM Python API.

CLASS DESCRIPTION
CustomEllipseModel

Select hydraulics for custom-sized elliptical conduits.

FlowClass

Represent current hydraulic flow classifications.

FlowUnits

Represent supported project flow-unit codes.

InertiaDamping

Represent Dynamic Wave inertial damping methods.

InfilKind

Represent configured subcatchment infiltration models.

LinkKind

Represent configured link subtypes.

NodeKind

Represent configured node subtypes.

NormalFlowLimit

Represent normal-flow limiting modes.

OrificeKind

Represent side- and bottom-oriented orifice links.

OutKind

Represent configured subcatchment outlet relationship kinds.

OutletHeadBasis

Represent the independent head used by an outlet rating.

RoadSurface

Represent roadway-weir surface materials.

SimulationState

Represent the authoritative simulation lifecycle state.

SolverErrorCode

Represent stable native solver, project, and file failure categories.

StandardCrossSectionShape

Represent non-reference SWMM cross-section shapes.

SurchargeMethod

Represent Dynamic Wave surcharge treatment methods.

UnitSystem

Represent the project's US customary or SI unit system.

WeirKind

Represent supported weir geometry and flow families.

CustomEllipseModel

Select hydraulics for custom-sized elliptical conduits.

ATTRIBUTE DESCRIPTION
EPA_LEGACY

TRUE_ELLIPSE

EPA_LEGACY class-attribute instance-attribute

EPA_LEGACY = 'epa_legacy'

TRUE_ELLIPSE class-attribute instance-attribute

TRUE_ELLIPSE = 'true_ellipse'

FlowClass

Represent current hydraulic flow classifications.

ATTRIBUTE DESCRIPTION
DOWNSTREAM_CRITICAL

DOWNSTREAM_DRY

DRY

SUBCRITICAL

SUPERCRITICAL

UPSTREAM_CRITICAL

UPSTREAM_DRY

DOWNSTREAM_CRITICAL class-attribute instance-attribute

DOWNSTREAM_CRITICAL = 'downstream_critical'

DOWNSTREAM_DRY class-attribute instance-attribute

DOWNSTREAM_DRY = 'downstream_dry'

DRY class-attribute instance-attribute

DRY = 'dry'

SUBCRITICAL class-attribute instance-attribute

SUBCRITICAL = 'subcritical'

SUPERCRITICAL class-attribute instance-attribute

SUPERCRITICAL = 'supercritical'

UPSTREAM_CRITICAL class-attribute instance-attribute

UPSTREAM_CRITICAL = 'upstream_critical'

UPSTREAM_DRY class-attribute instance-attribute

UPSTREAM_DRY = 'upstream_dry'

FlowUnits

Represent supported project flow-unit codes.

ATTRIBUTE DESCRIPTION
CFS

CMS

GPM

LPS

MGD

MLD

CFS class-attribute instance-attribute

CFS = 'cfs'

CMS class-attribute instance-attribute

CMS = 'cms'

GPM class-attribute instance-attribute

GPM = 'gpm'

LPS class-attribute instance-attribute

LPS = 'lps'

MGD class-attribute instance-attribute

MGD = 'mgd'

MLD class-attribute instance-attribute

MLD = 'mld'

InertiaDamping

Represent Dynamic Wave inertial damping methods.

ATTRIBUTE DESCRIPTION
FULL

NONE

PARTIAL

FULL class-attribute instance-attribute

FULL = 'full'

NONE class-attribute instance-attribute

NONE = 'none'

PARTIAL class-attribute instance-attribute

PARTIAL = 'partial'

InfilKind

Represent configured subcatchment infiltration models.

ATTRIBUTE DESCRIPTION
CURVE_NUMBER

GREEN_AMPT

HORTON

MODIFIED_GREEN_AMPT

MODIFIED_HORTON

CURVE_NUMBER class-attribute instance-attribute

CURVE_NUMBER = 'curve_number'

GREEN_AMPT class-attribute instance-attribute

GREEN_AMPT = 'green_ampt'

HORTON class-attribute instance-attribute

HORTON = 'horton'

MODIFIED_GREEN_AMPT class-attribute instance-attribute

MODIFIED_GREEN_AMPT = 'modified_green_ampt'

MODIFIED_HORTON class-attribute instance-attribute

MODIFIED_HORTON = 'modified_horton'

LinkKind

Represent configured link subtypes.

ATTRIBUTE DESCRIPTION
CONDUIT

ORIFICE

OUTLET

PUMP

WEIR

CONDUIT class-attribute instance-attribute

CONDUIT = 'conduit'

ORIFICE class-attribute instance-attribute

ORIFICE = 'orifice'

OUTLET class-attribute instance-attribute

OUTLET = 'outlet'

PUMP class-attribute instance-attribute

PUMP = 'pump'

WEIR class-attribute instance-attribute

WEIR = 'weir'

NodeKind

Represent configured node subtypes.

ATTRIBUTE DESCRIPTION
DIVIDER

JUNCTION

OUTFALL

STORAGE

DIVIDER class-attribute instance-attribute

DIVIDER = 'divider'

JUNCTION class-attribute instance-attribute

JUNCTION = 'junction'

OUTFALL class-attribute instance-attribute

OUTFALL = 'outfall'

STORAGE class-attribute instance-attribute

STORAGE = 'storage'

NormalFlowLimit

Represent normal-flow limiting modes.

ATTRIBUTE DESCRIPTION
BOTH

FROUDE

NEITHER

SLOPE

BOTH class-attribute instance-attribute

BOTH = 'both'

FROUDE class-attribute instance-attribute

FROUDE = 'froude'

NEITHER class-attribute instance-attribute

NEITHER = 'neither'

SLOPE class-attribute instance-attribute

SLOPE = 'slope'

OrificeKind

Represent side- and bottom-oriented orifice links.

ATTRIBUTE DESCRIPTION
BOTTOM

SIDE

BOTTOM class-attribute instance-attribute

BOTTOM = 'bottom'

SIDE class-attribute instance-attribute

SIDE = 'side'

OutKind

Represent configured subcatchment outlet relationship kinds.

ATTRIBUTE DESCRIPTION
NODE

SUBCATCHMENT

NODE class-attribute instance-attribute

NODE = 'node'

SUBCATCHMENT class-attribute instance-attribute

SUBCATCHMENT = 'subcatchment'

OutletHeadBasis

Represent the independent head used by an outlet rating.

ATTRIBUTE DESCRIPTION
DEPTH

HEAD

DEPTH class-attribute instance-attribute

DEPTH = 'depth'

HEAD class-attribute instance-attribute

HEAD = 'head'

RoadSurface

Represent roadway-weir surface materials.

ATTRIBUTE DESCRIPTION
GRAVEL

PAVED

UNSPECIFIED

GRAVEL class-attribute instance-attribute

GRAVEL = 'gravel'

PAVED class-attribute instance-attribute

PAVED = 'paved'

UNSPECIFIED class-attribute instance-attribute

UNSPECIFIED = 'unspecified'

SimulationState

Represent the authoritative simulation lifecycle state.

Notes

Simulation.state returns this enum. API operations validate the current state before invoking the native solver.

ATTRIBUTE DESCRIPTION
CLOSED

COMPLETE

ENDED

FAILED

OPEN

RUNNING

CLOSED class-attribute instance-attribute

CLOSED = 'closed'

COMPLETE class-attribute instance-attribute

COMPLETE = 'complete'

ENDED class-attribute instance-attribute

ENDED = 'ended'

FAILED class-attribute instance-attribute

FAILED = 'failed'

OPEN class-attribute instance-attribute

OPEN = 'open'

RUNNING class-attribute instance-attribute

RUNNING = 'running'

SolverErrorCode

Represent stable native solver, project, and file failure categories.

Notes

SolverError.code uses this enum. message supplies a human-readable description suitable for diagnostics.

ATTRIBUTE DESCRIPTION
AQUIFER_PARAMS

BARRELS

CHECKPOINT_APPEND_ROLE

CHECKPOINT_COMPATIBILITY

CHECKPOINT_DECODE

CHECKPOINT_DESTINATION_OPEN

CHECKPOINT_DESTINATION_VALIDATION

CHECKPOINT_EXTERNAL_DEPENDENCY

CHECKPOINT_INTEGRITY

CHECKPOINT_INVALID

CHECKPOINT_RAIN_RESOURCE

CHECKPOINT_RDII_RESOURCE

CHECKPOINT_READ

CHECKPOINT_REBUILD

CHECKPOINT_ROUTING_INTERFACE

CHECKPOINT_RUNOFF_INTERFACE

CHECKPOINT_SIDECAR_ABSENT

CHECKPOINT_SIDECAR_COPY

CHECKPOINT_SIDECAR_VALIDATION

CHECKPOINT_SOURCE_FLUSH

CHECKPOINT_SOURCE_IDENTITY

CHECKPOINT_SOURCE_PREFLIGHT

CHECKPOINT_UNSUPPORTED_FEATURE

CLIMATE_END_OF_FILE

CLIMATE_FILE_OPEN

CLIMATE_FILE_READ

CURVE_SEQUENCE

CYCLIC_TREATMENT

DATETIME

DIVIDER

DIVIDER_LINK

DUMMY_LINK

DUP_NAME

ELEV_DROP

FILE_NAME

GROUND_ELEV

HOTSTART_FILE_FORMAT

HOTSTART_FILE_OPEN

HOTSTART_FILE_READ

INFIL_PARAMS

INPUT

INP_FILE

ITEMS

KEYWORD

KINWAVE

LENGTH

LID_AREAS

LID_CAPTURE_AREA

LID_LAYER

LID_PARAMS

LID_TYPE

LINE_LENGTH

LOOP

MATH_EXPR

MEMORY

MULTI_OUTLET

NAME

NODE_DEPTH

NO_CLIMATE_FILE

NO_CURVE

NO_OUTLETS

NO_XSECT

NUMBER

ODE_SOLVER

OUTFALL

OUT_FILE

OUT_READ

OUT_SIZE

OUT_WRITE

PUMP_LIMITS

RAIN_FILE_CONFLICT

RAIN_FILE_DATA

RAIN_FILE_FORMAT

RAIN_FILE_GAGE

RAIN_FILE_OPEN

RAIN_FILE_SCRATCH

RAIN_FILE_SEQUENCE

RAIN_GAGE_FORMAT

RAIN_GAGE_INTERVAL

RAIN_GAGE_TSERIES

RAIN_IFACE_FORMAT

RDII_AREA

RDII_FILE_FORMAT

RDII_FILE_OPEN

RDII_FILE_SCRATCH

REGULATOR

REGULATOR_SHAPE

REPORT_DATE

REPORT_STEP

ROUGHNESS

ROUTING_FILE_FORMAT

ROUTING_FILE_NAMES

ROUTING_FILE_NOMATCH

ROUTING_FILE_OPEN

RPT_FILE

RULE

RUNOFF_FILE_END

RUNOFF_FILE_FORMAT

RUNOFF_FILE_OPEN

RUNOFF_FILE_READ

SLOPE

SNOWMELT_PARAMS

SNOWPACK_PARAMS

START_DATE

STORAGE_VOLUME

SUBCATCH_OUTLET

SYSTEM

TABLE_FILE_OPEN

TABLE_FILE_READ

TIMESERIES_SEQUENCE

TIMESTEP

TRANSECT_MANNING

TRANSECT_NO_DEPTH

TRANSECT_OVERBANK

TRANSECT_SEQUENCE

TRANSECT_TOO_FEW

TRANSECT_TOO_MANY

TRANSECT_UNKNOWN

UNITHYD_RATIOS

UNITHYD_TIMES

WEIR_DIVIDER

XSECT

message

Return the stable human-readable semantic category.

TYPE: str

AQUIFER_PARAMS class-attribute instance-attribute

AQUIFER_PARAMS = 'aquifer_params'

BARRELS class-attribute instance-attribute

BARRELS = 'barrels'

CHECKPOINT_APPEND_ROLE class-attribute instance-attribute

CHECKPOINT_APPEND_ROLE = 'checkpoint_append_role'

CHECKPOINT_COMPATIBILITY class-attribute instance-attribute

CHECKPOINT_COMPATIBILITY = 'checkpoint_compatibility'

CHECKPOINT_DECODE class-attribute instance-attribute

CHECKPOINT_DECODE = 'checkpoint_decode'

CHECKPOINT_DESTINATION_OPEN class-attribute instance-attribute

CHECKPOINT_DESTINATION_OPEN = 'checkpoint_destination_open'

CHECKPOINT_DESTINATION_VALIDATION class-attribute instance-attribute

CHECKPOINT_DESTINATION_VALIDATION = 'checkpoint_destination_validation'

CHECKPOINT_EXTERNAL_DEPENDENCY class-attribute instance-attribute

CHECKPOINT_EXTERNAL_DEPENDENCY = 'checkpoint_external_dependency'

CHECKPOINT_INTEGRITY class-attribute instance-attribute

CHECKPOINT_INTEGRITY = 'checkpoint_integrity'

CHECKPOINT_INVALID class-attribute instance-attribute

CHECKPOINT_INVALID = 'checkpoint_invalid'

CHECKPOINT_RAIN_RESOURCE class-attribute instance-attribute

CHECKPOINT_RAIN_RESOURCE = 'checkpoint_rain_resource'

CHECKPOINT_RDII_RESOURCE class-attribute instance-attribute

CHECKPOINT_RDII_RESOURCE = 'checkpoint_rdii_resource'

CHECKPOINT_READ class-attribute instance-attribute

CHECKPOINT_READ = 'checkpoint_read'

CHECKPOINT_REBUILD class-attribute instance-attribute

CHECKPOINT_REBUILD = 'checkpoint_rebuild'

CHECKPOINT_ROUTING_INTERFACE class-attribute instance-attribute

CHECKPOINT_ROUTING_INTERFACE = 'checkpoint_routing_interface'

CHECKPOINT_RUNOFF_INTERFACE class-attribute instance-attribute

CHECKPOINT_RUNOFF_INTERFACE = 'checkpoint_runoff_interface'

CHECKPOINT_SIDECAR_ABSENT class-attribute instance-attribute

CHECKPOINT_SIDECAR_ABSENT = 'checkpoint_sidecar_absent'

CHECKPOINT_SIDECAR_COPY class-attribute instance-attribute

CHECKPOINT_SIDECAR_COPY = 'checkpoint_sidecar_copy'

CHECKPOINT_SIDECAR_VALIDATION class-attribute instance-attribute

CHECKPOINT_SIDECAR_VALIDATION = 'checkpoint_sidecar_validation'

CHECKPOINT_SOURCE_FLUSH class-attribute instance-attribute

CHECKPOINT_SOURCE_FLUSH = 'checkpoint_source_flush'

CHECKPOINT_SOURCE_IDENTITY class-attribute instance-attribute

CHECKPOINT_SOURCE_IDENTITY = 'checkpoint_source_identity'

CHECKPOINT_SOURCE_PREFLIGHT class-attribute instance-attribute

CHECKPOINT_SOURCE_PREFLIGHT = 'checkpoint_source_preflight'

CHECKPOINT_UNSUPPORTED_FEATURE class-attribute instance-attribute

CHECKPOINT_UNSUPPORTED_FEATURE = 'checkpoint_unsupported_feature'

CLIMATE_END_OF_FILE class-attribute instance-attribute

CLIMATE_END_OF_FILE = 'climate_end_of_file'

CLIMATE_FILE_OPEN class-attribute instance-attribute

CLIMATE_FILE_OPEN = 'climate_file_open'

CLIMATE_FILE_READ class-attribute instance-attribute

CLIMATE_FILE_READ = 'climate_file_read'

CURVE_SEQUENCE class-attribute instance-attribute

CURVE_SEQUENCE = 'curve_sequence'

CYCLIC_TREATMENT class-attribute instance-attribute

CYCLIC_TREATMENT = 'cyclic_treatment'

DATETIME class-attribute instance-attribute

DATETIME = 'datetime'

DIVIDER class-attribute instance-attribute

DIVIDER = 'divider'
DIVIDER_LINK = 'divider_link'
DUMMY_LINK = 'dummy_link'

DUP_NAME class-attribute instance-attribute

DUP_NAME = 'dup_name'

ELEV_DROP class-attribute instance-attribute

ELEV_DROP = 'elev_drop'

FILE_NAME class-attribute instance-attribute

FILE_NAME = 'file_name'

GROUND_ELEV class-attribute instance-attribute

GROUND_ELEV = 'ground_elev'

HOTSTART_FILE_FORMAT class-attribute instance-attribute

HOTSTART_FILE_FORMAT = 'hotstart_file_format'

HOTSTART_FILE_OPEN class-attribute instance-attribute

HOTSTART_FILE_OPEN = 'hotstart_file_open'

HOTSTART_FILE_READ class-attribute instance-attribute

HOTSTART_FILE_READ = 'hotstart_file_read'

INFIL_PARAMS class-attribute instance-attribute

INFIL_PARAMS = 'infil_params'

INPUT class-attribute instance-attribute

INPUT = 'input'

INP_FILE class-attribute instance-attribute

INP_FILE = 'inp_file'

ITEMS class-attribute instance-attribute

ITEMS = 'items'

KEYWORD class-attribute instance-attribute

KEYWORD = 'keyword'

KINWAVE class-attribute instance-attribute

KINWAVE = 'kinwave'

LENGTH class-attribute instance-attribute

LENGTH = 'length'

LID_AREAS class-attribute instance-attribute

LID_AREAS = 'lid_areas'

LID_CAPTURE_AREA class-attribute instance-attribute

LID_CAPTURE_AREA = 'lid_capture_area'

LID_LAYER class-attribute instance-attribute

LID_LAYER = 'lid_layer'

LID_PARAMS class-attribute instance-attribute

LID_PARAMS = 'lid_params'

LID_TYPE class-attribute instance-attribute

LID_TYPE = 'lid_type'

LINE_LENGTH class-attribute instance-attribute

LINE_LENGTH = 'line_length'

LOOP class-attribute instance-attribute

LOOP = 'loop'

MATH_EXPR class-attribute instance-attribute

MATH_EXPR = 'math_expr'

MEMORY class-attribute instance-attribute

MEMORY = 'memory'

MULTI_OUTLET class-attribute instance-attribute

MULTI_OUTLET = 'multi_outlet'

NAME class-attribute instance-attribute

NAME = 'name'

NODE_DEPTH class-attribute instance-attribute

NODE_DEPTH = 'node_depth'

NO_CLIMATE_FILE class-attribute instance-attribute

NO_CLIMATE_FILE = 'no_climate_file'

NO_CURVE class-attribute instance-attribute

NO_CURVE = 'no_curve'

NO_OUTLETS class-attribute instance-attribute

NO_OUTLETS = 'no_outlets'

NO_XSECT class-attribute instance-attribute

NO_XSECT = 'no_xsect'

NUMBER class-attribute instance-attribute

NUMBER = 'number'

ODE_SOLVER class-attribute instance-attribute

ODE_SOLVER = 'ode_solver'

OUTFALL class-attribute instance-attribute

OUTFALL = 'outfall'

OUT_FILE class-attribute instance-attribute

OUT_FILE = 'out_file'

OUT_READ class-attribute instance-attribute

OUT_READ = 'out_read'

OUT_SIZE class-attribute instance-attribute

OUT_SIZE = 'out_size'

OUT_WRITE class-attribute instance-attribute

OUT_WRITE = 'out_write'

PUMP_LIMITS class-attribute instance-attribute

PUMP_LIMITS = 'pump_limits'

RAIN_FILE_CONFLICT class-attribute instance-attribute

RAIN_FILE_CONFLICT = 'rain_file_conflict'

RAIN_FILE_DATA class-attribute instance-attribute

RAIN_FILE_DATA = 'rain_file_data'

RAIN_FILE_FORMAT class-attribute instance-attribute

RAIN_FILE_FORMAT = 'rain_file_format'

RAIN_FILE_GAGE class-attribute instance-attribute

RAIN_FILE_GAGE = 'rain_file_gage'

RAIN_FILE_OPEN class-attribute instance-attribute

RAIN_FILE_OPEN = 'rain_file_open'

RAIN_FILE_SCRATCH class-attribute instance-attribute

RAIN_FILE_SCRATCH = 'rain_file_scratch'

RAIN_FILE_SEQUENCE class-attribute instance-attribute

RAIN_FILE_SEQUENCE = 'rain_file_sequence'

RAIN_GAGE_FORMAT class-attribute instance-attribute

RAIN_GAGE_FORMAT = 'rain_gage_format'

RAIN_GAGE_INTERVAL class-attribute instance-attribute

RAIN_GAGE_INTERVAL = 'rain_gage_interval'

RAIN_GAGE_TSERIES class-attribute instance-attribute

RAIN_GAGE_TSERIES = 'rain_gage_tseries'

RAIN_IFACE_FORMAT class-attribute instance-attribute

RAIN_IFACE_FORMAT = 'rain_iface_format'

RDII_AREA class-attribute instance-attribute

RDII_AREA = 'rdii_area'

RDII_FILE_FORMAT class-attribute instance-attribute

RDII_FILE_FORMAT = 'rdii_file_format'

RDII_FILE_OPEN class-attribute instance-attribute

RDII_FILE_OPEN = 'rdii_file_open'

RDII_FILE_SCRATCH class-attribute instance-attribute

RDII_FILE_SCRATCH = 'rdii_file_scratch'

REGULATOR class-attribute instance-attribute

REGULATOR = 'regulator'

REGULATOR_SHAPE class-attribute instance-attribute

REGULATOR_SHAPE = 'regulator_shape'

REPORT_DATE class-attribute instance-attribute

REPORT_DATE = 'report_date'

REPORT_STEP class-attribute instance-attribute

REPORT_STEP = 'report_step'

ROUGHNESS class-attribute instance-attribute

ROUGHNESS = 'roughness'

ROUTING_FILE_FORMAT class-attribute instance-attribute

ROUTING_FILE_FORMAT = 'routing_file_format'

ROUTING_FILE_NAMES class-attribute instance-attribute

ROUTING_FILE_NAMES = 'routing_file_names'

ROUTING_FILE_NOMATCH class-attribute instance-attribute

ROUTING_FILE_NOMATCH = 'routing_file_nomatch'

ROUTING_FILE_OPEN class-attribute instance-attribute

ROUTING_FILE_OPEN = 'routing_file_open'

RPT_FILE class-attribute instance-attribute

RPT_FILE = 'rpt_file'

RULE class-attribute instance-attribute

RULE = 'rule'

RUNOFF_FILE_END class-attribute instance-attribute

RUNOFF_FILE_END = 'runoff_file_end'

RUNOFF_FILE_FORMAT class-attribute instance-attribute

RUNOFF_FILE_FORMAT = 'runoff_file_format'

RUNOFF_FILE_OPEN class-attribute instance-attribute

RUNOFF_FILE_OPEN = 'runoff_file_open'

RUNOFF_FILE_READ class-attribute instance-attribute

RUNOFF_FILE_READ = 'runoff_file_read'

SLOPE class-attribute instance-attribute

SLOPE = 'slope'

SNOWMELT_PARAMS class-attribute instance-attribute

SNOWMELT_PARAMS = 'snowmelt_params'

SNOWPACK_PARAMS class-attribute instance-attribute

SNOWPACK_PARAMS = 'snowpack_params'

START_DATE class-attribute instance-attribute

START_DATE = 'start_date'

STORAGE_VOLUME class-attribute instance-attribute

STORAGE_VOLUME = 'storage_volume'

SUBCATCH_OUTLET class-attribute instance-attribute

SUBCATCH_OUTLET = 'subcatch_outlet'

SYSTEM class-attribute instance-attribute

SYSTEM = 'system'

TABLE_FILE_OPEN class-attribute instance-attribute

TABLE_FILE_OPEN = 'table_file_open'

TABLE_FILE_READ class-attribute instance-attribute

TABLE_FILE_READ = 'table_file_read'

TIMESERIES_SEQUENCE class-attribute instance-attribute

TIMESERIES_SEQUENCE = 'timeseries_sequence'

TIMESTEP class-attribute instance-attribute

TIMESTEP = 'timestep'

TRANSECT_MANNING class-attribute instance-attribute

TRANSECT_MANNING = 'transect_manning'

TRANSECT_NO_DEPTH class-attribute instance-attribute

TRANSECT_NO_DEPTH = 'transect_no_depth'

TRANSECT_OVERBANK class-attribute instance-attribute

TRANSECT_OVERBANK = 'transect_overbank'

TRANSECT_SEQUENCE class-attribute instance-attribute

TRANSECT_SEQUENCE = 'transect_sequence'

TRANSECT_TOO_FEW class-attribute instance-attribute

TRANSECT_TOO_FEW = 'transect_too_few'

TRANSECT_TOO_MANY class-attribute instance-attribute

TRANSECT_TOO_MANY = 'transect_too_many'

TRANSECT_UNKNOWN class-attribute instance-attribute

TRANSECT_UNKNOWN = 'transect_unknown'

UNITHYD_RATIOS class-attribute instance-attribute

UNITHYD_RATIOS = 'unithyd_ratios'

UNITHYD_TIMES class-attribute instance-attribute

UNITHYD_TIMES = 'unithyd_times'

WEIR_DIVIDER class-attribute instance-attribute

WEIR_DIVIDER = 'weir_divider'

XSECT class-attribute instance-attribute

XSECT = 'xsect'

message property

message: str

Return the stable human-readable semantic category.

StandardCrossSectionShape

Represent non-reference SWMM cross-section shapes.

ATTRIBUTE DESCRIPTION
ARCH

BASKET_HANDLE

CATENARY

CIRCULAR

DUMMY

EGG_SHAPED

FILLED_CIRCULAR

FORCE_MAIN

GOTHIC

HORIZONTAL_ELLIPSE

HORSESHOE

MODIFIED_BASKET

PARABOLIC

POWER_FUNCTION

RECT_CLOSED

RECT_OPEN

RECT_ROUND

RECT_TRIANGULAR

SEMI_CIRCULAR

SEMI_ELLIPTICAL

TRAPEZOIDAL

TRIANGULAR

VERTICAL_ELLIPSE

ARCH class-attribute instance-attribute

ARCH = 'arch'

BASKET_HANDLE class-attribute instance-attribute

BASKET_HANDLE = 'basket_handle'

CATENARY class-attribute instance-attribute

CATENARY = 'catenary'

CIRCULAR class-attribute instance-attribute

CIRCULAR = 'circular'

DUMMY class-attribute instance-attribute

DUMMY = 'dummy'

EGG_SHAPED class-attribute instance-attribute

EGG_SHAPED = 'egg_shaped'

FILLED_CIRCULAR class-attribute instance-attribute

FILLED_CIRCULAR = 'filled_circular'

FORCE_MAIN class-attribute instance-attribute

FORCE_MAIN = 'force_main'

GOTHIC class-attribute instance-attribute

GOTHIC = 'gothic'

HORIZONTAL_ELLIPSE class-attribute instance-attribute

HORIZONTAL_ELLIPSE = 'horizontal_ellipse'

HORSESHOE class-attribute instance-attribute

HORSESHOE = 'horseshoe'

MODIFIED_BASKET class-attribute instance-attribute

MODIFIED_BASKET = 'modified_basket'

PARABOLIC class-attribute instance-attribute

PARABOLIC = 'parabolic'

POWER_FUNCTION class-attribute instance-attribute

POWER_FUNCTION = 'power_function'

RECT_CLOSED class-attribute instance-attribute

RECT_CLOSED = 'rect_closed'

RECT_OPEN class-attribute instance-attribute

RECT_OPEN = 'rect_open'

RECT_ROUND class-attribute instance-attribute

RECT_ROUND = 'rect_round'

RECT_TRIANGULAR class-attribute instance-attribute

RECT_TRIANGULAR = 'rect_triangular'

SEMI_CIRCULAR class-attribute instance-attribute

SEMI_CIRCULAR = 'semi_circular'

SEMI_ELLIPTICAL class-attribute instance-attribute

SEMI_ELLIPTICAL = 'semi_elliptical'

TRAPEZOIDAL class-attribute instance-attribute

TRAPEZOIDAL = 'trapezoidal'

TRIANGULAR class-attribute instance-attribute

TRIANGULAR = 'triangular'

VERTICAL_ELLIPSE class-attribute instance-attribute

VERTICAL_ELLIPSE = 'vertical_ellipse'

SurchargeMethod

Represent Dynamic Wave surcharge treatment methods.

ATTRIBUTE DESCRIPTION
EXTRAN

SLOT

EXTRAN class-attribute instance-attribute

EXTRAN = 'extran'

SLOT class-attribute instance-attribute

SLOT = 'slot'

UnitSystem

Represent the project's US customary or SI unit system.

ATTRIBUTE DESCRIPTION
SI

US

SI class-attribute instance-attribute

SI = 'si'

US class-attribute instance-attribute

US = 'us'

WeirKind

Represent supported weir geometry and flow families.

ATTRIBUTE DESCRIPTION
ROADWAY

SIDEFLOW

TRANSVERSE

TRAPEZOIDAL

V_NOTCH

ROADWAY class-attribute instance-attribute

ROADWAY = 'roadway'

SIDEFLOW class-attribute instance-attribute

SIDEFLOW = 'sideflow'

TRANSVERSE class-attribute instance-attribute

TRANSVERSE = 'transverse'

TRAPEZOIDAL class-attribute instance-attribute

TRAPEZOIDAL = 'trapezoidal'

V_NOTCH class-attribute instance-attribute

V_NOTCH = 'v_notch'