R/ISOImageryTransferFunctionType.R

In eblondel/geometa: Tools for Reading and Writing ISO/OGC Geographic Metadata

#' ISOImageryTransferFunctionType
#'
#' @docType class
#' @importFrom R6 R6Class
#' @export
#' @keywords ISO imagery transfer function type
#' @return Object of \code{\link{R6Class}} for modelling an ISO imagery transfer function type
#' @format \code{\link{R6Class}} object.
#' 
#' @examples
#'   #possible values
#'   values <- ISOImageryTransferFunctionType$values(labels = TRUE)
#'   
#'   #some def
#'   log <- ISOImageryTransferFunctionType$new(value = "logarithmic")
#' 
#' @references 
#'   - ISO 19139 \url{https://schemas.isotc211.org/19115/-2/gmi/1.0/gmi/#element_MI_TransferFunctionTypeCode}
#'   
#'   - ISO 19115-3 \url{https://schemas.isotc211.org/19115/-3/mrc/1.0/mrc/#element_MI_TransferFunctionTypeCode}
#' 
#' @author Emmanuel Blondel <emmanuel.blondel1@@gmail.com>
#'
ISOImageryTransferFunctionType <- R6Class("ISOImageryTransferFunctionType",
  inherit = ISOCodeListValue,
  private = list(
    xmlElement = "MI_TransferFunctionTypeCode",
    xmlNamespacePrefix = list(
      "19139" = "GMI",
      "19115-3" = "MRC"
    )
  ),
  public = list(
    
    #'@description Initializes object
    #'@param xml object of class \link{XMLInternalNode-class}
    #'@param value value
    #'@param description description
    initialize = function(xml = NULL, value, description = NULL){
      super$initialize(xml = xml, id = private$xmlElement, value = value, description = description, 
                       addCodeSpaceAttr = FALSE)
    }
  )                        
)

ISOImageryTransferFunctionType$values <- function(labels = FALSE){
  return(ISOCodeListValue$values(ISOImageryTransferFunctionType, labels))
}