github.com/m3db/m3@v1.5.0/src/query/ts/series.go (about)

     1  // Copyright (c) 2018 Uber Technologies, Inc.
     2  //
     3  // Permission is hereby granted, free of charge, to any person obtaining a copy
     4  // of this software and associated documentation files (the "Software"), to deal
     5  // in the Software without restriction, including without limitation the rights
     6  // to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
     7  // copies of the Software, and to permit persons to whom the Software is
     8  // furnished to do so, subject to the following conditions:
     9  //
    10  // The above copyright notice and this permission notice shall be included in
    11  // all copies or substantial portions of the Software.
    12  //
    13  // THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
    14  // IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
    15  // FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
    16  // AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
    17  // LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
    18  // OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
    19  // THE SOFTWARE.
    20  
    21  package ts
    22  
    23  import (
    24  	"github.com/m3db/m3/src/query/models"
    25  )
    26  
    27  // Series is the public interface to a block of timeseries values.
    28  // Each block has a start time, a logical number of steps, and a step size
    29  // indicating the number of milliseconds represented by each point.
    30  type Series struct {
    31  	name []byte
    32  	vals Values
    33  	Tags models.Tags
    34  }
    35  
    36  // NewSeries creates a new Series at a given start time, backed by the provided values.
    37  func NewSeries(name []byte, vals Values, tags models.Tags) *Series {
    38  	return &Series{
    39  		name: name,
    40  		vals: vals,
    41  		Tags: tags,
    42  	}
    43  }
    44  
    45  // Name returns the name of the timeseries block
    46  func (s *Series) Name() []byte { return s.name }
    47  
    48  // Len returns the number of values in the time series. Used for aggregation.
    49  func (s *Series) Len() int { return s.vals.Len() }
    50  
    51  // Values returns the underlying values interface.
    52  func (s *Series) Values() Values { return s.vals }
    53  
    54  // SeriesList represents a slice of series pointers.
    55  type SeriesList []*Series