R/ISOImageryCoverageDescription.R

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

#' ISOImageryCoverageDescription
#'
#' @docType class
#' @importFrom R6 R6Class
#' @export
#' @keywords ISO imagery image description
#' @return Object of \code{\link{R6Class}} for modelling an ISO imagery image description
#' @format \code{\link{R6Class}} object.
#' 
#' @examples
#'    #create coverage description
#'    md <- ISOImageryCoverageDescription$new()
#'    md$setAttributeDescription("test")
#'    md$setContentType("modelResult")
#'    
#'    #adding 3 arbitrary dimensions
#'    for(i in 1:3){
#'       band <- ISOBand$new()
#'       mn <- ISOMemberName$new(aName = sprintf("name %s",i), attributeType = sprintf("type %s",i))
#'       band$setSequenceIdentifier(mn)
#'       band$setDescriptor("descriptor")
#'       band$setMaxValue(10)
#'       band$setMinValue(1)
#'       gml <- GMLBaseUnit$new(id = sprintf("ID%s",i))
#'       gml$setDescriptionReference("someref")
#'       gml$setIdentifier("identifier", "codespace")
#'       gml$addName("name1", "codespace")
#'       gml$addName("name2", "codespace")
#'       gml$setQuantityTypeReference("someref")
#'       gml$setCatalogSymbol("symbol")
#'       gml$setUnitsSystem("somelink")
#'       band$setUnits(gml)
#'       band$setPeakResponse(9)
#'       band$setBitsPerValue(5)
#'       band$setToneGradation(100)
#'       band$setScaleFactor(1)
#'       band$setOffset(4)
#'       md$addDimension(band)
#'    }
#'    
#'    des <- ISOImageryRangeElementDescription$new()
#'    des$setName("name")
#'    des$setDefinition("description")
#'    des$addRangeElement("record1")
#'    des$addRangeElement("record2")
#'    md$addRangeElementDescription(des)
#'    xml <- md$encode()
#' 
#' @references 
#'   ISO 19115-2:2009 - Geographic information -- Metadata Part 2: Extensions for imagery and gridded data
#' 
#' @author Emmanuel Blondel <emmanuel.blondel1@@gmail.com>
#' 
ISOImageryCoverageDescription <- R6Class("ISOImageryCoverageDescription",
  inherit = ISOCoverageDescription,
  private = list(
    xmlElement = "MI_CoverageDescription",
    xmlNamespacePrefix = "GMI"
  ),
  public = list(
    #'@field rangeElementDescription rangeElementDescription [0..*] : ISOImageryRangeElementDescription
    rangeElementDescription = list(),
    
    #'@description Initializes object
    #'@param xml object of class \link{XMLInternalNode-class}
    initialize = function(xml = NULL){
      super$initialize(xml = xml)
    },
    
    #'@description Adds range element description
    #'@param description object of class \link{ISOImageryRangeElementDescription}
    #'@return \code{TRUE} if added, \code{FALSE} otherwise
    addRangeElementDescription = function(description){
      if(!is(description, "ISOImageryRangeElementDescription")){
        stop("The argument should be an object of class 'ISOImageryRangeElementDescription'")
      }
      return(self$addListElement("rangeElementDescription", description))
    },
    
    #'@description Deletes range element description
    #'@param description object of class \link{ISOImageryRangeElementDescription}
    #'@return \code{TRUE} if deleted, \code{FALSE} otherwise
    delRangeElementDescription = function(description){
      if(!is(description, "ISOImageryRangeElementDescription")){
        stop("The argument should be an object of class 'ISOImageryRangeElementDescription'")
      }
      return(self$delListElement("rangeElementDescription", description))
    }
  )                        
)