ISOSampleDimension

ISOSampleDimension

ISOSampleDimension

Format

R6Class object.

Value

Object of R6Class for modelling an ISOSampleDimension

References

- ISO 19115-3 https://schemas.isotc211.org/19115/-3/mrc/1.0/mrc/#element_MD_SampleDimension

Author

Emmanuel Blondel <emmanuel.blondel1@gmail.com>

Super classes

geometa::geometaLogger -> geometa::ISOAbstractObject -> geometa::ISORangeDimension -> ISOSampleDimension

Public fields

maxValue

maxValue [0..1] : numeric

minValue

minValue [0..1] : numeric

units

units [0..1] : GMLUnitDefinition

scaleFactor

scaleFactor [0..1] : numeric

offset

offset [0..1] : numeric

meanValue

meanValue [0..1] : numeric (=> ISO 19115-3)

numberOfValues

numberOfValues [0..1] : integer (=> ISO 19115-3)

standardDeviation

standardDeviation [0..1]: numeric (=> ISO 19115-3)

otherPropertyType

otherPropertyType [0..1] : ISORecordType (=> ISO 19115-3)

otherProperty

otherProperty [0..1] : ISORecord (=> ISO 19115-3)

bitsPerValue

bitsPerValue [0..1] : integer (=> ISO 19115-3)

Methods

Public methods

• ISOSampleDimension$new()

• ISOSampleDimension$setMaxValue()

• ISOSampleDimension$setMinValue()

• ISOSampleDimension$setUnits()

• ISOSampleDimension$setScaleFactor()

• ISOSampleDimension$setOffset()

• ISOSampleDimension$setMeanValue()

• ISOSampleDimension$setNumberOfValues()

• ISOSampleDimension$setStandardDeviation()

• ISOSampleDimension$setOtherPropertyType()

• ISOSampleDimension$setOtherProperty()

• ISOSampleDimension$setBitsPerValue()

• ISOSampleDimension$clone()

Inherited methods

• geometa::geometaLogger$ERROR()
• geometa::geometaLogger$INFO()
• geometa::geometaLogger$WARN()
• geometa::ISOAbstractObject$addFieldAttrs()
• geometa::ISOAbstractObject$addListElement()
• geometa::ISOAbstractObject$checkMetadataStandardCompliance()
• geometa::ISOAbstractObject$contains()
• geometa::ISOAbstractObject$createLocalisedProperty()
• geometa::ISOAbstractObject$decode()
• geometa::ISOAbstractObject$delListElement()
• geometa::ISOAbstractObject$encode()
• geometa::ISOAbstractObject$getClass()
• geometa::ISOAbstractObject$getClassName()
• geometa::ISOAbstractObject$getNamespaceDefinition()
• geometa::ISOAbstractObject$isDocument()
• geometa::ISOAbstractObject$isFieldInheritedFrom()
• geometa::ISOAbstractObject$print()
• geometa::ISOAbstractObject$save()
• geometa::ISOAbstractObject$setAttr()
• geometa::ISOAbstractObject$setCodeList()
• geometa::ISOAbstractObject$setCodeListValue()
• geometa::ISOAbstractObject$setCodeSpace()
• geometa::ISOAbstractObject$setHref()
• geometa::ISOAbstractObject$setId()
• geometa::ISOAbstractObject$setIsNull()
• geometa::ISOAbstractObject$setValue()
• geometa::ISOAbstractObject$stopIfMetadataStandardIsNot()
• geometa::ISOAbstractObject$validate()
• geometa::ISOAbstractObject$wrapBaseElement()
• geometa::ISORangeDimension$setDescription()
• geometa::ISORangeDimension$setDescriptor()
• geometa::ISORangeDimension$setName()
• geometa::ISORangeDimension$setSequenceIdentifier()

---

Method new()

Initializes object

Usage

ISOSampleDimension$new(xml = NULL)

Arguments

xml

object of class XMLInternalNode-class

---

Method setMaxValue()

Set max value

Usage

ISOSampleDimension$setMaxValue(maxValue)

Arguments

maxValue

max value, object of class numeric

---

Method setMinValue()

Set min value

Usage

ISOSampleDimension$setMinValue(minValue)

Arguments

minValue

min value, object of class numeric

---

Method setUnits()

Set unit definition

Usage

ISOSampleDimension$setUnits(uom)

Arguments

uom

object of class GMLUnitDefinition

---

Method setScaleFactor()

Set scale factor

Usage

ISOSampleDimension$setScaleFactor(scaleFactor)

Arguments

scaleFactor

object of class numeric

---

Method setOffset()

Set offset

Usage

ISOSampleDimension$setOffset(offset)

Arguments

offset

object of class numeric

---

Method setMeanValue()

Set mean value

Usage

ISOSampleDimension$setMeanValue(meanValue)

Arguments

meanValue

meanValue object of class numeric

---

Method setNumberOfValues()

Set number of values

Usage

ISOSampleDimension$setNumberOfValues(numberOfValues)

Arguments

numberOfValues

numberOfValues object of class integer

---

Method setStandardDeviation()

Set standard deviation

Usage

ISOSampleDimension$setStandardDeviation(standardDeviation)

Arguments

standardDeviation

standardDeviation object of class numeric$

---

Method setOtherPropertyType()

setOtherPropertyType

Usage

ISOSampleDimension$setOtherPropertyType(otherPropertyType)

Arguments

otherPropertyType

otherPropertyType object of class ISORecordType

---

Method setOtherProperty()

setOtherProperty

Usage

ISOSampleDimension$setOtherProperty(otherProperty)

Arguments

otherProperty

otherProperty object of class ISORecord

---

Method setBitsPerValue()

Set bits per value

Usage

ISOSampleDimension$setBitsPerValue(bitsPerValue)

Arguments

bitsPerValue

bitsPerValue object of class integer

---

Method clone()

The objects of this class are cloneable with this method.

Usage

ISOSampleDimension$clone(deep = FALSE)

Arguments

deep

Whether to make a deep clone.

Examples

# \dontrun{
   setMetadataStandard("19115-3")
   #create band range dimension
   md <- ISOSampleDimension$new()
   md$setSequenceIdentifier(ISOMemberName$new(aName = "name", attributeType = "type"))
   md$setDescriptor("descriptor")
#> Error in self$stopIfMetadataStandardIsNot("19139"): The method can't be used with current metadata standard '19115-3'
   md$setMaxValue(10)
   md$setMinValue(1)
   gml <- GMLBaseUnit$new(id = "ID")
   gml$setDescriptionReference("someref")
   gml$setIdentifier("identifier", "codespace")
   gml$addName("name1", "codespace")
#> [1] TRUE
   gml$addName("name2", "codespace")
#> [1] TRUE
   gml$setQuantityTypeReference("someref")
   gml$setCatalogSymbol("symbol")
   gml$setUnitsSystem("somelink")
   md$setUnits(gml)
   md$setScaleFactor(1)
   md$setOffset(4)
   xml <- md$encode()
#> [geometa][INFO] Object 'ISOSampleDimension' is VALID according to ISO 19115-3 XML schemas! 
   setMetadataStandard("19139")
 # }