<p>GMLTimePeriod</p>
<p>GMLTimePeriod</p>

GMLTimePeriod

Provides facilities to read, write and validate geographic metadata
defined with ISO TC211 / OGC ISO geographic information metadata standards, and
encoded using the ISO 19139 and ISO 19115-3 (XML) standard technical specifications.
This includes ISO 19110 (Feature cataloguing), 19115 (dataset metadata), 19119 (service metadata)
and 19136 (GML). Other interoperable schemas from the OGC are progressively supported
as well, such as the Sensor Web Enablement (SWE) Common Data Model, the OGC GML
Coverage Implementation Schema (GMLCOV), or the OGC GML Referenceable Grid (GMLRGRID).

Emmanuel Blondel

geometa

Tools for Reading and Writing ISO/OGC Geographic Metadata

GMLTimePeriod function

GMLTimePeriod — GMLTimePeriod

<p><code><a href='https://r6.r-lib.org/reference/R6Class.html'>R6Class</a></code> object.</p>

Format

<p>Emmanuel Blondel &lt;emmanuel.blondel1@gmail.com&gt;</p>

Author

<p><code>geometa::geometaLogger</code> -&gt; <code>geometa::ISOAbstractObject</code> -&gt; <code>geometa::GMLAbstractObject</code> -&gt; <code>geometa::GMLAbstractGML</code> -&gt; <code>geometa::GMLAbstractTimeObject</code> -&gt; <code>geometa::GMLAbstractTimePrimitive</code> -&gt; <code>geometa::GMLAbstractTimeGeometricPrimitive</code> -&gt; <code>GMLTimePeriod</code></p>

Super classes

<p><div class="r6-fields"></p><dl>
<dt><code>beginPosition</code></dt>
<dd><p>beginPosition [1]: 'POSIXct','POSIXt'</p></dd>


<dt><code>endPosition</code></dt>
<dd><p>endPosition [1]: 'POSIXct','POSIXt'</p></dd>


<dt><code>duration</code></dt>
<dd><p>duration [0..1]: character</p></dd>


</dl><p></div></p>

Public fields


<div class='section' id='public-methods'>
<h3>Public methods</h3>

<ul>
<li><p><a href='#method-GMLTimePeriod-new'><code>GMLTimePeriod$new()</code></a></p></li>
<li><p><a href='#method-GMLTimePeriod-setBeginPosition'><code>GMLTimePeriod$setBeginPosition()</code></a></p></li>
<li><p><a href='#method-GMLTimePeriod-setEndPosition'><code>GMLTimePeriod$setEndPosition()</code></a></p></li>
<li><p><a href='#method-GMLTimePeriod-computeInterval'><code>GMLTimePeriod$computeInterval()</code></a></p></li>
<li><p><a href='#method-GMLTimePeriod-setDuration'><code>GMLTimePeriod$setDuration()</code></a></p></li>
<li><p><a href='#method-GMLTimePeriod-clone'><code>GMLTimePeriod$clone()</code></a></p></li>
</ul>

