R/Currency-class.R

Defines functions validCurrencyObject

#' Currency class
#'
#' The three-character code or hex string used to denote currencies.
#'
#' A character vector where each element must match the regular expression
#' \code{"^([a-zA-Z0-9]{3}|[A-Fa-f0-9]{40})$"}.
#'
#' @examples
#' USD <- Currency("USD"); USD
#' XAU <- Currency("015841551A748AD2C1F76FF6ECB0CCCD00000000"); XAU
#'
#' @export Currency
#' @exportClass Currency
Currency <- setClass("Currency", contains = "character")
validCurrencyObject <- function(object) {
    if (!all(grepl("^([a-zA-Z0-9]{3}|[A-Fa-f0-9]{40})$", object))) {
        return("Invalid currency.")
    }
    return(TRUE)
}
setValidity("Currency", validCurrencyObject)
hmalmedal/ripplerestr documentation built on May 17, 2019, 4:34 p.m.