R/sattagstream_extends.R

In williamcioffi/sattagutils: utils for manupulating sat tag output

#' @include sattagstream.R
NULL

#' an S4 class which extends sattagstream
#'
#' corresponds to the *-All.csv data stream.
#' @seealso \code{\link[sattagutils]{sattag-class}} 
#' @seealso \code{\link[sattagutils]{sattagstream-class}}
#' @family sattagstream types
setClass("all", 			contains = "sattagstream")

#' an S4 class which extends sattagstream
#'
#' corresponds to the *-Argos.csv data stream.
#' @seealso \code{\link[sattagutils]{sattag-class}} 
#' @seealso \code{\link[sattagutils]{sattagstream-class}}
#' @family sattagstream types
setClass("argos", 		contains = "sattagstream")

#' an S4 class which extends sattagstream
#'
#' corresponds to the *-Behavior.csv data stream.
#' @seealso \code{\link[sattagutils]{sattag-class}} 
#' @seealso \code{\link[sattagutils]{sattagstream-class}}
#' @family sattagstream types
setClass("behavior", 		contains = "sattagstream")

#' an S4 class which extends sattagstream
#'
#' corresponds to the *-Corrupt.csv data stream.
#' @seealso \code{\link[sattagutils]{sattag-class}} 
#' @seealso \code{\link[sattagutils]{sattagstream-class}}
#' @family sattagstream types
setClass("corrupt", 		contains = "sattagstream")

#' an S4 class which extends sattagstream
#'
#' corresponds to the *-FastGPS.csv data stream. this is not a well formated csv when downloaded from the portal so beware when importing. see \code{\link[sattagutils]{load_tag}}.
#' @seealso \code{\link[sattagutils]{sattag-class}} 
#' @seealso \code{\link[sattagutils]{sattagstream-class}}
#' @family sattagstream types
setClass("fastgps", 		contains = "sattagstream")

#' an S4 class which extends sattagstream
#'
#' corresponds to the *-Histos.csv data stream.
#' @seealso \code{\link[sattagutils]{sattag-class}} 
#' @seealso \code{\link[sattagutils]{sattagstream-class}}
#' @family sattagstream types
setClass("histos", 		contains = "sattagstream")

#' an S4 class which extends sattagstream
#'
#' corresponds to the *-Labels.csv data stream. this csv file appears to be missing an EOF when downloaded from the portal so beware when importing. see \code{\link[sattagutils]{load_tag}}.
#' @seealso \code{\link[sattagutils]{sattag-class}} 
#' @seealso \code{\link[sattagutils]{sattagstream-class}}
#' @family sattagstream types
setClass("labels", 		contains = "sattagstream")

#' an S4 class which extends sattagstream
#'
#' corresponds to the *-Locations.csv data stream.
#' @seealso \code{\link[sattagutils]{sattag-class}} 
#' @seealso \code{\link[sattagutils]{sattagstream-class}}
#' @family sattagstream types
setClass("locations", 	contains = "sattagstream")

#' an S4 class which extends sattagstream
#'
#' corresponds to the *-MinMaxDepth.csv data stream.
#' @seealso \code{\link[sattagutils]{sattag-class}} 
#' @seealso \code{\link[sattagutils]{sattagstream-class}}
#' @family sattagstream types
setClass("minmaxdepth",	contains = "sattagstream")

#' an S4 class which extends sattagstream
#'
#' corresponds to the *-RawArgos.csv data stream. this is not a well formated csv when downloaded from the portal so beware when importing. see \code{\link[sattagutils]{load_tag}}.
#' @seealso \code{\link[sattagutils]{sattag-class}} 
#' @seealso \code{\link[sattagutils]{sattagstream-class}}
#' @family sattagstream types
setClass("rawargos", 		contains = "sattagstream")

#' an S4 class which extends sattagstream
#'
#' corresponds to the *-RTC.csv data stream.
#' @seealso \code{\link[sattagutils]{sattag-class}} 
#' @seealso \code{\link[sattagutils]{sattagstream-class}}
#' @family sattagstream types
setClass("rtc", 			contains = "sattagstream")

#' an S4 class which extends sattagstream
#'
#' corresponds to the *-Series.csv data stream.
#' @seealso \code{\link[sattagutils]{sattag-class}} 
#' @seealso \code{\link[sattagutils]{sattagstream-class}}
#' @family sattagstream types
setClass("series", 		contains = "sattagstream")

#' an S4 class which extends sattagstream
#'
#' corresponds to the *-SeriesRange.csv data stream.
#' @seealso \code{\link[sattagutils]{sattag-class}} 
#' @seealso \code{\link[sattagutils]{sattagstream-class}}
#' @family sattagstream types
setClass("seriesrange", 	contains = "sattagstream")

#' an S4 class which extends sattagstream
#'
#' corresponds to the *-SST.csv data stream.
#' @seealso \code{\link[sattagutils]{sattag-class}} 
#' @seealso \code{\link[sattagutils]{sattagstream-class}}
#' @family sattagstream types
setClass("sst", 			contains = "sattagstream")

#' an S4 class which extends sattagstream
#'
#' corresponds to the *-Status.csv data stream.
#' @seealso \code{\link[sattagutils]{sattag-class}} 
#' @seealso \code{\link[sattagutils]{sattagstream-class}}
#' @family sattagstream types
setClass("status", 		contains = "sattagstream")

#' an S4 class which extends sattagstream
#'
#' corresponds to the *-Summary.csv data stream. used to populate slots in \code{\link[sattagutils]{sattag}} within \code{\link[sattagutils]{load_tag}}.
#' @seealso \code{\link[sattagutils]{sattag-class}} 
#' @seealso \code{\link[sattagutils]{sattagstream-class}}
#' @family sattagstream types
setClass("summary", 		contains = "sattagstream")