toolkitapi module

SWMM Object Enum.

class SimulationTime(value, names=<not given>, *values, module=None, qualname=None, type=None, start=1, boundary=None)

Bases: Enum

StartDateTime = 0

EndDateTime = 1

ReportStart = 2

class SimulationUnits(value, names=<not given>, *values, module=None, qualname=None, type=None, start=1, boundary=None)

Bases: Enum

UnitSystem = 0

FlowUnits = 1

class SimAnalysisSettings(value, names=<not given>, *values, module=None, qualname=None, type=None, start=1, boundary=None)

Bases: Enum

AllowPonding = 0

SkipSteadyState = 1

IgnoreRainfall = 2

IgnoreRDII = 3

IgnoreSnowmelt = 4

IgnoreGwater = 5

IgnoreRouting = 6

IgnoreQuality = 7

class SimulationParameters(value, names=<not given>, *values, module=None, qualname=None, type=None, start=1, boundary=None)

Bases: Enum

RouteStep = 0

MinRouteStep = 1

LengtheningStep = 2

StartDryDays = 3

CourantFactor = 4

MinSurfArea = 5

MinSlope = 6

RunoffError = 7

GwaterError = 8

FlowError = 9

QualError = 10

HeadTol = 11

SysFlowTol = 12

LatFlowTol = 13

class ObjectType(value, names=<not given>, *values, module=None, qualname=None, type=None, start=1, boundary=None)

Bases: Enum

GAGE = 0

SUBCATCH = 1

NODE = 2

LINK = 3

POLLUT = 4

LANDUSE = 5

TIMEPATTERN = 6

CURVE = 7

TSERIES = 8

CONTROL = 9

TRANSECT = 10

AQUIFER = 11

UNITHYD = 12

SNOWMELT = 13

SHAPE = 14

LID = 15

MAX_OBJ_TYPES = 16

class NodeParams(value, names=<not given>, *values, module=None, qualname=None, type=None, start=1, boundary=None)

Bases: Enum

invertElev = 0

fullDepth = 1

surDepth = 2

pondedArea = 3

initDepth = 4

class NodeResults(value, names=<not given>, *values, module=None, qualname=None, type=None, start=1, boundary=None)

Bases: Enum

totalinflow = 0

outflow = 1

losses = 2

newVolume = 3

overflow = 4

newDepth = 5

newHead = 6

newLatFlow = 7

hyd_res_time = 8

class NodePollut(value, names=<not given>, *values, module=None, qualname=None, type=None, start=1, boundary=None)

Bases: Enum

nodeQual = 0

inflowQual = 1

reactorQual = 2

class NodeType(value, names=<not given>, *values, module=None, qualname=None, type=None, start=1, boundary=None)

Bases: Enum

junction = 0

outfall = 1

storage = 2

divider = 3

class LinkParams(value, names=<not given>, *values, module=None, qualname=None, type=None, start=1, boundary=None)

Bases: Enum

offset1 = 0

offset2 = 1

q0 = 2

qLimit = 3

cLossInlet = 4

cLossOutlet = 5

cLossAvg = 6

seepRate = 7

class LinkResults(value, names=<not given>, *values, module=None, qualname=None, type=None, start=1, boundary=None)

Bases: Enum

newFlow = 0

newDepth = 1

newVolume = 2

surfArea1 = 3

surfArea2 = 4

setting = 5

targetSetting = 6

froude = 7

class LinkPollut(value, names=<not given>, *values, module=None, qualname=None, type=None, start=1, boundary=None)

Bases: Enum

linkQual = 0

totalLoad = 1

reactorQual = 2

class LinkType(value, names=<not given>, *values, module=None, qualname=None, type=None, start=1, boundary=None)

Bases: Enum

conduit = 0

pump = 1

orifice = 2

weir = 3

outlet = 4

class SubcParams(value, names=<not given>, *values, module=None, qualname=None, type=None, start=1, boundary=None)

Bases: Enum

width = 0

area = 1

fracImperv = 2

slope = 3

curbLength = 4

class SubcResults(value, names=<not given>, *values, module=None, qualname=None, type=None, start=1, boundary=None)

Bases: Enum

rainfall = 0

evapLoss = 1

infilLoss = 2

runon = 3

