R/ISOFileName.R

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

#' ISOFileName
#'
#' @docType class
#' @importFrom R6 R6Class
#' @export
#' @keywords ISO file name
#' @return Object of \code{\link{R6Class}} for modelling an ISO FileName
#' @format \code{\link{R6Class}} object.
#' 
#' @examples 
#'   md <- ISOFileName$new(file = "someuri", name = "filename")
#'   xml <- md$encode()
#' 
#' @references
#'  ISO/TS 19139:2007 Geographic information -- XML
#' 
#' @author Emmanuel Blondel <emmanuel.blondel1@@gmail.com>
#'
ISOFileName <- R6Class("ISOFileName",
  inherit = ISOAbstractObject,
  private = list(
    xmlElement = "FileName",
    xmlNamespacePrefix = "GMX"
  ),
  public = list(
    #'@field attrs attrs
    attrs = list(),
    
    #'@description Initializes object
    #'@param xml object of class \link{XMLInternalNode-class}
    #'@param file file
    #'@param name name
    initialize = function(xml = NULL, file = NULL, name = NULL){
      super$initialize(xml = xml)
      if(!is.null(file) & !is.null(name)){
        self$attrs$src <- file
        self$value <- name
      }
    }
  )                        
)