tides

README

tides

import "github.com/GeoNet/delta/tides"

• Overview
• Index
• Subdirectories

Overview

Package tides provides an embeddable mechanism for providing tidal constituents for given gauge sites that can be used for tide predication.

Index

• type Constituent
  • func (c Constituent) String() string
• type Tide
  • func Lookup(code string) *Tide
  • func (t Tide) Zone() float64

Package files

auto.go tides.go

type Constituent

type Constituent struct {
    Name      string
    Amplitude float64
    Lag       float64
}

Constitutent stores the calculated amplotude and lag for a named tidal phase, the amplitude and lag are given in units of meters and degrees respectively.

func (Constituent) String

func (c Constituent) String() string

String provides a standard representation of the tidal constituent.

type Tide

type Tide struct {
    Code      string
    Network   string
    Number    string
    TimeZone  float64
    Latitude  float64
    Longitude float64
    Crex      string

    Constituents []Constituent
}

Tide provides the general parameters needed to predict tides at a given site and the associated tidal consitituents. The TimeZone, Latitude, and Longitude are expected to be the parameters used to generated the tidal prediction constituents and may differ from the geographic values recorded elsewhere.

func Lookup

func Lookup(code string) *Tide

Lookup will return a Tide pointer for the requested site code. A nil pointer will be returned if a code cannot be found.

func (Tide) Zone

func (t Tide) Zone() float64

Zone provides a conversion of the time zone parameter for use with common tidal prediction software.

---

Generated by godoc2md

Documentation

Overview

Package tides provides an embeddable mechanism for providing tidal constituents for given gauge sites that can be used for tide predication.

Index

• type Constituent
  • func (c Constituent) String() string
• type Tide
  • func Lookup(code string) *Tide
  • func (t Tide) Zone() float64

Types

type Constituent

type Constituent struct {
	Name      string
	Amplitude float64
	Lag       float64
}

Constitutent stores the calculated amplotude and lag for a named tidal phase, the amplitude and lag are given in units of meters and degrees respectively.

func (Constituent) String

func (c Constituent) String() string

String provides a standard representation of the tidal constituent.

type Tide

type Tide struct {
	Code      string
	Network   string
	Number    string
	TimeZone  float64
	Latitude  float64
	Longitude float64
	Crex      string

	Constituents []Constituent
}

Tide provides the general parameters needed to predict tides at a given site and the associated tidal consitituents. The TimeZone, Latitude, and Longitude are expected to be the parameters used to generated the tidal prediction constituents and may differ from the geographic values recorded elsewhere.

func Lookup

func Lookup(code string) *Tide

Lookup will return a Tide pointer for the requested site code. A nil pointer will be returned if a code cannot be found.

func (Tide) Zone

func (t Tide) Zone() float64

Zone provides a conversion of the time zone parameter for use with common tidal prediction software.