</div><p><details><summary>Inherited methods</summary>
<ul>
<li><span class="pkg-link" data-pkg="geometa" data-topic="geometaLogger" data-id="ERROR"><a href='../../geometa/html/geometaLogger.html#method-geometaLogger-ERROR'><code>geometa::geometaLogger$ERROR()</code></a></span></li>
<li><span class="pkg-link" data-pkg="geometa" data-topic="geometaLogger" data-id="INFO"><a href='../../geometa/html/geometaLogger.html#method-geometaLogger-INFO'><code>geometa::geometaLogger$INFO()</code></a></span></li>
<li><span class="pkg-link" data-pkg="geometa" data-topic="geometaLogger" data-id="WARN"><a href='../../geometa/html/geometaLogger.html#method-geometaLogger-WARN'><code>geometa::geometaLogger$WARN()</code></a></span></li>
<li><span class="pkg-link" data-pkg="geometa" data-topic="ISOAbstractObject" data-id="addFieldAttrs"><a href='../../geometa/html/ISOAbstractObject.html#method-ISOAbstractObject-addFieldAttrs'><code>geometa::ISOAbstractObject$addFieldAttrs()</code></a></span></li>
<li><span class="pkg-link" data-pkg="geometa" data-topic="ISOAbstractObject" data-id="addListElement"><a href='../../geometa/html/ISOAbstractObject.html#method-ISOAbstractObject-addListElement'><code>geometa::ISOAbstractObject$addListElement()</code></a></span></li>
<li><span class="pkg-link" data-pkg="geometa" data-topic="ISOAbstractObject" data-id="checkMetadataStandardCompliance"><a href='../../geometa/html/ISOAbstractObject.html#method-ISOAbstractObject-checkMetadataStandardCompliance'><code>geometa::ISOAbstractObject$checkMetadataStandardCompliance()</code></a></span></li>
<li><span class="pkg-link" data-pkg="geometa" data-topic="ISOAbstractObject" data-id="contains"><a href='../../geometa/html/ISOAbstractObject.html#method-ISOAbstractObject-contains'><code>geometa::ISOAbstractObject$contains()</code></a></span></li>
<li><span class="pkg-link" data-pkg="geometa" data-topic="ISOAbstractObject" data-id="createLocalisedProperty"><a href='../../geometa/html/ISOAbstractObject.html#method-ISOAbstractObject-createLocalisedProperty'><code>geometa::ISOAbstractObject$createLocalisedProperty()</code></a></span></li>
<li><span class="pkg-link" data-pkg="geometa" data-topic="ISOAbstractObject" data-id="decode"><a href='../../geometa/html/ISOAbstractObject.html#method-ISOAbstractObject-decode'><code>geometa::ISOAbstractObject$decode()</code></a></span></li>
<li><span class="pkg-link" data-pkg="geometa" data-topic="ISOAbstractObject" data-id="delListElement"><a href='../../geometa/html/ISOAbstractObject.html#method-ISOAbstractObject-delListElement'><code>geometa::ISOAbstractObject$delListElement()</code></a></span></li>
<li><span class="pkg-link" data-pkg="geometa" data-topic="ISOAbstractObject" data-id="encode"><a href='../../geometa/html/ISOAbstractObject.html#method-ISOAbstractObject-encode'><code>geometa::ISOAbstractObject$encode()</code></a></span></li>
<li><span class="pkg-link" data-pkg="geometa" data-topic="ISOAbstractObject" data-id="getClass"><a href='../../geometa/html/ISOAbstractObject.html#method-ISOAbstractObject-getClass'><code>geometa::ISOAbstractObject$getClass()</code></a></span></li>
<li><span class="pkg-link" data-pkg="geometa" data-topic="ISOAbstractObject" data-id="getClassName"><a href='../../geometa/html/ISOAbstractObject.html#method-ISOAbstractObject-getClassName'><code>geometa::ISOAbstractObject$getClassName()</code></a></span></li>
<li><span class="pkg-link" data-pkg="geometa" data-topic="ISOAbstractObject" data-id="getNamespaceDefinition"><a href='../../geometa/html/ISOAbstractObject.html#method-ISOAbstractObject-getNamespaceDefinition'><code>geometa::ISOAbstractObject$getNamespaceDefinition()</code></a></span></li>
<li><span class="pkg-link" data-pkg="geometa" data-topic="ISOAbstractObject" data-id="isDocument"><a href='../../geometa/html/ISOAbstractObject.html#method-ISOAbstractObject-isDocument'><code>geometa::ISOAbstractObject$isDocument()</code></a></span></li>
<li><span class="pkg-link" data-pkg="geometa" data-topic="ISOAbstractObject" data-id="isFieldInheritedFrom"><a href='../../geometa/html/ISOAbstractObject.html#method-ISOAbstractObject-isFieldInheritedFrom'><code>geometa::ISOAbstractObject$isFieldInheritedFrom()</code></a></span></li>
<li><span class="pkg-link" data-pkg="geometa" data-topic="ISOAbstractObject" data-id="print"><a href='../../geometa/html/ISOAbstractObject.html#method-ISOAbstractObject-print'><code>geometa::ISOAbstractObject$print()</code></a></span></li>
<li><span class="pkg-link" data-pkg="geometa" data-topic="ISOAbstractObject" data-id="save"><a href='../../geometa/html/ISOAbstractObject.html#method-ISOAbstractObject-save'><code>geometa::ISOAbstractObject$save()</code></a></span></li>
<li><span class="pkg-link" data-pkg="geometa" data-topic="ISOAbstractObject" data-id="setAttr"><a href='../../geometa/html/ISOAbstractObject.html#method-ISOAbstractObject-setAttr'><code>geometa::ISOAbstractObject$setAttr()</code></a></span></li>
<li><span class="pkg-link" data-pkg="geometa" data-topic="ISOAbstractObject" data-id="setCodeList"><a href='../../geometa/html/ISOAbstractObject.html#method-ISOAbstractObject-setCodeList'><code>geometa::ISOAbstractObject$setCodeList()</code></a></span></li>
<li><span class="pkg-link" data-pkg="geometa" data-topic="ISOAbstractObject" data-id="setCodeListValue"><a href='../../geometa/html/ISOAbstractObject.html#method-ISOAbstractObject-setCodeListValue'><code>geometa::ISOAbstractObject$setCodeListValue()</code></a></span></li>
<li><span class="pkg-link" data-pkg="geometa" data-topic="ISOAbstractObject" data-id="setCodeSpace"><a href='../../geometa/html/ISOAbstractObject.html#method-ISOAbstractObject-setCodeSpace'><code>geometa::ISOAbstractObject$setCodeSpace()</code></a></span></li>
<li><span class="pkg-link" data-pkg="geometa" data-topic="ISOAbstractObject" data-id="setHref"><a href='../../geometa/html/ISOAbstractObject.html#method-ISOAbstractObject-setHref'><code>geometa::ISOAbstractObject$setHref()</code></a></span></li>
<li><span class="pkg-link" data-pkg="geometa" data-topic="ISOAbstractObject" data-id="setId"><a href='../../geometa/html/ISOAbstractObject.html#method-ISOAbstractObject-setId'><code>geometa::ISOAbstractObject$setId()</code></a></span></li>
<li><span class="pkg-link" data-pkg="geometa" data-topic="ISOAbstractObject" data-id="setIsNull"><a href='../../geometa/html/ISOAbstractObject.html#method-ISOAbstractObject-setIsNull'><code>geometa::ISOAbstractObject$setIsNull()</code></a></span></li>
<li><span class="pkg-link" data-pkg="geometa" data-topic="ISOAbstractObject" data-id="setValue"><a href='../../geometa/html/ISOAbstractObject.html#method-ISOAbstractObject-setValue'><code>geometa::ISOAbstractObject$setValue()</code></a></span></li>
<li><span class="pkg-link" data-pkg="geometa" data-topic="ISOAbstractObject" data-id="stopIfMetadataStandardIsNot"><a href='../../geometa/html/ISOAbstractObject.html#method-ISOAbstractObject-stopIfMetadataStandardIsNot'><code>geometa::ISOAbstractObject$stopIfMetadataStandardIsNot()</code></a></span></li>
<li><span class="pkg-link" data-pkg="geometa" data-topic="ISOAbstractObject" data-id="validate"><a href='../../geometa/html/ISOAbstractObject.html#method-ISOAbstractObject-validate'><code>geometa::ISOAbstractObject$validate()</code></a></span></li>
<li><span class="pkg-link" data-pkg="geometa" data-topic="ISOAbstractObject" data-id="wrapBaseElement"><a href='../../geometa/html/ISOAbstractObject.html#method-ISOAbstractObject-wrapBaseElement'><code>geometa::ISOAbstractObject$wrapBaseElement()</code></a></span></li>
<li><span class="pkg-link" data-pkg="geometa" data-topic="GMLAbstractGML" data-id="addName"><a href='../../geometa/html/GMLAbstractGML.html#method-GMLAbstractGML-addName'><code>geometa::GMLAbstractGML$addName()</code></a></span></li>
<li><span class="pkg-link" data-pkg="geometa" data-topic="GMLAbstractGML" data-id="delName"><a href='../../geometa/html/GMLAbstractGML.html#method-GMLAbstractGML-delName'><code>geometa::GMLAbstractGML$delName()</code></a></span></li>
<li><span class="pkg-link" data-pkg="geometa" data-topic="GMLAbstractGML" data-id="setDescription"><a href='../../geometa/html/GMLAbstractGML.html#method-GMLAbstractGML-setDescription'><code>geometa::GMLAbstractGML$setDescription()</code></a></span></li>
<li><span class="pkg-link" data-pkg="geometa" data-topic="GMLAbstractGML" data-id="setDescriptionReference"><a href='../../geometa/html/GMLAbstractGML.html#method-GMLAbstractGML-setDescriptionReference'><code>geometa::GMLAbstractGML$setDescriptionReference()</code></a></span></li>
<li><span class="pkg-link" data-pkg="geometa" data-topic="GMLAbstractGML" data-id="setIdentifier"><a href='../../geometa/html/GMLAbstractGML.html#method-GMLAbstractGML-setIdentifier'><code>geometa::GMLAbstractGML$setIdentifier()</code></a></span></li>
<li><span class="pkg-link" data-pkg="geometa" data-topic="GMLAbstractTimePrimitive" data-id="addRelatedTime"><a href='../../geometa/html/GMLAbstractTimePrimitive.html#method-GMLAbstractTimePrimitive-addRelatedTime'><code>geometa::GMLAbstractTimePrimitive$addRelatedTime()</code></a></span></li>
<li><span class="pkg-link" data-pkg="geometa" data-topic="GMLAbstractTimePrimitive" data-id="delRelatedTime"><a href='../../geometa/html/GMLAbstractTimePrimitive.html#method-GMLAbstractTimePrimitive-delRelatedTime'><code>geometa::GMLAbstractTimePrimitive$delRelatedTime()</code></a></span></li>
</ul>
</details>

