metadataApi

package
v0.1.1 Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Dec 10, 2023 License: MIT Imports: 9 Imported by: 1

Documentation

Index

Constants

View Source
const (
	STATION_TYPE_WATER_LEVEL = "water_level"
)

Variables

This section is empty.

Functions

This section is empty.

Types

type Client

type Client struct {
	Verbose bool
	AppName string
	// contains filtered or unexported fields
}

func NewClient

func NewClient(verbose bool, appName string) *Client

type HarmonicConstituent

type HarmonicConstituent struct {
	Amplitude   float64
	Description string
	Name        string
	Number      int64
	PhaseGMT    float64
	PhaseLocal  float64
	Speed       float64
}

func (*HarmonicConstituent) UnmarshalJSON

func (m *HarmonicConstituent) UnmarshalJSON(b []byte) error

type HarmonicConstituentsRequest

type HarmonicConstituentsRequest struct {
	Units string `url:"units"`
}

func (*HarmonicConstituentsRequest) Validate

func (m *HarmonicConstituentsRequest) Validate() error

type HarmonicConstituentsResponse

type HarmonicConstituentsResponse struct {
	HarmonicConstituents []HarmonicConstituent
	Units                string
}

func (*HarmonicConstituentsResponse) UnmarshalJSON

func (m *HarmonicConstituentsResponse) UnmarshalJSON(b []byte) error

type ResourceRef

type ResourceRef struct {
	Self string `url:"self"`
}

func (*ResourceRef) Validate

func (m *ResourceRef) Validate() error

type StationMetadata

type StationMetadata struct {
	Details    *ResourceRef
	GreatLakes *bool
	ShefCode   *string
	Tidal      *bool
}

func (*StationMetadata) StationTypes

func (m *StationMetadata) StationTypes() []string

func (*StationMetadata) UnmarshalJSON

func (m *StationMetadata) UnmarshalJSON(b []byte) error

type StationRequest

type StationRequest struct {
	StationID string
	Metadata  *StationMetadata
	// contains filtered or unexported fields
}

func NewStationRequest

func NewStationRequest(client *Client, stationID string) *StationRequest

func (*StationRequest) FetchMetadata

func (c *StationRequest) FetchMetadata(ctx context.Context) (*StationResponse, error)

func (*StationRequest) HarmonicConstituents

func (*StationRequest) TidePredictionOffsets

func (c *StationRequest) TidePredictionOffsets(ctx context.Context) (*TidePredictionOffsetsResponse, error)

type StationResponse

type StationResponse struct {
	Count    int
	Stations []StationMetadata
	Units    *string
}

func (*StationResponse) UnmarshalJSON

func (m *StationResponse) UnmarshalJSON(b []byte) error

type StationsRequest

type StationsRequest struct {
	StationIDs []string
	Metadata   *StationMetadata
	// contains filtered or unexported fields
}

func NewStationsRequest

func NewStationsRequest(client *Client, stationIDs []string) *StationsRequest

func (*StationsRequest) FetchMetadata

func (c *StationsRequest) FetchMetadata(ctx context.Context) ([]*StationResponse, error)

func (*StationsRequest) HarmonicConstituents

func (c *StationsRequest) HarmonicConstituents(ctx context.Context) ([]*HarmonicConstituentsResponse, error)

func (*StationsRequest) TidePredictionOffsets

func (c *StationsRequest) TidePredictionOffsets(ctx context.Context) ([]*TidePredictionOffsetsResponse, error)

type TidePredictionOffsetsResponse

type TidePredictionOffsetsResponse struct {
	HeightAdjustedType   string
	HeightOffsetHighTide float64
	HeightOffsetLowTide  float64
	RefStationID         string
	TimeOffsetHighTide   float64
	TimeOffsetLowTide    float64
	Type                 string
}

func (*TidePredictionOffsetsResponse) UnmarshalJSON

func (m *TidePredictionOffsetsResponse) UnmarshalJSON(b []byte) error

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL