R/TemporalExtent-class.R

In flahn/scidbst: Spatio Temporal Extension for SciDB (scidbst)

#' @include scidbst-class-decl.R
#' @include TemporalExtent-class-decl.R
NULL


if (!isGeneric("tmin")) {
  setGeneric("tmin",function(x) {
    standardGeneric("tmin")
  })
}
if (!isGeneric("tmax")) {
  setGeneric("tmax",function(x) {
    standardGeneric("tmax")
  })
}


#' Minimum temporal boundary
#'
#' Return the minimum boundary of a TemporalExtent object
#' @rdname tmin-method
#' @name tmin
#' @param x object
#' @return POSIXt object referring to the minimum boundary
#'
#' @export
setMethod("tmin",signature(x="TemporalExtent"),function(x) {
  return(x@min)
})

#' @rdname tmin-method
#' @export
setMethod("tmin",signature(x="scidbst"),function(x) {
  return(tmin(x@tExtent))
})

#' Maximum temporal boundary
#'
#' Return the maximum boundary of a TemporalExtent object
#' @rdname tmax-method
#' @name tmax
#' @param x object
#' @return POSIXt object referring to the maximum boundary
#'
#' @export
setMethod("tmax",signature(x="TemporalExtent"),function(x) {
  return(x@max)
})

#' @rdname tmax-method
#' @export
setMethod("tmax",signature(x="scidbst"),function(x) {
  return(tmax(x@tExtent))
})

#' Show method
#'
#' creates a print version of the TemporalExtent object
#'
#' @param x TemporalExtent
#'
#' @export
setMethod("show",signature(object="TemporalExtent"),function(object){
  cat("Temporal Extent:\n")
  cat(paste("\tFrom:\t",object@min,"\n",sep=""))
  cat(paste("\tTo:\t",object@max,"\n",sep=""))
})