Data.ZoomCache

API for implementing ZoomCache applications

Types

data TimeStamp

Constructors

TS

Fields

unTS :: !Integer

Instances

Eq TimeStamp

Ord TimeStamp

Show TimeStamp

ZoomWrite (TimeStamp, Double)

ZoomWrite (TimeStamp, Int)

type TrackNo = Int

data TrackType

Constructors

ZDouble

ZInt

Instances

Eq TrackType

Show TrackType

data DataRateType

Constant or Variable datarate. For constant datarate, timestamps are implied as incrementing by 1/datarate For variable datarate, explicit timestamps are attached to each datum, encoded as a separate block of timestamps in the Raw Data packet.

Constructors

ConstantDR

VariableDR

Instances

Show DataRateType

data CacheFile

Global and track headers for a zoom-cache file

Constructors

CacheFile

Fields

cfGlobal :: Global

cfSpecs :: IntMap TrackSpec

class ZoomReadable a where

Methods

readRaw :: (Functor m, MonadIO m) => Iteratee [Word8] m a

fromList :: [a] -> RawData a

readSummary :: (Functor m, MonadIO m) => Iteratee [Word8] m (SummaryData a)

prettyRawData :: RawData a -> [String]

prettySummaryData :: SummaryData a -> String

Instances

ZoomReadable Double

ZoomReadable Int

data ZoomRaw

Constructors

forall a . ZoomReadable a => ZoomRaw (RawData a)

data ZoomSummary

Constructors

forall a . ZoomReadable a => ZoomSummary (Summary a)

data Packet

Constructors

Packet

Fields

packetTrack :: TrackNo

packetEntryTime :: TimeStamp

packetExitTime :: TimeStamp

packetCount :: Int

packetData :: ZoomRaw

packetTimeStamps :: [TimeStamp]

data Summary a

A recorded block of summary data

Constructors

Summary

Fields

summaryTrack :: TrackNo

summaryLevel :: Int

summaryEntryTime :: TimeStamp

summaryExitTime :: TimeStamp

summaryData :: SummaryData a

Track specification

type TrackMap = IntMap TrackSpec

A map of all track numbers to their TrackSpec

data TrackSpec

A specification of the type and name of each track

Constructors

TrackSpec

Fields

specType :: TrackType

specDRType :: DataRateType

specRate :: Rational

specName :: ByteString

Instances

Show TrackSpec

The ZoomWrite class

class ZoomWrite t where

The ZoomWrite class provides write, a method to write a Haskell value to an open ZoomCache file.

Methods

write :: TrackNo -> t -> ZoomW ()

Write a value to an open ZoomCache file.

Instances

ZoomWrite Double

ZoomWrite Int

ZoomWrite (TimeStamp, Double)

ZoomWrite (TimeStamp, Int)

The ZoomW monad

type ZoomW = StateT ZoomWHandle IO

A StateT IO monad for writing a ZoomCache file

withFileWrite

Arguments

:: TrackMap

-> Bool

Whether or not to write raw data packets. If False, only summary blocks are written.

-> ZoomW ()

-> FilePath

-> IO ()

Run a ZoomW () action on a given file handle, using the specified TrackMap specification

flush :: ZoomW ()

Force a flush of ZoomCache summary blocks to disk. It is not usually necessary to call this function as summary blocks are transparently written at regular intervals.

Watermarks

watermark :: TrackNo -> ZoomW (Maybe Int)

Query the maximum number of data points to buffer for a given track before forcing a flush of all buffered data and summaries.

setWatermark :: TrackNo -> Int -> ZoomW ()

Set the maximum number of data points to buffer for a given track before forcing a flush of all buffered data and summaries.

TrackSpec helpers

oneTrack :: TrackType -> DataRateType -> Rational -> ByteString -> TrackMap

Create a track map for a stream of a given type, as track no. 1

Iteratee parsers

module Data.Iteratee.ZoomCache

Pretty printing

module Data.ZoomCache.Pretty