Portability	unknown
Stability	unstable
Maintainer	Conrad Parker <conrad@metadecks.org>

Data.ZoomCache.Types

Contents

Classes
Types

Description

ZoomCache packet and summary types and interfaces

Synopsis

Classes

class ZoomReadable a whereSource

A codec instance must specify a SummaryData type, and implement all methods of this class.

Associated Types

data SummaryData a :: *Source

Summaries of a subsequence of values of type a. In the default instances for Int and Double, this is a record containing values such as the maximum, minimum and mean of the subsequence.

Methods

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

An iteratee to read one value of type a from a stream of '[Word8]'.

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

An iteratee to read one value of type 'SummaryData a' from a stream of '[Word8]'.

prettyRaw :: a -> String Source

Pretty printing, used for dumping values of type a.

prettySummaryData :: SummaryData a -> String Source

Pretty printing for values of type 'SummaryData a'.

Instances

ZoomReadable Double
ZoomReadable Int

class ZoomWritable a whereSource

A codec instance must additionally specify a SummaryWork type

Associated Types

data SummaryWork a :: *Source

Intermediate calculations

Methods

fromRaw :: a -> Builder Source

Serialize a value of type a

fromSummaryData :: SummaryData a -> Builder Source

Serialize a 'SummaryData a'

initSummaryWork :: TimeStamp -> SummaryWork aSource

Generate a new 'SummaryWork a', given an initial timestamp.

updateSummaryData :: Int -> TimeStamp -> a -> SummaryWork a -> SummaryWork aSource

Update a SummaryData with the value of a occuring at the given TimeStamp.

toSummaryData :: Double -> SummaryWork a -> SummaryData aSource

Finalize a 'SummaryWork a', generating a 'SummaryData a'.

appendSummaryData :: Double -> SummaryData a -> Double -> SummaryData a -> SummaryData aSource

Append two SummaryData

Instances

ZoomWritable Double
ZoomWritable Int

data ZoomRaw Source

Constructors

forall a . ZoomReadable a => ZoomRaw [a]

data ZoomSummary Source

Constructors

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

data ZoomWork Source

Constructors

forall a . (Typeable a, ZoomWritable a) => ZoomWork
Fields levels :: IntMap (Summary a -> Summary a) currWork :: Maybe (SummaryWork a)

Types

data Packet Source

Constructors

Packet
Fields packetTrack :: TrackNo packetEntryTime :: TimeStamp packetExitTime :: TimeStamp packetCount :: Int packetData :: ZoomRaw packetTimeStamps :: [TimeStamp]

data Summary a Source

A recorded block of summary data

Constructors

Summary
Fields summaryTrack :: TrackNo summaryLevel :: Int summaryEntryTime :: TimeStamp summaryExitTime :: TimeStamp summaryData :: SummaryData a

summaryDuration :: Summary a -> Int64 Source

The duration covered by a summary, in units of 1 / the track's datarate