newRunoff = 4

newSnowDepth = 5

class SubcPollut(value, names=<not given>, *values, module=None, qualname=None, type=None, start=1, boundary=None)

Bases: Enum

buildup = 0

concPonded = 1

subcQual = 2

subcTotalLoad = 3

class LidUParams(value, names=<not given>, *values, module=None, qualname=None, type=None, start=1, boundary=None)

Bases: Enum

unitArea = 0

fullWidth = 1

botWidth = 2

initSat = 3

fromImperv = 4

fromPerv = 5

class LidResults(value, names=<not given>, *values, module=None, qualname=None, type=None, start=1, boundary=None)

Bases: Enum

inflow = 0

evap = 1

infil = 2

surfFlow = 3

drainFlow = 4

initVol = 5

finalVol = 6

surfDepth = 7

paveDepth = 8

soilMoist = 9

storDepth = 10

dryTime = 11

oldDrainFlow = 12

newDrainFlow = 13

pervArea = 14

flowToPerv = 15

evapRate = 16

nativeInfil = 17

surfInflow = 18

surfInfil = 19

surfEvap = 20

surfOutflow = 21

paveEvap = 22

pavePerc = 23

soilEvap = 24

soilPerc = 25

storInflow = 26

storExfil = 27

storEvap = 28

storDrain = 29

class LidUOptions(value, names=<not given>, *values, module=None, qualname=None, type=None, start=1, boundary=None)

Bases: Enum

index = 0

number = 1

toPerv = 2

drainSub = 3

drainNode = 4

class LidLayers(value, names=<not given>, *values, module=None, qualname=None, type=None, start=1, boundary=None)

Bases: Enum

surface = 0

soil = 1

storage = 2

pavement = 3

drain = 4

drainMat = 5

class LidLayersProperty(value, names=<not given>, *values, module=None, qualname=None, type=None, start=1, boundary=None)

Bases: Enum

thickness = 0

voidFrac = 1

roughness = 2

surfSlope = 3

sideSlope = 4

alpha = 5

porosity = 6

fieldCap = 7

wiltPoint = 8

suction = 9

kSat = 10

kSlope = 11

clogFactor = 12

impervFrac = 13

coeff = 14

expon = 15

offset = 16

delay = 17

hOpen = 18

hClose = 19

qCurve = 20

regenDays = 21

regenDegree = 22

class RainGageResults(value, names=<not given>, *values, module=None, qualname=None, type=None, start=1, boundary=None)

Bases: Enum

total_precip = 0

rainfall = 1

snowfall = 2

class HotstartFile(value, names=<not given>, *values, module=None, qualname=None, type=None, start=1, boundary=None)

Bases: Enum

use = 0

save = 1

class NodeStats

Bases: Structure

avgDepth

Structure/Union member

maxDepth

Structure/Union member

maxDepthDate

Structure/Union member

maxInflow

Structure/Union member

maxInflowDate

Structure/Union member

maxLatFlow

Structure/Union member

maxOverflow

Structure/Union member

maxOverflowDate

Structure/Union member

maxPondedVol

Structure/Union member

maxRptDepth

Structure/Union member

timeCourantCritical

Structure/Union member

timeFlooded

Structure/Union member

timeSurcharged

Structure/Union member

totLatFlow

Structure/Union member

volFlooded

Structure/Union member

class StorageStats

Bases: Structure

avgVol

Structure/Union member

evapLosses

Structure/Union member

exfilLosses

Structure/Union member

initVol

Structure/Union member

maxFlow

Structure/Union member

maxVol

Structure/Union member

maxVolDate

Structure/Union member

class OutfallStats

Bases: Structure

avgFlow

Structure/Union member

maxFlow

Structure/Union member

totalLoad

Structure/Union member

totalPeriods

Structure/Union member

class LinkStats

Bases: Structure

flowTurnSign

Structure/Union member

flowTurns

Structure/Union member

maxDepth

Structure/Union member

maxFlow

Structure/Union member

maxFlowDate

Structure/Union member

maxVeloc

Structure/Union member

timeCapacityLimited

Structure/Union member

timeCourantCritical

Structure/Union member

timeFullDnstream

Structure/Union member

timeFullFlow

Structure/Union member

timeFullUpstream

