man-roxygen/oshExList.r

#' A list-object of conditions used to filter oshex objects
#' 
#' An \code{oshExList} is an S4 class used as the condition argument of the
#' \code{\link{osh_filter}} function. It contains one or more \code{oshExpression} classes of
#' different types (see 'Details' below).
#' 
#' @slot conditions A list of \code{oshExpression} objects used to filter an \code{oshex} object. 
#' An \code{oshExList} is inherited by different subclasses:
#' 
#' \describe{
#'   \item{\code{oshExListTemp}}{Used for temporal filtering. 
#'   It is created by call to the function \code{\link{temp}}.}
#'   \item{\code{oshExListTags}}{Used for tags filtering.
#'   It is created by call to the function \code{\link{tag}}.}
#'   \item{\code{oshExListAttrs}}{Used for attributes filtering.
#'   It is created by call to the function \code{\link{attrs}}.}
#' }
#' 
#' 
#' @section Details:
#' oshExList are constructed by the following function \code{\link{temp}}, \code{\link{tag}},
#' and \code{\link{attrs}}, and are used to filter oshex objects using \code{\link{osh_filter}}.
#' 
#' Each oshExList may contain one or more oshExpression objects. An oshExpression holds a condition
#' of a certain type. A textual (\code{txt}) condition is used to filter tags and attributes textual 
#' values. A numeric (\code{number}) condition is used to filter tags by their numeric values. A temporal
#' (\code{time}) condition is used to filter tags by their timestamp attribute.
dof1985/OSHEX documentation built on May 28, 2019, 3:36 p.m.