IRISMustangMetrics (version 2.4.7)

SingleValueMetric-class: Class "SingleValueMetric"

Description

A container for metrics results and associated metadata. This information is used to create XML that is then submitted to the MUSTANG Backend Storage System (BSS). This has been superceded by GeneralValueMetric and is deprecated.

Objects from the Class

Objects can be created by calls of the form:

new("SingleValueMetric", snclq, starttime, endtime, metricName, value)

Lists of SingleValueMetric objects are returned by various metrics functions in this package.

Slots

snclq:

Object of class "character": SNCLQ identifier.

metricName:

Object of class "character": Name of the metric.

starttime:

Object of class "POSIXct": Start time.

endtime:

Object of class "POSIXct": End time.

valueName:

Object of class "character": Name of the XML value identifier (default="value").

value:

Object of class "numeric": Metric value.

valueString:

Object of class "character": String representation of the metric value.

quality_flag:

Object of class "numeric": Quality flag.

quality_flagString:

Object of class "character": String representation of quality flag.

attributeName:

Object of class "character": Name of one or more optional attributes.

attributeValueString:

Object of class "character": String representation of one or more attribute values.

Methods

%%\item{initialize}{\code{signature(.Object = "SingleValueMetric")}: \strong{NOT YET WRITTEN} }

show

signature(object = "SingleValueMetric"): Prettyprints the information in the SingleValueMetric

Author

Jonathan Callahan

Examples

  if (FALSE) {
# Open a connection to EarthScope webservices
iris <- new("IrisClient")

# Get the waveform
starttime <- as.POSIXct("2012-01-24", tz="GMT")
endtime <- as.POSIXct("2012-01-25", tz="GMT")
st <- getDataselect(iris,"AK","PIN","","BHZ",starttime,endtime)

# Apply a metric and show the results
metricList <- basicStatsMetric(st)
show(metricList[[1]])
  }