-- Hoogle documentation, generated by Haddock
-- See Hoogle, http://www.haskell.org/hoogle/


-- | A parser for SWMM 5 binary .OUT files
--   
--   The United States Environmental Protection Agency (EPA) Storm Water
--   Management Model (SWMM) is a dynamic hydrology-hydraulic water quality
--   simulation model for single event or long-term (continuous) simulation
--   of runoff quantity and quality from primarily urban areas. SWMM 5,
--   which is currently the newest version of SWMM, produces a binary .OUT
--   file as its output. SWMMoutGetMB is a SWMM binary reader using the Get
--   monad in Haskell to retrieve contents of this binary file and save it
--   into a SWMMObject, which can then be used in Haskell programs.
@package SWMMoutGetMB
@version 0.1.0.1


-- | Parser for SWMM 5 Binary .OUT files
module Water.SWMM
data SWMMObject
SWMMObject :: Header -> ObjectIds -> ObjectProperties -> ReportingVariables -> ReportingInterval -> ComputedResult -> ClosingRecord -> SWMMObject
[header] :: SWMMObject -> Header
[ids] :: SWMMObject -> ObjectIds
[properties] :: SWMMObject -> ObjectProperties
[variables] :: SWMMObject -> ReportingVariables
[intervals] :: SWMMObject -> ReportingInterval
[result] :: SWMMObject -> ComputedResult
[closingRecord] :: SWMMObject -> ClosingRecord
data Header
Header :: Integer -> Integer -> Integer -> Integer -> Integer -> Integer -> Integer -> Header
[headerIdNumber] :: Header -> Integer
[versionNumber] :: Header -> Integer
[codeNumber] :: Header -> Integer
[numberOfSubcatchments] :: Header -> Integer
[numberOfNodes] :: Header -> Integer
[numberOfLinks] :: Header -> Integer
[numberOfPollutants] :: Header -> Integer
data ObjectIds
ObjectIds :: [ByteString] -> [ByteString] -> [ByteString] -> [ByteString] -> [Integer] -> ObjectIds
[subcatchmentIds] :: ObjectIds -> [ByteString]
[nodeIds] :: ObjectIds -> [ByteString]
[linkIds] :: ObjectIds -> [ByteString]
[pollutantIds] :: ObjectIds -> [ByteString]
[concentrationIds] :: ObjectIds -> [Integer]
data Properties
Properties :: Integer -> [Integer] -> [Float] -> Properties
[numberOfProperties] :: Properties -> Integer
[codeNumberProperties] :: Properties -> [Integer]
[valueProperties] :: Properties -> [Float]
data ObjectProperties
ObjectProperties :: Properties -> Properties -> Properties -> ObjectProperties
[subcatchmentProperties] :: ObjectProperties -> Properties
[nodeProperties] :: ObjectProperties -> Properties
[linkProperties] :: ObjectProperties -> Properties
data Variables
Variables :: Integer -> [Integer] -> Variables
[numberOfVariables] :: Variables -> Integer
[codeNumberVariables] :: Variables -> [Integer]
data ReportingVariables
ReportingVariables :: Variables -> Variables -> Variables -> Variables -> ReportingVariables
[subcatchmentVariables] :: ReportingVariables -> Variables
[nodeVariables] :: ReportingVariables -> Variables
[linkVariables] :: ReportingVariables -> Variables
[systemVariables] :: ReportingVariables -> Variables
data ReportingInterval
ReportingInterval :: Double -> Integer -> ReportingInterval
[startDateTime] :: ReportingInterval -> Double
[timeIntervals] :: ReportingInterval -> Integer
data ValuesForOneDateTime
ValuesForOneDateTime :: Double -> [[Float]] -> [[Float]] -> [[Float]] -> [Float] -> ValuesForOneDateTime
[dateTimeValue] :: ValuesForOneDateTime -> Double
[subcatchmentValue] :: ValuesForOneDateTime -> [[Float]]
[nodeValue] :: ValuesForOneDateTime -> [[Float]]
[linkValue] :: ValuesForOneDateTime -> [[Float]]
[systemValue] :: ValuesForOneDateTime -> [Float]
data ComputedResult
ComputedResult :: [ValuesForOneDateTime] -> ComputedResult
[allDateTimes] :: ComputedResult -> [ValuesForOneDateTime]
data ClosingRecord
ClosingRecord :: Integer -> Integer -> Integer -> Integer -> Integer -> Integer -> ClosingRecord
[idBytePosition] :: ClosingRecord -> Integer
[propertiesBytePosition] :: ClosingRecord -> Integer
[resultBytePosition] :: ClosingRecord -> Integer
[numberOfPeriods] :: ClosingRecord -> Integer
[errorCode] :: ClosingRecord -> Integer
[closingIdNumber] :: ClosingRecord -> Integer
parseSWMMBinary :: ByteString -> SWMMObject
instance GHC.Classes.Eq Water.SWMM.SWMMObject
instance GHC.Show.Show Water.SWMM.SWMMObject
instance GHC.Classes.Eq Water.SWMM.ComputedResult
instance GHC.Show.Show Water.SWMM.ComputedResult
instance GHC.Show.Show Water.SWMM.ValuesForOneDateTime
instance GHC.Classes.Eq Water.SWMM.ReportingVariables
instance GHC.Show.Show Water.SWMM.ReportingVariables
instance GHC.Classes.Eq Water.SWMM.Variables
instance GHC.Show.Show Water.SWMM.Variables
instance GHC.Classes.Eq Water.SWMM.ObjectProperties
instance GHC.Show.Show Water.SWMM.ObjectProperties
instance GHC.Classes.Eq Water.SWMM.Properties
instance GHC.Show.Show Water.SWMM.Properties
instance GHC.Classes.Eq Water.SWMM.ClosingRecord
instance GHC.Show.Show Water.SWMM.ClosingRecord
instance GHC.Classes.Eq Water.SWMM.ReportingInterval
instance GHC.Show.Show Water.SWMM.ReportingInterval
instance GHC.Classes.Eq Water.SWMM.ObjectIds
instance GHC.Show.Show Water.SWMM.ObjectIds
instance GHC.Classes.Eq Water.SWMM.Header
instance GHC.Show.Show Water.SWMM.Header
instance GHC.Classes.Ord Water.SWMM.ValuesForOneDateTime
instance GHC.Classes.Eq Water.SWMM.ValuesForOneDateTime