<hr>
<a id="method-GMLTimePeriod-new"></a></p><div class='section' id='method-new-'>
<h3>Method <code>new()</code></h3>
<p>Initializes object</p><div class='section' id='usage'>
<h4>Usage</h4>
<p><div class="r"></p><pre><code>GMLTimePeriod$new(xml = NULL, beginPosition = NULL, endPosition = NULL)</code></pre><p></div></p>
</div>

<div class='section' id='arguments'>
<h4>Arguments</h4>
<p><div class="arguments"></p><dl>
<dt><code>xml</code></dt>
<dd><p>object of class <a href='https://rdrr.io/pkg/XML/man/XMLNode-class.html'>XMLInternalNode-class</a></p></dd>


<dt><code>beginPosition</code></dt>
<dd><p>object of class <a href='https://rdrr.io/r/base/numeric.html'>numeric</a>, <a href='https://rdrr.io/r/base/Dates.html'>Date</a> or POSIXct-class</p></dd>


<dt><code>endPosition</code></dt>
<dd><p>object of class <a href='https://rdrr.io/r/base/numeric.html'>numeric</a>, <a href='https://rdrr.io/r/base/Dates.html'>Date</a> or POSIXct-class</p></dd>


</dl><p></div></p>
</div>

</div><p><hr>
<a id="method-GMLTimePeriod-setBeginPosition"></a></p><div class='section' id='method-setbeginposition-'>
<h3>Method <code>setBeginPosition()</code></h3>
<p>Set begin position</p><div class='section' id='usage'>
<h4>Usage</h4>
<p><div class="r"></p><pre><code>GMLTimePeriod$setBeginPosition(
  beginPosition = NULL,
  frame = NULL,
  calendarEraName = NULL,
  indeterminatePosition = NULL
)</code></pre><p></div></p>
</div>