Structure/Union member

timeInFlowClass

Structure/Union member

timeInletControl

Structure/Union member

timeNormalFlow

Structure/Union member

timeSurcharged

Structure/Union member

class PumpStats

Bases: Structure

avgFlow

Structure/Union member

energy

Structure/Union member

maxFlow

Structure/Union member

minFlow

Structure/Union member

offCurveHigh

Structure/Union member

offCurveLow

Structure/Union member

startUps

Structure/Union member

totalPeriods

Structure/Union member

utilized

Structure/Union member

volume

Structure/Union member

class SubcStats

Bases: Structure

evap

Structure/Union member

infil

Structure/Union member

maxFlow

Structure/Union member

precip

Structure/Union member

runoff

Structure/Union member

runon

Structure/Union member

class RoutingTotals

Bases: Structure

dwInflow

Structure/Union member

evapLoss

Structure/Union member

exInflow

Structure/Union member

finalStorage

Structure/Union member

flooding

Structure/Union member

gwInflow

Structure/Union member

iiInflow

Structure/Union member

initStorage

Structure/Union member

outflow

Structure/Union member

pctError

Structure/Union member

reacted

Structure/Union member

seepLoss

Structure/Union member

wwInflow

Structure/Union member

class RunoffTotals

Bases: Structure

drains

Structure/Union member

evap

Structure/Union member

finalSnowCover

Structure/Union member

finalStorage

Structure/Union member

infil

Structure/Union member

initSnowCover

Structure/Union member

initStorage

Structure/Union member

pctError

Structure/Union member

rainfall

Structure/Union member

runoff

Structure/Union member

runon

Structure/Union member

snowRemoved

Structure/Union member

class SMO_elementCount(value, names=<not given>, *values, module=None, qualname=None, type=None, start=1, boundary=None)

Bases: Enum

subcatchCount = 0

nodeCount = 1

linkCount = 2

pollutantCount = 3

class SMO_unit(value, names=<not given>, *values, module=None, qualname=None, type=None, start=1, boundary=None)

Bases: Enum

flow_rate = 0

concentration = 1

class SMO_apiFunction(value, names=<not given>, *values, module=None, qualname=None, type=None, start=1, boundary=None)

Bases: Enum

getAttribute = 0

getResult = 1

class SMO_elementType(value, names=<not given>, *values, module=None, qualname=None, type=None, start=1, boundary=None)

Bases: Enum

SM_subcatch = 0

SM_node = 1

SM_link = 2

SM_sys = 3

class SMO_time(value, names=<not given>, *values, module=None, qualname=None, type=None, start=1, boundary=None)

Bases: Enum

reportStep = 0

numPeriods = 1

class SMO_subcatchAttribute(value, names=<not given>, *values, module=None, qualname=None, type=None, start=1, boundary=None)

Bases: Enum

rainfall_subcatch = 0

snow_depth_subcatch = 1

evap_loss = 2

infil_loss = 3

runoff_rate = 4

gwoutflow_rate = 5

gwtable_elev = 6

soil_moisture = 7

pollutant_conc_subcatch = 8

class SMO_nodeAttribute(value, names=<not given>, *values, module=None, qualname=None, type=None, start=1, boundary=None)

Bases: Enum

invert_depth = 0

hydraulic_head = 1

stored_ponded_volume = 2

lateral_inflow = 3

total_inflow = 4

flooding_losses = 5

pollutant_conc_node = 6

class SMO_linkAttribute(value, names=<not given>, *values, module=None, qualname=None, type=None, start=1, boundary=None)

Bases: Enum

flow_rate_link = 0

flow_depth = 1

flow_velocity = 2

flow_volume = 3

capacity = 4

pollutant_conc_link = 5

class SMO_systemAttribute(value, names=<not given>, *values, module=None, qualname=None, type=None, start=1, boundary=None)

Bases: Enum

air_temp = 0

rainfall_system = 1

snow_depth_system = 2

evap_infil_loss = 3

runoff_flow = 4

dry_weather_inflow = 5

groundwater_inflow = 6

RDII_inflow = 7

direct_inflow = 8

total_lateral_inflow = 9

flood_losses = 10

outfall_flows = 11

volume_stored = 12

evap_rate = 13