GMLConventionalUnit: GMLConventionalUnit

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

GMLConventionalUnit

Description

GMLConventionalUnit

GMLConventionalUnit

Format

R6Class object.

Value

Object of R6Class for modelling an GML derived unit

Super classes

geometa::geometaLogger -> geometa::ISOAbstractObject -> geometa::GMLAbstractObject -> geometa::GMLAbstractGML -> geometa::GMLDefinition -> geometa::GMLUnitDefinition -> GMLConventionalUnit

Public fields

conversionToPreferredUnit

conversionToPreferredUnit [1..1]: character/integer

roughConversionToPreferredUnit

roughConversionToPreferredUnit [1..1]: character/integer

derivationUnitTerm

derivationUnitTerm [1..*]: character

Methods

Public methods

• GMLConventionalUnit$new()

• GMLConventionalUnit$addDerivationUnitTerm()

• GMLConventionalUnit$delDerivationUnitTerm()

• GMLConventionalUnit$setConversionToPreferredUnit()

• GMLConventionalUnit$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::GMLAbstractGML$addName()
• geometa::GMLAbstractGML$delName()
• geometa::GMLAbstractGML$setDescription()
• geometa::GMLAbstractGML$setDescriptionReference()
• geometa::GMLAbstractGML$setIdentifier()
• geometa::GMLDefinition$addRemark()
• geometa::GMLDefinition$delRemark()
• geometa::GMLUnitDefinition$setCatalogSymbol()
• geometa::GMLUnitDefinition$setQuantityTypeReference()

---

Method new()

Initializes object

Usage

GMLConventionalUnit$new(xml = NULL, defaults = list(), id = NULL)

Arguments

xml

object of class XMLInternalNode-class

defaults

default values

id

id

---

Method addDerivationUnitTerm()

Adds a derivation unit term, made of a uom reference, and an exponent which can be negative/positive but not equal to zero.

Usage

GMLConventionalUnit$addDerivationUnitTerm(uom, exponent)

Arguments

uom

unit of measure reference

exponent

exponent

Returns

TRUE if added, FALSE otherwise

---

Method delDerivationUnitTerm()

Deletes a derivation unit term

Usage

GMLConventionalUnit$delDerivationUnitTerm(uom, exponent)

Arguments

uom

unit of measure reference

exponent

exponent

Returns

TRUE if deleted, FALSE otherwise

---

Method setConversionToPreferredUnit()

Sets the conversion to preferred unit.

Usage

GMLConventionalUnit$setConversionToPreferredUnit(uom, factor, rough = FALSE)

Arguments

uom

unit of measure reference

factor

factor

rough

rough . Defaut is FALSE

---

Method clone()

The objects of this class are cloneable with this method.

Usage

GMLConventionalUnit$clone(deep = FALSE)

Arguments

deep

Whether to make a deep clone.

Author(s)

Emmanuel Blondel <[e-mail]>

References

ISO 19136:2007 Geographic Information – Geographic Markup Language. http://www.iso.org/iso/iso_catalogue/catalogue_tc/catalogue_detail.htm?csnumber=32554

OGC Geography Markup Language. http://www.opengeospatial.org/standards/gml

Examples

   gml <- GMLConventionalUnit$new()
   gml$setDescriptionReference("someref")
   gml$setIdentifier("identifier", "codespace")
   gml$addName("name1", "codespace")
   gml$addName("name2", "codespace")
   gml$setQuantityTypeReference("someref")
   gml$setCatalogSymbol("symbol")
   gml$addDerivationUnitTerm("uomId", 2L)
   gml$setConversionToPreferredUnit("uomId", 2L)

eblondel/geometa documentation built on Oct. 10, 2024, 4:46 p.m.