<div class='section' id='arguments'>
<h4>Arguments</h4>
<p><div class="arguments"></p><dl>
<dt><code>beginPosition</code></dt>
<dd><p>object of class <a href='https://rdrr.io/r/base/numeric.html'>numeric</a>, <a href='https://rdrr.io/r/base/Dates.html'>Date</a> or POSIXct-class</p></dd>


<dt><code>frame</code></dt>
<dd><p>frame attribute</p></dd>


<dt><code>calendarEraName</code></dt>
<dd><p>calendarEraName attribute</p></dd>


<dt><code>indeterminatePosition</code></dt>
<dd><p>indeterminatePosition attribute</p></dd>


</dl><p></div></p>
</div>

</div><p><hr>
<a id="method-GMLTimePeriod-setEndPosition"></a></p><div class='section' id='method-setendposition-'>
<h3>Method <code>setEndPosition()</code></h3>
<p>Set end position</p><div class='section' id='usage'>
<h4>Usage</h4>
<p><div class="r"></p><pre><code>GMLTimePeriod$setEndPosition(
  endPosition = NULL,
  frame = NULL,
  calendarEraName = NULL,
  indeterminatePosition = NULL
)</code></pre><p></div></p>
</div>

<div class='section' id='arguments'>
<h4>Arguments</h4>
<p><div class="arguments"></p><dl>
<dt><code>endPosition</code></dt>
<dd><p>object of class <a href='https://rdrr.io/r/base/numeric.html'>numeric</a>, <a href='https://rdrr.io/r/base/Dates.html'>Date</a> or POSIXct-class</p></dd>


