feeds

Documentation

Overview

Copyright © 2021 University of Washington

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

Index

• func FindEVTFiles(dir string) (files []string, err error)
• func FindSFLFiles(dir string) (files []string, err error)
• type Emitter
• type Evt
  • func NewEvt(files []string, outDir string) (e *Evt, err error)
  • func (e *Evt) Close() (err error)
  • func (e *Evt) Earliest() (t time.Time)
  • func (e *Evt) Emit() (err error)
  • func (e *Evt) Len() int
  • func (e *Evt) Name() string
  • func (e *Evt) Next() bool
  • func (e *Evt) Time() (t time.Time)
  • func (e *Evt) Warnings() []Warning
• type SeaLog
  • func NewSeaLog(file string, outDir string) (s *SeaLog, err error)
  • func (s *SeaLog) Close() (err error)
  • func (s *SeaLog) Earliest() (t time.Time)
  • func (s *SeaLog) Emit() (err error)
  • func (s *SeaLog) Len() int
  • func (s *SeaLog) Name() string
  • func (s *SeaLog) Next() bool
  • func (s *SeaLog) Time() (t time.Time)
  • func (s *SeaLog) Warnings() []Warning
• type Sfl
  • func NewSfl(files []string, outDir string) (s *Sfl, err error)
  • func (s *Sfl) Close() (err error)
  • func (s *Sfl) Earliest() (t time.Time)
  • func (s *Sfl) Emit() (err error)
  • func (s *Sfl) Len() int
  • func (s *Sfl) Name() string
  • func (s *Sfl) Next() bool
  • func (s *Sfl) Time() (t time.Time)
  • func (s *Sfl) Warnings() []Warning
• type Underway
  • func NewUnderway(file string, host string, port uint, throttleSec int64) (u *Underway, err error)
  • func (u *Underway) Close() (err error)
  • func (u *Underway) Earliest() (t time.Time)
  • func (u *Underway) Emit() (err error)
  • func (u *Underway) Len() int
  • func (u *Underway) Name() string
  • func (u *Underway) Next() bool
  • func (u *Underway) Time() (t time.Time)
  • func (u *Underway) Warnings() []Warning
• type Warning
  • func (w Warning) String() string

Functions

func FindEVTFiles

func FindEVTFiles(dir string) (files []string, err error)

func FindSFLFiles

func FindSFLFiles(dir string) (files []string, err error)

Types

type Emitter

type Emitter interface {
	Name() string
	Earliest() time.Time
	Next() bool      // move to next item to emit in time series
	Time() time.Time // get time for item to emit
	Emit() error
	Close() error // close any open resources
	Len() int
}

type Evt

type Evt struct {
	// contains filtered or unexported fields
}

func NewEvt

func NewEvt(files []string, outDir string) (e *Evt, err error)

func (*Evt) Close

func (e *Evt) Close() (err error)

func (*Evt) Earliest

func (e *Evt) Earliest() (t time.Time)

func (*Evt) Emit

func (e *Evt) Emit() (err error)

func (*Evt) Len

func (e *Evt) Len() int

func (*Evt) Name

func (e *Evt) Name() string

func (*Evt) Next

func (e *Evt) Next() bool

func (*Evt) Time

func (e *Evt) Time() (t time.Time)

func (*Evt) Warnings

func (e *Evt) Warnings() []Warning

type SeaLog

type SeaLog struct {
	// contains filtered or unexported fields
}

func NewSeaLog

func NewSeaLog(file string, outDir string) (s *SeaLog, err error)

func (*SeaLog) Close

func (s *SeaLog) Close() (err error)

func (*SeaLog) Earliest

func (s *SeaLog) Earliest() (t time.Time)

func (*SeaLog) Emit

func (s *SeaLog) Emit() (err error)

func (*SeaLog) Len

func (s *SeaLog) Len() int

func (*SeaLog) Name

func (s *SeaLog) Name() string

func (*SeaLog) Next

func (s *SeaLog) Next() bool

func (*SeaLog) Time

func (s *SeaLog) Time() (t time.Time)

func (*SeaLog) Warnings

func (s *SeaLog) Warnings() []Warning

type Sfl

type Sfl struct {
	// contains filtered or unexported fields
}

*****************************************************************************

func NewSfl

func NewSfl(files []string, outDir string) (s *Sfl, err error)

func (*Sfl) Close

func (s *Sfl) Close() (err error)

func (*Sfl) Earliest

func (s *Sfl) Earliest() (t time.Time)

func (*Sfl) Emit

func (s *Sfl) Emit() (err error)

func (*Sfl) Len

func (s *Sfl) Len() int

func (*Sfl) Name

func (s *Sfl) Name() string

func (*Sfl) Next

func (s *Sfl) Next() bool

func (*Sfl) Time

func (s *Sfl) Time() (t time.Time)

func (*Sfl) Warnings

func (s *Sfl) Warnings() []Warning

type Underway

type Underway struct {
	// contains filtered or unexported fields
}

func NewUnderway

func NewUnderway(file string, host string, port uint, throttleSec int64) (u *Underway, err error)

func (*Underway) Close

func (u *Underway) Close() (err error)

func (*Underway) Earliest

func (u *Underway) Earliest() (t time.Time)

func (*Underway) Emit

func (u *Underway) Emit() (err error)

func (*Underway) Len

func (u *Underway) Len() int

func (*Underway) Name

func (u *Underway) Name() string

func (*Underway) Next

func (u *Underway) Next() bool

func (*Underway) Time

func (u *Underway) Time() (t time.Time)

func (*Underway) Warnings

func (u *Underway) Warnings() []Warning

type Warning

type Warning struct {
	// contains filtered or unexported fields
}

func (Warning) String

func (w Warning) String() string