ISOMedium: ISOMedium

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

ISOMedium

Description

ISOMedium

ISOMedium

Format

R6Class object.

Value

Object of R6Class for modelling an ISO Citation

Super classes

geometa::geometaLogger -> geometa::ISOAbstractObject -> ISOMedium

Public fields

name

name

density

density

densityUnits

density units

volumes

volumes

mediumFormat

medium format

mediumNote

medium note

Methods

Public methods

• ISOMedium$new()

• ISOMedium$setName()

• ISOMedium$addDensity()

• ISOMedium$delDensity()

• ISOMedium$setDensityUnits()

• ISOMedium$setVolumes()

• ISOMedium$addMediumFormat()

• ISOMedium$delMediumFormat()

• ISOMedium$setMediumNote()

• ISOMedium$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()

---

Method new()

Initializes object

Usage

ISOMedium$new(xml = NULL)

Arguments

xml

object of class XMLInternalNode-class

---

Method setName()

Set name

Usage

ISOMedium$setName(name)

Arguments

name

name object of class ISOMediumName or character among values returned by ISOMediumName$values()

---

Method addDensity()

Adds density

Usage

ISOMedium$addDensity(density)

Arguments

density

object of class numeric

Returns

TRUE if added, FALSE otherwise

---

Method delDensity()

Deletes density

Usage

ISOMedium$delDensity(density)

Arguments

density

object of class numeric

Returns

TRUE if deleted, FALSE otherwise

---

Method setDensityUnits()

Set density units

Usage

ISOMedium$setDensityUnits(densityUnits)

Arguments

densityUnits

densityUnits

---

Method setVolumes()

Set volumes

Usage

ISOMedium$setVolumes(volumes)

Arguments

volumes

object of class integer

---

Method addMediumFormat()

Adds medium format

Usage

ISOMedium$addMediumFormat(mediumFormat)

Arguments

mediumFormat

object of class ISOMediumFormat or character among values returned by ISOMediumFormat$values()

Returns

TRUE if added, FALSE otherwise

---

Method delMediumFormat()

Deletes medium format

Usage

ISOMedium$delMediumFormat(mediumFormat)

Arguments

mediumFormat

object of class ISOMediumFormat or character among values returned by ISOMediumFormat$values()

Returns

TRUE if deleted, FALSE otherwise

---

Method setMediumNote()

Set medium note

Usage

ISOMedium$setMediumNote(mediumNote, locales = NULL)

Arguments

mediumNote

medium note

locales

list of localized notes. Default is NULL

---

Method clone()

The objects of this class are cloneable with this method.

Usage

ISOMedium$clone(deep = FALSE)

Arguments

deep

Whether to make a deep clone.

Author(s)

Emmanuel Blondel <[e-mail]>

References

- ISO 19139 https://schemas.isotc211.org/19139/-/gmd/1.0/gmd/#element_MD_Medium

- ISO 19115-3 https://schemas.isotc211.org/19115/-3/mrd/1.0/mrd/#element_MD_Medium

Examples

 md <- ISOMedium$new()
 md$setName("satellite")
 md$addDensity(1.0)
 md$setDensityUnits("string")
 md$setVolumes(1L)
 md$addMediumFormat("tar")
 md$setMediumNote("some note")
 xml <- md$encode()
 

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