<dt><code>frame</code></dt>
<dd><p>frame attribute</p></dd>


<dt><code>calendarEraName</code></dt>
<dd><p>calendarEraName attribute</p></dd>


<dt><code>indeterminatePosition</code></dt>
<dd><p>indeterminatePosition attribute</p></dd>


</dl><p></div></p>
</div>

</div><p><hr>
<a id="method-GMLTimePeriod-computeInterval"></a></p><div class='section' id='method-computeinterval-'>
<h3>Method <code>computeInterval()</code></h3>
<p>Compute interval (ISO defined duration) and set proper attribute for XML encoding. The
method calls the static function <code>GMLTimePeriod$computeISODuration</code></p><div class='section' id='usage'>
<h4>Usage</h4>
<p><div class="r"></p><pre><code>GMLTimePeriod$computeInterval()</code></pre><p></div></p>
</div>


</div><p><hr>
<a id="method-GMLTimePeriod-setDuration"></a></p><div class='section' id='method-setduration-'>
<h3>Method <code>setDuration()</code></h3>
<p>Set ISO duration</p><div class='section' id='usage'>
<h4>Usage</h4>
<p><div class="r"></p><pre><code>GMLTimePeriod$setDuration(
  years = 0,
  months = 0,
  days = 0,
  hours = 0,
  mins = 0,
  secs = 0
)</code></pre><p></div></p>
</div>

<div class='section' id='arguments'>
<h4>Arguments</h4>
<p><div class="arguments"></p><dl>
<dt><code>years</code></dt>
<dd><p>years</p></dd>


<dt><code>months</code></dt>
<dd><p>months</p></dd>


<dt><code>days</code></dt>
<dd><p>days</p></dd>


<dt><code>hours</code></dt>
<dd><p>hours</p></dd>


<dt><code>mins</code></dt>
<dd><p>mins</p></dd>


<dt><code>secs</code></dt>
<dd><p>secs</p></dd>


</dl><p></div></p>
</div>

</div><p><hr>
<a id="method-GMLTimePeriod-clone"></a></p><div class='section' id='method-clone-'>
<h3>Method <code>clone()</code></h3>
<p>The objects of this class are cloneable with this method.</p><div class='section' id='usage'>
<h4>Usage</h4>
<p><div class="r"></p><pre><code>GMLTimePeriod$clone(deep = FALSE)</code></pre><p></div></p>
</div>

<div class='section' id='arguments'>
<h4>Arguments</h4>
<p><div class="arguments"></p><dl>
<dt><code>deep</code></dt>
<dd><p>Whether to make a deep clone.</p></dd>


</dl><p></div></p>
</div>

</div>


GMLTimePeriod: GMLTimePeriod

Description

Arguments

Value

Examples