You cannot select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.

35443 lines
1.9 MiB
HTML

<!DOCTYPE html>
<html >
<head>
<meta charset="utf-8" />
<title>seiscomp.datamodel &#8212; SeisComP Release documentation</title>
<link rel="stylesheet" href="../_static/pygments.css" type="text/css" />
<link rel="stylesheet" href="../_static/seiscomp.css" type="text/css" />
<link rel="stylesheet" type="text/css" href="../_static/graphviz.css" />
<script type="text/javascript" src="../_static/seiscomp.js"></script>
<script type="text/javascript" id="documentation_options" data-url_root="../" src="../_static/documentation_options.js"></script>
<script src="../_static/jquery.js"></script>
<script src="../_static/underscore.js"></script>
<script src="../_static/doctools.js"></script>
<script src="../_static/language_data.js"></script>
<link rel="shortcut icon" href="../_static/favicon.ico"/>
<link rel="index" title="Index" href="../genindex.html" />
<link rel="search" title="Search" href="../search.html" />
<link rel="next" title="seiscomp.client" href="api-python-client.html" />
<link rel="prev" title="Packages" href="sdk-python-packages.html" />
</head>
<body>
<div class="header">
<div class="container">
<div class="brand">
<img class="logo" src="../_static/brands/seiscomp/text/white.svg"/>
<!-- span class="title">SeisComP Release</span -->
<span class="version">5.3.0</span>
</div>
</div>
</div>
<div class="nav">
<div class="container">
<div class="content"><a class="pull-right" id="sidebar-toggle">TOC</a>
<div class="related" role="navigation" aria-label="related navigation">
<ul>
<li class="right">
<a href="../genindex.html" title="General Index"
accesskey="I">
index
</a>
</li>
<li class="right">
<a href="api-python-client.html" title="seiscomp.client"
accesskey="N">
next
</a>
</li>
<li class="right">
<a href="sdk-python-packages.html" title="Packages"
accesskey="P">
previous
</a>
</li>
<li class="nav-item nav-item-0">
<a href="../index.html">Home</a>
</li>
<li class="nav-item nav-item-1">
<a href="sdk.html" >Software Development Kit</a>
</li>
<li class="nav-item nav-item-2">
<a href="sdk-python.html" >Python</a>
</li>
<li class="nav-item nav-item-3">
<a href="sdk-python-packages.html" accesskey="U">Packages</a>
</li>
</ul>
</div>
</div>
</div>
</div>
<div class="container">
<div class="fitted content" id="anchors-container">
<div class="body" role="main">
<div class="section" id="module-seiscomp.datamodel">
<span id="seiscomp-datamodel"></span><span id="api-datamodel-python"></span><h1>seiscomp.datamodel<a class="headerlink" href="#module-seiscomp.datamodel" title="Permalink to this headline"></a></h1>
<div class="section" id="base-objects">
<h2>Base Objects<a class="headerlink" href="#base-objects" title="Permalink to this headline"></a></h2>
<ul class="simple">
<li><p><a class="reference internal" href="#api-python-datamodel-object"><span class="std std-ref">Object</span></a></p></li>
<li><p><a class="reference internal" href="#api-python-datamodel-publicobject"><span class="std std-ref">PublicObject</span></a></p></li>
<li><p><a class="reference internal" href="#api-python-datamodel-notifier"><span class="std std-ref">Notifier</span></a></p></li>
</ul>
</div>
<div class="section" id="domain-overview">
<h2>Domain Overview<a class="headerlink" href="#domain-overview" title="Permalink to this headline"></a></h2>
<div class="section" id="eventparameters">
<h3>EventParameters<a class="headerlink" href="#eventparameters" title="Permalink to this headline"></a></h3>
<div class="figure align-center" id="id1">
<div class="graphviz"><object data="../_images/graphviz-250dcee77a7985c802bbe9707b6453e791a22fb8.svg" type="image/svg+xml" class="graphviz">
<p class="warning">digraph &quot;EventParameters hierarchy&quot; {
node [fontname=Verdana fontsize=8 shape=plaintext penwidth=0.5 style=&quot;rounded,filled&quot; fillcolor=&quot;#fcf2e3&quot; color=&quot;#000000&quot;]
edge [color=&quot;#000000&quot;]
layout=&quot;dot&quot;
Pick [label=&quot;Pick&quot;, href=&quot;../base/api-python.html#api-python-datamodel-pick&quot;, target=&quot;_top&quot;]
Comment [label=&quot;Comment&quot;, href=&quot;../base/api-python.html#api-python-datamodel-comment&quot;, target=&quot;_top&quot;]
Amplitude [label=&quot;Amplitude&quot;, href=&quot;../base/api-python.html#api-python-datamodel-amplitude&quot;, target=&quot;_top&quot;]
Reading [label=&quot;Reading&quot;, href=&quot;../base/api-python.html#api-python-datamodel-reading&quot;, target=&quot;_top&quot;]
PickReference [label=&quot;PickReference&quot;, href=&quot;../base/api-python.html#api-python-datamodel-pickreference&quot;, target=&quot;_top&quot;]
AmplitudeReference [label=&quot;AmplitudeReference&quot;, href=&quot;../base/api-python.html#api-python-datamodel-amplitudereference&quot;, target=&quot;_top&quot;]
Origin [label=&quot;Origin&quot;, href=&quot;../base/api-python.html#api-python-datamodel-origin&quot;, target=&quot;_top&quot;]
CompositeTime [label=&quot;CompositeTime&quot;, href=&quot;../base/api-python.html#api-python-datamodel-compositetime&quot;, target=&quot;_top&quot;]
Arrival [label=&quot;Arrival&quot;, href=&quot;../base/api-python.html#api-python-datamodel-arrival&quot;, target=&quot;_top&quot;]
StationMagnitude [label=&quot;StationMagnitude&quot;, href=&quot;../base/api-python.html#api-python-datamodel-stationmagnitude&quot;, target=&quot;_top&quot;]
Magnitude [label=&quot;Magnitude&quot;, href=&quot;../base/api-python.html#api-python-datamodel-magnitude&quot;, target=&quot;_top&quot;]
StationMagnitudeContribution [label=&quot;StationMagnitudeContribution&quot;, href=&quot;../base/api-python.html#api-python-datamodel-stationmagnitudecontribution&quot;, target=&quot;_top&quot;]
FocalMechanism [label=&quot;FocalMechanism&quot;, href=&quot;../base/api-python.html#api-python-datamodel-focalmechanism&quot;, target=&quot;_top&quot;]
MomentTensor [label=&quot;MomentTensor&quot;, href=&quot;../base/api-python.html#api-python-datamodel-momenttensor&quot;, target=&quot;_top&quot;]
DataUsed [label=&quot;DataUsed&quot;, href=&quot;../base/api-python.html#api-python-datamodel-dataused&quot;, target=&quot;_top&quot;]
MomentTensorPhaseSetting [label=&quot;MomentTensorPhaseSetting&quot;, href=&quot;../base/api-python.html#api-python-datamodel-momenttensorphasesetting&quot;, target=&quot;_top&quot;]
MomentTensorStationContribution [label=&quot;MomentTensorStationContribution&quot;, href=&quot;../base/api-python.html#api-python-datamodel-momenttensorstationcontribution&quot;, target=&quot;_top&quot;]
MomentTensorComponentContribution [label=&quot;MomentTensorComponentContribution&quot;, href=&quot;../base/api-python.html#api-python-datamodel-momenttensorcomponentcontribution&quot;, target=&quot;_top&quot;]
Event [label=&quot;Event&quot;, href=&quot;../base/api-python.html#api-python-datamodel-event&quot;, target=&quot;_top&quot;]
EventDescription [label=&quot;EventDescription&quot;, href=&quot;../base/api-python.html#api-python-datamodel-eventdescription&quot;, target=&quot;_top&quot;]
OriginReference [label=&quot;OriginReference&quot;, href=&quot;../base/api-python.html#api-python-datamodel-originreference&quot;, target=&quot;_top&quot;]
FocalMechanismReference [label=&quot;FocalMechanismReference&quot;, href=&quot;../base/api-python.html#api-python-datamodel-focalmechanismreference&quot;, target=&quot;_top&quot;]
EventParameters [label=&quot;EventParameters&quot;, href=&quot;../base/api-python.html#api-python-datamodel-eventparameters&quot;, target=&quot;_top&quot;]
EventParameters -&gt; Pick [dir=back arrowtail=diamond]
MomentTensor -&gt; Comment [dir=back arrowtail=diamond]
FocalMechanism -&gt; Comment [dir=back arrowtail=diamond]
Amplitude -&gt; Comment [dir=back arrowtail=diamond]
Magnitude -&gt; Comment [dir=back arrowtail=diamond]
StationMagnitude -&gt; Comment [dir=back arrowtail=diamond]
Pick -&gt; Comment [dir=back arrowtail=diamond]
Event -&gt; Comment [dir=back arrowtail=diamond]
Origin -&gt; Comment [dir=back arrowtail=diamond]
EventParameters -&gt; Amplitude [dir=back arrowtail=diamond]
EventParameters -&gt; Reading [dir=back arrowtail=diamond]
Reading -&gt; PickReference [dir=back arrowtail=diamond]
Reading -&gt; AmplitudeReference [dir=back arrowtail=diamond]
EventParameters -&gt; Origin [dir=back arrowtail=diamond]
Origin -&gt; CompositeTime [dir=back arrowtail=diamond]
Origin -&gt; Arrival [dir=back arrowtail=diamond]
Origin -&gt; StationMagnitude [dir=back arrowtail=diamond]
Origin -&gt; Magnitude [dir=back arrowtail=diamond]
Magnitude -&gt; StationMagnitudeContribution [dir=back arrowtail=diamond]
EventParameters -&gt; FocalMechanism [dir=back arrowtail=diamond]
FocalMechanism -&gt; MomentTensor [dir=back arrowtail=diamond]
MomentTensor -&gt; DataUsed [dir=back arrowtail=diamond]
MomentTensor -&gt; MomentTensorPhaseSetting [dir=back arrowtail=diamond]
MomentTensor -&gt; MomentTensorStationContribution [dir=back arrowtail=diamond]
MomentTensorStationContribution -&gt; MomentTensorComponentContribution [dir=back arrowtail=diamond]
EventParameters -&gt; Event [dir=back arrowtail=diamond]
Event -&gt; EventDescription [dir=back arrowtail=diamond]
Event -&gt; OriginReference [dir=back arrowtail=diamond]
Event -&gt; FocalMechanismReference [dir=back arrowtail=diamond]
}</p></object></div>
<p class="caption"><span class="caption-text">EventParameters object connections from parent to child.</span><a class="headerlink" href="#id1" title="Permalink to this image"></a></p>
</div>
<div class="figure align-center" id="id2">
<div class="graphviz"><object data="../_images/graphviz-b899a52f182d4d1f497e3e4f0b567bd0756b9df1.svg" type="image/svg+xml" class="graphviz">
<p class="warning">digraph &quot;EventParameters hierarchy&quot; {
node [fontname=Verdana fontsize=8 shape=plaintext penwidth=0.5 style=&quot;rounded,filled&quot; fillcolor=&quot;#fcf2e3&quot; color=&quot;#000000&quot;]
edge [color=&quot;#000000&quot;]
layout = &quot;dot&quot;
Pick [
labeltooltip = &quot;Pick&quot;
label = &lt;
&lt;table border=&quot;0&quot; cellpadding=&quot;0&quot; cellspacing=&quot;2&quot;&gt;
&lt;tr&gt;&lt;td&gt;Pick&lt;/td&gt;&lt;/tr&gt;
&lt;hr/&gt;
&lt;tr&gt;&lt;td&gt; &lt;/td&gt;&lt;/tr&gt;
&lt;tr&gt;&lt;td align=&quot;left&quot; port=&quot;publicID&quot;&gt;&lt;font color=&quot;#8b0000&quot;&gt;+ publicID: string&lt;/font&gt;&lt;/td&gt;&lt;/tr&gt;
&lt;tr&gt;&lt;td align=&quot;left&quot; port=&quot;time&quot;&gt;&lt;font color=&quot;#8b0000&quot;&gt;+ time: TimeQuantity&lt;/font&gt;&lt;/td&gt;&lt;/tr&gt;
&lt;tr&gt;&lt;td align=&quot;left&quot; port=&quot;waveformID&quot;&gt;&lt;font color=&quot;#8b0000&quot;&gt;+ waveformID: WaveformStreamID&lt;/font&gt;&lt;/td&gt;&lt;/tr&gt;
&lt;tr&gt;&lt;td align=&quot;left&quot; port=&quot;filterID&quot;&gt;&lt;font color=&quot;#8b0000&quot;&gt;+ filterID: string&lt;/font&gt;&lt;/td&gt;&lt;/tr&gt;
&lt;tr&gt;&lt;td align=&quot;left&quot; port=&quot;methodID&quot;&gt;&lt;font color=&quot;#8b0000&quot;&gt;+ methodID: string&lt;/font&gt;&lt;/td&gt;&lt;/tr&gt;
&lt;tr&gt;&lt;td align=&quot;left&quot; port=&quot;horizontalSlowness&quot;&gt;&lt;font color=&quot;#8b0000&quot;&gt;+ horizontalSlowness: RealQuantity [0..1]&lt;/font&gt;&lt;/td&gt;&lt;/tr&gt;
&lt;tr&gt;&lt;td align=&quot;left&quot; port=&quot;backazimuth&quot;&gt;&lt;font color=&quot;#8b0000&quot;&gt;+ backazimuth: RealQuantity [0..1]&lt;/font&gt;&lt;/td&gt;&lt;/tr&gt;
&lt;tr&gt;&lt;td align=&quot;left&quot; port=&quot;slownessMethodID&quot;&gt;&lt;font color=&quot;#8b0000&quot;&gt;+ slownessMethodID: string&lt;/font&gt;&lt;/td&gt;&lt;/tr&gt;
&lt;tr&gt;&lt;td align=&quot;left&quot; port=&quot;onset&quot;&gt;&lt;font color=&quot;#8b0000&quot;&gt;+ onset: PickOnset [0..1]&lt;/font&gt;&lt;/td&gt;&lt;/tr&gt;
&lt;tr&gt;&lt;td align=&quot;left&quot; port=&quot;phaseHint&quot;&gt;&lt;font color=&quot;#8b0000&quot;&gt;+ phaseHint: Phase [0..1]&lt;/font&gt;&lt;/td&gt;&lt;/tr&gt;
&lt;tr&gt;&lt;td align=&quot;left&quot; port=&quot;polarity&quot;&gt;&lt;font color=&quot;#8b0000&quot;&gt;+ polarity: PickPolarity [0..1]&lt;/font&gt;&lt;/td&gt;&lt;/tr&gt;
&lt;tr&gt;&lt;td align=&quot;left&quot; port=&quot;evaluationMode&quot;&gt;&lt;font color=&quot;#8b0000&quot;&gt;+ evaluationMode: EvaluationMode [0..1]&lt;/font&gt;&lt;/td&gt;&lt;/tr&gt;
&lt;tr&gt;&lt;td align=&quot;left&quot; port=&quot;evaluationStatus&quot;&gt;&lt;font color=&quot;#8b0000&quot;&gt;+ evaluationStatus: EvaluationStatus [0..1]&lt;/font&gt;&lt;/td&gt;&lt;/tr&gt;
&lt;tr&gt;&lt;td align=&quot;left&quot; port=&quot;creationInfo&quot;&gt;&lt;font color=&quot;#8b0000&quot;&gt;+ creationInfo: CreationInfo [0..1]&lt;/font&gt;&lt;/td&gt;&lt;/tr&gt;
&lt;tr&gt;&lt;td align=&quot;left&quot;&gt;&lt;font color=&quot;#8b0000&quot;&gt;+ comment: Comment [0..*]&lt;/font&gt;&lt;/td&gt;&lt;/tr&gt;
&lt;/table&gt;
&gt;
href = &quot;../base/api-python.html#api-python-datamodel-pick&quot;
target = &quot;_top&quot;
]
Comment [
labeltooltip = &quot;Comment&quot;
label = &lt;
&lt;table border=&quot;0&quot; cellpadding=&quot;0&quot; cellspacing=&quot;2&quot;&gt;
&lt;tr&gt;&lt;td&gt;Comment&lt;/td&gt;&lt;/tr&gt;
&lt;hr/&gt;
&lt;tr&gt;&lt;td&gt; &lt;/td&gt;&lt;/tr&gt;
&lt;tr&gt;&lt;td align=&quot;left&quot; port=&quot;text&quot;&gt;&lt;font color=&quot;#8b0000&quot;&gt;+ text: string&lt;/font&gt;&lt;/td&gt;&lt;/tr&gt;
&lt;tr&gt;&lt;td align=&quot;left&quot; port=&quot;id&quot;&gt;&lt;font color=&quot;#8b0000&quot;&gt;+ id: string&lt;/font&gt;&lt;/td&gt;&lt;/tr&gt;
&lt;tr&gt;&lt;td align=&quot;left&quot; port=&quot;start&quot;&gt;&lt;font color=&quot;#8b0000&quot;&gt;+ start: datetime [0..1]&lt;/font&gt;&lt;/td&gt;&lt;/tr&gt;
&lt;tr&gt;&lt;td align=&quot;left&quot; port=&quot;end&quot;&gt;&lt;font color=&quot;#8b0000&quot;&gt;+ end: datetime [0..1]&lt;/font&gt;&lt;/td&gt;&lt;/tr&gt;
&lt;tr&gt;&lt;td align=&quot;left&quot; port=&quot;creationInfo&quot;&gt;&lt;font color=&quot;#8b0000&quot;&gt;+ creationInfo: CreationInfo [0..1]&lt;/font&gt;&lt;/td&gt;&lt;/tr&gt;
&lt;/table&gt;
&gt;
href = &quot;../base/api-python.html#api-python-datamodel-comment&quot;
target = &quot;_top&quot;
]
Amplitude [
labeltooltip = &quot;Amplitude&quot;
label = &lt;
&lt;table border=&quot;0&quot; cellpadding=&quot;0&quot; cellspacing=&quot;2&quot;&gt;
&lt;tr&gt;&lt;td&gt;Amplitude&lt;/td&gt;&lt;/tr&gt;
&lt;hr/&gt;
&lt;tr&gt;&lt;td&gt; &lt;/td&gt;&lt;/tr&gt;
&lt;tr&gt;&lt;td align=&quot;left&quot; port=&quot;publicID&quot;&gt;&lt;font color=&quot;#8b0000&quot;&gt;+ publicID: string&lt;/font&gt;&lt;/td&gt;&lt;/tr&gt;
&lt;tr&gt;&lt;td align=&quot;left&quot; port=&quot;type&quot;&gt;&lt;font color=&quot;#8b0000&quot;&gt;+ type: string&lt;/font&gt;&lt;/td&gt;&lt;/tr&gt;
&lt;tr&gt;&lt;td align=&quot;left&quot; port=&quot;amplitude&quot;&gt;&lt;font color=&quot;#8b0000&quot;&gt;+ amplitude: RealQuantity [0..1]&lt;/font&gt;&lt;/td&gt;&lt;/tr&gt;
&lt;tr&gt;&lt;td align=&quot;left&quot; port=&quot;timeWindow&quot;&gt;&lt;font color=&quot;#8b0000&quot;&gt;+ timeWindow: TimeWindow [0..1]&lt;/font&gt;&lt;/td&gt;&lt;/tr&gt;
&lt;tr&gt;&lt;td align=&quot;left&quot; port=&quot;period&quot;&gt;&lt;font color=&quot;#8b0000&quot;&gt;+ period: RealQuantity [0..1]&lt;/font&gt;&lt;/td&gt;&lt;/tr&gt;
&lt;tr&gt;&lt;td align=&quot;left&quot; port=&quot;snr&quot;&gt;&lt;font color=&quot;#8b0000&quot;&gt;+ snr: float [0..1]&lt;/font&gt;&lt;/td&gt;&lt;/tr&gt;
&lt;tr&gt;&lt;td align=&quot;left&quot; port=&quot;unit&quot;&gt;&lt;font color=&quot;#8b0000&quot;&gt;+ unit: string&lt;/font&gt;&lt;/td&gt;&lt;/tr&gt;
&lt;tr&gt;&lt;td align=&quot;left&quot; port=&quot;pickID&quot;&gt;&lt;font color=&quot;#8b0000&quot;&gt;+ pickID: string&lt;/font&gt;&lt;/td&gt;&lt;/tr&gt;
&lt;tr&gt;&lt;td align=&quot;left&quot; port=&quot;waveformID&quot;&gt;&lt;font color=&quot;#8b0000&quot;&gt;+ waveformID: WaveformStreamID [0..1]&lt;/font&gt;&lt;/td&gt;&lt;/tr&gt;
&lt;tr&gt;&lt;td align=&quot;left&quot; port=&quot;filterID&quot;&gt;&lt;font color=&quot;#8b0000&quot;&gt;+ filterID: string&lt;/font&gt;&lt;/td&gt;&lt;/tr&gt;
&lt;tr&gt;&lt;td align=&quot;left&quot; port=&quot;methodID&quot;&gt;&lt;font color=&quot;#8b0000&quot;&gt;+ methodID: string&lt;/font&gt;&lt;/td&gt;&lt;/tr&gt;
&lt;tr&gt;&lt;td align=&quot;left&quot; port=&quot;scalingTime&quot;&gt;&lt;font color=&quot;#8b0000&quot;&gt;+ scalingTime: TimeQuantity [0..1]&lt;/font&gt;&lt;/td&gt;&lt;/tr&gt;
&lt;tr&gt;&lt;td align=&quot;left&quot; port=&quot;magnitudeHint&quot;&gt;&lt;font color=&quot;#8b0000&quot;&gt;+ magnitudeHint: string&lt;/font&gt;&lt;/td&gt;&lt;/tr&gt;
&lt;tr&gt;&lt;td align=&quot;left&quot; port=&quot;evaluationMode&quot;&gt;&lt;font color=&quot;#8b0000&quot;&gt;+ evaluationMode: EvaluationMode [0..1]&lt;/font&gt;&lt;/td&gt;&lt;/tr&gt;
&lt;tr&gt;&lt;td align=&quot;left&quot; port=&quot;creationInfo&quot;&gt;&lt;font color=&quot;#8b0000&quot;&gt;+ creationInfo: CreationInfo [0..1]&lt;/font&gt;&lt;/td&gt;&lt;/tr&gt;
&lt;tr&gt;&lt;td align=&quot;left&quot;&gt;&lt;font color=&quot;#8b0000&quot;&gt;+ comment: Comment [0..*]&lt;/font&gt;&lt;/td&gt;&lt;/tr&gt;
&lt;/table&gt;
&gt;
href = &quot;../base/api-python.html#api-python-datamodel-amplitude&quot;
target = &quot;_top&quot;
]
Reading [
labeltooltip = &quot;Reading&quot;
label = &lt;
&lt;table border=&quot;0&quot; cellpadding=&quot;0&quot; cellspacing=&quot;2&quot;&gt;
&lt;tr&gt;&lt;td&gt;Reading&lt;/td&gt;&lt;/tr&gt;
&lt;hr/&gt;
&lt;tr&gt;&lt;td&gt; &lt;/td&gt;&lt;/tr&gt;
&lt;tr&gt;&lt;td align=&quot;left&quot; port=&quot;publicID&quot;&gt;&lt;font color=&quot;#8b0000&quot;&gt;+ publicID: string&lt;/font&gt;&lt;/td&gt;&lt;/tr&gt;
&lt;tr&gt;&lt;td align=&quot;left&quot;&gt;&lt;font color=&quot;#8b0000&quot;&gt;+ pickReference: PickReference [0..*]&lt;/font&gt;&lt;/td&gt;&lt;/tr&gt;
&lt;tr&gt;&lt;td align=&quot;left&quot;&gt;&lt;font color=&quot;#8b0000&quot;&gt;+ amplitudeReference: AmplitudeReference [0..*]&lt;/font&gt;&lt;/td&gt;&lt;/tr&gt;
&lt;/table&gt;
&gt;
href = &quot;../base/api-python.html#api-python-datamodel-reading&quot;
target = &quot;_top&quot;
]
PickReference [
labeltooltip = &quot;PickReference&quot;
label = &lt;
&lt;table border=&quot;0&quot; cellpadding=&quot;0&quot; cellspacing=&quot;2&quot;&gt;
&lt;tr&gt;&lt;td&gt;PickReference&lt;/td&gt;&lt;/tr&gt;
&lt;hr/&gt;
&lt;tr&gt;&lt;td&gt; &lt;/td&gt;&lt;/tr&gt;
&lt;tr&gt;&lt;td align=&quot;left&quot; port=&quot;pickID&quot;&gt;&lt;font color=&quot;#8b0000&quot;&gt;+ pickID: string&lt;/font&gt;&lt;/td&gt;&lt;/tr&gt;
&lt;/table&gt;
&gt;
href = &quot;../base/api-python.html#api-python-datamodel-pickreference&quot;
target = &quot;_top&quot;
]
AmplitudeReference [
labeltooltip = &quot;AmplitudeReference&quot;
label = &lt;
&lt;table border=&quot;0&quot; cellpadding=&quot;0&quot; cellspacing=&quot;2&quot;&gt;
&lt;tr&gt;&lt;td&gt;AmplitudeReference&lt;/td&gt;&lt;/tr&gt;
&lt;hr/&gt;
&lt;tr&gt;&lt;td&gt; &lt;/td&gt;&lt;/tr&gt;
&lt;tr&gt;&lt;td align=&quot;left&quot; port=&quot;amplitudeID&quot;&gt;&lt;font color=&quot;#8b0000&quot;&gt;+ amplitudeID: string&lt;/font&gt;&lt;/td&gt;&lt;/tr&gt;
&lt;/table&gt;
&gt;
href = &quot;../base/api-python.html#api-python-datamodel-amplitudereference&quot;
target = &quot;_top&quot;
]
Origin [
labeltooltip = &quot;Origin&quot;
label = &lt;
&lt;table border=&quot;0&quot; cellpadding=&quot;0&quot; cellspacing=&quot;2&quot;&gt;
&lt;tr&gt;&lt;td&gt;Origin&lt;/td&gt;&lt;/tr&gt;
&lt;hr/&gt;
&lt;tr&gt;&lt;td&gt; &lt;/td&gt;&lt;/tr&gt;
&lt;tr&gt;&lt;td align=&quot;left&quot; port=&quot;publicID&quot;&gt;&lt;font color=&quot;#8b0000&quot;&gt;+ publicID: string&lt;/font&gt;&lt;/td&gt;&lt;/tr&gt;
&lt;tr&gt;&lt;td align=&quot;left&quot; port=&quot;time&quot;&gt;&lt;font color=&quot;#8b0000&quot;&gt;+ time: TimeQuantity&lt;/font&gt;&lt;/td&gt;&lt;/tr&gt;
&lt;tr&gt;&lt;td align=&quot;left&quot; port=&quot;latitude&quot;&gt;&lt;font color=&quot;#8b0000&quot;&gt;+ latitude: RealQuantity&lt;/font&gt;&lt;/td&gt;&lt;/tr&gt;
&lt;tr&gt;&lt;td align=&quot;left&quot; port=&quot;longitude&quot;&gt;&lt;font color=&quot;#8b0000&quot;&gt;+ longitude: RealQuantity&lt;/font&gt;&lt;/td&gt;&lt;/tr&gt;
&lt;tr&gt;&lt;td align=&quot;left&quot; port=&quot;depth&quot;&gt;&lt;font color=&quot;#8b0000&quot;&gt;+ depth: RealQuantity [0..1]&lt;/font&gt;&lt;/td&gt;&lt;/tr&gt;
&lt;tr&gt;&lt;td align=&quot;left&quot; port=&quot;depthType&quot;&gt;&lt;font color=&quot;#8b0000&quot;&gt;+ depthType: OriginDepthType [0..1]&lt;/font&gt;&lt;/td&gt;&lt;/tr&gt;
&lt;tr&gt;&lt;td align=&quot;left&quot; port=&quot;timeFixed&quot;&gt;&lt;font color=&quot;#8b0000&quot;&gt;+ timeFixed: boolean [0..1]&lt;/font&gt;&lt;/td&gt;&lt;/tr&gt;
&lt;tr&gt;&lt;td align=&quot;left&quot; port=&quot;epicenterFixed&quot;&gt;&lt;font color=&quot;#8b0000&quot;&gt;+ epicenterFixed: boolean [0..1]&lt;/font&gt;&lt;/td&gt;&lt;/tr&gt;
&lt;tr&gt;&lt;td align=&quot;left&quot; port=&quot;referenceSystemID&quot;&gt;&lt;font color=&quot;#8b0000&quot;&gt;+ referenceSystemID: string&lt;/font&gt;&lt;/td&gt;&lt;/tr&gt;
&lt;tr&gt;&lt;td align=&quot;left&quot; port=&quot;methodID&quot;&gt;&lt;font color=&quot;#8b0000&quot;&gt;+ methodID: string&lt;/font&gt;&lt;/td&gt;&lt;/tr&gt;
&lt;tr&gt;&lt;td align=&quot;left&quot; port=&quot;earthModelID&quot;&gt;&lt;font color=&quot;#8b0000&quot;&gt;+ earthModelID: string&lt;/font&gt;&lt;/td&gt;&lt;/tr&gt;
&lt;tr&gt;&lt;td align=&quot;left&quot; port=&quot;quality&quot;&gt;&lt;font color=&quot;#8b0000&quot;&gt;+ quality: OriginQuality [0..1]&lt;/font&gt;&lt;/td&gt;&lt;/tr&gt;
&lt;tr&gt;&lt;td align=&quot;left&quot; port=&quot;uncertainty&quot;&gt;&lt;font color=&quot;#8b0000&quot;&gt;+ uncertainty: OriginUncertainty [0..1]&lt;/font&gt;&lt;/td&gt;&lt;/tr&gt;
&lt;tr&gt;&lt;td align=&quot;left&quot; port=&quot;type&quot;&gt;&lt;font color=&quot;#8b0000&quot;&gt;+ type: OriginType [0..1]&lt;/font&gt;&lt;/td&gt;&lt;/tr&gt;
&lt;tr&gt;&lt;td align=&quot;left&quot; port=&quot;evaluationMode&quot;&gt;&lt;font color=&quot;#8b0000&quot;&gt;+ evaluationMode: EvaluationMode [0..1]&lt;/font&gt;&lt;/td&gt;&lt;/tr&gt;
&lt;tr&gt;&lt;td align=&quot;left&quot; port=&quot;evaluationStatus&quot;&gt;&lt;font color=&quot;#8b0000&quot;&gt;+ evaluationStatus: EvaluationStatus [0..1]&lt;/font&gt;&lt;/td&gt;&lt;/tr&gt;
&lt;tr&gt;&lt;td align=&quot;left&quot; port=&quot;creationInfo&quot;&gt;&lt;font color=&quot;#8b0000&quot;&gt;+ creationInfo: CreationInfo [0..1]&lt;/font&gt;&lt;/td&gt;&lt;/tr&gt;
&lt;tr&gt;&lt;td align=&quot;left&quot;&gt;&lt;font color=&quot;#8b0000&quot;&gt;+ comment: Comment [0..*]&lt;/font&gt;&lt;/td&gt;&lt;/tr&gt;
&lt;tr&gt;&lt;td align=&quot;left&quot;&gt;&lt;font color=&quot;#8b0000&quot;&gt;+ compositeTime: CompositeTime [0..*]&lt;/font&gt;&lt;/td&gt;&lt;/tr&gt;
&lt;tr&gt;&lt;td align=&quot;left&quot;&gt;&lt;font color=&quot;#8b0000&quot;&gt;+ arrival: Arrival [0..*]&lt;/font&gt;&lt;/td&gt;&lt;/tr&gt;
&lt;tr&gt;&lt;td align=&quot;left&quot;&gt;&lt;font color=&quot;#8b0000&quot;&gt;+ stationMagnitude: StationMagnitude [0..*]&lt;/font&gt;&lt;/td&gt;&lt;/tr&gt;
&lt;tr&gt;&lt;td align=&quot;left&quot;&gt;&lt;font color=&quot;#8b0000&quot;&gt;+ magnitude: Magnitude [0..*]&lt;/font&gt;&lt;/td&gt;&lt;/tr&gt;
&lt;/table&gt;
&gt;
href = &quot;../base/api-python.html#api-python-datamodel-origin&quot;
target = &quot;_top&quot;
]
CompositeTime [
labeltooltip = &quot;CompositeTime&quot;
label = &lt;
&lt;table border=&quot;0&quot; cellpadding=&quot;0&quot; cellspacing=&quot;2&quot;&gt;
&lt;tr&gt;&lt;td&gt;CompositeTime&lt;/td&gt;&lt;/tr&gt;
&lt;hr/&gt;
&lt;tr&gt;&lt;td&gt; &lt;/td&gt;&lt;/tr&gt;
&lt;tr&gt;&lt;td align=&quot;left&quot; port=&quot;year&quot;&gt;&lt;font color=&quot;#8b0000&quot;&gt;+ year: IntegerQuantity [0..1]&lt;/font&gt;&lt;/td&gt;&lt;/tr&gt;
&lt;tr&gt;&lt;td align=&quot;left&quot; port=&quot;month&quot;&gt;&lt;font color=&quot;#8b0000&quot;&gt;+ month: IntegerQuantity [0..1]&lt;/font&gt;&lt;/td&gt;&lt;/tr&gt;
&lt;tr&gt;&lt;td align=&quot;left&quot; port=&quot;day&quot;&gt;&lt;font color=&quot;#8b0000&quot;&gt;+ day: IntegerQuantity [0..1]&lt;/font&gt;&lt;/td&gt;&lt;/tr&gt;
&lt;tr&gt;&lt;td align=&quot;left&quot; port=&quot;hour&quot;&gt;&lt;font color=&quot;#8b0000&quot;&gt;+ hour: IntegerQuantity [0..1]&lt;/font&gt;&lt;/td&gt;&lt;/tr&gt;
&lt;tr&gt;&lt;td align=&quot;left&quot; port=&quot;minute&quot;&gt;&lt;font color=&quot;#8b0000&quot;&gt;+ minute: IntegerQuantity [0..1]&lt;/font&gt;&lt;/td&gt;&lt;/tr&gt;
&lt;tr&gt;&lt;td align=&quot;left&quot; port=&quot;second&quot;&gt;&lt;font color=&quot;#8b0000&quot;&gt;+ second: RealQuantity [0..1]&lt;/font&gt;&lt;/td&gt;&lt;/tr&gt;
&lt;/table&gt;
&gt;
href = &quot;../base/api-python.html#api-python-datamodel-compositetime&quot;
target = &quot;_top&quot;
]
Arrival [
labeltooltip = &quot;Arrival&quot;
label = &lt;
&lt;table border=&quot;0&quot; cellpadding=&quot;0&quot; cellspacing=&quot;2&quot;&gt;
&lt;tr&gt;&lt;td&gt;Arrival&lt;/td&gt;&lt;/tr&gt;
&lt;hr/&gt;
&lt;tr&gt;&lt;td&gt; &lt;/td&gt;&lt;/tr&gt;
&lt;tr&gt;&lt;td align=&quot;left&quot; port=&quot;pickID&quot;&gt;&lt;font color=&quot;#8b0000&quot;&gt;+ pickID: string&lt;/font&gt;&lt;/td&gt;&lt;/tr&gt;
&lt;tr&gt;&lt;td align=&quot;left&quot; port=&quot;phase&quot;&gt;&lt;font color=&quot;#8b0000&quot;&gt;+ phase: Phase&lt;/font&gt;&lt;/td&gt;&lt;/tr&gt;
&lt;tr&gt;&lt;td align=&quot;left&quot; port=&quot;timeCorrection&quot;&gt;&lt;font color=&quot;#8b0000&quot;&gt;+ timeCorrection: float [0..1]&lt;/font&gt;&lt;/td&gt;&lt;/tr&gt;
&lt;tr&gt;&lt;td align=&quot;left&quot; port=&quot;azimuth&quot;&gt;&lt;font color=&quot;#8b0000&quot;&gt;+ azimuth: float [0..1]&lt;/font&gt;&lt;/td&gt;&lt;/tr&gt;
&lt;tr&gt;&lt;td align=&quot;left&quot; port=&quot;distance&quot;&gt;&lt;font color=&quot;#8b0000&quot;&gt;+ distance: float [0..1]&lt;/font&gt;&lt;/td&gt;&lt;/tr&gt;
&lt;tr&gt;&lt;td align=&quot;left&quot; port=&quot;takeOffAngle&quot;&gt;&lt;font color=&quot;#8b0000&quot;&gt;+ takeOffAngle: float [0..1]&lt;/font&gt;&lt;/td&gt;&lt;/tr&gt;
&lt;tr&gt;&lt;td align=&quot;left&quot; port=&quot;timeResidual&quot;&gt;&lt;font color=&quot;#8b0000&quot;&gt;+ timeResidual: float [0..1]&lt;/font&gt;&lt;/td&gt;&lt;/tr&gt;
&lt;tr&gt;&lt;td align=&quot;left&quot; port=&quot;horizontalSlownessResidual&quot;&gt;&lt;font color=&quot;#8b0000&quot;&gt;+ horizontalSlownessResidual: float [0..1]&lt;/font&gt;&lt;/td&gt;&lt;/tr&gt;
&lt;tr&gt;&lt;td align=&quot;left&quot; port=&quot;backazimuthResidual&quot;&gt;&lt;font color=&quot;#8b0000&quot;&gt;+ backazimuthResidual: float [0..1]&lt;/font&gt;&lt;/td&gt;&lt;/tr&gt;
&lt;tr&gt;&lt;td align=&quot;left&quot; port=&quot;timeUsed&quot;&gt;&lt;font color=&quot;#8b0000&quot;&gt;+ timeUsed: boolean [0..1]&lt;/font&gt;&lt;/td&gt;&lt;/tr&gt;
&lt;tr&gt;&lt;td align=&quot;left&quot; port=&quot;horizontalSlownessUsed&quot;&gt;&lt;font color=&quot;#8b0000&quot;&gt;+ horizontalSlownessUsed: boolean [0..1]&lt;/font&gt;&lt;/td&gt;&lt;/tr&gt;
&lt;tr&gt;&lt;td align=&quot;left&quot; port=&quot;backazimuthUsed&quot;&gt;&lt;font color=&quot;#8b0000&quot;&gt;+ backazimuthUsed: boolean [0..1]&lt;/font&gt;&lt;/td&gt;&lt;/tr&gt;
&lt;tr&gt;&lt;td align=&quot;left&quot; port=&quot;weight&quot;&gt;&lt;font color=&quot;#8b0000&quot;&gt;+ weight: float [0..1]&lt;/font&gt;&lt;/td&gt;&lt;/tr&gt;
&lt;tr&gt;&lt;td align=&quot;left&quot; port=&quot;earthModelID&quot;&gt;&lt;font color=&quot;#8b0000&quot;&gt;+ earthModelID: string&lt;/font&gt;&lt;/td&gt;&lt;/tr&gt;
&lt;tr&gt;&lt;td align=&quot;left&quot; port=&quot;preliminary&quot;&gt;&lt;font color=&quot;#8b0000&quot;&gt;+ preliminary: boolean [0..1]&lt;/font&gt;&lt;/td&gt;&lt;/tr&gt;
&lt;tr&gt;&lt;td align=&quot;left&quot; port=&quot;creationInfo&quot;&gt;&lt;font color=&quot;#8b0000&quot;&gt;+ creationInfo: CreationInfo [0..1]&lt;/font&gt;&lt;/td&gt;&lt;/tr&gt;
&lt;/table&gt;
&gt;
href = &quot;../base/api-python.html#api-python-datamodel-arrival&quot;
target = &quot;_top&quot;
]
StationMagnitude [
labeltooltip = &quot;StationMagnitude&quot;
label = &lt;
&lt;table border=&quot;0&quot; cellpadding=&quot;0&quot; cellspacing=&quot;2&quot;&gt;
&lt;tr&gt;&lt;td&gt;StationMagnitude&lt;/td&gt;&lt;/tr&gt;
&lt;hr/&gt;
&lt;tr&gt;&lt;td&gt; &lt;/td&gt;&lt;/tr&gt;
&lt;tr&gt;&lt;td align=&quot;left&quot; port=&quot;publicID&quot;&gt;&lt;font color=&quot;#8b0000&quot;&gt;+ publicID: string&lt;/font&gt;&lt;/td&gt;&lt;/tr&gt;
&lt;tr&gt;&lt;td align=&quot;left&quot; port=&quot;originID&quot;&gt;&lt;font color=&quot;#8b0000&quot;&gt;+ originID: string&lt;/font&gt;&lt;/td&gt;&lt;/tr&gt;
&lt;tr&gt;&lt;td align=&quot;left&quot; port=&quot;magnitude&quot;&gt;&lt;font color=&quot;#8b0000&quot;&gt;+ magnitude: RealQuantity&lt;/font&gt;&lt;/td&gt;&lt;/tr&gt;
&lt;tr&gt;&lt;td align=&quot;left&quot; port=&quot;type&quot;&gt;&lt;font color=&quot;#8b0000&quot;&gt;+ type: string&lt;/font&gt;&lt;/td&gt;&lt;/tr&gt;
&lt;tr&gt;&lt;td align=&quot;left&quot; port=&quot;amplitudeID&quot;&gt;&lt;font color=&quot;#8b0000&quot;&gt;+ amplitudeID: string&lt;/font&gt;&lt;/td&gt;&lt;/tr&gt;
&lt;tr&gt;&lt;td align=&quot;left&quot; port=&quot;methodID&quot;&gt;&lt;font color=&quot;#8b0000&quot;&gt;+ methodID: string&lt;/font&gt;&lt;/td&gt;&lt;/tr&gt;
&lt;tr&gt;&lt;td align=&quot;left&quot; port=&quot;waveformID&quot;&gt;&lt;font color=&quot;#8b0000&quot;&gt;+ waveformID: WaveformStreamID [0..1]&lt;/font&gt;&lt;/td&gt;&lt;/tr&gt;
&lt;tr&gt;&lt;td align=&quot;left&quot; port=&quot;passedQC&quot;&gt;&lt;font color=&quot;#8b0000&quot;&gt;+ passedQC: boolean [0..1]&lt;/font&gt;&lt;/td&gt;&lt;/tr&gt;
&lt;tr&gt;&lt;td align=&quot;left&quot; port=&quot;creationInfo&quot;&gt;&lt;font color=&quot;#8b0000&quot;&gt;+ creationInfo: CreationInfo [0..1]&lt;/font&gt;&lt;/td&gt;&lt;/tr&gt;
&lt;tr&gt;&lt;td align=&quot;left&quot;&gt;&lt;font color=&quot;#8b0000&quot;&gt;+ comment: Comment [0..*]&lt;/font&gt;&lt;/td&gt;&lt;/tr&gt;
&lt;/table&gt;
&gt;
href = &quot;../base/api-python.html#api-python-datamodel-stationmagnitude&quot;
target = &quot;_top&quot;
]
Magnitude [
labeltooltip = &quot;Magnitude&quot;
label = &lt;
&lt;table border=&quot;0&quot; cellpadding=&quot;0&quot; cellspacing=&quot;2&quot;&gt;
&lt;tr&gt;&lt;td&gt;Magnitude&lt;/td&gt;&lt;/tr&gt;
&lt;hr/&gt;
&lt;tr&gt;&lt;td&gt; &lt;/td&gt;&lt;/tr&gt;
&lt;tr&gt;&lt;td align=&quot;left&quot; port=&quot;publicID&quot;&gt;&lt;font color=&quot;#8b0000&quot;&gt;+ publicID: string&lt;/font&gt;&lt;/td&gt;&lt;/tr&gt;
&lt;tr&gt;&lt;td align=&quot;left&quot; port=&quot;magnitude&quot;&gt;&lt;font color=&quot;#8b0000&quot;&gt;+ magnitude: RealQuantity&lt;/font&gt;&lt;/td&gt;&lt;/tr&gt;
&lt;tr&gt;&lt;td align=&quot;left&quot; port=&quot;type&quot;&gt;&lt;font color=&quot;#8b0000&quot;&gt;+ type: string&lt;/font&gt;&lt;/td&gt;&lt;/tr&gt;
&lt;tr&gt;&lt;td align=&quot;left&quot; port=&quot;originID&quot;&gt;&lt;font color=&quot;#8b0000&quot;&gt;+ originID: string&lt;/font&gt;&lt;/td&gt;&lt;/tr&gt;
&lt;tr&gt;&lt;td align=&quot;left&quot; port=&quot;methodID&quot;&gt;&lt;font color=&quot;#8b0000&quot;&gt;+ methodID: string&lt;/font&gt;&lt;/td&gt;&lt;/tr&gt;
&lt;tr&gt;&lt;td align=&quot;left&quot; port=&quot;stationCount&quot;&gt;&lt;font color=&quot;#8b0000&quot;&gt;+ stationCount: int [0..1]&lt;/font&gt;&lt;/td&gt;&lt;/tr&gt;
&lt;tr&gt;&lt;td align=&quot;left&quot; port=&quot;azimuthalGap&quot;&gt;&lt;font color=&quot;#8b0000&quot;&gt;+ azimuthalGap: float [0..1]&lt;/font&gt;&lt;/td&gt;&lt;/tr&gt;
&lt;tr&gt;&lt;td align=&quot;left&quot; port=&quot;evaluationStatus&quot;&gt;&lt;font color=&quot;#8b0000&quot;&gt;+ evaluationStatus: EvaluationStatus [0..1]&lt;/font&gt;&lt;/td&gt;&lt;/tr&gt;
&lt;tr&gt;&lt;td align=&quot;left&quot; port=&quot;creationInfo&quot;&gt;&lt;font color=&quot;#8b0000&quot;&gt;+ creationInfo: CreationInfo [0..1]&lt;/font&gt;&lt;/td&gt;&lt;/tr&gt;
&lt;tr&gt;&lt;td align=&quot;left&quot;&gt;&lt;font color=&quot;#8b0000&quot;&gt;+ comment: Comment [0..*]&lt;/font&gt;&lt;/td&gt;&lt;/tr&gt;
&lt;tr&gt;&lt;td align=&quot;left&quot;&gt;&lt;font color=&quot;#8b0000&quot;&gt;+ stationMagnitudeContribution: StationMagnitudeContribution [0..*]&lt;/font&gt;&lt;/td&gt;&lt;/tr&gt;
&lt;/table&gt;
&gt;
href = &quot;../base/api-python.html#api-python-datamodel-magnitude&quot;
target = &quot;_top&quot;
]
StationMagnitudeContribution [
labeltooltip = &quot;StationMagnitudeContribution&quot;
label = &lt;
&lt;table border=&quot;0&quot; cellpadding=&quot;0&quot; cellspacing=&quot;2&quot;&gt;
&lt;tr&gt;&lt;td&gt;StationMagnitudeContribution&lt;/td&gt;&lt;/tr&gt;
&lt;hr/&gt;
&lt;tr&gt;&lt;td&gt; &lt;/td&gt;&lt;/tr&gt;
&lt;tr&gt;&lt;td align=&quot;left&quot; port=&quot;stationMagnitudeID&quot;&gt;&lt;font color=&quot;#8b0000&quot;&gt;+ stationMagnitudeID: string&lt;/font&gt;&lt;/td&gt;&lt;/tr&gt;
&lt;tr&gt;&lt;td align=&quot;left&quot; port=&quot;residual&quot;&gt;&lt;font color=&quot;#8b0000&quot;&gt;+ residual: float [0..1]&lt;/font&gt;&lt;/td&gt;&lt;/tr&gt;
&lt;tr&gt;&lt;td align=&quot;left&quot; port=&quot;weight&quot;&gt;&lt;font color=&quot;#8b0000&quot;&gt;+ weight: float [0..1]&lt;/font&gt;&lt;/td&gt;&lt;/tr&gt;
&lt;/table&gt;
&gt;
href = &quot;../base/api-python.html#api-python-datamodel-stationmagnitudecontribution&quot;
target = &quot;_top&quot;
]
FocalMechanism [
labeltooltip = &quot;FocalMechanism&quot;
label = &lt;
&lt;table border=&quot;0&quot; cellpadding=&quot;0&quot; cellspacing=&quot;2&quot;&gt;
&lt;tr&gt;&lt;td&gt;FocalMechanism&lt;/td&gt;&lt;/tr&gt;
&lt;hr/&gt;
&lt;tr&gt;&lt;td&gt; &lt;/td&gt;&lt;/tr&gt;
&lt;tr&gt;&lt;td align=&quot;left&quot; port=&quot;publicID&quot;&gt;&lt;font color=&quot;#8b0000&quot;&gt;+ publicID: string&lt;/font&gt;&lt;/td&gt;&lt;/tr&gt;
&lt;tr&gt;&lt;td align=&quot;left&quot; port=&quot;triggeringOriginID&quot;&gt;&lt;font color=&quot;#8b0000&quot;&gt;+ triggeringOriginID: string&lt;/font&gt;&lt;/td&gt;&lt;/tr&gt;
&lt;tr&gt;&lt;td align=&quot;left&quot; port=&quot;nodalPlanes&quot;&gt;&lt;font color=&quot;#8b0000&quot;&gt;+ nodalPlanes: NodalPlanes [0..1]&lt;/font&gt;&lt;/td&gt;&lt;/tr&gt;
&lt;tr&gt;&lt;td align=&quot;left&quot; port=&quot;principalAxes&quot;&gt;&lt;font color=&quot;#8b0000&quot;&gt;+ principalAxes: PrincipalAxes [0..1]&lt;/font&gt;&lt;/td&gt;&lt;/tr&gt;
&lt;tr&gt;&lt;td align=&quot;left&quot; port=&quot;azimuthalGap&quot;&gt;&lt;font color=&quot;#8b0000&quot;&gt;+ azimuthalGap: float [0..1]&lt;/font&gt;&lt;/td&gt;&lt;/tr&gt;
&lt;tr&gt;&lt;td align=&quot;left&quot; port=&quot;stationPolarityCount&quot;&gt;&lt;font color=&quot;#8b0000&quot;&gt;+ stationPolarityCount: int [0..1]&lt;/font&gt;&lt;/td&gt;&lt;/tr&gt;
&lt;tr&gt;&lt;td align=&quot;left&quot; port=&quot;misfit&quot;&gt;&lt;font color=&quot;#8b0000&quot;&gt;+ misfit: float [0..1]&lt;/font&gt;&lt;/td&gt;&lt;/tr&gt;
&lt;tr&gt;&lt;td align=&quot;left&quot; port=&quot;stationDistributionRatio&quot;&gt;&lt;font color=&quot;#8b0000&quot;&gt;+ stationDistributionRatio: float [0..1]&lt;/font&gt;&lt;/td&gt;&lt;/tr&gt;
&lt;tr&gt;&lt;td align=&quot;left&quot; port=&quot;methodID&quot;&gt;&lt;font color=&quot;#8b0000&quot;&gt;+ methodID: string&lt;/font&gt;&lt;/td&gt;&lt;/tr&gt;
&lt;tr&gt;&lt;td align=&quot;left&quot; port=&quot;evaluationMode&quot;&gt;&lt;font color=&quot;#8b0000&quot;&gt;+ evaluationMode: EvaluationMode [0..1]&lt;/font&gt;&lt;/td&gt;&lt;/tr&gt;
&lt;tr&gt;&lt;td align=&quot;left&quot; port=&quot;evaluationStatus&quot;&gt;&lt;font color=&quot;#8b0000&quot;&gt;+ evaluationStatus: EvaluationStatus [0..1]&lt;/font&gt;&lt;/td&gt;&lt;/tr&gt;
&lt;tr&gt;&lt;td align=&quot;left&quot; port=&quot;creationInfo&quot;&gt;&lt;font color=&quot;#8b0000&quot;&gt;+ creationInfo: CreationInfo [0..1]&lt;/font&gt;&lt;/td&gt;&lt;/tr&gt;
&lt;tr&gt;&lt;td align=&quot;left&quot;&gt;&lt;font color=&quot;#8b0000&quot;&gt;+ comment: Comment [0..*]&lt;/font&gt;&lt;/td&gt;&lt;/tr&gt;
&lt;tr&gt;&lt;td align=&quot;left&quot;&gt;&lt;font color=&quot;#8b0000&quot;&gt;+ momentTensor: MomentTensor [0..*]&lt;/font&gt;&lt;/td&gt;&lt;/tr&gt;
&lt;/table&gt;
&gt;
href = &quot;../base/api-python.html#api-python-datamodel-focalmechanism&quot;
target = &quot;_top&quot;
]
MomentTensor [
labeltooltip = &quot;MomentTensor&quot;
label = &lt;
&lt;table border=&quot;0&quot; cellpadding=&quot;0&quot; cellspacing=&quot;2&quot;&gt;
&lt;tr&gt;&lt;td&gt;MomentTensor&lt;/td&gt;&lt;/tr&gt;
&lt;hr/&gt;
&lt;tr&gt;&lt;td&gt; &lt;/td&gt;&lt;/tr&gt;
&lt;tr&gt;&lt;td align=&quot;left&quot; port=&quot;publicID&quot;&gt;&lt;font color=&quot;#8b0000&quot;&gt;+ publicID: string&lt;/font&gt;&lt;/td&gt;&lt;/tr&gt;
&lt;tr&gt;&lt;td align=&quot;left&quot; port=&quot;derivedOriginID&quot;&gt;&lt;font color=&quot;#8b0000&quot;&gt;+ derivedOriginID: string&lt;/font&gt;&lt;/td&gt;&lt;/tr&gt;
&lt;tr&gt;&lt;td align=&quot;left&quot; port=&quot;momentMagnitudeID&quot;&gt;&lt;font color=&quot;#8b0000&quot;&gt;+ momentMagnitudeID: string&lt;/font&gt;&lt;/td&gt;&lt;/tr&gt;
&lt;tr&gt;&lt;td align=&quot;left&quot; port=&quot;scalarMoment&quot;&gt;&lt;font color=&quot;#8b0000&quot;&gt;+ scalarMoment: RealQuantity [0..1]&lt;/font&gt;&lt;/td&gt;&lt;/tr&gt;
&lt;tr&gt;&lt;td align=&quot;left&quot; port=&quot;tensor&quot;&gt;&lt;font color=&quot;#8b0000&quot;&gt;+ tensor: Tensor [0..1]&lt;/font&gt;&lt;/td&gt;&lt;/tr&gt;
&lt;tr&gt;&lt;td align=&quot;left&quot; port=&quot;variance&quot;&gt;&lt;font color=&quot;#8b0000&quot;&gt;+ variance: float [0..1]&lt;/font&gt;&lt;/td&gt;&lt;/tr&gt;
&lt;tr&gt;&lt;td align=&quot;left&quot; port=&quot;varianceReduction&quot;&gt;&lt;font color=&quot;#8b0000&quot;&gt;+ varianceReduction: float [0..1]&lt;/font&gt;&lt;/td&gt;&lt;/tr&gt;
&lt;tr&gt;&lt;td align=&quot;left&quot; port=&quot;doubleCouple&quot;&gt;&lt;font color=&quot;#8b0000&quot;&gt;+ doubleCouple: float [0..1]&lt;/font&gt;&lt;/td&gt;&lt;/tr&gt;
&lt;tr&gt;&lt;td align=&quot;left&quot; port=&quot;clvd&quot;&gt;&lt;font color=&quot;#8b0000&quot;&gt;+ clvd: float [0..1]&lt;/font&gt;&lt;/td&gt;&lt;/tr&gt;
&lt;tr&gt;&lt;td align=&quot;left&quot; port=&quot;iso&quot;&gt;&lt;font color=&quot;#8b0000&quot;&gt;+ iso: float [0..1]&lt;/font&gt;&lt;/td&gt;&lt;/tr&gt;
&lt;tr&gt;&lt;td align=&quot;left&quot; port=&quot;greensFunctionID&quot;&gt;&lt;font color=&quot;#8b0000&quot;&gt;+ greensFunctionID: string&lt;/font&gt;&lt;/td&gt;&lt;/tr&gt;
&lt;tr&gt;&lt;td align=&quot;left&quot; port=&quot;filterID&quot;&gt;&lt;font color=&quot;#8b0000&quot;&gt;+ filterID: string&lt;/font&gt;&lt;/td&gt;&lt;/tr&gt;
&lt;tr&gt;&lt;td align=&quot;left&quot; port=&quot;sourceTimeFunction&quot;&gt;&lt;font color=&quot;#8b0000&quot;&gt;+ sourceTimeFunction: SourceTimeFunction [0..1]&lt;/font&gt;&lt;/td&gt;&lt;/tr&gt;
&lt;tr&gt;&lt;td align=&quot;left&quot; port=&quot;methodID&quot;&gt;&lt;font color=&quot;#8b0000&quot;&gt;+ methodID: string&lt;/font&gt;&lt;/td&gt;&lt;/tr&gt;
&lt;tr&gt;&lt;td align=&quot;left&quot; port=&quot;method&quot;&gt;&lt;font color=&quot;#8b0000&quot;&gt;+ method: MomentTensorMethod [0..1]&lt;/font&gt;&lt;/td&gt;&lt;/tr&gt;
&lt;tr&gt;&lt;td align=&quot;left&quot; port=&quot;status&quot;&gt;&lt;font color=&quot;#8b0000&quot;&gt;+ status: MomentTensorStatus [0..1]&lt;/font&gt;&lt;/td&gt;&lt;/tr&gt;
&lt;tr&gt;&lt;td align=&quot;left&quot; port=&quot;cmtName&quot;&gt;&lt;font color=&quot;#8b0000&quot;&gt;+ cmtName: string&lt;/font&gt;&lt;/td&gt;&lt;/tr&gt;
&lt;tr&gt;&lt;td align=&quot;left&quot; port=&quot;cmtVersion&quot;&gt;&lt;font color=&quot;#8b0000&quot;&gt;+ cmtVersion: string&lt;/font&gt;&lt;/td&gt;&lt;/tr&gt;
&lt;tr&gt;&lt;td align=&quot;left&quot; port=&quot;creationInfo&quot;&gt;&lt;font color=&quot;#8b0000&quot;&gt;+ creationInfo: CreationInfo [0..1]&lt;/font&gt;&lt;/td&gt;&lt;/tr&gt;
&lt;tr&gt;&lt;td align=&quot;left&quot;&gt;&lt;font color=&quot;#8b0000&quot;&gt;+ comment: Comment [0..*]&lt;/font&gt;&lt;/td&gt;&lt;/tr&gt;
&lt;tr&gt;&lt;td align=&quot;left&quot;&gt;&lt;font color=&quot;#8b0000&quot;&gt;+ dataUsed: DataUsed [0..*]&lt;/font&gt;&lt;/td&gt;&lt;/tr&gt;
&lt;tr&gt;&lt;td align=&quot;left&quot;&gt;&lt;font color=&quot;#8b0000&quot;&gt;+ momentTensorPhaseSetting: MomentTensorPhaseSetting [0..*]&lt;/font&gt;&lt;/td&gt;&lt;/tr&gt;
&lt;tr&gt;&lt;td align=&quot;left&quot;&gt;&lt;font color=&quot;#8b0000&quot;&gt;+ momentTensorStationContribution: MomentTensorStationContribution [0..*]&lt;/font&gt;&lt;/td&gt;&lt;/tr&gt;
&lt;/table&gt;
&gt;
href = &quot;../base/api-python.html#api-python-datamodel-momenttensor&quot;
target = &quot;_top&quot;
]
DataUsed [
labeltooltip = &quot;DataUsed&quot;
label = &lt;
&lt;table border=&quot;0&quot; cellpadding=&quot;0&quot; cellspacing=&quot;2&quot;&gt;
&lt;tr&gt;&lt;td&gt;DataUsed&lt;/td&gt;&lt;/tr&gt;
&lt;hr/&gt;
&lt;tr&gt;&lt;td&gt; &lt;/td&gt;&lt;/tr&gt;
&lt;tr&gt;&lt;td align=&quot;left&quot; port=&quot;waveType&quot;&gt;&lt;font color=&quot;#8b0000&quot;&gt;+ waveType: DataUsedWaveType&lt;/font&gt;&lt;/td&gt;&lt;/tr&gt;
&lt;tr&gt;&lt;td align=&quot;left&quot; port=&quot;stationCount&quot;&gt;&lt;font color=&quot;#8b0000&quot;&gt;+ stationCount: int&lt;/font&gt;&lt;/td&gt;&lt;/tr&gt;
&lt;tr&gt;&lt;td align=&quot;left&quot; port=&quot;componentCount&quot;&gt;&lt;font color=&quot;#8b0000&quot;&gt;+ componentCount: int&lt;/font&gt;&lt;/td&gt;&lt;/tr&gt;
&lt;tr&gt;&lt;td align=&quot;left&quot; port=&quot;shortestPeriod&quot;&gt;&lt;font color=&quot;#8b0000&quot;&gt;+ shortestPeriod: float [0..1]&lt;/font&gt;&lt;/td&gt;&lt;/tr&gt;
&lt;/table&gt;
&gt;
href = &quot;../base/api-python.html#api-python-datamodel-dataused&quot;
target = &quot;_top&quot;
]
MomentTensorPhaseSetting [
labeltooltip = &quot;MomentTensorPhaseSetting&quot;
label = &lt;
&lt;table border=&quot;0&quot; cellpadding=&quot;0&quot; cellspacing=&quot;2&quot;&gt;
&lt;tr&gt;&lt;td&gt;MomentTensorPhaseSetting&lt;/td&gt;&lt;/tr&gt;
&lt;hr/&gt;
&lt;tr&gt;&lt;td&gt; &lt;/td&gt;&lt;/tr&gt;
&lt;tr&gt;&lt;td align=&quot;left&quot; port=&quot;code&quot;&gt;&lt;font color=&quot;#8b0000&quot;&gt;+ code: string&lt;/font&gt;&lt;/td&gt;&lt;/tr&gt;
&lt;tr&gt;&lt;td align=&quot;left&quot; port=&quot;lowerPeriod&quot;&gt;&lt;font color=&quot;#8b0000&quot;&gt;+ lowerPeriod: float&lt;/font&gt;&lt;/td&gt;&lt;/tr&gt;
&lt;tr&gt;&lt;td align=&quot;left&quot; port=&quot;upperPeriod&quot;&gt;&lt;font color=&quot;#8b0000&quot;&gt;+ upperPeriod: float&lt;/font&gt;&lt;/td&gt;&lt;/tr&gt;
&lt;tr&gt;&lt;td align=&quot;left&quot; port=&quot;minimumSNR&quot;&gt;&lt;font color=&quot;#8b0000&quot;&gt;+ minimumSNR: float [0..1]&lt;/font&gt;&lt;/td&gt;&lt;/tr&gt;
&lt;tr&gt;&lt;td align=&quot;left&quot; port=&quot;maximumTimeShift&quot;&gt;&lt;font color=&quot;#8b0000&quot;&gt;+ maximumTimeShift: float [0..1]&lt;/font&gt;&lt;/td&gt;&lt;/tr&gt;
&lt;/table&gt;
&gt;
href = &quot;../base/api-python.html#api-python-datamodel-momenttensorphasesetting&quot;
target = &quot;_top&quot;
]
MomentTensorStationContribution [
labeltooltip = &quot;MomentTensorStationContribution&quot;
label = &lt;
&lt;table border=&quot;0&quot; cellpadding=&quot;0&quot; cellspacing=&quot;2&quot;&gt;
&lt;tr&gt;&lt;td&gt;MomentTensorStationContribution&lt;/td&gt;&lt;/tr&gt;
&lt;hr/&gt;
&lt;tr&gt;&lt;td&gt; &lt;/td&gt;&lt;/tr&gt;
&lt;tr&gt;&lt;td align=&quot;left&quot; port=&quot;publicID&quot;&gt;&lt;font color=&quot;#8b0000&quot;&gt;+ publicID: string&lt;/font&gt;&lt;/td&gt;&lt;/tr&gt;
&lt;tr&gt;&lt;td align=&quot;left&quot; port=&quot;active&quot;&gt;&lt;font color=&quot;#8b0000&quot;&gt;+ active: boolean&lt;/font&gt;&lt;/td&gt;&lt;/tr&gt;
&lt;tr&gt;&lt;td align=&quot;left&quot; port=&quot;waveformID&quot;&gt;&lt;font color=&quot;#8b0000&quot;&gt;+ waveformID: WaveformStreamID [0..1]&lt;/font&gt;&lt;/td&gt;&lt;/tr&gt;
&lt;tr&gt;&lt;td align=&quot;left&quot; port=&quot;weight&quot;&gt;&lt;font color=&quot;#8b0000&quot;&gt;+ weight: float [0..1]&lt;/font&gt;&lt;/td&gt;&lt;/tr&gt;
&lt;tr&gt;&lt;td align=&quot;left&quot; port=&quot;timeShift&quot;&gt;&lt;font color=&quot;#8b0000&quot;&gt;+ timeShift: float [0..1]&lt;/font&gt;&lt;/td&gt;&lt;/tr&gt;
&lt;tr&gt;&lt;td align=&quot;left&quot;&gt;&lt;font color=&quot;#8b0000&quot;&gt;+ momentTensorComponentContribution: MomentTensorComponentContribution [0..*]&lt;/font&gt;&lt;/td&gt;&lt;/tr&gt;
&lt;/table&gt;
&gt;
href = &quot;../base/api-python.html#api-python-datamodel-momenttensorstationcontribution&quot;
target = &quot;_top&quot;
]
MomentTensorComponentContribution [
labeltooltip = &quot;MomentTensorComponentContribution&quot;
label = &lt;
&lt;table border=&quot;0&quot; cellpadding=&quot;0&quot; cellspacing=&quot;2&quot;&gt;
&lt;tr&gt;&lt;td&gt;MomentTensorComponentContribution&lt;/td&gt;&lt;/tr&gt;
&lt;hr/&gt;
&lt;tr&gt;&lt;td&gt; &lt;/td&gt;&lt;/tr&gt;
&lt;tr&gt;&lt;td align=&quot;left&quot; port=&quot;phaseCode&quot;&gt;&lt;font color=&quot;#8b0000&quot;&gt;+ phaseCode: string&lt;/font&gt;&lt;/td&gt;&lt;/tr&gt;
&lt;tr&gt;&lt;td align=&quot;left&quot; port=&quot;component&quot;&gt;&lt;font color=&quot;#8b0000&quot;&gt;+ component: int&lt;/font&gt;&lt;/td&gt;&lt;/tr&gt;
&lt;tr&gt;&lt;td align=&quot;left&quot; port=&quot;active&quot;&gt;&lt;font color=&quot;#8b0000&quot;&gt;+ active: boolean&lt;/font&gt;&lt;/td&gt;&lt;/tr&gt;
&lt;tr&gt;&lt;td align=&quot;left&quot; port=&quot;weight&quot;&gt;&lt;font color=&quot;#8b0000&quot;&gt;+ weight: float&lt;/font&gt;&lt;/td&gt;&lt;/tr&gt;
&lt;tr&gt;&lt;td align=&quot;left&quot; port=&quot;timeShift&quot;&gt;&lt;font color=&quot;#8b0000&quot;&gt;+ timeShift: float&lt;/font&gt;&lt;/td&gt;&lt;/tr&gt;
&lt;tr&gt;&lt;td align=&quot;left&quot; port=&quot;dataTimeWindow&quot;&gt;&lt;font color=&quot;#8b0000&quot;&gt;+ dataTimeWindow: float&lt;/font&gt;&lt;/td&gt;&lt;/tr&gt;
&lt;tr&gt;&lt;td align=&quot;left&quot; port=&quot;misfit&quot;&gt;&lt;font color=&quot;#8b0000&quot;&gt;+ misfit: float [0..1]&lt;/font&gt;&lt;/td&gt;&lt;/tr&gt;
&lt;tr&gt;&lt;td align=&quot;left&quot; port=&quot;snr&quot;&gt;&lt;font color=&quot;#8b0000&quot;&gt;+ snr: float [0..1]&lt;/font&gt;&lt;/td&gt;&lt;/tr&gt;
&lt;/table&gt;
&gt;
href = &quot;../base/api-python.html#api-python-datamodel-momenttensorcomponentcontribution&quot;
target = &quot;_top&quot;
]
Event [
labeltooltip = &quot;Event&quot;
label = &lt;
&lt;table border=&quot;0&quot; cellpadding=&quot;0&quot; cellspacing=&quot;2&quot;&gt;
&lt;tr&gt;&lt;td&gt;Event&lt;/td&gt;&lt;/tr&gt;
&lt;hr/&gt;
&lt;tr&gt;&lt;td&gt; &lt;/td&gt;&lt;/tr&gt;
&lt;tr&gt;&lt;td align=&quot;left&quot; port=&quot;publicID&quot;&gt;&lt;font color=&quot;#8b0000&quot;&gt;+ publicID: string&lt;/font&gt;&lt;/td&gt;&lt;/tr&gt;
&lt;tr&gt;&lt;td align=&quot;left&quot; port=&quot;preferredOriginID&quot;&gt;&lt;font color=&quot;#8b0000&quot;&gt;+ preferredOriginID: string&lt;/font&gt;&lt;/td&gt;&lt;/tr&gt;
&lt;tr&gt;&lt;td align=&quot;left&quot; port=&quot;preferredMagnitudeID&quot;&gt;&lt;font color=&quot;#8b0000&quot;&gt;+ preferredMagnitudeID: string&lt;/font&gt;&lt;/td&gt;&lt;/tr&gt;
&lt;tr&gt;&lt;td align=&quot;left&quot; port=&quot;preferredFocalMechanismID&quot;&gt;&lt;font color=&quot;#8b0000&quot;&gt;+ preferredFocalMechanismID: string&lt;/font&gt;&lt;/td&gt;&lt;/tr&gt;
&lt;tr&gt;&lt;td align=&quot;left&quot; port=&quot;type&quot;&gt;&lt;font color=&quot;#8b0000&quot;&gt;+ type: EventType [0..1]&lt;/font&gt;&lt;/td&gt;&lt;/tr&gt;
&lt;tr&gt;&lt;td align=&quot;left&quot; port=&quot;typeCertainty&quot;&gt;&lt;font color=&quot;#8b0000&quot;&gt;+ typeCertainty: EventTypeCertainty [0..1]&lt;/font&gt;&lt;/td&gt;&lt;/tr&gt;
&lt;tr&gt;&lt;td align=&quot;left&quot; port=&quot;creationInfo&quot;&gt;&lt;font color=&quot;#8b0000&quot;&gt;+ creationInfo: CreationInfo [0..1]&lt;/font&gt;&lt;/td&gt;&lt;/tr&gt;
&lt;tr&gt;&lt;td align=&quot;left&quot;&gt;&lt;font color=&quot;#8b0000&quot;&gt;+ eventDescription: EventDescription [0..*]&lt;/font&gt;&lt;/td&gt;&lt;/tr&gt;
&lt;tr&gt;&lt;td align=&quot;left&quot;&gt;&lt;font color=&quot;#8b0000&quot;&gt;+ comment: Comment [0..*]&lt;/font&gt;&lt;/td&gt;&lt;/tr&gt;
&lt;tr&gt;&lt;td align=&quot;left&quot;&gt;&lt;font color=&quot;#8b0000&quot;&gt;+ originReference: OriginReference [0..*]&lt;/font&gt;&lt;/td&gt;&lt;/tr&gt;
&lt;tr&gt;&lt;td align=&quot;left&quot;&gt;&lt;font color=&quot;#8b0000&quot;&gt;+ focalMechanismReference: FocalMechanismReference [0..*]&lt;/font&gt;&lt;/td&gt;&lt;/tr&gt;
&lt;/table&gt;
&gt;
href = &quot;../base/api-python.html#api-python-datamodel-event&quot;
target = &quot;_top&quot;
]
EventDescription [
labeltooltip = &quot;EventDescription&quot;
label = &lt;
&lt;table border=&quot;0&quot; cellpadding=&quot;0&quot; cellspacing=&quot;2&quot;&gt;
&lt;tr&gt;&lt;td&gt;EventDescription&lt;/td&gt;&lt;/tr&gt;
&lt;hr/&gt;
&lt;tr&gt;&lt;td&gt; &lt;/td&gt;&lt;/tr&gt;
&lt;tr&gt;&lt;td align=&quot;left&quot; port=&quot;text&quot;&gt;&lt;font color=&quot;#8b0000&quot;&gt;+ text: string&lt;/font&gt;&lt;/td&gt;&lt;/tr&gt;
&lt;tr&gt;&lt;td align=&quot;left&quot; port=&quot;type&quot;&gt;&lt;font color=&quot;#8b0000&quot;&gt;+ type: EventDescriptionType&lt;/font&gt;&lt;/td&gt;&lt;/tr&gt;
&lt;/table&gt;
&gt;
href = &quot;../base/api-python.html#api-python-datamodel-eventdescription&quot;
target = &quot;_top&quot;
]
OriginReference [
labeltooltip = &quot;OriginReference&quot;
label = &lt;
&lt;table border=&quot;0&quot; cellpadding=&quot;0&quot; cellspacing=&quot;2&quot;&gt;
&lt;tr&gt;&lt;td&gt;OriginReference&lt;/td&gt;&lt;/tr&gt;
&lt;hr/&gt;
&lt;tr&gt;&lt;td&gt; &lt;/td&gt;&lt;/tr&gt;
&lt;tr&gt;&lt;td align=&quot;left&quot; port=&quot;originID&quot;&gt;&lt;font color=&quot;#8b0000&quot;&gt;+ originID: string&lt;/font&gt;&lt;/td&gt;&lt;/tr&gt;
&lt;/table&gt;
&gt;
href = &quot;../base/api-python.html#api-python-datamodel-originreference&quot;
target = &quot;_top&quot;
]
FocalMechanismReference [
labeltooltip = &quot;FocalMechanismReference&quot;
label = &lt;
&lt;table border=&quot;0&quot; cellpadding=&quot;0&quot; cellspacing=&quot;2&quot;&gt;
&lt;tr&gt;&lt;td&gt;FocalMechanismReference&lt;/td&gt;&lt;/tr&gt;
&lt;hr/&gt;
&lt;tr&gt;&lt;td&gt; &lt;/td&gt;&lt;/tr&gt;
&lt;tr&gt;&lt;td align=&quot;left&quot; port=&quot;focalMechanismID&quot;&gt;&lt;font color=&quot;#8b0000&quot;&gt;+ focalMechanismID: string&lt;/font&gt;&lt;/td&gt;&lt;/tr&gt;
&lt;/table&gt;
&gt;
href = &quot;../base/api-python.html#api-python-datamodel-focalmechanismreference&quot;
target = &quot;_top&quot;
]
EventParameters [
labeltooltip = &quot;EventParameters&quot;
label = &lt;
&lt;table border=&quot;0&quot; cellpadding=&quot;0&quot; cellspacing=&quot;2&quot;&gt;
&lt;tr&gt;&lt;td&gt;EventParameters&lt;/td&gt;&lt;/tr&gt;
&lt;hr/&gt;
&lt;tr&gt;&lt;td&gt; &lt;/td&gt;&lt;/tr&gt;
&lt;tr&gt;&lt;td align=&quot;left&quot; port=&quot;publicID&quot;&gt;&lt;font color=&quot;#8b0000&quot;&gt;+ publicID: string&lt;/font&gt;&lt;/td&gt;&lt;/tr&gt;
&lt;tr&gt;&lt;td align=&quot;left&quot;&gt;&lt;font color=&quot;#8b0000&quot;&gt;+ pick: Pick [0..*]&lt;/font&gt;&lt;/td&gt;&lt;/tr&gt;
&lt;tr&gt;&lt;td align=&quot;left&quot;&gt;&lt;font color=&quot;#8b0000&quot;&gt;+ amplitude: Amplitude [0..*]&lt;/font&gt;&lt;/td&gt;&lt;/tr&gt;
&lt;tr&gt;&lt;td align=&quot;left&quot;&gt;&lt;font color=&quot;#8b0000&quot;&gt;+ reading: Reading [0..*]&lt;/font&gt;&lt;/td&gt;&lt;/tr&gt;
&lt;tr&gt;&lt;td align=&quot;left&quot;&gt;&lt;font color=&quot;#8b0000&quot;&gt;+ origin: Origin [0..*]&lt;/font&gt;&lt;/td&gt;&lt;/tr&gt;
&lt;tr&gt;&lt;td align=&quot;left&quot;&gt;&lt;font color=&quot;#8b0000&quot;&gt;+ focalMechanism: FocalMechanism [0..*]&lt;/font&gt;&lt;/td&gt;&lt;/tr&gt;
&lt;tr&gt;&lt;td align=&quot;left&quot;&gt;&lt;font color=&quot;#8b0000&quot;&gt;+ event: Event [0..*]&lt;/font&gt;&lt;/td&gt;&lt;/tr&gt;
&lt;/table&gt;
&gt;
href = &quot;../base/api-python.html#api-python-datamodel-eventparameters&quot;
target = &quot;_top&quot;
]
EventParameters -&gt; Pick [dir=back arrowtail=diamond]
MomentTensor -&gt; Comment [dir=back arrowtail=diamond]
FocalMechanism -&gt; Comment [dir=back arrowtail=diamond]
Amplitude -&gt; Comment [dir=back arrowtail=diamond]
Magnitude -&gt; Comment [dir=back arrowtail=diamond]
StationMagnitude -&gt; Comment [dir=back arrowtail=diamond]
Pick -&gt; Comment [dir=back arrowtail=diamond]
Event -&gt; Comment [dir=back arrowtail=diamond]
Origin -&gt; Comment [dir=back arrowtail=diamond]
EventParameters -&gt; Amplitude [dir=back arrowtail=diamond]
EventParameters -&gt; Reading [dir=back arrowtail=diamond]
Reading -&gt; PickReference [dir=back arrowtail=diamond]
Reading -&gt; AmplitudeReference [dir=back arrowtail=diamond]
EventParameters -&gt; Origin [dir=back arrowtail=diamond]
Origin -&gt; CompositeTime [dir=back arrowtail=diamond]
Origin -&gt; Arrival [dir=back arrowtail=diamond]
Origin -&gt; StationMagnitude [dir=back arrowtail=diamond]
Origin -&gt; Magnitude [dir=back arrowtail=diamond]
Magnitude -&gt; StationMagnitudeContribution [dir=back arrowtail=diamond]
EventParameters -&gt; FocalMechanism [dir=back arrowtail=diamond]
FocalMechanism -&gt; MomentTensor [dir=back arrowtail=diamond]
MomentTensor -&gt; DataUsed [dir=back arrowtail=diamond]
MomentTensor -&gt; MomentTensorPhaseSetting [dir=back arrowtail=diamond]
MomentTensor -&gt; MomentTensorStationContribution [dir=back arrowtail=diamond]
MomentTensorStationContribution -&gt; MomentTensorComponentContribution [dir=back arrowtail=diamond]
EventParameters -&gt; Event [dir=back arrowtail=diamond]
Event -&gt; EventDescription [dir=back arrowtail=diamond]
Event -&gt; OriginReference [dir=back arrowtail=diamond]
Event -&gt; FocalMechanismReference [dir=back arrowtail=diamond]
}</p></object></div>
<p class="caption"><span class="caption-text">EventParameters object connections from parent to child including attributes and elements.</span><a class="headerlink" href="#id2" title="Permalink to this image"></a></p>
</div>
</div>
<div class="section" id="config">
<h3>Config<a class="headerlink" href="#config" title="Permalink to this headline"></a></h3>
<div class="figure align-center" id="id3">
<div class="graphviz"><object data="../_images/graphviz-d94ee2ab07be3cf6f1de33a4997976f0654010e2.svg" type="image/svg+xml" class="graphviz">
<p class="warning">digraph &quot;Config hierarchy&quot; {
node [fontname=Verdana fontsize=8 shape=plaintext penwidth=0.5 style=&quot;rounded,filled&quot; fillcolor=&quot;#fcf2e3&quot; color=&quot;#000000&quot;]
edge [color=&quot;#000000&quot;]
layout = &quot;dot&quot;
ParameterSet [
labeltooltip = &quot;ParameterSet&quot;
label = &lt;
&lt;table border=&quot;0&quot; cellpadding=&quot;0&quot; cellspacing=&quot;2&quot;&gt;
&lt;tr&gt;&lt;td&gt;ParameterSet&lt;/td&gt;&lt;/tr&gt;
&lt;hr/&gt;
&lt;tr&gt;&lt;td&gt; &lt;/td&gt;&lt;/tr&gt;
&lt;tr&gt;&lt;td align=&quot;left&quot; port=&quot;publicID&quot;&gt;&lt;font color=&quot;#8b0000&quot;&gt;+ publicID: string&lt;/font&gt;&lt;/td&gt;&lt;/tr&gt;
&lt;tr&gt;&lt;td align=&quot;left&quot; port=&quot;baseID&quot;&gt;&lt;font color=&quot;#8b0000&quot;&gt;+ baseID: string&lt;/font&gt;&lt;/td&gt;&lt;/tr&gt;
&lt;tr&gt;&lt;td align=&quot;left&quot; port=&quot;moduleID&quot;&gt;&lt;font color=&quot;#8b0000&quot;&gt;+ moduleID: string&lt;/font&gt;&lt;/td&gt;&lt;/tr&gt;
&lt;tr&gt;&lt;td align=&quot;left&quot; port=&quot;created&quot;&gt;&lt;font color=&quot;#8b0000&quot;&gt;+ created: datetime [0..1]&lt;/font&gt;&lt;/td&gt;&lt;/tr&gt;
&lt;tr&gt;&lt;td align=&quot;left&quot;&gt;&lt;font color=&quot;#8b0000&quot;&gt;+ parameter: Parameter [0..*]&lt;/font&gt;&lt;/td&gt;&lt;/tr&gt;
&lt;tr&gt;&lt;td align=&quot;left&quot;&gt;&lt;font color=&quot;#8b0000&quot;&gt;+ comment: Comment [0..*]&lt;/font&gt;&lt;/td&gt;&lt;/tr&gt;
&lt;/table&gt;
&gt;
href = &quot;../base/api-python.html#api-python-datamodel-parameterset&quot;
target = &quot;_top&quot;
]
Parameter [
labeltooltip = &quot;Parameter&quot;
label = &lt;
&lt;table border=&quot;0&quot; cellpadding=&quot;0&quot; cellspacing=&quot;2&quot;&gt;
&lt;tr&gt;&lt;td&gt;Parameter&lt;/td&gt;&lt;/tr&gt;
&lt;hr/&gt;
&lt;tr&gt;&lt;td&gt; &lt;/td&gt;&lt;/tr&gt;
&lt;tr&gt;&lt;td align=&quot;left&quot; port=&quot;publicID&quot;&gt;&lt;font color=&quot;#8b0000&quot;&gt;+ publicID: string&lt;/font&gt;&lt;/td&gt;&lt;/tr&gt;
&lt;tr&gt;&lt;td align=&quot;left&quot; port=&quot;name&quot;&gt;&lt;font color=&quot;#8b0000&quot;&gt;+ name: string&lt;/font&gt;&lt;/td&gt;&lt;/tr&gt;
&lt;tr&gt;&lt;td align=&quot;left&quot; port=&quot;value&quot;&gt;&lt;font color=&quot;#8b0000&quot;&gt;+ value: string&lt;/font&gt;&lt;/td&gt;&lt;/tr&gt;
&lt;tr&gt;&lt;td align=&quot;left&quot;&gt;&lt;font color=&quot;#8b0000&quot;&gt;+ comment: Comment [0..*]&lt;/font&gt;&lt;/td&gt;&lt;/tr&gt;
&lt;/table&gt;
&gt;
href = &quot;../base/api-python.html#api-python-datamodel-parameter&quot;
target = &quot;_top&quot;
]
Comment [
labeltooltip = &quot;Comment&quot;
label = &lt;
&lt;table border=&quot;0&quot; cellpadding=&quot;0&quot; cellspacing=&quot;2&quot;&gt;
&lt;tr&gt;&lt;td&gt;Comment&lt;/td&gt;&lt;/tr&gt;
&lt;hr/&gt;
&lt;tr&gt;&lt;td&gt; &lt;/td&gt;&lt;/tr&gt;
&lt;tr&gt;&lt;td align=&quot;left&quot; port=&quot;text&quot;&gt;&lt;font color=&quot;#8b0000&quot;&gt;+ text: string&lt;/font&gt;&lt;/td&gt;&lt;/tr&gt;
&lt;tr&gt;&lt;td align=&quot;left&quot; port=&quot;id&quot;&gt;&lt;font color=&quot;#8b0000&quot;&gt;+ id: string&lt;/font&gt;&lt;/td&gt;&lt;/tr&gt;
&lt;tr&gt;&lt;td align=&quot;left&quot; port=&quot;start&quot;&gt;&lt;font color=&quot;#8b0000&quot;&gt;+ start: datetime [0..1]&lt;/font&gt;&lt;/td&gt;&lt;/tr&gt;
&lt;tr&gt;&lt;td align=&quot;left&quot; port=&quot;end&quot;&gt;&lt;font color=&quot;#8b0000&quot;&gt;+ end: datetime [0..1]&lt;/font&gt;&lt;/td&gt;&lt;/tr&gt;
&lt;tr&gt;&lt;td align=&quot;left&quot; port=&quot;creationInfo&quot;&gt;&lt;font color=&quot;#8b0000&quot;&gt;+ creationInfo: CreationInfo [0..1]&lt;/font&gt;&lt;/td&gt;&lt;/tr&gt;
&lt;/table&gt;
&gt;
href = &quot;../base/api-python.html#api-python-datamodel-comment&quot;
target = &quot;_top&quot;
]
ConfigModule [
labeltooltip = &quot;ConfigModule&quot;
label = &lt;
&lt;table border=&quot;0&quot; cellpadding=&quot;0&quot; cellspacing=&quot;2&quot;&gt;
&lt;tr&gt;&lt;td&gt;ConfigModule&lt;/td&gt;&lt;/tr&gt;
&lt;hr/&gt;
&lt;tr&gt;&lt;td&gt; &lt;/td&gt;&lt;/tr&gt;
&lt;tr&gt;&lt;td align=&quot;left&quot; port=&quot;publicID&quot;&gt;&lt;font color=&quot;#8b0000&quot;&gt;+ publicID: string&lt;/font&gt;&lt;/td&gt;&lt;/tr&gt;
&lt;tr&gt;&lt;td align=&quot;left&quot; port=&quot;name&quot;&gt;&lt;font color=&quot;#8b0000&quot;&gt;+ name: string&lt;/font&gt;&lt;/td&gt;&lt;/tr&gt;
&lt;tr&gt;&lt;td align=&quot;left&quot; port=&quot;parameterSetID&quot;&gt;&lt;font color=&quot;#8b0000&quot;&gt;+ parameterSetID: string&lt;/font&gt;&lt;/td&gt;&lt;/tr&gt;
&lt;tr&gt;&lt;td align=&quot;left&quot; port=&quot;enabled&quot;&gt;&lt;font color=&quot;#8b0000&quot;&gt;+ enabled: boolean&lt;/font&gt;&lt;/td&gt;&lt;/tr&gt;
&lt;tr&gt;&lt;td align=&quot;left&quot;&gt;&lt;font color=&quot;#8b0000&quot;&gt;+ configStation: ConfigStation [0..*]&lt;/font&gt;&lt;/td&gt;&lt;/tr&gt;
&lt;/table&gt;
&gt;
href = &quot;../base/api-python.html#api-python-datamodel-configmodule&quot;
target = &quot;_top&quot;
]
ConfigStation [
labeltooltip = &quot;ConfigStation&quot;
label = &lt;
&lt;table border=&quot;0&quot; cellpadding=&quot;0&quot; cellspacing=&quot;2&quot;&gt;
&lt;tr&gt;&lt;td&gt;ConfigStation&lt;/td&gt;&lt;/tr&gt;
&lt;hr/&gt;
&lt;tr&gt;&lt;td&gt; &lt;/td&gt;&lt;/tr&gt;
&lt;tr&gt;&lt;td align=&quot;left&quot; port=&quot;publicID&quot;&gt;&lt;font color=&quot;#8b0000&quot;&gt;+ publicID: string&lt;/font&gt;&lt;/td&gt;&lt;/tr&gt;
&lt;tr&gt;&lt;td align=&quot;left&quot; port=&quot;networkCode&quot;&gt;&lt;font color=&quot;#8b0000&quot;&gt;+ networkCode: string&lt;/font&gt;&lt;/td&gt;&lt;/tr&gt;
&lt;tr&gt;&lt;td align=&quot;left&quot; port=&quot;stationCode&quot;&gt;&lt;font color=&quot;#8b0000&quot;&gt;+ stationCode: string&lt;/font&gt;&lt;/td&gt;&lt;/tr&gt;
&lt;tr&gt;&lt;td align=&quot;left&quot; port=&quot;enabled&quot;&gt;&lt;font color=&quot;#8b0000&quot;&gt;+ enabled: boolean&lt;/font&gt;&lt;/td&gt;&lt;/tr&gt;
&lt;tr&gt;&lt;td align=&quot;left&quot; port=&quot;creationInfo&quot;&gt;&lt;font color=&quot;#8b0000&quot;&gt;+ creationInfo: CreationInfo [0..1]&lt;/font&gt;&lt;/td&gt;&lt;/tr&gt;
&lt;tr&gt;&lt;td align=&quot;left&quot;&gt;&lt;font color=&quot;#8b0000&quot;&gt;+ setup: Setup [0..*]&lt;/font&gt;&lt;/td&gt;&lt;/tr&gt;
&lt;/table&gt;
&gt;
href = &quot;../base/api-python.html#api-python-datamodel-configstation&quot;
target = &quot;_top&quot;
]
Setup [
labeltooltip = &quot;Setup&quot;
label = &lt;
&lt;table border=&quot;0&quot; cellpadding=&quot;0&quot; cellspacing=&quot;2&quot;&gt;
&lt;tr&gt;&lt;td&gt;Setup&lt;/td&gt;&lt;/tr&gt;
&lt;hr/&gt;
&lt;tr&gt;&lt;td&gt; &lt;/td&gt;&lt;/tr&gt;
&lt;tr&gt;&lt;td align=&quot;left&quot; port=&quot;name&quot;&gt;&lt;font color=&quot;#8b0000&quot;&gt;+ name: string&lt;/font&gt;&lt;/td&gt;&lt;/tr&gt;
&lt;tr&gt;&lt;td align=&quot;left&quot; port=&quot;parameterSetID&quot;&gt;&lt;font color=&quot;#8b0000&quot;&gt;+ parameterSetID: string&lt;/font&gt;&lt;/td&gt;&lt;/tr&gt;
&lt;tr&gt;&lt;td align=&quot;left&quot; port=&quot;enabled&quot;&gt;&lt;font color=&quot;#8b0000&quot;&gt;+ enabled: boolean&lt;/font&gt;&lt;/td&gt;&lt;/tr&gt;
&lt;/table&gt;
&gt;
href = &quot;../base/api-python.html#api-python-datamodel-setup&quot;
target = &quot;_top&quot;
]
Config [
labeltooltip = &quot;Config&quot;
label = &lt;
&lt;table border=&quot;0&quot; cellpadding=&quot;0&quot; cellspacing=&quot;2&quot;&gt;
&lt;tr&gt;&lt;td&gt;Config&lt;/td&gt;&lt;/tr&gt;
&lt;hr/&gt;
&lt;tr&gt;&lt;td&gt; &lt;/td&gt;&lt;/tr&gt;
&lt;tr&gt;&lt;td align=&quot;left&quot; port=&quot;publicID&quot;&gt;&lt;font color=&quot;#8b0000&quot;&gt;+ publicID: string&lt;/font&gt;&lt;/td&gt;&lt;/tr&gt;
&lt;tr&gt;&lt;td align=&quot;left&quot;&gt;&lt;font color=&quot;#8b0000&quot;&gt;+ parameterSet: ParameterSet [0..*]&lt;/font&gt;&lt;/td&gt;&lt;/tr&gt;
&lt;tr&gt;&lt;td align=&quot;left&quot;&gt;&lt;font color=&quot;#8b0000&quot;&gt;+ configModule: ConfigModule [0..*]&lt;/font&gt;&lt;/td&gt;&lt;/tr&gt;
&lt;/table&gt;
&gt;
href = &quot;../base/api-python.html#api-python-datamodel-config&quot;
target = &quot;_top&quot;
]
Config -&gt; ParameterSet [dir=back arrowtail=diamond]
ParameterSet -&gt; Parameter [dir=back arrowtail=diamond]
Parameter -&gt; Comment [dir=back arrowtail=diamond]
ParameterSet -&gt; Comment [dir=back arrowtail=diamond]
Config -&gt; ConfigModule [dir=back arrowtail=diamond]
ConfigModule -&gt; ConfigStation [dir=back arrowtail=diamond]
ConfigStation -&gt; Setup [dir=back arrowtail=diamond]
}</p></object></div>
<p class="caption"><span class="caption-text">Config object connections from parent to child including attributes and elements.</span><a class="headerlink" href="#id3" title="Permalink to this image"></a></p>
</div>
</div>
<div class="section" id="qualitycontrol">
<h3>QualityControl<a class="headerlink" href="#qualitycontrol" title="Permalink to this headline"></a></h3>
<div class="figure align-center" id="id4">
<div class="graphviz"><object data="../_images/graphviz-93d11327342315a30dd7d7bc665da60de88d9192.svg" type="image/svg+xml" class="graphviz">
<p class="warning">digraph &quot;QualityControl hierarchy&quot; {
node [fontname=Verdana fontsize=8 shape=plaintext penwidth=0.5 style=&quot;rounded,filled&quot; fillcolor=&quot;#fcf2e3&quot; color=&quot;#000000&quot;]
edge [color=&quot;#000000&quot;]
layout = &quot;dot&quot;
QCLog [
labeltooltip = &quot;QCLog&quot;
label = &lt;
&lt;table border=&quot;0&quot; cellpadding=&quot;0&quot; cellspacing=&quot;2&quot;&gt;
&lt;tr&gt;&lt;td&gt;QCLog&lt;/td&gt;&lt;/tr&gt;
&lt;hr/&gt;
&lt;tr&gt;&lt;td&gt; &lt;/td&gt;&lt;/tr&gt;
&lt;tr&gt;&lt;td align=&quot;left&quot; port=&quot;publicID&quot;&gt;&lt;font color=&quot;#8b0000&quot;&gt;+ publicID: string&lt;/font&gt;&lt;/td&gt;&lt;/tr&gt;
&lt;tr&gt;&lt;td align=&quot;left&quot; port=&quot;waveformID&quot;&gt;&lt;font color=&quot;#8b0000&quot;&gt;+ waveformID: WaveformStreamID&lt;/font&gt;&lt;/td&gt;&lt;/tr&gt;
&lt;tr&gt;&lt;td align=&quot;left&quot; port=&quot;creatorID&quot;&gt;&lt;font color=&quot;#8b0000&quot;&gt;+ creatorID: string&lt;/font&gt;&lt;/td&gt;&lt;/tr&gt;
&lt;tr&gt;&lt;td align=&quot;left&quot; port=&quot;created&quot;&gt;&lt;font color=&quot;#8b0000&quot;&gt;+ created: datetime&lt;/font&gt;&lt;/td&gt;&lt;/tr&gt;
&lt;tr&gt;&lt;td align=&quot;left&quot; port=&quot;start&quot;&gt;&lt;font color=&quot;#8b0000&quot;&gt;+ start: datetime&lt;/font&gt;&lt;/td&gt;&lt;/tr&gt;
&lt;tr&gt;&lt;td align=&quot;left&quot; port=&quot;end&quot;&gt;&lt;font color=&quot;#8b0000&quot;&gt;+ end: datetime&lt;/font&gt;&lt;/td&gt;&lt;/tr&gt;
&lt;tr&gt;&lt;td align=&quot;left&quot; port=&quot;message&quot;&gt;&lt;font color=&quot;#8b0000&quot;&gt;+ message: string&lt;/font&gt;&lt;/td&gt;&lt;/tr&gt;
&lt;/table&gt;
&gt;
href = &quot;../base/api-python.html#api-python-datamodel-qclog&quot;
target = &quot;_top&quot;
]
WaveformQuality [
labeltooltip = &quot;WaveformQuality&quot;
label = &lt;
&lt;table border=&quot;0&quot; cellpadding=&quot;0&quot; cellspacing=&quot;2&quot;&gt;
&lt;tr&gt;&lt;td&gt;WaveformQuality&lt;/td&gt;&lt;/tr&gt;
&lt;hr/&gt;
&lt;tr&gt;&lt;td&gt; &lt;/td&gt;&lt;/tr&gt;
&lt;tr&gt;&lt;td align=&quot;left&quot; port=&quot;waveformID&quot;&gt;&lt;font color=&quot;#8b0000&quot;&gt;+ waveformID: WaveformStreamID&lt;/font&gt;&lt;/td&gt;&lt;/tr&gt;
&lt;tr&gt;&lt;td align=&quot;left&quot; port=&quot;creatorID&quot;&gt;&lt;font color=&quot;#8b0000&quot;&gt;+ creatorID: string&lt;/font&gt;&lt;/td&gt;&lt;/tr&gt;
&lt;tr&gt;&lt;td align=&quot;left&quot; port=&quot;created&quot;&gt;&lt;font color=&quot;#8b0000&quot;&gt;+ created: datetime&lt;/font&gt;&lt;/td&gt;&lt;/tr&gt;
&lt;tr&gt;&lt;td align=&quot;left&quot; port=&quot;start&quot;&gt;&lt;font color=&quot;#8b0000&quot;&gt;+ start: datetime&lt;/font&gt;&lt;/td&gt;&lt;/tr&gt;
&lt;tr&gt;&lt;td align=&quot;left&quot; port=&quot;end&quot;&gt;&lt;font color=&quot;#8b0000&quot;&gt;+ end: datetime [0..1]&lt;/font&gt;&lt;/td&gt;&lt;/tr&gt;
&lt;tr&gt;&lt;td align=&quot;left&quot; port=&quot;type&quot;&gt;&lt;font color=&quot;#8b0000&quot;&gt;+ type: string&lt;/font&gt;&lt;/td&gt;&lt;/tr&gt;
&lt;tr&gt;&lt;td align=&quot;left&quot; port=&quot;parameter&quot;&gt;&lt;font color=&quot;#8b0000&quot;&gt;+ parameter: string&lt;/font&gt;&lt;/td&gt;&lt;/tr&gt;
&lt;tr&gt;&lt;td align=&quot;left&quot; port=&quot;value&quot;&gt;&lt;font color=&quot;#8b0000&quot;&gt;+ value: float&lt;/font&gt;&lt;/td&gt;&lt;/tr&gt;
&lt;tr&gt;&lt;td align=&quot;left&quot; port=&quot;lowerUncertainty&quot;&gt;&lt;font color=&quot;#8b0000&quot;&gt;+ lowerUncertainty: float [0..1]&lt;/font&gt;&lt;/td&gt;&lt;/tr&gt;
&lt;tr&gt;&lt;td align=&quot;left&quot; port=&quot;upperUncertainty&quot;&gt;&lt;font color=&quot;#8b0000&quot;&gt;+ upperUncertainty: float [0..1]&lt;/font&gt;&lt;/td&gt;&lt;/tr&gt;
&lt;tr&gt;&lt;td align=&quot;left&quot; port=&quot;windowLength&quot;&gt;&lt;font color=&quot;#8b0000&quot;&gt;+ windowLength: float [0..1]&lt;/font&gt;&lt;/td&gt;&lt;/tr&gt;
&lt;/table&gt;
&gt;
href = &quot;../base/api-python.html#api-python-datamodel-waveformquality&quot;
target = &quot;_top&quot;
]
Outage [
labeltooltip = &quot;Outage&quot;
label = &lt;
&lt;table border=&quot;0&quot; cellpadding=&quot;0&quot; cellspacing=&quot;2&quot;&gt;
&lt;tr&gt;&lt;td&gt;Outage&lt;/td&gt;&lt;/tr&gt;
&lt;hr/&gt;
&lt;tr&gt;&lt;td&gt; &lt;/td&gt;&lt;/tr&gt;
&lt;tr&gt;&lt;td align=&quot;left&quot; port=&quot;waveformID&quot;&gt;&lt;font color=&quot;#8b0000&quot;&gt;+ waveformID: WaveformStreamID&lt;/font&gt;&lt;/td&gt;&lt;/tr&gt;
&lt;tr&gt;&lt;td align=&quot;left&quot; port=&quot;creatorID&quot;&gt;&lt;font color=&quot;#8b0000&quot;&gt;+ creatorID: string&lt;/font&gt;&lt;/td&gt;&lt;/tr&gt;
&lt;tr&gt;&lt;td align=&quot;left&quot; port=&quot;created&quot;&gt;&lt;font color=&quot;#8b0000&quot;&gt;+ created: datetime&lt;/font&gt;&lt;/td&gt;&lt;/tr&gt;
&lt;tr&gt;&lt;td align=&quot;left&quot; port=&quot;start&quot;&gt;&lt;font color=&quot;#8b0000&quot;&gt;+ start: datetime&lt;/font&gt;&lt;/td&gt;&lt;/tr&gt;
&lt;tr&gt;&lt;td align=&quot;left&quot; port=&quot;end&quot;&gt;&lt;font color=&quot;#8b0000&quot;&gt;+ end: datetime [0..1]&lt;/font&gt;&lt;/td&gt;&lt;/tr&gt;
&lt;/table&gt;
&gt;
href = &quot;../base/api-python.html#api-python-datamodel-outage&quot;
target = &quot;_top&quot;
]
QualityControl [
labeltooltip = &quot;QualityControl&quot;
label = &lt;
&lt;table border=&quot;0&quot; cellpadding=&quot;0&quot; cellspacing=&quot;2&quot;&gt;
&lt;tr&gt;&lt;td&gt;QualityControl&lt;/td&gt;&lt;/tr&gt;
&lt;hr/&gt;
&lt;tr&gt;&lt;td&gt; &lt;/td&gt;&lt;/tr&gt;
&lt;tr&gt;&lt;td align=&quot;left&quot; port=&quot;publicID&quot;&gt;&lt;font color=&quot;#8b0000&quot;&gt;+ publicID: string&lt;/font&gt;&lt;/td&gt;&lt;/tr&gt;
&lt;tr&gt;&lt;td align=&quot;left&quot;&gt;&lt;font color=&quot;#8b0000&quot;&gt;+ qCLog: QCLog [0..*]&lt;/font&gt;&lt;/td&gt;&lt;/tr&gt;
&lt;tr&gt;&lt;td align=&quot;left&quot;&gt;&lt;font color=&quot;#8b0000&quot;&gt;+ waveformQuality: WaveformQuality [0..*]&lt;/font&gt;&lt;/td&gt;&lt;/tr&gt;
&lt;tr&gt;&lt;td align=&quot;left&quot;&gt;&lt;font color=&quot;#8b0000&quot;&gt;+ outage: Outage [0..*]&lt;/font&gt;&lt;/td&gt;&lt;/tr&gt;
&lt;/table&gt;
&gt;
href = &quot;../base/api-python.html#api-python-datamodel-qualitycontrol&quot;
target = &quot;_top&quot;
]
QualityControl -&gt; QCLog [dir=back arrowtail=diamond]
QualityControl -&gt; WaveformQuality [dir=back arrowtail=diamond]
QualityControl -&gt; Outage [dir=back arrowtail=diamond]
}</p></object></div>
<p class="caption"><span class="caption-text">QualityControl object connections from parent to child including attributes and elements.</span><a class="headerlink" href="#id4" title="Permalink to this image"></a></p>
</div>
</div>
<div class="section" id="inventory">
<h3>Inventory<a class="headerlink" href="#inventory" title="Permalink to this headline"></a></h3>
<div class="figure align-center" id="id5">
<div class="graphviz"><object data="../_images/graphviz-62bb0a412f898ea996e9f83c0dc6dd8faf896ee5.svg" type="image/svg+xml" class="graphviz">
<p class="warning">digraph &quot;Inventory hierarchy&quot; {
node [fontname=Verdana fontsize=8 shape=plaintext penwidth=0.5 style=&quot;rounded,filled&quot; fillcolor=&quot;#fcf2e3&quot; color=&quot;#000000&quot;]
edge [color=&quot;#000000&quot;]
layout=&quot;dot&quot;
StationGroup [label=&quot;StationGroup&quot;, href=&quot;../base/api-python.html#api-python-datamodel-stationgroup&quot;, target=&quot;_top&quot;]
StationReference [label=&quot;StationReference&quot;, href=&quot;../base/api-python.html#api-python-datamodel-stationreference&quot;, target=&quot;_top&quot;]
AuxDevice [label=&quot;AuxDevice&quot;, href=&quot;../base/api-python.html#api-python-datamodel-auxdevice&quot;, target=&quot;_top&quot;]
AuxSource [label=&quot;AuxSource&quot;, href=&quot;../base/api-python.html#api-python-datamodel-auxsource&quot;, target=&quot;_top&quot;]
Sensor [label=&quot;Sensor&quot;, href=&quot;../base/api-python.html#api-python-datamodel-sensor&quot;, target=&quot;_top&quot;]
SensorCalibration [label=&quot;SensorCalibration&quot;, href=&quot;../base/api-python.html#api-python-datamodel-sensorcalibration&quot;, target=&quot;_top&quot;]
Datalogger [label=&quot;Datalogger&quot;, href=&quot;../base/api-python.html#api-python-datamodel-datalogger&quot;, target=&quot;_top&quot;]
DataloggerCalibration [label=&quot;DataloggerCalibration&quot;, href=&quot;../base/api-python.html#api-python-datamodel-dataloggercalibration&quot;, target=&quot;_top&quot;]
Decimation [label=&quot;Decimation&quot;, href=&quot;../base/api-python.html#api-python-datamodel-decimation&quot;, target=&quot;_top&quot;]
ResponsePAZ [label=&quot;ResponsePAZ&quot;, href=&quot;../base/api-python.html#api-python-datamodel-responsepaz&quot;, target=&quot;_top&quot;]
ResponseFIR [label=&quot;ResponseFIR&quot;, href=&quot;../base/api-python.html#api-python-datamodel-responsefir&quot;, target=&quot;_top&quot;]
ResponseIIR [label=&quot;ResponseIIR&quot;, href=&quot;../base/api-python.html#api-python-datamodel-responseiir&quot;, target=&quot;_top&quot;]
ResponsePolynomial [label=&quot;ResponsePolynomial&quot;, href=&quot;../base/api-python.html#api-python-datamodel-responsepolynomial&quot;, target=&quot;_top&quot;]
ResponseFAP [label=&quot;ResponseFAP&quot;, href=&quot;../base/api-python.html#api-python-datamodel-responsefap&quot;, target=&quot;_top&quot;]
Network [label=&quot;Network&quot;, href=&quot;../base/api-python.html#api-python-datamodel-network&quot;, target=&quot;_top&quot;]
Comment [label=&quot;Comment&quot;, href=&quot;../base/api-python.html#api-python-datamodel-comment&quot;, target=&quot;_top&quot;]
Station [label=&quot;Station&quot;, href=&quot;../base/api-python.html#api-python-datamodel-station&quot;, target=&quot;_top&quot;]
SensorLocation [label=&quot;SensorLocation&quot;, href=&quot;../base/api-python.html#api-python-datamodel-sensorlocation&quot;, target=&quot;_top&quot;]
AuxStream [label=&quot;AuxStream&quot;, href=&quot;../base/api-python.html#api-python-datamodel-auxstream&quot;, target=&quot;_top&quot;]
Stream [label=&quot;Stream&quot;, href=&quot;../base/api-python.html#api-python-datamodel-stream&quot;, target=&quot;_top&quot;]
Inventory [label=&quot;Inventory&quot;, href=&quot;../base/api-python.html#api-python-datamodel-inventory&quot;, target=&quot;_top&quot;]
Inventory -&gt; StationGroup [dir=back arrowtail=diamond]
StationGroup -&gt; StationReference [dir=back arrowtail=diamond]
Inventory -&gt; AuxDevice [dir=back arrowtail=diamond]
AuxDevice -&gt; AuxSource [dir=back arrowtail=diamond]
Inventory -&gt; Sensor [dir=back arrowtail=diamond]
Sensor -&gt; SensorCalibration [dir=back arrowtail=diamond]
Inventory -&gt; Datalogger [dir=back arrowtail=diamond]
Datalogger -&gt; DataloggerCalibration [dir=back arrowtail=diamond]
Datalogger -&gt; Decimation [dir=back arrowtail=diamond]
Inventory -&gt; ResponsePAZ [dir=back arrowtail=diamond]
Inventory -&gt; ResponseFIR [dir=back arrowtail=diamond]
Inventory -&gt; ResponseIIR [dir=back arrowtail=diamond]
Inventory -&gt; ResponsePolynomial [dir=back arrowtail=diamond]
Inventory -&gt; ResponseFAP [dir=back arrowtail=diamond]
Inventory -&gt; Network [dir=back arrowtail=diamond]
Stream -&gt; Comment [dir=back arrowtail=diamond]
SensorLocation -&gt; Comment [dir=back arrowtail=diamond]
Station -&gt; Comment [dir=back arrowtail=diamond]
Network -&gt; Comment [dir=back arrowtail=diamond]
Network -&gt; Station [dir=back arrowtail=diamond]
Station -&gt; SensorLocation [dir=back arrowtail=diamond]
SensorLocation -&gt; AuxStream [dir=back arrowtail=diamond]
SensorLocation -&gt; Stream [dir=back arrowtail=diamond]
}</p></object></div>
<p class="caption"><span class="caption-text">Inventory object connections from parent to child.</span><a class="headerlink" href="#id5" title="Permalink to this image"></a></p>
</div>
<div class="figure align-center" id="id6">
<div class="graphviz"><object data="../_images/graphviz-1577a678a3e7298feaf843105ef974118be9732e.svg" type="image/svg+xml" class="graphviz">
<p class="warning">digraph &quot;Inventory hierarchy&quot; {
node [fontname=Verdana fontsize=8 shape=plaintext penwidth=0.5 style=&quot;rounded,filled&quot; fillcolor=&quot;#fcf2e3&quot; color=&quot;#000000&quot;]
edge [color=&quot;#000000&quot;]
layout = &quot;dot&quot;
StationGroup [
labeltooltip = &quot;StationGroup&quot;
label = &lt;
&lt;table border=&quot;0&quot; cellpadding=&quot;0&quot; cellspacing=&quot;2&quot;&gt;
&lt;tr&gt;&lt;td&gt;StationGroup&lt;/td&gt;&lt;/tr&gt;
&lt;hr/&gt;
&lt;tr&gt;&lt;td&gt; &lt;/td&gt;&lt;/tr&gt;
&lt;tr&gt;&lt;td align=&quot;left&quot; port=&quot;publicID&quot;&gt;&lt;font color=&quot;#8b0000&quot;&gt;+ publicID: string&lt;/font&gt;&lt;/td&gt;&lt;/tr&gt;
&lt;tr&gt;&lt;td align=&quot;left&quot; port=&quot;type&quot;&gt;&lt;font color=&quot;#8b0000&quot;&gt;+ type: StationGroupType [0..1]&lt;/font&gt;&lt;/td&gt;&lt;/tr&gt;
&lt;tr&gt;&lt;td align=&quot;left&quot; port=&quot;code&quot;&gt;&lt;font color=&quot;#8b0000&quot;&gt;+ code: string&lt;/font&gt;&lt;/td&gt;&lt;/tr&gt;
&lt;tr&gt;&lt;td align=&quot;left&quot; port=&quot;start&quot;&gt;&lt;font color=&quot;#8b0000&quot;&gt;+ start: datetime [0..1]&lt;/font&gt;&lt;/td&gt;&lt;/tr&gt;
&lt;tr&gt;&lt;td align=&quot;left&quot; port=&quot;end&quot;&gt;&lt;font color=&quot;#8b0000&quot;&gt;+ end: datetime [0..1]&lt;/font&gt;&lt;/td&gt;&lt;/tr&gt;
&lt;tr&gt;&lt;td align=&quot;left&quot; port=&quot;description&quot;&gt;&lt;font color=&quot;#8b0000&quot;&gt;+ description: string&lt;/font&gt;&lt;/td&gt;&lt;/tr&gt;
&lt;tr&gt;&lt;td align=&quot;left&quot; port=&quot;latitude&quot;&gt;&lt;font color=&quot;#8b0000&quot;&gt;+ latitude: float [0..1]&lt;/font&gt;&lt;/td&gt;&lt;/tr&gt;
&lt;tr&gt;&lt;td align=&quot;left&quot; port=&quot;longitude&quot;&gt;&lt;font color=&quot;#8b0000&quot;&gt;+ longitude: float [0..1]&lt;/font&gt;&lt;/td&gt;&lt;/tr&gt;
&lt;tr&gt;&lt;td align=&quot;left&quot; port=&quot;elevation&quot;&gt;&lt;font color=&quot;#8b0000&quot;&gt;+ elevation: float [0..1]&lt;/font&gt;&lt;/td&gt;&lt;/tr&gt;
&lt;tr&gt;&lt;td align=&quot;left&quot;&gt;&lt;font color=&quot;#8b0000&quot;&gt;+ stationReference: StationReference [0..*]&lt;/font&gt;&lt;/td&gt;&lt;/tr&gt;
&lt;/table&gt;
&gt;
href = &quot;../base/api-python.html#api-python-datamodel-stationgroup&quot;
target = &quot;_top&quot;
]
StationReference [
labeltooltip = &quot;StationReference&quot;
label = &lt;
&lt;table border=&quot;0&quot; cellpadding=&quot;0&quot; cellspacing=&quot;2&quot;&gt;
&lt;tr&gt;&lt;td&gt;StationReference&lt;/td&gt;&lt;/tr&gt;
&lt;hr/&gt;
&lt;tr&gt;&lt;td&gt; &lt;/td&gt;&lt;/tr&gt;
&lt;tr&gt;&lt;td align=&quot;left&quot; port=&quot;stationID&quot;&gt;&lt;font color=&quot;#8b0000&quot;&gt;+ stationID: string&lt;/font&gt;&lt;/td&gt;&lt;/tr&gt;
&lt;/table&gt;
&gt;
href = &quot;../base/api-python.html#api-python-datamodel-stationreference&quot;
target = &quot;_top&quot;
]
AuxDevice [
labeltooltip = &quot;AuxDevice&quot;
label = &lt;
&lt;table border=&quot;0&quot; cellpadding=&quot;0&quot; cellspacing=&quot;2&quot;&gt;
&lt;tr&gt;&lt;td&gt;AuxDevice&lt;/td&gt;&lt;/tr&gt;
&lt;hr/&gt;
&lt;tr&gt;&lt;td&gt; &lt;/td&gt;&lt;/tr&gt;
&lt;tr&gt;&lt;td align=&quot;left&quot; port=&quot;publicID&quot;&gt;&lt;font color=&quot;#8b0000&quot;&gt;+ publicID: string&lt;/font&gt;&lt;/td&gt;&lt;/tr&gt;
&lt;tr&gt;&lt;td align=&quot;left&quot; port=&quot;name&quot;&gt;&lt;font color=&quot;#8b0000&quot;&gt;+ name: string&lt;/font&gt;&lt;/td&gt;&lt;/tr&gt;
&lt;tr&gt;&lt;td align=&quot;left&quot; port=&quot;description&quot;&gt;&lt;font color=&quot;#8b0000&quot;&gt;+ description: string&lt;/font&gt;&lt;/td&gt;&lt;/tr&gt;
&lt;tr&gt;&lt;td align=&quot;left&quot; port=&quot;model&quot;&gt;&lt;font color=&quot;#8b0000&quot;&gt;+ model: string&lt;/font&gt;&lt;/td&gt;&lt;/tr&gt;
&lt;tr&gt;&lt;td align=&quot;left&quot; port=&quot;manufacturer&quot;&gt;&lt;font color=&quot;#8b0000&quot;&gt;+ manufacturer: string&lt;/font&gt;&lt;/td&gt;&lt;/tr&gt;
&lt;tr&gt;&lt;td align=&quot;left&quot; port=&quot;remark&quot;&gt;&lt;font color=&quot;#8b0000&quot;&gt;+ remark: Blob [0..1]&lt;/font&gt;&lt;/td&gt;&lt;/tr&gt;
&lt;tr&gt;&lt;td align=&quot;left&quot;&gt;&lt;font color=&quot;#8b0000&quot;&gt;+ auxSource: AuxSource [0..*]&lt;/font&gt;&lt;/td&gt;&lt;/tr&gt;
&lt;/table&gt;
&gt;
href = &quot;../base/api-python.html#api-python-datamodel-auxdevice&quot;
target = &quot;_top&quot;
]
AuxSource [
labeltooltip = &quot;AuxSource&quot;
label = &lt;
&lt;table border=&quot;0&quot; cellpadding=&quot;0&quot; cellspacing=&quot;2&quot;&gt;
&lt;tr&gt;&lt;td&gt;AuxSource&lt;/td&gt;&lt;/tr&gt;
&lt;hr/&gt;
&lt;tr&gt;&lt;td&gt; &lt;/td&gt;&lt;/tr&gt;
&lt;tr&gt;&lt;td align=&quot;left&quot; port=&quot;name&quot;&gt;&lt;font color=&quot;#8b0000&quot;&gt;+ name: string&lt;/font&gt;&lt;/td&gt;&lt;/tr&gt;
&lt;tr&gt;&lt;td align=&quot;left&quot; port=&quot;description&quot;&gt;&lt;font color=&quot;#8b0000&quot;&gt;+ description: string&lt;/font&gt;&lt;/td&gt;&lt;/tr&gt;
&lt;tr&gt;&lt;td align=&quot;left&quot; port=&quot;unit&quot;&gt;&lt;font color=&quot;#8b0000&quot;&gt;+ unit: string&lt;/font&gt;&lt;/td&gt;&lt;/tr&gt;
&lt;tr&gt;&lt;td align=&quot;left&quot; port=&quot;conversion&quot;&gt;&lt;font color=&quot;#8b0000&quot;&gt;+ conversion: string&lt;/font&gt;&lt;/td&gt;&lt;/tr&gt;
&lt;tr&gt;&lt;td align=&quot;left&quot; port=&quot;sampleRateNumerator&quot;&gt;&lt;font color=&quot;#8b0000&quot;&gt;+ sampleRateNumerator: int [0..1]&lt;/font&gt;&lt;/td&gt;&lt;/tr&gt;
&lt;tr&gt;&lt;td align=&quot;left&quot; port=&quot;sampleRateDenominator&quot;&gt;&lt;font color=&quot;#8b0000&quot;&gt;+ sampleRateDenominator: int [0..1]&lt;/font&gt;&lt;/td&gt;&lt;/tr&gt;
&lt;tr&gt;&lt;td align=&quot;left&quot; port=&quot;remark&quot;&gt;&lt;font color=&quot;#8b0000&quot;&gt;+ remark: Blob [0..1]&lt;/font&gt;&lt;/td&gt;&lt;/tr&gt;
&lt;/table&gt;
&gt;
href = &quot;../base/api-python.html#api-python-datamodel-auxsource&quot;
target = &quot;_top&quot;
]
Sensor [
labeltooltip = &quot;Sensor&quot;
label = &lt;
&lt;table border=&quot;0&quot; cellpadding=&quot;0&quot; cellspacing=&quot;2&quot;&gt;
&lt;tr&gt;&lt;td&gt;Sensor&lt;/td&gt;&lt;/tr&gt;
&lt;hr/&gt;
&lt;tr&gt;&lt;td&gt; &lt;/td&gt;&lt;/tr&gt;
&lt;tr&gt;&lt;td align=&quot;left&quot; port=&quot;publicID&quot;&gt;&lt;font color=&quot;#8b0000&quot;&gt;+ publicID: string&lt;/font&gt;&lt;/td&gt;&lt;/tr&gt;
&lt;tr&gt;&lt;td align=&quot;left&quot; port=&quot;name&quot;&gt;&lt;font color=&quot;#8b0000&quot;&gt;+ name: string&lt;/font&gt;&lt;/td&gt;&lt;/tr&gt;
&lt;tr&gt;&lt;td align=&quot;left&quot; port=&quot;description&quot;&gt;&lt;font color=&quot;#8b0000&quot;&gt;+ description: string&lt;/font&gt;&lt;/td&gt;&lt;/tr&gt;
&lt;tr&gt;&lt;td align=&quot;left&quot; port=&quot;model&quot;&gt;&lt;font color=&quot;#8b0000&quot;&gt;+ model: string&lt;/font&gt;&lt;/td&gt;&lt;/tr&gt;
&lt;tr&gt;&lt;td align=&quot;left&quot; port=&quot;manufacturer&quot;&gt;&lt;font color=&quot;#8b0000&quot;&gt;+ manufacturer: string&lt;/font&gt;&lt;/td&gt;&lt;/tr&gt;
&lt;tr&gt;&lt;td align=&quot;left&quot; port=&quot;type&quot;&gt;&lt;font color=&quot;#8b0000&quot;&gt;+ type: string&lt;/font&gt;&lt;/td&gt;&lt;/tr&gt;
&lt;tr&gt;&lt;td align=&quot;left&quot; port=&quot;unit&quot;&gt;&lt;font color=&quot;#8b0000&quot;&gt;+ unit: string&lt;/font&gt;&lt;/td&gt;&lt;/tr&gt;
&lt;tr&gt;&lt;td align=&quot;left&quot; port=&quot;lowFrequency&quot;&gt;&lt;font color=&quot;#8b0000&quot;&gt;+ lowFrequency: float [0..1]&lt;/font&gt;&lt;/td&gt;&lt;/tr&gt;
&lt;tr&gt;&lt;td align=&quot;left&quot; port=&quot;highFrequency&quot;&gt;&lt;font color=&quot;#8b0000&quot;&gt;+ highFrequency: float [0..1]&lt;/font&gt;&lt;/td&gt;&lt;/tr&gt;
&lt;tr&gt;&lt;td align=&quot;left&quot; port=&quot;response&quot;&gt;&lt;font color=&quot;#8b0000&quot;&gt;+ response: string&lt;/font&gt;&lt;/td&gt;&lt;/tr&gt;
&lt;tr&gt;&lt;td align=&quot;left&quot; port=&quot;remark&quot;&gt;&lt;font color=&quot;#8b0000&quot;&gt;+ remark: Blob [0..1]&lt;/font&gt;&lt;/td&gt;&lt;/tr&gt;
&lt;tr&gt;&lt;td align=&quot;left&quot;&gt;&lt;font color=&quot;#8b0000&quot;&gt;+ sensorCalibration: SensorCalibration [0..*]&lt;/font&gt;&lt;/td&gt;&lt;/tr&gt;
&lt;/table&gt;
&gt;
href = &quot;../base/api-python.html#api-python-datamodel-sensor&quot;
target = &quot;_top&quot;
]
SensorCalibration [
labeltooltip = &quot;SensorCalibration&quot;
label = &lt;
&lt;table border=&quot;0&quot; cellpadding=&quot;0&quot; cellspacing=&quot;2&quot;&gt;
&lt;tr&gt;&lt;td&gt;SensorCalibration&lt;/td&gt;&lt;/tr&gt;
&lt;hr/&gt;
&lt;tr&gt;&lt;td&gt; &lt;/td&gt;&lt;/tr&gt;
&lt;tr&gt;&lt;td align=&quot;left&quot; port=&quot;serialNumber&quot;&gt;&lt;font color=&quot;#8b0000&quot;&gt;+ serialNumber: string&lt;/font&gt;&lt;/td&gt;&lt;/tr&gt;
&lt;tr&gt;&lt;td align=&quot;left&quot; port=&quot;channel&quot;&gt;&lt;font color=&quot;#8b0000&quot;&gt;+ channel: int&lt;/font&gt;&lt;/td&gt;&lt;/tr&gt;
&lt;tr&gt;&lt;td align=&quot;left&quot; port=&quot;start&quot;&gt;&lt;font color=&quot;#8b0000&quot;&gt;+ start: datetime&lt;/font&gt;&lt;/td&gt;&lt;/tr&gt;
&lt;tr&gt;&lt;td align=&quot;left&quot; port=&quot;end&quot;&gt;&lt;font color=&quot;#8b0000&quot;&gt;+ end: datetime [0..1]&lt;/font&gt;&lt;/td&gt;&lt;/tr&gt;
&lt;tr&gt;&lt;td align=&quot;left&quot; port=&quot;gain&quot;&gt;&lt;font color=&quot;#8b0000&quot;&gt;+ gain: float [0..1]&lt;/font&gt;&lt;/td&gt;&lt;/tr&gt;
&lt;tr&gt;&lt;td align=&quot;left&quot; port=&quot;gainFrequency&quot;&gt;&lt;font color=&quot;#8b0000&quot;&gt;+ gainFrequency: float [0..1]&lt;/font&gt;&lt;/td&gt;&lt;/tr&gt;
&lt;tr&gt;&lt;td align=&quot;left&quot; port=&quot;remark&quot;&gt;&lt;font color=&quot;#8b0000&quot;&gt;+ remark: Blob [0..1]&lt;/font&gt;&lt;/td&gt;&lt;/tr&gt;
&lt;/table&gt;
&gt;
href = &quot;../base/api-python.html#api-python-datamodel-sensorcalibration&quot;
target = &quot;_top&quot;
]
Datalogger [
labeltooltip = &quot;Datalogger&quot;
label = &lt;
&lt;table border=&quot;0&quot; cellpadding=&quot;0&quot; cellspacing=&quot;2&quot;&gt;
&lt;tr&gt;&lt;td&gt;Datalogger&lt;/td&gt;&lt;/tr&gt;
&lt;hr/&gt;
&lt;tr&gt;&lt;td&gt; &lt;/td&gt;&lt;/tr&gt;
&lt;tr&gt;&lt;td align=&quot;left&quot; port=&quot;publicID&quot;&gt;&lt;font color=&quot;#8b0000&quot;&gt;+ publicID: string&lt;/font&gt;&lt;/td&gt;&lt;/tr&gt;
&lt;tr&gt;&lt;td align=&quot;left&quot; port=&quot;name&quot;&gt;&lt;font color=&quot;#8b0000&quot;&gt;+ name: string&lt;/font&gt;&lt;/td&gt;&lt;/tr&gt;
&lt;tr&gt;&lt;td align=&quot;left&quot; port=&quot;description&quot;&gt;&lt;font color=&quot;#8b0000&quot;&gt;+ description: string&lt;/font&gt;&lt;/td&gt;&lt;/tr&gt;
&lt;tr&gt;&lt;td align=&quot;left&quot; port=&quot;digitizerModel&quot;&gt;&lt;font color=&quot;#8b0000&quot;&gt;+ digitizerModel: string&lt;/font&gt;&lt;/td&gt;&lt;/tr&gt;
&lt;tr&gt;&lt;td align=&quot;left&quot; port=&quot;digitizerManufacturer&quot;&gt;&lt;font color=&quot;#8b0000&quot;&gt;+ digitizerManufacturer: string&lt;/font&gt;&lt;/td&gt;&lt;/tr&gt;
&lt;tr&gt;&lt;td align=&quot;left&quot; port=&quot;recorderModel&quot;&gt;&lt;font color=&quot;#8b0000&quot;&gt;+ recorderModel: string&lt;/font&gt;&lt;/td&gt;&lt;/tr&gt;
&lt;tr&gt;&lt;td align=&quot;left&quot; port=&quot;recorderManufacturer&quot;&gt;&lt;font color=&quot;#8b0000&quot;&gt;+ recorderManufacturer: string&lt;/font&gt;&lt;/td&gt;&lt;/tr&gt;
&lt;tr&gt;&lt;td align=&quot;left&quot; port=&quot;clockModel&quot;&gt;&lt;font color=&quot;#8b0000&quot;&gt;+ clockModel: string&lt;/font&gt;&lt;/td&gt;&lt;/tr&gt;
&lt;tr&gt;&lt;td align=&quot;left&quot; port=&quot;clockManufacturer&quot;&gt;&lt;font color=&quot;#8b0000&quot;&gt;+ clockManufacturer: string&lt;/font&gt;&lt;/td&gt;&lt;/tr&gt;
&lt;tr&gt;&lt;td align=&quot;left&quot; port=&quot;clockType&quot;&gt;&lt;font color=&quot;#8b0000&quot;&gt;+ clockType: string&lt;/font&gt;&lt;/td&gt;&lt;/tr&gt;
&lt;tr&gt;&lt;td align=&quot;left&quot; port=&quot;gain&quot;&gt;&lt;font color=&quot;#8b0000&quot;&gt;+ gain: float [0..1]&lt;/font&gt;&lt;/td&gt;&lt;/tr&gt;
&lt;tr&gt;&lt;td align=&quot;left&quot; port=&quot;maxClockDrift&quot;&gt;&lt;font color=&quot;#8b0000&quot;&gt;+ maxClockDrift: float [0..1]&lt;/font&gt;&lt;/td&gt;&lt;/tr&gt;
&lt;tr&gt;&lt;td align=&quot;left&quot; port=&quot;remark&quot;&gt;&lt;font color=&quot;#8b0000&quot;&gt;+ remark: Blob [0..1]&lt;/font&gt;&lt;/td&gt;&lt;/tr&gt;
&lt;tr&gt;&lt;td align=&quot;left&quot;&gt;&lt;font color=&quot;#8b0000&quot;&gt;+ dataloggerCalibration: DataloggerCalibration [0..*]&lt;/font&gt;&lt;/td&gt;&lt;/tr&gt;
&lt;tr&gt;&lt;td align=&quot;left&quot;&gt;&lt;font color=&quot;#8b0000&quot;&gt;+ decimation: Decimation [0..*]&lt;/font&gt;&lt;/td&gt;&lt;/tr&gt;
&lt;/table&gt;
&gt;
href = &quot;../base/api-python.html#api-python-datamodel-datalogger&quot;
target = &quot;_top&quot;
]
DataloggerCalibration [
labeltooltip = &quot;DataloggerCalibration&quot;
label = &lt;
&lt;table border=&quot;0&quot; cellpadding=&quot;0&quot; cellspacing=&quot;2&quot;&gt;
&lt;tr&gt;&lt;td&gt;DataloggerCalibration&lt;/td&gt;&lt;/tr&gt;
&lt;hr/&gt;
&lt;tr&gt;&lt;td&gt; &lt;/td&gt;&lt;/tr&gt;
&lt;tr&gt;&lt;td align=&quot;left&quot; port=&quot;serialNumber&quot;&gt;&lt;font color=&quot;#8b0000&quot;&gt;+ serialNumber: string&lt;/font&gt;&lt;/td&gt;&lt;/tr&gt;
&lt;tr&gt;&lt;td align=&quot;left&quot; port=&quot;channel&quot;&gt;&lt;font color=&quot;#8b0000&quot;&gt;+ channel: int&lt;/font&gt;&lt;/td&gt;&lt;/tr&gt;
&lt;tr&gt;&lt;td align=&quot;left&quot; port=&quot;start&quot;&gt;&lt;font color=&quot;#8b0000&quot;&gt;+ start: datetime&lt;/font&gt;&lt;/td&gt;&lt;/tr&gt;
&lt;tr&gt;&lt;td align=&quot;left&quot; port=&quot;end&quot;&gt;&lt;font color=&quot;#8b0000&quot;&gt;+ end: datetime [0..1]&lt;/font&gt;&lt;/td&gt;&lt;/tr&gt;
&lt;tr&gt;&lt;td align=&quot;left&quot; port=&quot;gain&quot;&gt;&lt;font color=&quot;#8b0000&quot;&gt;+ gain: float [0..1]&lt;/font&gt;&lt;/td&gt;&lt;/tr&gt;
&lt;tr&gt;&lt;td align=&quot;left&quot; port=&quot;gainFrequency&quot;&gt;&lt;font color=&quot;#8b0000&quot;&gt;+ gainFrequency: float [0..1]&lt;/font&gt;&lt;/td&gt;&lt;/tr&gt;
&lt;tr&gt;&lt;td align=&quot;left&quot; port=&quot;remark&quot;&gt;&lt;font color=&quot;#8b0000&quot;&gt;+ remark: Blob [0..1]&lt;/font&gt;&lt;/td&gt;&lt;/tr&gt;
&lt;/table&gt;
&gt;
href = &quot;../base/api-python.html#api-python-datamodel-dataloggercalibration&quot;
target = &quot;_top&quot;
]
Decimation [
labeltooltip = &quot;Decimation&quot;
label = &lt;
&lt;table border=&quot;0&quot; cellpadding=&quot;0&quot; cellspacing=&quot;2&quot;&gt;
&lt;tr&gt;&lt;td&gt;Decimation&lt;/td&gt;&lt;/tr&gt;
&lt;hr/&gt;
&lt;tr&gt;&lt;td&gt; &lt;/td&gt;&lt;/tr&gt;
&lt;tr&gt;&lt;td align=&quot;left&quot; port=&quot;sampleRateNumerator&quot;&gt;&lt;font color=&quot;#8b0000&quot;&gt;+ sampleRateNumerator: int&lt;/font&gt;&lt;/td&gt;&lt;/tr&gt;
&lt;tr&gt;&lt;td align=&quot;left&quot; port=&quot;sampleRateDenominator&quot;&gt;&lt;font color=&quot;#8b0000&quot;&gt;+ sampleRateDenominator: int&lt;/font&gt;&lt;/td&gt;&lt;/tr&gt;
&lt;tr&gt;&lt;td align=&quot;left&quot; port=&quot;analogueFilterChain&quot;&gt;&lt;font color=&quot;#8b0000&quot;&gt;+ analogueFilterChain: Blob [0..1]&lt;/font&gt;&lt;/td&gt;&lt;/tr&gt;
&lt;tr&gt;&lt;td align=&quot;left&quot; port=&quot;digitalFilterChain&quot;&gt;&lt;font color=&quot;#8b0000&quot;&gt;+ digitalFilterChain: Blob [0..1]&lt;/font&gt;&lt;/td&gt;&lt;/tr&gt;
&lt;/table&gt;
&gt;
href = &quot;../base/api-python.html#api-python-datamodel-decimation&quot;
target = &quot;_top&quot;
]
ResponsePAZ [
labeltooltip = &quot;ResponsePAZ&quot;
label = &lt;
&lt;table border=&quot;0&quot; cellpadding=&quot;0&quot; cellspacing=&quot;2&quot;&gt;
&lt;tr&gt;&lt;td&gt;ResponsePAZ&lt;/td&gt;&lt;/tr&gt;
&lt;hr/&gt;
&lt;tr&gt;&lt;td&gt; &lt;/td&gt;&lt;/tr&gt;
&lt;tr&gt;&lt;td align=&quot;left&quot; port=&quot;publicID&quot;&gt;&lt;font color=&quot;#8b0000&quot;&gt;+ publicID: string&lt;/font&gt;&lt;/td&gt;&lt;/tr&gt;
&lt;tr&gt;&lt;td align=&quot;left&quot; port=&quot;name&quot;&gt;&lt;font color=&quot;#8b0000&quot;&gt;+ name: string&lt;/font&gt;&lt;/td&gt;&lt;/tr&gt;
&lt;tr&gt;&lt;td align=&quot;left&quot; port=&quot;type&quot;&gt;&lt;font color=&quot;#8b0000&quot;&gt;+ type: string&lt;/font&gt;&lt;/td&gt;&lt;/tr&gt;
&lt;tr&gt;&lt;td align=&quot;left&quot; port=&quot;gain&quot;&gt;&lt;font color=&quot;#8b0000&quot;&gt;+ gain: float [0..1]&lt;/font&gt;&lt;/td&gt;&lt;/tr&gt;
&lt;tr&gt;&lt;td align=&quot;left&quot; port=&quot;gainFrequency&quot;&gt;&lt;font color=&quot;#8b0000&quot;&gt;+ gainFrequency: float [0..1]&lt;/font&gt;&lt;/td&gt;&lt;/tr&gt;
&lt;tr&gt;&lt;td align=&quot;left&quot; port=&quot;normalizationFactor&quot;&gt;&lt;font color=&quot;#8b0000&quot;&gt;+ normalizationFactor: float [0..1]&lt;/font&gt;&lt;/td&gt;&lt;/tr&gt;
&lt;tr&gt;&lt;td align=&quot;left&quot; port=&quot;normalizationFrequency&quot;&gt;&lt;font color=&quot;#8b0000&quot;&gt;+ normalizationFrequency: float [0..1]&lt;/font&gt;&lt;/td&gt;&lt;/tr&gt;
&lt;tr&gt;&lt;td align=&quot;left&quot; port=&quot;numberOfZeros&quot;&gt;&lt;font color=&quot;#8b0000&quot;&gt;+ numberOfZeros: int [0..1]&lt;/font&gt;&lt;/td&gt;&lt;/tr&gt;
&lt;tr&gt;&lt;td align=&quot;left&quot; port=&quot;numberOfPoles&quot;&gt;&lt;font color=&quot;#8b0000&quot;&gt;+ numberOfPoles: int [0..1]&lt;/font&gt;&lt;/td&gt;&lt;/tr&gt;
&lt;tr&gt;&lt;td align=&quot;left&quot; port=&quot;zeros&quot;&gt;&lt;font color=&quot;#8b0000&quot;&gt;+ zeros: ComplexArray [0..1]&lt;/font&gt;&lt;/td&gt;&lt;/tr&gt;
&lt;tr&gt;&lt;td align=&quot;left&quot; port=&quot;poles&quot;&gt;&lt;font color=&quot;#8b0000&quot;&gt;+ poles: ComplexArray [0..1]&lt;/font&gt;&lt;/td&gt;&lt;/tr&gt;
&lt;tr&gt;&lt;td align=&quot;left&quot; port=&quot;remark&quot;&gt;&lt;font color=&quot;#8b0000&quot;&gt;+ remark: Blob [0..1]&lt;/font&gt;&lt;/td&gt;&lt;/tr&gt;
&lt;tr&gt;&lt;td align=&quot;left&quot; port=&quot;decimationFactor&quot;&gt;&lt;font color=&quot;#8b0000&quot;&gt;+ decimationFactor: int [0..1]&lt;/font&gt;&lt;/td&gt;&lt;/tr&gt;
&lt;tr&gt;&lt;td align=&quot;left&quot; port=&quot;delay&quot;&gt;&lt;font color=&quot;#8b0000&quot;&gt;+ delay: float [0..1]&lt;/font&gt;&lt;/td&gt;&lt;/tr&gt;
&lt;tr&gt;&lt;td align=&quot;left&quot; port=&quot;correction&quot;&gt;&lt;font color=&quot;#8b0000&quot;&gt;+ correction: float [0..1]&lt;/font&gt;&lt;/td&gt;&lt;/tr&gt;
&lt;/table&gt;
&gt;
href = &quot;../base/api-python.html#api-python-datamodel-responsepaz&quot;
target = &quot;_top&quot;
]
ResponseFIR [
labeltooltip = &quot;ResponseFIR&quot;
label = &lt;
&lt;table border=&quot;0&quot; cellpadding=&quot;0&quot; cellspacing=&quot;2&quot;&gt;
&lt;tr&gt;&lt;td&gt;ResponseFIR&lt;/td&gt;&lt;/tr&gt;
&lt;hr/&gt;
&lt;tr&gt;&lt;td&gt; &lt;/td&gt;&lt;/tr&gt;
&lt;tr&gt;&lt;td align=&quot;left&quot; port=&quot;publicID&quot;&gt;&lt;font color=&quot;#8b0000&quot;&gt;+ publicID: string&lt;/font&gt;&lt;/td&gt;&lt;/tr&gt;
&lt;tr&gt;&lt;td align=&quot;left&quot; port=&quot;name&quot;&gt;&lt;font color=&quot;#8b0000&quot;&gt;+ name: string&lt;/font&gt;&lt;/td&gt;&lt;/tr&gt;
&lt;tr&gt;&lt;td align=&quot;left&quot; port=&quot;gain&quot;&gt;&lt;font color=&quot;#8b0000&quot;&gt;+ gain: float [0..1]&lt;/font&gt;&lt;/td&gt;&lt;/tr&gt;
&lt;tr&gt;&lt;td align=&quot;left&quot; port=&quot;gainFrequency&quot;&gt;&lt;font color=&quot;#8b0000&quot;&gt;+ gainFrequency: float [0..1]&lt;/font&gt;&lt;/td&gt;&lt;/tr&gt;
&lt;tr&gt;&lt;td align=&quot;left&quot; port=&quot;decimationFactor&quot;&gt;&lt;font color=&quot;#8b0000&quot;&gt;+ decimationFactor: int [0..1]&lt;/font&gt;&lt;/td&gt;&lt;/tr&gt;
&lt;tr&gt;&lt;td align=&quot;left&quot; port=&quot;delay&quot;&gt;&lt;font color=&quot;#8b0000&quot;&gt;+ delay: float [0..1]&lt;/font&gt;&lt;/td&gt;&lt;/tr&gt;
&lt;tr&gt;&lt;td align=&quot;left&quot; port=&quot;correction&quot;&gt;&lt;font color=&quot;#8b0000&quot;&gt;+ correction: float [0..1]&lt;/font&gt;&lt;/td&gt;&lt;/tr&gt;
&lt;tr&gt;&lt;td align=&quot;left&quot; port=&quot;numberOfCoefficients&quot;&gt;&lt;font color=&quot;#8b0000&quot;&gt;+ numberOfCoefficients: int [0..1]&lt;/font&gt;&lt;/td&gt;&lt;/tr&gt;
&lt;tr&gt;&lt;td align=&quot;left&quot; port=&quot;symmetry&quot;&gt;&lt;font color=&quot;#8b0000&quot;&gt;+ symmetry: string&lt;/font&gt;&lt;/td&gt;&lt;/tr&gt;
&lt;tr&gt;&lt;td align=&quot;left&quot; port=&quot;coefficients&quot;&gt;&lt;font color=&quot;#8b0000&quot;&gt;+ coefficients: RealArray [0..1]&lt;/font&gt;&lt;/td&gt;&lt;/tr&gt;
&lt;tr&gt;&lt;td align=&quot;left&quot; port=&quot;remark&quot;&gt;&lt;font color=&quot;#8b0000&quot;&gt;+ remark: Blob [0..1]&lt;/font&gt;&lt;/td&gt;&lt;/tr&gt;
&lt;/table&gt;
&gt;
href = &quot;../base/api-python.html#api-python-datamodel-responsefir&quot;
target = &quot;_top&quot;
]
ResponseIIR [
labeltooltip = &quot;ResponseIIR&quot;
label = &lt;
&lt;table border=&quot;0&quot; cellpadding=&quot;0&quot; cellspacing=&quot;2&quot;&gt;
&lt;tr&gt;&lt;td&gt;ResponseIIR&lt;/td&gt;&lt;/tr&gt;
&lt;hr/&gt;
&lt;tr&gt;&lt;td&gt; &lt;/td&gt;&lt;/tr&gt;
&lt;tr&gt;&lt;td align=&quot;left&quot; port=&quot;publicID&quot;&gt;&lt;font color=&quot;#8b0000&quot;&gt;+ publicID: string&lt;/font&gt;&lt;/td&gt;&lt;/tr&gt;
&lt;tr&gt;&lt;td align=&quot;left&quot; port=&quot;name&quot;&gt;&lt;font color=&quot;#8b0000&quot;&gt;+ name: string&lt;/font&gt;&lt;/td&gt;&lt;/tr&gt;
&lt;tr&gt;&lt;td align=&quot;left&quot; port=&quot;type&quot;&gt;&lt;font color=&quot;#8b0000&quot;&gt;+ type: string&lt;/font&gt;&lt;/td&gt;&lt;/tr&gt;
&lt;tr&gt;&lt;td align=&quot;left&quot; port=&quot;gain&quot;&gt;&lt;font color=&quot;#8b0000&quot;&gt;+ gain: float [0..1]&lt;/font&gt;&lt;/td&gt;&lt;/tr&gt;
&lt;tr&gt;&lt;td align=&quot;left&quot; port=&quot;gainFrequency&quot;&gt;&lt;font color=&quot;#8b0000&quot;&gt;+ gainFrequency: float [0..1]&lt;/font&gt;&lt;/td&gt;&lt;/tr&gt;
&lt;tr&gt;&lt;td align=&quot;left&quot; port=&quot;decimationFactor&quot;&gt;&lt;font color=&quot;#8b0000&quot;&gt;+ decimationFactor: int [0..1]&lt;/font&gt;&lt;/td&gt;&lt;/tr&gt;
&lt;tr&gt;&lt;td align=&quot;left&quot; port=&quot;delay&quot;&gt;&lt;font color=&quot;#8b0000&quot;&gt;+ delay: float [0..1]&lt;/font&gt;&lt;/td&gt;&lt;/tr&gt;
&lt;tr&gt;&lt;td align=&quot;left&quot; port=&quot;correction&quot;&gt;&lt;font color=&quot;#8b0000&quot;&gt;+ correction: float [0..1]&lt;/font&gt;&lt;/td&gt;&lt;/tr&gt;
&lt;tr&gt;&lt;td align=&quot;left&quot; port=&quot;numberOfNumerators&quot;&gt;&lt;font color=&quot;#8b0000&quot;&gt;+ numberOfNumerators: int [0..1]&lt;/font&gt;&lt;/td&gt;&lt;/tr&gt;
&lt;tr&gt;&lt;td align=&quot;left&quot; port=&quot;numberOfDenominators&quot;&gt;&lt;font color=&quot;#8b0000&quot;&gt;+ numberOfDenominators: int [0..1]&lt;/font&gt;&lt;/td&gt;&lt;/tr&gt;
&lt;tr&gt;&lt;td align=&quot;left&quot; port=&quot;numerators&quot;&gt;&lt;font color=&quot;#8b0000&quot;&gt;+ numerators: RealArray [0..1]&lt;/font&gt;&lt;/td&gt;&lt;/tr&gt;
&lt;tr&gt;&lt;td align=&quot;left&quot; port=&quot;denominators&quot;&gt;&lt;font color=&quot;#8b0000&quot;&gt;+ denominators: RealArray [0..1]&lt;/font&gt;&lt;/td&gt;&lt;/tr&gt;
&lt;tr&gt;&lt;td align=&quot;left&quot; port=&quot;remark&quot;&gt;&lt;font color=&quot;#8b0000&quot;&gt;+ remark: Blob [0..1]&lt;/font&gt;&lt;/td&gt;&lt;/tr&gt;
&lt;/table&gt;
&gt;
href = &quot;../base/api-python.html#api-python-datamodel-responseiir&quot;
target = &quot;_top&quot;
]
ResponsePolynomial [
labeltooltip = &quot;ResponsePolynomial&quot;
label = &lt;
&lt;table border=&quot;0&quot; cellpadding=&quot;0&quot; cellspacing=&quot;2&quot;&gt;
&lt;tr&gt;&lt;td&gt;ResponsePolynomial&lt;/td&gt;&lt;/tr&gt;
&lt;hr/&gt;
&lt;tr&gt;&lt;td&gt; &lt;/td&gt;&lt;/tr&gt;
&lt;tr&gt;&lt;td align=&quot;left&quot; port=&quot;publicID&quot;&gt;&lt;font color=&quot;#8b0000&quot;&gt;+ publicID: string&lt;/font&gt;&lt;/td&gt;&lt;/tr&gt;
&lt;tr&gt;&lt;td align=&quot;left&quot; port=&quot;name&quot;&gt;&lt;font color=&quot;#8b0000&quot;&gt;+ name: string&lt;/font&gt;&lt;/td&gt;&lt;/tr&gt;
&lt;tr&gt;&lt;td align=&quot;left&quot; port=&quot;gain&quot;&gt;&lt;font color=&quot;#8b0000&quot;&gt;+ gain: float [0..1]&lt;/font&gt;&lt;/td&gt;&lt;/tr&gt;
&lt;tr&gt;&lt;td align=&quot;left&quot; port=&quot;gainFrequency&quot;&gt;&lt;font color=&quot;#8b0000&quot;&gt;+ gainFrequency: float [0..1]&lt;/font&gt;&lt;/td&gt;&lt;/tr&gt;
&lt;tr&gt;&lt;td align=&quot;left&quot; port=&quot;frequencyUnit&quot;&gt;&lt;font color=&quot;#8b0000&quot;&gt;+ frequencyUnit: string&lt;/font&gt;&lt;/td&gt;&lt;/tr&gt;
&lt;tr&gt;&lt;td align=&quot;left&quot; port=&quot;approximationType&quot;&gt;&lt;font color=&quot;#8b0000&quot;&gt;+ approximationType: string&lt;/font&gt;&lt;/td&gt;&lt;/tr&gt;
&lt;tr&gt;&lt;td align=&quot;left&quot; port=&quot;approximationLowerBound&quot;&gt;&lt;font color=&quot;#8b0000&quot;&gt;+ approximationLowerBound: float [0..1]&lt;/font&gt;&lt;/td&gt;&lt;/tr&gt;
&lt;tr&gt;&lt;td align=&quot;left&quot; port=&quot;approximationUpperBound&quot;&gt;&lt;font color=&quot;#8b0000&quot;&gt;+ approximationUpperBound: float [0..1]&lt;/font&gt;&lt;/td&gt;&lt;/tr&gt;
&lt;tr&gt;&lt;td align=&quot;left&quot; port=&quot;approximationError&quot;&gt;&lt;font color=&quot;#8b0000&quot;&gt;+ approximationError: float [0..1]&lt;/font&gt;&lt;/td&gt;&lt;/tr&gt;
&lt;tr&gt;&lt;td align=&quot;left&quot; port=&quot;numberOfCoefficients&quot;&gt;&lt;font color=&quot;#8b0000&quot;&gt;+ numberOfCoefficients: int [0..1]&lt;/font&gt;&lt;/td&gt;&lt;/tr&gt;
&lt;tr&gt;&lt;td align=&quot;left&quot; port=&quot;coefficients&quot;&gt;&lt;font color=&quot;#8b0000&quot;&gt;+ coefficients: RealArray [0..1]&lt;/font&gt;&lt;/td&gt;&lt;/tr&gt;
&lt;tr&gt;&lt;td align=&quot;left&quot; port=&quot;remark&quot;&gt;&lt;font color=&quot;#8b0000&quot;&gt;+ remark: Blob [0..1]&lt;/font&gt;&lt;/td&gt;&lt;/tr&gt;
&lt;/table&gt;
&gt;
href = &quot;../base/api-python.html#api-python-datamodel-responsepolynomial&quot;
target = &quot;_top&quot;
]
ResponseFAP [
labeltooltip = &quot;ResponseFAP&quot;
label = &lt;
&lt;table border=&quot;0&quot; cellpadding=&quot;0&quot; cellspacing=&quot;2&quot;&gt;
&lt;tr&gt;&lt;td&gt;ResponseFAP&lt;/td&gt;&lt;/tr&gt;
&lt;hr/&gt;
&lt;tr&gt;&lt;td&gt; &lt;/td&gt;&lt;/tr&gt;
&lt;tr&gt;&lt;td align=&quot;left&quot; port=&quot;publicID&quot;&gt;&lt;font color=&quot;#8b0000&quot;&gt;+ publicID: string&lt;/font&gt;&lt;/td&gt;&lt;/tr&gt;
&lt;tr&gt;&lt;td align=&quot;left&quot; port=&quot;name&quot;&gt;&lt;font color=&quot;#8b0000&quot;&gt;+ name: string&lt;/font&gt;&lt;/td&gt;&lt;/tr&gt;
&lt;tr&gt;&lt;td align=&quot;left&quot; port=&quot;gain&quot;&gt;&lt;font color=&quot;#8b0000&quot;&gt;+ gain: float [0..1]&lt;/font&gt;&lt;/td&gt;&lt;/tr&gt;
&lt;tr&gt;&lt;td align=&quot;left&quot; port=&quot;gainFrequency&quot;&gt;&lt;font color=&quot;#8b0000&quot;&gt;+ gainFrequency: float [0..1]&lt;/font&gt;&lt;/td&gt;&lt;/tr&gt;
&lt;tr&gt;&lt;td align=&quot;left&quot; port=&quot;numberOfTuples&quot;&gt;&lt;font color=&quot;#8b0000&quot;&gt;+ numberOfTuples: int [0..1]&lt;/font&gt;&lt;/td&gt;&lt;/tr&gt;
&lt;tr&gt;&lt;td align=&quot;left&quot; port=&quot;tuples&quot;&gt;&lt;font color=&quot;#8b0000&quot;&gt;+ tuples: RealArray [0..1]&lt;/font&gt;&lt;/td&gt;&lt;/tr&gt;
&lt;tr&gt;&lt;td align=&quot;left&quot; port=&quot;remark&quot;&gt;&lt;font color=&quot;#8b0000&quot;&gt;+ remark: Blob [0..1]&lt;/font&gt;&lt;/td&gt;&lt;/tr&gt;
&lt;/table&gt;
&gt;
href = &quot;../base/api-python.html#api-python-datamodel-responsefap&quot;
target = &quot;_top&quot;
]
Network [
labeltooltip = &quot;Network&quot;
label = &lt;
&lt;table border=&quot;0&quot; cellpadding=&quot;0&quot; cellspacing=&quot;2&quot;&gt;
&lt;tr&gt;&lt;td&gt;Network&lt;/td&gt;&lt;/tr&gt;
&lt;hr/&gt;
&lt;tr&gt;&lt;td&gt; &lt;/td&gt;&lt;/tr&gt;
&lt;tr&gt;&lt;td align=&quot;left&quot; port=&quot;publicID&quot;&gt;&lt;font color=&quot;#8b0000&quot;&gt;+ publicID: string&lt;/font&gt;&lt;/td&gt;&lt;/tr&gt;
&lt;tr&gt;&lt;td align=&quot;left&quot; port=&quot;code&quot;&gt;&lt;font color=&quot;#8b0000&quot;&gt;+ code: string&lt;/font&gt;&lt;/td&gt;&lt;/tr&gt;
&lt;tr&gt;&lt;td align=&quot;left&quot; port=&quot;start&quot;&gt;&lt;font color=&quot;#8b0000&quot;&gt;+ start: datetime&lt;/font&gt;&lt;/td&gt;&lt;/tr&gt;
&lt;tr&gt;&lt;td align=&quot;left&quot; port=&quot;end&quot;&gt;&lt;font color=&quot;#8b0000&quot;&gt;+ end: datetime [0..1]&lt;/font&gt;&lt;/td&gt;&lt;/tr&gt;
&lt;tr&gt;&lt;td align=&quot;left&quot; port=&quot;description&quot;&gt;&lt;font color=&quot;#8b0000&quot;&gt;+ description: string&lt;/font&gt;&lt;/td&gt;&lt;/tr&gt;
&lt;tr&gt;&lt;td align=&quot;left&quot; port=&quot;institutions&quot;&gt;&lt;font color=&quot;#8b0000&quot;&gt;+ institutions: string&lt;/font&gt;&lt;/td&gt;&lt;/tr&gt;
&lt;tr&gt;&lt;td align=&quot;left&quot; port=&quot;region&quot;&gt;&lt;font color=&quot;#8b0000&quot;&gt;+ region: string&lt;/font&gt;&lt;/td&gt;&lt;/tr&gt;
&lt;tr&gt;&lt;td align=&quot;left&quot; port=&quot;type&quot;&gt;&lt;font color=&quot;#8b0000&quot;&gt;+ type: string&lt;/font&gt;&lt;/td&gt;&lt;/tr&gt;
&lt;tr&gt;&lt;td align=&quot;left&quot; port=&quot;netClass&quot;&gt;&lt;font color=&quot;#8b0000&quot;&gt;+ netClass: string&lt;/font&gt;&lt;/td&gt;&lt;/tr&gt;
&lt;tr&gt;&lt;td align=&quot;left&quot; port=&quot;archive&quot;&gt;&lt;font color=&quot;#8b0000&quot;&gt;+ archive: string&lt;/font&gt;&lt;/td&gt;&lt;/tr&gt;
&lt;tr&gt;&lt;td align=&quot;left&quot; port=&quot;restricted&quot;&gt;&lt;font color=&quot;#8b0000&quot;&gt;+ restricted: boolean [0..1]&lt;/font&gt;&lt;/td&gt;&lt;/tr&gt;
&lt;tr&gt;&lt;td align=&quot;left&quot; port=&quot;shared&quot;&gt;&lt;font color=&quot;#8b0000&quot;&gt;+ shared: boolean [0..1]&lt;/font&gt;&lt;/td&gt;&lt;/tr&gt;
&lt;tr&gt;&lt;td align=&quot;left&quot; port=&quot;remark&quot;&gt;&lt;font color=&quot;#8b0000&quot;&gt;+ remark: Blob [0..1]&lt;/font&gt;&lt;/td&gt;&lt;/tr&gt;
&lt;tr&gt;&lt;td align=&quot;left&quot;&gt;&lt;font color=&quot;#8b0000&quot;&gt;+ comment: Comment [0..*]&lt;/font&gt;&lt;/td&gt;&lt;/tr&gt;
&lt;tr&gt;&lt;td align=&quot;left&quot;&gt;&lt;font color=&quot;#8b0000&quot;&gt;+ station: Station [0..*]&lt;/font&gt;&lt;/td&gt;&lt;/tr&gt;
&lt;/table&gt;
&gt;
href = &quot;../base/api-python.html#api-python-datamodel-network&quot;
target = &quot;_top&quot;
]
Comment [
labeltooltip = &quot;Comment&quot;
label = &lt;
&lt;table border=&quot;0&quot; cellpadding=&quot;0&quot; cellspacing=&quot;2&quot;&gt;
&lt;tr&gt;&lt;td&gt;Comment&lt;/td&gt;&lt;/tr&gt;
&lt;hr/&gt;
&lt;tr&gt;&lt;td&gt; &lt;/td&gt;&lt;/tr&gt;
&lt;tr&gt;&lt;td align=&quot;left&quot; port=&quot;text&quot;&gt;&lt;font color=&quot;#8b0000&quot;&gt;+ text: string&lt;/font&gt;&lt;/td&gt;&lt;/tr&gt;
&lt;tr&gt;&lt;td align=&quot;left&quot; port=&quot;id&quot;&gt;&lt;font color=&quot;#8b0000&quot;&gt;+ id: string&lt;/font&gt;&lt;/td&gt;&lt;/tr&gt;
&lt;tr&gt;&lt;td align=&quot;left&quot; port=&quot;start&quot;&gt;&lt;font color=&quot;#8b0000&quot;&gt;+ start: datetime [0..1]&lt;/font&gt;&lt;/td&gt;&lt;/tr&gt;
&lt;tr&gt;&lt;td align=&quot;left&quot; port=&quot;end&quot;&gt;&lt;font color=&quot;#8b0000&quot;&gt;+ end: datetime [0..1]&lt;/font&gt;&lt;/td&gt;&lt;/tr&gt;
&lt;tr&gt;&lt;td align=&quot;left&quot; port=&quot;creationInfo&quot;&gt;&lt;font color=&quot;#8b0000&quot;&gt;+ creationInfo: CreationInfo [0..1]&lt;/font&gt;&lt;/td&gt;&lt;/tr&gt;
&lt;/table&gt;
&gt;
href = &quot;../base/api-python.html#api-python-datamodel-comment&quot;
target = &quot;_top&quot;
]
Station [
labeltooltip = &quot;Station&quot;
label = &lt;
&lt;table border=&quot;0&quot; cellpadding=&quot;0&quot; cellspacing=&quot;2&quot;&gt;
&lt;tr&gt;&lt;td&gt;Station&lt;/td&gt;&lt;/tr&gt;
&lt;hr/&gt;
&lt;tr&gt;&lt;td&gt; &lt;/td&gt;&lt;/tr&gt;
&lt;tr&gt;&lt;td align=&quot;left&quot; port=&quot;publicID&quot;&gt;&lt;font color=&quot;#8b0000&quot;&gt;+ publicID: string&lt;/font&gt;&lt;/td&gt;&lt;/tr&gt;
&lt;tr&gt;&lt;td align=&quot;left&quot; port=&quot;code&quot;&gt;&lt;font color=&quot;#8b0000&quot;&gt;+ code: string&lt;/font&gt;&lt;/td&gt;&lt;/tr&gt;
&lt;tr&gt;&lt;td align=&quot;left&quot; port=&quot;start&quot;&gt;&lt;font color=&quot;#8b0000&quot;&gt;+ start: datetime&lt;/font&gt;&lt;/td&gt;&lt;/tr&gt;
&lt;tr&gt;&lt;td align=&quot;left&quot; port=&quot;end&quot;&gt;&lt;font color=&quot;#8b0000&quot;&gt;+ end: datetime [0..1]&lt;/font&gt;&lt;/td&gt;&lt;/tr&gt;
&lt;tr&gt;&lt;td align=&quot;left&quot; port=&quot;description&quot;&gt;&lt;font color=&quot;#8b0000&quot;&gt;+ description: string&lt;/font&gt;&lt;/td&gt;&lt;/tr&gt;
&lt;tr&gt;&lt;td align=&quot;left&quot; port=&quot;latitude&quot;&gt;&lt;font color=&quot;#8b0000&quot;&gt;+ latitude: float [0..1]&lt;/font&gt;&lt;/td&gt;&lt;/tr&gt;
&lt;tr&gt;&lt;td align=&quot;left&quot; port=&quot;longitude&quot;&gt;&lt;font color=&quot;#8b0000&quot;&gt;+ longitude: float [0..1]&lt;/font&gt;&lt;/td&gt;&lt;/tr&gt;
&lt;tr&gt;&lt;td align=&quot;left&quot; port=&quot;elevation&quot;&gt;&lt;font color=&quot;#8b0000&quot;&gt;+ elevation: float [0..1]&lt;/font&gt;&lt;/td&gt;&lt;/tr&gt;
&lt;tr&gt;&lt;td align=&quot;left&quot; port=&quot;place&quot;&gt;&lt;font color=&quot;#8b0000&quot;&gt;+ place: string&lt;/font&gt;&lt;/td&gt;&lt;/tr&gt;
&lt;tr&gt;&lt;td align=&quot;left&quot; port=&quot;country&quot;&gt;&lt;font color=&quot;#8b0000&quot;&gt;+ country: string&lt;/font&gt;&lt;/td&gt;&lt;/tr&gt;
&lt;tr&gt;&lt;td align=&quot;left&quot; port=&quot;affiliation&quot;&gt;&lt;font color=&quot;#8b0000&quot;&gt;+ affiliation: string&lt;/font&gt;&lt;/td&gt;&lt;/tr&gt;
&lt;tr&gt;&lt;td align=&quot;left&quot; port=&quot;type&quot;&gt;&lt;font color=&quot;#8b0000&quot;&gt;+ type: string&lt;/font&gt;&lt;/td&gt;&lt;/tr&gt;
&lt;tr&gt;&lt;td align=&quot;left&quot; port=&quot;archive&quot;&gt;&lt;font color=&quot;#8b0000&quot;&gt;+ archive: string&lt;/font&gt;&lt;/td&gt;&lt;/tr&gt;
&lt;tr&gt;&lt;td align=&quot;left&quot; port=&quot;archiveNetworkCode&quot;&gt;&lt;font color=&quot;#8b0000&quot;&gt;+ archiveNetworkCode: string&lt;/font&gt;&lt;/td&gt;&lt;/tr&gt;
&lt;tr&gt;&lt;td align=&quot;left&quot; port=&quot;restricted&quot;&gt;&lt;font color=&quot;#8b0000&quot;&gt;+ restricted: boolean [0..1]&lt;/font&gt;&lt;/td&gt;&lt;/tr&gt;
&lt;tr&gt;&lt;td align=&quot;left&quot; port=&quot;shared&quot;&gt;&lt;font color=&quot;#8b0000&quot;&gt;+ shared: boolean [0..1]&lt;/font&gt;&lt;/td&gt;&lt;/tr&gt;
&lt;tr&gt;&lt;td align=&quot;left&quot; port=&quot;remark&quot;&gt;&lt;font color=&quot;#8b0000&quot;&gt;+ remark: Blob [0..1]&lt;/font&gt;&lt;/td&gt;&lt;/tr&gt;
&lt;tr&gt;&lt;td align=&quot;left&quot;&gt;&lt;font color=&quot;#8b0000&quot;&gt;+ comment: Comment [0..*]&lt;/font&gt;&lt;/td&gt;&lt;/tr&gt;
&lt;tr&gt;&lt;td align=&quot;left&quot;&gt;&lt;font color=&quot;#8b0000&quot;&gt;+ sensorLocation: SensorLocation [0..*]&lt;/font&gt;&lt;/td&gt;&lt;/tr&gt;
&lt;/table&gt;
&gt;
href = &quot;../base/api-python.html#api-python-datamodel-station&quot;
target = &quot;_top&quot;
]
SensorLocation [
labeltooltip = &quot;SensorLocation&quot;
label = &lt;
&lt;table border=&quot;0&quot; cellpadding=&quot;0&quot; cellspacing=&quot;2&quot;&gt;
&lt;tr&gt;&lt;td&gt;SensorLocation&lt;/td&gt;&lt;/tr&gt;
&lt;hr/&gt;
&lt;tr&gt;&lt;td&gt; &lt;/td&gt;&lt;/tr&gt;
&lt;tr&gt;&lt;td align=&quot;left&quot; port=&quot;publicID&quot;&gt;&lt;font color=&quot;#8b0000&quot;&gt;+ publicID: string&lt;/font&gt;&lt;/td&gt;&lt;/tr&gt;
&lt;tr&gt;&lt;td align=&quot;left&quot; port=&quot;code&quot;&gt;&lt;font color=&quot;#8b0000&quot;&gt;+ code: string&lt;/font&gt;&lt;/td&gt;&lt;/tr&gt;
&lt;tr&gt;&lt;td align=&quot;left&quot; port=&quot;start&quot;&gt;&lt;font color=&quot;#8b0000&quot;&gt;+ start: datetime&lt;/font&gt;&lt;/td&gt;&lt;/tr&gt;
&lt;tr&gt;&lt;td align=&quot;left&quot; port=&quot;end&quot;&gt;&lt;font color=&quot;#8b0000&quot;&gt;+ end: datetime [0..1]&lt;/font&gt;&lt;/td&gt;&lt;/tr&gt;
&lt;tr&gt;&lt;td align=&quot;left&quot; port=&quot;latitude&quot;&gt;&lt;font color=&quot;#8b0000&quot;&gt;+ latitude: float [0..1]&lt;/font&gt;&lt;/td&gt;&lt;/tr&gt;
&lt;tr&gt;&lt;td align=&quot;left&quot; port=&quot;longitude&quot;&gt;&lt;font color=&quot;#8b0000&quot;&gt;+ longitude: float [0..1]&lt;/font&gt;&lt;/td&gt;&lt;/tr&gt;
&lt;tr&gt;&lt;td align=&quot;left&quot; port=&quot;elevation&quot;&gt;&lt;font color=&quot;#8b0000&quot;&gt;+ elevation: float [0..1]&lt;/font&gt;&lt;/td&gt;&lt;/tr&gt;
&lt;tr&gt;&lt;td align=&quot;left&quot;&gt;&lt;font color=&quot;#8b0000&quot;&gt;+ comment: Comment [0..*]&lt;/font&gt;&lt;/td&gt;&lt;/tr&gt;
&lt;tr&gt;&lt;td align=&quot;left&quot;&gt;&lt;font color=&quot;#8b0000&quot;&gt;+ auxStream: AuxStream [0..*]&lt;/font&gt;&lt;/td&gt;&lt;/tr&gt;
&lt;tr&gt;&lt;td align=&quot;left&quot;&gt;&lt;font color=&quot;#8b0000&quot;&gt;+ stream: Stream [0..*]&lt;/font&gt;&lt;/td&gt;&lt;/tr&gt;
&lt;/table&gt;
&gt;
href = &quot;../base/api-python.html#api-python-datamodel-sensorlocation&quot;
target = &quot;_top&quot;
]
AuxStream [
labeltooltip = &quot;AuxStream&quot;
label = &lt;
&lt;table border=&quot;0&quot; cellpadding=&quot;0&quot; cellspacing=&quot;2&quot;&gt;
&lt;tr&gt;&lt;td&gt;AuxStream&lt;/td&gt;&lt;/tr&gt;
&lt;hr/&gt;
&lt;tr&gt;&lt;td&gt; &lt;/td&gt;&lt;/tr&gt;
&lt;tr&gt;&lt;td align=&quot;left&quot; port=&quot;code&quot;&gt;&lt;font color=&quot;#8b0000&quot;&gt;+ code: string&lt;/font&gt;&lt;/td&gt;&lt;/tr&gt;
&lt;tr&gt;&lt;td align=&quot;left&quot; port=&quot;start&quot;&gt;&lt;font color=&quot;#8b0000&quot;&gt;+ start: datetime&lt;/font&gt;&lt;/td&gt;&lt;/tr&gt;
&lt;tr&gt;&lt;td align=&quot;left&quot; port=&quot;end&quot;&gt;&lt;font color=&quot;#8b0000&quot;&gt;+ end: datetime [0..1]&lt;/font&gt;&lt;/td&gt;&lt;/tr&gt;
&lt;tr&gt;&lt;td align=&quot;left&quot; port=&quot;device&quot;&gt;&lt;font color=&quot;#8b0000&quot;&gt;+ device: string&lt;/font&gt;&lt;/td&gt;&lt;/tr&gt;
&lt;tr&gt;&lt;td align=&quot;left&quot; port=&quot;deviceSerialNumber&quot;&gt;&lt;font color=&quot;#8b0000&quot;&gt;+ deviceSerialNumber: string&lt;/font&gt;&lt;/td&gt;&lt;/tr&gt;
&lt;tr&gt;&lt;td align=&quot;left&quot; port=&quot;source&quot;&gt;&lt;font color=&quot;#8b0000&quot;&gt;+ source: string&lt;/font&gt;&lt;/td&gt;&lt;/tr&gt;
&lt;tr&gt;&lt;td align=&quot;left&quot; port=&quot;format&quot;&gt;&lt;font color=&quot;#8b0000&quot;&gt;+ format: string&lt;/font&gt;&lt;/td&gt;&lt;/tr&gt;
&lt;tr&gt;&lt;td align=&quot;left&quot; port=&quot;flags&quot;&gt;&lt;font color=&quot;#8b0000&quot;&gt;+ flags: string&lt;/font&gt;&lt;/td&gt;&lt;/tr&gt;
&lt;tr&gt;&lt;td align=&quot;left&quot; port=&quot;restricted&quot;&gt;&lt;font color=&quot;#8b0000&quot;&gt;+ restricted: boolean [0..1]&lt;/font&gt;&lt;/td&gt;&lt;/tr&gt;
&lt;tr&gt;&lt;td align=&quot;left&quot; port=&quot;shared&quot;&gt;&lt;font color=&quot;#8b0000&quot;&gt;+ shared: boolean [0..1]&lt;/font&gt;&lt;/td&gt;&lt;/tr&gt;
&lt;/table&gt;
&gt;
href = &quot;../base/api-python.html#api-python-datamodel-auxstream&quot;
target = &quot;_top&quot;
]
Stream [
labeltooltip = &quot;Stream&quot;
label = &lt;
&lt;table border=&quot;0&quot; cellpadding=&quot;0&quot; cellspacing=&quot;2&quot;&gt;
&lt;tr&gt;&lt;td&gt;Stream&lt;/td&gt;&lt;/tr&gt;
&lt;hr/&gt;
&lt;tr&gt;&lt;td&gt; &lt;/td&gt;&lt;/tr&gt;
&lt;tr&gt;&lt;td align=&quot;left&quot; port=&quot;publicID&quot;&gt;&lt;font color=&quot;#8b0000&quot;&gt;+ publicID: string&lt;/font&gt;&lt;/td&gt;&lt;/tr&gt;
&lt;tr&gt;&lt;td align=&quot;left&quot; port=&quot;code&quot;&gt;&lt;font color=&quot;#8b0000&quot;&gt;+ code: string&lt;/font&gt;&lt;/td&gt;&lt;/tr&gt;
&lt;tr&gt;&lt;td align=&quot;left&quot; port=&quot;start&quot;&gt;&lt;font color=&quot;#8b0000&quot;&gt;+ start: datetime&lt;/font&gt;&lt;/td&gt;&lt;/tr&gt;
&lt;tr&gt;&lt;td align=&quot;left&quot; port=&quot;end&quot;&gt;&lt;font color=&quot;#8b0000&quot;&gt;+ end: datetime [0..1]&lt;/font&gt;&lt;/td&gt;&lt;/tr&gt;
&lt;tr&gt;&lt;td align=&quot;left&quot; port=&quot;datalogger&quot;&gt;&lt;font color=&quot;#8b0000&quot;&gt;+ datalogger: string&lt;/font&gt;&lt;/td&gt;&lt;/tr&gt;
&lt;tr&gt;&lt;td align=&quot;left&quot; port=&quot;dataloggerSerialNumber&quot;&gt;&lt;font color=&quot;#8b0000&quot;&gt;+ dataloggerSerialNumber: string&lt;/font&gt;&lt;/td&gt;&lt;/tr&gt;
&lt;tr&gt;&lt;td align=&quot;left&quot; port=&quot;dataloggerChannel&quot;&gt;&lt;font color=&quot;#8b0000&quot;&gt;+ dataloggerChannel: int [0..1]&lt;/font&gt;&lt;/td&gt;&lt;/tr&gt;
&lt;tr&gt;&lt;td align=&quot;left&quot; port=&quot;sensor&quot;&gt;&lt;font color=&quot;#8b0000&quot;&gt;+ sensor: string&lt;/font&gt;&lt;/td&gt;&lt;/tr&gt;
&lt;tr&gt;&lt;td align=&quot;left&quot; port=&quot;sensorSerialNumber&quot;&gt;&lt;font color=&quot;#8b0000&quot;&gt;+ sensorSerialNumber: string&lt;/font&gt;&lt;/td&gt;&lt;/tr&gt;
&lt;tr&gt;&lt;td align=&quot;left&quot; port=&quot;sensorChannel&quot;&gt;&lt;font color=&quot;#8b0000&quot;&gt;+ sensorChannel: int [0..1]&lt;/font&gt;&lt;/td&gt;&lt;/tr&gt;
&lt;tr&gt;&lt;td align=&quot;left&quot; port=&quot;clockSerialNumber&quot;&gt;&lt;font color=&quot;#8b0000&quot;&gt;+ clockSerialNumber: string&lt;/font&gt;&lt;/td&gt;&lt;/tr&gt;
&lt;tr&gt;&lt;td align=&quot;left&quot; port=&quot;sampleRateNumerator&quot;&gt;&lt;font color=&quot;#8b0000&quot;&gt;+ sampleRateNumerator: int [0..1]&lt;/font&gt;&lt;/td&gt;&lt;/tr&gt;
&lt;tr&gt;&lt;td align=&quot;left&quot; port=&quot;sampleRateDenominator&quot;&gt;&lt;font color=&quot;#8b0000&quot;&gt;+ sampleRateDenominator: int [0..1]&lt;/font&gt;&lt;/td&gt;&lt;/tr&gt;
&lt;tr&gt;&lt;td align=&quot;left&quot; port=&quot;depth&quot;&gt;&lt;font color=&quot;#8b0000&quot;&gt;+ depth: float [0..1]&lt;/font&gt;&lt;/td&gt;&lt;/tr&gt;
&lt;tr&gt;&lt;td align=&quot;left&quot; port=&quot;azimuth&quot;&gt;&lt;font color=&quot;#8b0000&quot;&gt;+ azimuth: float [0..1]&lt;/font&gt;&lt;/td&gt;&lt;/tr&gt;
&lt;tr&gt;&lt;td align=&quot;left&quot; port=&quot;dip&quot;&gt;&lt;font color=&quot;#8b0000&quot;&gt;+ dip: float [0..1]&lt;/font&gt;&lt;/td&gt;&lt;/tr&gt;
&lt;tr&gt;&lt;td align=&quot;left&quot; port=&quot;gain&quot;&gt;&lt;font color=&quot;#8b0000&quot;&gt;+ gain: float [0..1]&lt;/font&gt;&lt;/td&gt;&lt;/tr&gt;
&lt;tr&gt;&lt;td align=&quot;left&quot; port=&quot;gainFrequency&quot;&gt;&lt;font color=&quot;#8b0000&quot;&gt;+ gainFrequency: float [0..1]&lt;/font&gt;&lt;/td&gt;&lt;/tr&gt;
&lt;tr&gt;&lt;td align=&quot;left&quot; port=&quot;gainUnit&quot;&gt;&lt;font color=&quot;#8b0000&quot;&gt;+ gainUnit: string&lt;/font&gt;&lt;/td&gt;&lt;/tr&gt;
&lt;tr&gt;&lt;td align=&quot;left&quot; port=&quot;format&quot;&gt;&lt;font color=&quot;#8b0000&quot;&gt;+ format: string&lt;/font&gt;&lt;/td&gt;&lt;/tr&gt;
&lt;tr&gt;&lt;td align=&quot;left&quot; port=&quot;flags&quot;&gt;&lt;font color=&quot;#8b0000&quot;&gt;+ flags: string&lt;/font&gt;&lt;/td&gt;&lt;/tr&gt;
&lt;tr&gt;&lt;td align=&quot;left&quot; port=&quot;restricted&quot;&gt;&lt;font color=&quot;#8b0000&quot;&gt;+ restricted: boolean [0..1]&lt;/font&gt;&lt;/td&gt;&lt;/tr&gt;
&lt;tr&gt;&lt;td align=&quot;left&quot; port=&quot;shared&quot;&gt;&lt;font color=&quot;#8b0000&quot;&gt;+ shared: boolean [0..1]&lt;/font&gt;&lt;/td&gt;&lt;/tr&gt;
&lt;tr&gt;&lt;td align=&quot;left&quot;&gt;&lt;font color=&quot;#8b0000&quot;&gt;+ comment: Comment [0..*]&lt;/font&gt;&lt;/td&gt;&lt;/tr&gt;
&lt;/table&gt;
&gt;
href = &quot;../base/api-python.html#api-python-datamodel-stream&quot;
target = &quot;_top&quot;
]
Inventory [
labeltooltip = &quot;Inventory&quot;
label = &lt;
&lt;table border=&quot;0&quot; cellpadding=&quot;0&quot; cellspacing=&quot;2&quot;&gt;
&lt;tr&gt;&lt;td&gt;Inventory&lt;/td&gt;&lt;/tr&gt;
&lt;hr/&gt;
&lt;tr&gt;&lt;td&gt; &lt;/td&gt;&lt;/tr&gt;
&lt;tr&gt;&lt;td align=&quot;left&quot; port=&quot;publicID&quot;&gt;&lt;font color=&quot;#8b0000&quot;&gt;+ publicID: string&lt;/font&gt;&lt;/td&gt;&lt;/tr&gt;
&lt;tr&gt;&lt;td align=&quot;left&quot;&gt;&lt;font color=&quot;#8b0000&quot;&gt;+ stationGroup: StationGroup [0..*]&lt;/font&gt;&lt;/td&gt;&lt;/tr&gt;
&lt;tr&gt;&lt;td align=&quot;left&quot;&gt;&lt;font color=&quot;#8b0000&quot;&gt;+ auxDevice: AuxDevice [0..*]&lt;/font&gt;&lt;/td&gt;&lt;/tr&gt;
&lt;tr&gt;&lt;td align=&quot;left&quot;&gt;&lt;font color=&quot;#8b0000&quot;&gt;+ sensor: Sensor [0..*]&lt;/font&gt;&lt;/td&gt;&lt;/tr&gt;
&lt;tr&gt;&lt;td align=&quot;left&quot;&gt;&lt;font color=&quot;#8b0000&quot;&gt;+ datalogger: Datalogger [0..*]&lt;/font&gt;&lt;/td&gt;&lt;/tr&gt;
&lt;tr&gt;&lt;td align=&quot;left&quot;&gt;&lt;font color=&quot;#8b0000&quot;&gt;+ responsePAZ: ResponsePAZ [0..*]&lt;/font&gt;&lt;/td&gt;&lt;/tr&gt;
&lt;tr&gt;&lt;td align=&quot;left&quot;&gt;&lt;font color=&quot;#8b0000&quot;&gt;+ responseFIR: ResponseFIR [0..*]&lt;/font&gt;&lt;/td&gt;&lt;/tr&gt;
&lt;tr&gt;&lt;td align=&quot;left&quot;&gt;&lt;font color=&quot;#8b0000&quot;&gt;+ responseIIR: ResponseIIR [0..*]&lt;/font&gt;&lt;/td&gt;&lt;/tr&gt;
&lt;tr&gt;&lt;td align=&quot;left&quot;&gt;&lt;font color=&quot;#8b0000&quot;&gt;+ responsePolynomial: ResponsePolynomial [0..*]&lt;/font&gt;&lt;/td&gt;&lt;/tr&gt;
&lt;tr&gt;&lt;td align=&quot;left&quot;&gt;&lt;font color=&quot;#8b0000&quot;&gt;+ responseFAP: ResponseFAP [0..*]&lt;/font&gt;&lt;/td&gt;&lt;/tr&gt;
&lt;tr&gt;&lt;td align=&quot;left&quot;&gt;&lt;font color=&quot;#8b0000&quot;&gt;+ network: Network [0..*]&lt;/font&gt;&lt;/td&gt;&lt;/tr&gt;
&lt;/table&gt;
&gt;
href = &quot;../base/api-python.html#api-python-datamodel-inventory&quot;
target = &quot;_top&quot;
]
Inventory -&gt; StationGroup [dir=back arrowtail=diamond]
StationGroup -&gt; StationReference [dir=back arrowtail=diamond]
Inventory -&gt; AuxDevice [dir=back arrowtail=diamond]
AuxDevice -&gt; AuxSource [dir=back arrowtail=diamond]
Inventory -&gt; Sensor [dir=back arrowtail=diamond]
Sensor -&gt; SensorCalibration [dir=back arrowtail=diamond]
Inventory -&gt; Datalogger [dir=back arrowtail=diamond]
Datalogger -&gt; DataloggerCalibration [dir=back arrowtail=diamond]
Datalogger -&gt; Decimation [dir=back arrowtail=diamond]
Inventory -&gt; ResponsePAZ [dir=back arrowtail=diamond]
Inventory -&gt; ResponseFIR [dir=back arrowtail=diamond]
Inventory -&gt; ResponseIIR [dir=back arrowtail=diamond]
Inventory -&gt; ResponsePolynomial [dir=back arrowtail=diamond]
Inventory -&gt; ResponseFAP [dir=back arrowtail=diamond]
Inventory -&gt; Network [dir=back arrowtail=diamond]
Stream -&gt; Comment [dir=back arrowtail=diamond]
SensorLocation -&gt; Comment [dir=back arrowtail=diamond]
Station -&gt; Comment [dir=back arrowtail=diamond]
Network -&gt; Comment [dir=back arrowtail=diamond]
Network -&gt; Station [dir=back arrowtail=diamond]
Station -&gt; SensorLocation [dir=back arrowtail=diamond]
SensorLocation -&gt; AuxStream [dir=back arrowtail=diamond]
SensorLocation -&gt; Stream [dir=back arrowtail=diamond]
}</p></object></div>
<p class="caption"><span class="caption-text">Inventory object connections from parent to child including attributes and elements.</span><a class="headerlink" href="#id6" title="Permalink to this image"></a></p>
</div>
</div>
<div class="section" id="routing">
<h3>Routing<a class="headerlink" href="#routing" title="Permalink to this headline"></a></h3>
<div class="figure align-center" id="id7">
<div class="graphviz"><object data="../_images/graphviz-eeed14b6b9c5fb0a658f7c139db294dd31681921.svg" type="image/svg+xml" class="graphviz">
<p class="warning">digraph &quot;Routing hierarchy&quot; {
node [fontname=Verdana fontsize=8 shape=plaintext penwidth=0.5 style=&quot;rounded,filled&quot; fillcolor=&quot;#fcf2e3&quot; color=&quot;#000000&quot;]
edge [color=&quot;#000000&quot;]
layout = &quot;dot&quot;
Route [
labeltooltip = &quot;Route&quot;
label = &lt;
&lt;table border=&quot;0&quot; cellpadding=&quot;0&quot; cellspacing=&quot;2&quot;&gt;
&lt;tr&gt;&lt;td&gt;Route&lt;/td&gt;&lt;/tr&gt;
&lt;hr/&gt;
&lt;tr&gt;&lt;td&gt; &lt;/td&gt;&lt;/tr&gt;
&lt;tr&gt;&lt;td align=&quot;left&quot; port=&quot;publicID&quot;&gt;&lt;font color=&quot;#8b0000&quot;&gt;+ publicID: string&lt;/font&gt;&lt;/td&gt;&lt;/tr&gt;
&lt;tr&gt;&lt;td align=&quot;left&quot; port=&quot;networkCode&quot;&gt;&lt;font color=&quot;#8b0000&quot;&gt;+ networkCode: string&lt;/font&gt;&lt;/td&gt;&lt;/tr&gt;
&lt;tr&gt;&lt;td align=&quot;left&quot; port=&quot;stationCode&quot;&gt;&lt;font color=&quot;#8b0000&quot;&gt;+ stationCode: string&lt;/font&gt;&lt;/td&gt;&lt;/tr&gt;
&lt;tr&gt;&lt;td align=&quot;left&quot; port=&quot;locationCode&quot;&gt;&lt;font color=&quot;#8b0000&quot;&gt;+ locationCode: string&lt;/font&gt;&lt;/td&gt;&lt;/tr&gt;
&lt;tr&gt;&lt;td align=&quot;left&quot; port=&quot;streamCode&quot;&gt;&lt;font color=&quot;#8b0000&quot;&gt;+ streamCode: string&lt;/font&gt;&lt;/td&gt;&lt;/tr&gt;
&lt;tr&gt;&lt;td align=&quot;left&quot;&gt;&lt;font color=&quot;#8b0000&quot;&gt;+ routeArclink: RouteArclink [0..*]&lt;/font&gt;&lt;/td&gt;&lt;/tr&gt;
&lt;tr&gt;&lt;td align=&quot;left&quot;&gt;&lt;font color=&quot;#8b0000&quot;&gt;+ routeSeedlink: RouteSeedlink [0..*]&lt;/font&gt;&lt;/td&gt;&lt;/tr&gt;
&lt;/table&gt;
&gt;
href = &quot;../base/api-python.html#api-python-datamodel-route&quot;
target = &quot;_top&quot;
]
RouteArclink [
labeltooltip = &quot;RouteArclink&quot;
label = &lt;
&lt;table border=&quot;0&quot; cellpadding=&quot;0&quot; cellspacing=&quot;2&quot;&gt;
&lt;tr&gt;&lt;td&gt;RouteArclink&lt;/td&gt;&lt;/tr&gt;
&lt;hr/&gt;
&lt;tr&gt;&lt;td&gt; &lt;/td&gt;&lt;/tr&gt;
&lt;tr&gt;&lt;td align=&quot;left&quot; port=&quot;address&quot;&gt;&lt;font color=&quot;#8b0000&quot;&gt;+ address: string&lt;/font&gt;&lt;/td&gt;&lt;/tr&gt;
&lt;tr&gt;&lt;td align=&quot;left&quot; port=&quot;start&quot;&gt;&lt;font color=&quot;#8b0000&quot;&gt;+ start: datetime&lt;/font&gt;&lt;/td&gt;&lt;/tr&gt;
&lt;tr&gt;&lt;td align=&quot;left&quot; port=&quot;end&quot;&gt;&lt;font color=&quot;#8b0000&quot;&gt;+ end: datetime [0..1]&lt;/font&gt;&lt;/td&gt;&lt;/tr&gt;
&lt;tr&gt;&lt;td align=&quot;left&quot; port=&quot;priority&quot;&gt;&lt;font color=&quot;#8b0000&quot;&gt;+ priority: int [0..1]&lt;/font&gt;&lt;/td&gt;&lt;/tr&gt;
&lt;/table&gt;
&gt;
href = &quot;../base/api-python.html#api-python-datamodel-routearclink&quot;
target = &quot;_top&quot;
]
RouteSeedlink [
labeltooltip = &quot;RouteSeedlink&quot;
label = &lt;
&lt;table border=&quot;0&quot; cellpadding=&quot;0&quot; cellspacing=&quot;2&quot;&gt;
&lt;tr&gt;&lt;td&gt;RouteSeedlink&lt;/td&gt;&lt;/tr&gt;
&lt;hr/&gt;
&lt;tr&gt;&lt;td&gt; &lt;/td&gt;&lt;/tr&gt;
&lt;tr&gt;&lt;td align=&quot;left&quot; port=&quot;address&quot;&gt;&lt;font color=&quot;#8b0000&quot;&gt;+ address: string&lt;/font&gt;&lt;/td&gt;&lt;/tr&gt;
&lt;tr&gt;&lt;td align=&quot;left&quot; port=&quot;priority&quot;&gt;&lt;font color=&quot;#8b0000&quot;&gt;+ priority: int [0..1]&lt;/font&gt;&lt;/td&gt;&lt;/tr&gt;
&lt;/table&gt;
&gt;
href = &quot;../base/api-python.html#api-python-datamodel-routeseedlink&quot;
target = &quot;_top&quot;
]
Access [
labeltooltip = &quot;Access&quot;
label = &lt;
&lt;table border=&quot;0&quot; cellpadding=&quot;0&quot; cellspacing=&quot;2&quot;&gt;
&lt;tr&gt;&lt;td&gt;Access&lt;/td&gt;&lt;/tr&gt;
&lt;hr/&gt;
&lt;tr&gt;&lt;td&gt; &lt;/td&gt;&lt;/tr&gt;
&lt;tr&gt;&lt;td align=&quot;left&quot; port=&quot;networkCode&quot;&gt;&lt;font color=&quot;#8b0000&quot;&gt;+ networkCode: string&lt;/font&gt;&lt;/td&gt;&lt;/tr&gt;
&lt;tr&gt;&lt;td align=&quot;left&quot; port=&quot;stationCode&quot;&gt;&lt;font color=&quot;#8b0000&quot;&gt;+ stationCode: string&lt;/font&gt;&lt;/td&gt;&lt;/tr&gt;
&lt;tr&gt;&lt;td align=&quot;left&quot; port=&quot;locationCode&quot;&gt;&lt;font color=&quot;#8b0000&quot;&gt;+ locationCode: string&lt;/font&gt;&lt;/td&gt;&lt;/tr&gt;
&lt;tr&gt;&lt;td align=&quot;left&quot; port=&quot;streamCode&quot;&gt;&lt;font color=&quot;#8b0000&quot;&gt;+ streamCode: string&lt;/font&gt;&lt;/td&gt;&lt;/tr&gt;
&lt;tr&gt;&lt;td align=&quot;left&quot; port=&quot;user&quot;&gt;&lt;font color=&quot;#8b0000&quot;&gt;+ user: string&lt;/font&gt;&lt;/td&gt;&lt;/tr&gt;
&lt;tr&gt;&lt;td align=&quot;left&quot; port=&quot;start&quot;&gt;&lt;font color=&quot;#8b0000&quot;&gt;+ start: datetime&lt;/font&gt;&lt;/td&gt;&lt;/tr&gt;
&lt;tr&gt;&lt;td align=&quot;left&quot; port=&quot;end&quot;&gt;&lt;font color=&quot;#8b0000&quot;&gt;+ end: datetime [0..1]&lt;/font&gt;&lt;/td&gt;&lt;/tr&gt;
&lt;/table&gt;
&gt;
href = &quot;../base/api-python.html#api-python-datamodel-access&quot;
target = &quot;_top&quot;
]
Routing [
labeltooltip = &quot;Routing&quot;
label = &lt;
&lt;table border=&quot;0&quot; cellpadding=&quot;0&quot; cellspacing=&quot;2&quot;&gt;
&lt;tr&gt;&lt;td&gt;Routing&lt;/td&gt;&lt;/tr&gt;
&lt;hr/&gt;
&lt;tr&gt;&lt;td&gt; &lt;/td&gt;&lt;/tr&gt;
&lt;tr&gt;&lt;td align=&quot;left&quot; port=&quot;publicID&quot;&gt;&lt;font color=&quot;#8b0000&quot;&gt;+ publicID: string&lt;/font&gt;&lt;/td&gt;&lt;/tr&gt;
&lt;tr&gt;&lt;td align=&quot;left&quot;&gt;&lt;font color=&quot;#8b0000&quot;&gt;+ route: Route [0..*]&lt;/font&gt;&lt;/td&gt;&lt;/tr&gt;
&lt;tr&gt;&lt;td align=&quot;left&quot;&gt;&lt;font color=&quot;#8b0000&quot;&gt;+ access: Access [0..*]&lt;/font&gt;&lt;/td&gt;&lt;/tr&gt;
&lt;/table&gt;
&gt;
href = &quot;../base/api-python.html#api-python-datamodel-routing&quot;
target = &quot;_top&quot;
]
Routing -&gt; Route [dir=back arrowtail=diamond]
Route -&gt; RouteArclink [dir=back arrowtail=diamond]
Route -&gt; RouteSeedlink [dir=back arrowtail=diamond]
Routing -&gt; Access [dir=back arrowtail=diamond]
}</p></object></div>
<p class="caption"><span class="caption-text">Routing object connections from parent to child including attributes and elements.</span><a class="headerlink" href="#id7" title="Permalink to this image"></a></p>
</div>
</div>
<div class="section" id="journaling">
<h3>Journaling<a class="headerlink" href="#journaling" title="Permalink to this headline"></a></h3>
<div class="figure align-center" id="id8">
<div class="graphviz"><object data="../_images/graphviz-7e6290f21f89d448330730d5a9ef13eed2c54283.svg" type="image/svg+xml" class="graphviz">
<p class="warning">digraph &quot;Journaling hierarchy&quot; {
node [fontname=Verdana fontsize=8 shape=plaintext penwidth=0.5 style=&quot;rounded,filled&quot; fillcolor=&quot;#fcf2e3&quot; color=&quot;#000000&quot;]
edge [color=&quot;#000000&quot;]
layout = &quot;dot&quot;
JournalEntry [
labeltooltip = &quot;JournalEntry&quot;
label = &lt;
&lt;table border=&quot;0&quot; cellpadding=&quot;0&quot; cellspacing=&quot;2&quot;&gt;
&lt;tr&gt;&lt;td&gt;JournalEntry&lt;/td&gt;&lt;/tr&gt;
&lt;hr/&gt;
&lt;tr&gt;&lt;td&gt; &lt;/td&gt;&lt;/tr&gt;
&lt;tr&gt;&lt;td align=&quot;left&quot; port=&quot;created&quot;&gt;&lt;font color=&quot;#8b0000&quot;&gt;+ created: datetime [0..1]&lt;/font&gt;&lt;/td&gt;&lt;/tr&gt;
&lt;tr&gt;&lt;td align=&quot;left&quot; port=&quot;objectID&quot;&gt;&lt;font color=&quot;#8b0000&quot;&gt;+ objectID: string&lt;/font&gt;&lt;/td&gt;&lt;/tr&gt;
&lt;tr&gt;&lt;td align=&quot;left&quot; port=&quot;sender&quot;&gt;&lt;font color=&quot;#8b0000&quot;&gt;+ sender: string&lt;/font&gt;&lt;/td&gt;&lt;/tr&gt;
&lt;tr&gt;&lt;td align=&quot;left&quot; port=&quot;action&quot;&gt;&lt;font color=&quot;#8b0000&quot;&gt;+ action: string&lt;/font&gt;&lt;/td&gt;&lt;/tr&gt;
&lt;tr&gt;&lt;td align=&quot;left&quot; port=&quot;parameters&quot;&gt;&lt;font color=&quot;#8b0000&quot;&gt;+ parameters: string&lt;/font&gt;&lt;/td&gt;&lt;/tr&gt;
&lt;/table&gt;
&gt;
href = &quot;../base/api-python.html#api-python-datamodel-journalentry&quot;
target = &quot;_top&quot;
]
Journaling [
labeltooltip = &quot;Journaling&quot;
label = &lt;
&lt;table border=&quot;0&quot; cellpadding=&quot;0&quot; cellspacing=&quot;2&quot;&gt;
&lt;tr&gt;&lt;td&gt;Journaling&lt;/td&gt;&lt;/tr&gt;
&lt;hr/&gt;
&lt;tr&gt;&lt;td&gt; &lt;/td&gt;&lt;/tr&gt;
&lt;tr&gt;&lt;td align=&quot;left&quot; port=&quot;publicID&quot;&gt;&lt;font color=&quot;#8b0000&quot;&gt;+ publicID: string&lt;/font&gt;&lt;/td&gt;&lt;/tr&gt;
&lt;tr&gt;&lt;td align=&quot;left&quot;&gt;&lt;font color=&quot;#8b0000&quot;&gt;+ journalEntry: JournalEntry [0..*]&lt;/font&gt;&lt;/td&gt;&lt;/tr&gt;
&lt;/table&gt;
&gt;
href = &quot;../base/api-python.html#api-python-datamodel-journaling&quot;
target = &quot;_top&quot;
]
Journaling -&gt; JournalEntry [dir=back arrowtail=diamond]
}</p></object></div>
<p class="caption"><span class="caption-text">Journaling object connections from parent to child including attributes and elements.</span><a class="headerlink" href="#id8" title="Permalink to this image"></a></p>
</div>
</div>
<div class="section" id="arclinklog">
<h3>ArclinkLog<a class="headerlink" href="#arclinklog" title="Permalink to this headline"></a></h3>
<div class="figure align-center" id="id9">
<div class="graphviz"><object data="../_images/graphviz-76fc344733ca965f3febc3fc87cb0c43cc793467.svg" type="image/svg+xml" class="graphviz">
<p class="warning">digraph &quot;ArclinkLog hierarchy&quot; {
node [fontname=Verdana fontsize=8 shape=plaintext penwidth=0.5 style=&quot;rounded,filled&quot; fillcolor=&quot;#fcf2e3&quot; color=&quot;#000000&quot;]
edge [color=&quot;#000000&quot;]
layout = &quot;dot&quot;
ArclinkRequest [
labeltooltip = &quot;ArclinkRequest&quot;
label = &lt;
&lt;table border=&quot;0&quot; cellpadding=&quot;0&quot; cellspacing=&quot;2&quot;&gt;
&lt;tr&gt;&lt;td&gt;ArclinkRequest&lt;/td&gt;&lt;/tr&gt;
&lt;hr/&gt;
&lt;tr&gt;&lt;td&gt; &lt;/td&gt;&lt;/tr&gt;
&lt;tr&gt;&lt;td align=&quot;left&quot; port=&quot;publicID&quot;&gt;&lt;font color=&quot;#8b0000&quot;&gt;+ publicID: string&lt;/font&gt;&lt;/td&gt;&lt;/tr&gt;
&lt;tr&gt;&lt;td align=&quot;left&quot; port=&quot;requestID&quot;&gt;&lt;font color=&quot;#8b0000&quot;&gt;+ requestID: string&lt;/font&gt;&lt;/td&gt;&lt;/tr&gt;
&lt;tr&gt;&lt;td align=&quot;left&quot; port=&quot;userID&quot;&gt;&lt;font color=&quot;#8b0000&quot;&gt;+ userID: string&lt;/font&gt;&lt;/td&gt;&lt;/tr&gt;
&lt;tr&gt;&lt;td align=&quot;left&quot; port=&quot;userIP&quot;&gt;&lt;font color=&quot;#8b0000&quot;&gt;+ userIP: string&lt;/font&gt;&lt;/td&gt;&lt;/tr&gt;
&lt;tr&gt;&lt;td align=&quot;left&quot; port=&quot;clientID&quot;&gt;&lt;font color=&quot;#8b0000&quot;&gt;+ clientID: string&lt;/font&gt;&lt;/td&gt;&lt;/tr&gt;
&lt;tr&gt;&lt;td align=&quot;left&quot; port=&quot;clientIP&quot;&gt;&lt;font color=&quot;#8b0000&quot;&gt;+ clientIP: string&lt;/font&gt;&lt;/td&gt;&lt;/tr&gt;
&lt;tr&gt;&lt;td align=&quot;left&quot; port=&quot;type&quot;&gt;&lt;font color=&quot;#8b0000&quot;&gt;+ type: string&lt;/font&gt;&lt;/td&gt;&lt;/tr&gt;
&lt;tr&gt;&lt;td align=&quot;left&quot; port=&quot;created&quot;&gt;&lt;font color=&quot;#8b0000&quot;&gt;+ created: datetime&lt;/font&gt;&lt;/td&gt;&lt;/tr&gt;
&lt;tr&gt;&lt;td align=&quot;left&quot; port=&quot;status&quot;&gt;&lt;font color=&quot;#8b0000&quot;&gt;+ status: string&lt;/font&gt;&lt;/td&gt;&lt;/tr&gt;
&lt;tr&gt;&lt;td align=&quot;left&quot; port=&quot;message&quot;&gt;&lt;font color=&quot;#8b0000&quot;&gt;+ message: string&lt;/font&gt;&lt;/td&gt;&lt;/tr&gt;
&lt;tr&gt;&lt;td align=&quot;left&quot; port=&quot;label&quot;&gt;&lt;font color=&quot;#8b0000&quot;&gt;+ label: string&lt;/font&gt;&lt;/td&gt;&lt;/tr&gt;
&lt;tr&gt;&lt;td align=&quot;left&quot; port=&quot;header&quot;&gt;&lt;font color=&quot;#8b0000&quot;&gt;+ header: string&lt;/font&gt;&lt;/td&gt;&lt;/tr&gt;
&lt;tr&gt;&lt;td align=&quot;left&quot; port=&quot;summary&quot;&gt;&lt;font color=&quot;#8b0000&quot;&gt;+ summary: ArclinkRequestSummary [0..1]&lt;/font&gt;&lt;/td&gt;&lt;/tr&gt;
&lt;tr&gt;&lt;td align=&quot;left&quot;&gt;&lt;font color=&quot;#8b0000&quot;&gt;+ arclinkStatusLine: ArclinkStatusLine [0..*]&lt;/font&gt;&lt;/td&gt;&lt;/tr&gt;
&lt;tr&gt;&lt;td align=&quot;left&quot;&gt;&lt;font color=&quot;#8b0000&quot;&gt;+ arclinkRequestLine: ArclinkRequestLine [0..*]&lt;/font&gt;&lt;/td&gt;&lt;/tr&gt;
&lt;/table&gt;
&gt;
href = &quot;../base/api-python.html#api-python-datamodel-arclinkrequest&quot;
target = &quot;_top&quot;
]
ArclinkStatusLine [
labeltooltip = &quot;ArclinkStatusLine&quot;
label = &lt;
&lt;table border=&quot;0&quot; cellpadding=&quot;0&quot; cellspacing=&quot;2&quot;&gt;
&lt;tr&gt;&lt;td&gt;ArclinkStatusLine&lt;/td&gt;&lt;/tr&gt;
&lt;hr/&gt;
&lt;tr&gt;&lt;td&gt; &lt;/td&gt;&lt;/tr&gt;
&lt;tr&gt;&lt;td align=&quot;left&quot; port=&quot;type&quot;&gt;&lt;font color=&quot;#8b0000&quot;&gt;+ type: string&lt;/font&gt;&lt;/td&gt;&lt;/tr&gt;
&lt;tr&gt;&lt;td align=&quot;left&quot; port=&quot;status&quot;&gt;&lt;font color=&quot;#8b0000&quot;&gt;+ status: string&lt;/font&gt;&lt;/td&gt;&lt;/tr&gt;
&lt;tr&gt;&lt;td align=&quot;left&quot; port=&quot;size&quot;&gt;&lt;font color=&quot;#8b0000&quot;&gt;+ size: int [0..1]&lt;/font&gt;&lt;/td&gt;&lt;/tr&gt;
&lt;tr&gt;&lt;td align=&quot;left&quot; port=&quot;message&quot;&gt;&lt;font color=&quot;#8b0000&quot;&gt;+ message: string&lt;/font&gt;&lt;/td&gt;&lt;/tr&gt;
&lt;tr&gt;&lt;td align=&quot;left&quot; port=&quot;volumeID&quot;&gt;&lt;font color=&quot;#8b0000&quot;&gt;+ volumeID: string&lt;/font&gt;&lt;/td&gt;&lt;/tr&gt;
&lt;/table&gt;
&gt;
href = &quot;../base/api-python.html#api-python-datamodel-arclinkstatusline&quot;
target = &quot;_top&quot;
]
ArclinkRequestLine [
labeltooltip = &quot;ArclinkRequestLine&quot;
label = &lt;
&lt;table border=&quot;0&quot; cellpadding=&quot;0&quot; cellspacing=&quot;2&quot;&gt;
&lt;tr&gt;&lt;td&gt;ArclinkRequestLine&lt;/td&gt;&lt;/tr&gt;
&lt;hr/&gt;
&lt;tr&gt;&lt;td&gt; &lt;/td&gt;&lt;/tr&gt;
&lt;tr&gt;&lt;td align=&quot;left&quot; port=&quot;start&quot;&gt;&lt;font color=&quot;#8b0000&quot;&gt;+ start: datetime&lt;/font&gt;&lt;/td&gt;&lt;/tr&gt;
&lt;tr&gt;&lt;td align=&quot;left&quot; port=&quot;end&quot;&gt;&lt;font color=&quot;#8b0000&quot;&gt;+ end: datetime&lt;/font&gt;&lt;/td&gt;&lt;/tr&gt;
&lt;tr&gt;&lt;td align=&quot;left&quot; port=&quot;streamID&quot;&gt;&lt;font color=&quot;#8b0000&quot;&gt;+ streamID: WaveformStreamID&lt;/font&gt;&lt;/td&gt;&lt;/tr&gt;
&lt;tr&gt;&lt;td align=&quot;left&quot; port=&quot;restricted&quot;&gt;&lt;font color=&quot;#8b0000&quot;&gt;+ restricted: boolean [0..1]&lt;/font&gt;&lt;/td&gt;&lt;/tr&gt;
&lt;tr&gt;&lt;td align=&quot;left&quot; port=&quot;shared&quot;&gt;&lt;font color=&quot;#8b0000&quot;&gt;+ shared: boolean [0..1]&lt;/font&gt;&lt;/td&gt;&lt;/tr&gt;
&lt;tr&gt;&lt;td align=&quot;left&quot; port=&quot;netClass&quot;&gt;&lt;font color=&quot;#8b0000&quot;&gt;+ netClass: string&lt;/font&gt;&lt;/td&gt;&lt;/tr&gt;
&lt;tr&gt;&lt;td align=&quot;left&quot; port=&quot;constraints&quot;&gt;&lt;font color=&quot;#8b0000&quot;&gt;+ constraints: string&lt;/font&gt;&lt;/td&gt;&lt;/tr&gt;
&lt;tr&gt;&lt;td align=&quot;left&quot; port=&quot;status&quot;&gt;&lt;font color=&quot;#8b0000&quot;&gt;+ status: ArclinkStatusLine&lt;/font&gt;&lt;/td&gt;&lt;/tr&gt;
&lt;/table&gt;
&gt;
href = &quot;../base/api-python.html#api-python-datamodel-arclinkrequestline&quot;
target = &quot;_top&quot;
]
ArclinkUser [
labeltooltip = &quot;ArclinkUser&quot;
label = &lt;
&lt;table border=&quot;0&quot; cellpadding=&quot;0&quot; cellspacing=&quot;2&quot;&gt;
&lt;tr&gt;&lt;td&gt;ArclinkUser&lt;/td&gt;&lt;/tr&gt;
&lt;hr/&gt;
&lt;tr&gt;&lt;td&gt; &lt;/td&gt;&lt;/tr&gt;
&lt;tr&gt;&lt;td align=&quot;left&quot; port=&quot;publicID&quot;&gt;&lt;font color=&quot;#8b0000&quot;&gt;+ publicID: string&lt;/font&gt;&lt;/td&gt;&lt;/tr&gt;
&lt;tr&gt;&lt;td align=&quot;left&quot; port=&quot;name&quot;&gt;&lt;font color=&quot;#8b0000&quot;&gt;+ name: string&lt;/font&gt;&lt;/td&gt;&lt;/tr&gt;
&lt;tr&gt;&lt;td align=&quot;left&quot; port=&quot;email&quot;&gt;&lt;font color=&quot;#8b0000&quot;&gt;+ email: string&lt;/font&gt;&lt;/td&gt;&lt;/tr&gt;
&lt;tr&gt;&lt;td align=&quot;left&quot; port=&quot;password&quot;&gt;&lt;font color=&quot;#8b0000&quot;&gt;+ password: string&lt;/font&gt;&lt;/td&gt;&lt;/tr&gt;
&lt;/table&gt;
&gt;
href = &quot;../base/api-python.html#api-python-datamodel-arclinkuser&quot;
target = &quot;_top&quot;
]
ArclinkLog [
labeltooltip = &quot;ArclinkLog&quot;
label = &lt;
&lt;table border=&quot;0&quot; cellpadding=&quot;0&quot; cellspacing=&quot;2&quot;&gt;
&lt;tr&gt;&lt;td&gt;ArclinkLog&lt;/td&gt;&lt;/tr&gt;
&lt;hr/&gt;
&lt;tr&gt;&lt;td&gt; &lt;/td&gt;&lt;/tr&gt;
&lt;tr&gt;&lt;td align=&quot;left&quot; port=&quot;publicID&quot;&gt;&lt;font color=&quot;#8b0000&quot;&gt;+ publicID: string&lt;/font&gt;&lt;/td&gt;&lt;/tr&gt;
&lt;tr&gt;&lt;td align=&quot;left&quot;&gt;&lt;font color=&quot;#8b0000&quot;&gt;+ arclinkRequest: ArclinkRequest [0..*]&lt;/font&gt;&lt;/td&gt;&lt;/tr&gt;
&lt;tr&gt;&lt;td align=&quot;left&quot;&gt;&lt;font color=&quot;#8b0000&quot;&gt;+ arclinkUser: ArclinkUser [0..*]&lt;/font&gt;&lt;/td&gt;&lt;/tr&gt;
&lt;/table&gt;
&gt;
href = &quot;../base/api-python.html#api-python-datamodel-arclinklog&quot;
target = &quot;_top&quot;
]
ArclinkLog -&gt; ArclinkRequest [dir=back arrowtail=diamond]
ArclinkRequest -&gt; ArclinkStatusLine [dir=back arrowtail=diamond]
ArclinkRequest -&gt; ArclinkRequestLine [dir=back arrowtail=diamond]
ArclinkLog -&gt; ArclinkUser [dir=back arrowtail=diamond]
}</p></object></div>
<p class="caption"><span class="caption-text">ArclinkLog object connections from parent to child including attributes and elements.</span><a class="headerlink" href="#id9" title="Permalink to this image"></a></p>
</div>
</div>
<div class="section" id="dataavailability">
<h3>DataAvailability<a class="headerlink" href="#dataavailability" title="Permalink to this headline"></a></h3>
<div class="figure align-center" id="id10">
<div class="graphviz"><object data="../_images/graphviz-ffbdae6fbfa546101690d3c19d5aa208b589cab3.svg" type="image/svg+xml" class="graphviz">
<p class="warning">digraph &quot;DataAvailability hierarchy&quot; {
node [fontname=Verdana fontsize=8 shape=plaintext penwidth=0.5 style=&quot;rounded,filled&quot; fillcolor=&quot;#fcf2e3&quot; color=&quot;#000000&quot;]
edge [color=&quot;#000000&quot;]
layout = &quot;dot&quot;
DataExtent [
labeltooltip = &quot;DataExtent&quot;
label = &lt;
&lt;table border=&quot;0&quot; cellpadding=&quot;0&quot; cellspacing=&quot;2&quot;&gt;
&lt;tr&gt;&lt;td&gt;DataExtent&lt;/td&gt;&lt;/tr&gt;
&lt;hr/&gt;
&lt;tr&gt;&lt;td&gt; &lt;/td&gt;&lt;/tr&gt;
&lt;tr&gt;&lt;td align=&quot;left&quot; port=&quot;publicID&quot;&gt;&lt;font color=&quot;#8b0000&quot;&gt;+ publicID: string&lt;/font&gt;&lt;/td&gt;&lt;/tr&gt;
&lt;tr&gt;&lt;td align=&quot;left&quot; port=&quot;waveformID&quot;&gt;&lt;font color=&quot;#8b0000&quot;&gt;+ waveformID: WaveformStreamID&lt;/font&gt;&lt;/td&gt;&lt;/tr&gt;
&lt;tr&gt;&lt;td align=&quot;left&quot; port=&quot;start&quot;&gt;&lt;font color=&quot;#8b0000&quot;&gt;+ start: datetime&lt;/font&gt;&lt;/td&gt;&lt;/tr&gt;
&lt;tr&gt;&lt;td align=&quot;left&quot; port=&quot;end&quot;&gt;&lt;font color=&quot;#8b0000&quot;&gt;+ end: datetime&lt;/font&gt;&lt;/td&gt;&lt;/tr&gt;
&lt;tr&gt;&lt;td align=&quot;left&quot; port=&quot;updated&quot;&gt;&lt;font color=&quot;#8b0000&quot;&gt;+ updated: datetime&lt;/font&gt;&lt;/td&gt;&lt;/tr&gt;
&lt;tr&gt;&lt;td align=&quot;left&quot; port=&quot;lastScan&quot;&gt;&lt;font color=&quot;#8b0000&quot;&gt;+ lastScan: datetime&lt;/font&gt;&lt;/td&gt;&lt;/tr&gt;
&lt;tr&gt;&lt;td align=&quot;left&quot; port=&quot;segmentOverflow&quot;&gt;&lt;font color=&quot;#8b0000&quot;&gt;+ segmentOverflow: boolean&lt;/font&gt;&lt;/td&gt;&lt;/tr&gt;
&lt;tr&gt;&lt;td align=&quot;left&quot;&gt;&lt;font color=&quot;#8b0000&quot;&gt;+ dataSegment: DataSegment [0..*]&lt;/font&gt;&lt;/td&gt;&lt;/tr&gt;
&lt;tr&gt;&lt;td align=&quot;left&quot;&gt;&lt;font color=&quot;#8b0000&quot;&gt;+ dataAttributeExtent: DataAttributeExtent [0..*]&lt;/font&gt;&lt;/td&gt;&lt;/tr&gt;
&lt;/table&gt;
&gt;
href = &quot;../base/api-python.html#api-python-datamodel-dataextent&quot;
target = &quot;_top&quot;
]
DataSegment [
labeltooltip = &quot;DataSegment&quot;
label = &lt;
&lt;table border=&quot;0&quot; cellpadding=&quot;0&quot; cellspacing=&quot;2&quot;&gt;
&lt;tr&gt;&lt;td&gt;DataSegment&lt;/td&gt;&lt;/tr&gt;
&lt;hr/&gt;
&lt;tr&gt;&lt;td&gt; &lt;/td&gt;&lt;/tr&gt;
&lt;tr&gt;&lt;td align=&quot;left&quot; port=&quot;start&quot;&gt;&lt;font color=&quot;#8b0000&quot;&gt;+ start: datetime&lt;/font&gt;&lt;/td&gt;&lt;/tr&gt;
&lt;tr&gt;&lt;td align=&quot;left&quot; port=&quot;end&quot;&gt;&lt;font color=&quot;#8b0000&quot;&gt;+ end: datetime&lt;/font&gt;&lt;/td&gt;&lt;/tr&gt;
&lt;tr&gt;&lt;td align=&quot;left&quot; port=&quot;updated&quot;&gt;&lt;font color=&quot;#8b0000&quot;&gt;+ updated: datetime&lt;/font&gt;&lt;/td&gt;&lt;/tr&gt;
&lt;tr&gt;&lt;td align=&quot;left&quot; port=&quot;sampleRate&quot;&gt;&lt;font color=&quot;#8b0000&quot;&gt;+ sampleRate: double&lt;/font&gt;&lt;/td&gt;&lt;/tr&gt;
&lt;tr&gt;&lt;td align=&quot;left&quot; port=&quot;quality&quot;&gt;&lt;font color=&quot;#8b0000&quot;&gt;+ quality: string&lt;/font&gt;&lt;/td&gt;&lt;/tr&gt;
&lt;tr&gt;&lt;td align=&quot;left&quot; port=&quot;outOfOrder&quot;&gt;&lt;font color=&quot;#8b0000&quot;&gt;+ outOfOrder: boolean&lt;/font&gt;&lt;/td&gt;&lt;/tr&gt;
&lt;/table&gt;
&gt;
href = &quot;../base/api-python.html#api-python-datamodel-datasegment&quot;
target = &quot;_top&quot;
]
DataAttributeExtent [
labeltooltip = &quot;DataAttributeExtent&quot;
label = &lt;
&lt;table border=&quot;0&quot; cellpadding=&quot;0&quot; cellspacing=&quot;2&quot;&gt;
&lt;tr&gt;&lt;td&gt;DataAttributeExtent&lt;/td&gt;&lt;/tr&gt;
&lt;hr/&gt;
&lt;tr&gt;&lt;td&gt; &lt;/td&gt;&lt;/tr&gt;
&lt;tr&gt;&lt;td align=&quot;left&quot; port=&quot;start&quot;&gt;&lt;font color=&quot;#8b0000&quot;&gt;+ start: datetime&lt;/font&gt;&lt;/td&gt;&lt;/tr&gt;
&lt;tr&gt;&lt;td align=&quot;left&quot; port=&quot;end&quot;&gt;&lt;font color=&quot;#8b0000&quot;&gt;+ end: datetime&lt;/font&gt;&lt;/td&gt;&lt;/tr&gt;
&lt;tr&gt;&lt;td align=&quot;left&quot; port=&quot;sampleRate&quot;&gt;&lt;font color=&quot;#8b0000&quot;&gt;+ sampleRate: double&lt;/font&gt;&lt;/td&gt;&lt;/tr&gt;
&lt;tr&gt;&lt;td align=&quot;left&quot; port=&quot;quality&quot;&gt;&lt;font color=&quot;#8b0000&quot;&gt;+ quality: string&lt;/font&gt;&lt;/td&gt;&lt;/tr&gt;
&lt;tr&gt;&lt;td align=&quot;left&quot; port=&quot;updated&quot;&gt;&lt;font color=&quot;#8b0000&quot;&gt;+ updated: datetime&lt;/font&gt;&lt;/td&gt;&lt;/tr&gt;
&lt;tr&gt;&lt;td align=&quot;left&quot; port=&quot;segmentCount&quot;&gt;&lt;font color=&quot;#8b0000&quot;&gt;+ segmentCount: int&lt;/font&gt;&lt;/td&gt;&lt;/tr&gt;
&lt;/table&gt;
&gt;
href = &quot;../base/api-python.html#api-python-datamodel-dataattributeextent&quot;
target = &quot;_top&quot;
]
DataAvailability [
labeltooltip = &quot;DataAvailability&quot;
label = &lt;
&lt;table border=&quot;0&quot; cellpadding=&quot;0&quot; cellspacing=&quot;2&quot;&gt;
&lt;tr&gt;&lt;td&gt;DataAvailability&lt;/td&gt;&lt;/tr&gt;
&lt;hr/&gt;
&lt;tr&gt;&lt;td&gt; &lt;/td&gt;&lt;/tr&gt;
&lt;tr&gt;&lt;td align=&quot;left&quot; port=&quot;publicID&quot;&gt;&lt;font color=&quot;#8b0000&quot;&gt;+ publicID: string&lt;/font&gt;&lt;/td&gt;&lt;/tr&gt;
&lt;tr&gt;&lt;td align=&quot;left&quot;&gt;&lt;font color=&quot;#8b0000&quot;&gt;+ dataExtent: DataExtent [0..*]&lt;/font&gt;&lt;/td&gt;&lt;/tr&gt;
&lt;/table&gt;
&gt;
href = &quot;../base/api-python.html#api-python-datamodel-dataavailability&quot;
target = &quot;_top&quot;
]
DataAvailability -&gt; DataExtent [dir=back arrowtail=diamond]
DataExtent -&gt; DataSegment [dir=back arrowtail=diamond]
DataExtent -&gt; DataAttributeExtent [dir=back arrowtail=diamond]
}</p></object></div>
<p class="caption"><span class="caption-text">DataAvailability object connections from parent to child including attributes and elements.</span><a class="headerlink" href="#id10" title="Permalink to this image"></a></p>
</div>
</div>
</div>
<div class="section" id="enumerations">
<h2>Enumerations<a class="headerlink" href="#enumerations" title="Permalink to this headline"></a></h2>
<ul class="simple">
<li><p><a class="reference internal" href="#api-python-datamodel-datausedwavetype"><span class="std std-ref">DataUsedWaveType</span></a></p></li>
<li><p><a class="reference internal" href="#api-python-datamodel-evaluationmode"><span class="std std-ref">EvaluationMode</span></a></p></li>
<li><p><a class="reference internal" href="#api-python-datamodel-evaluationstatus"><span class="std std-ref">EvaluationStatus</span></a></p></li>
<li><p><a class="reference internal" href="#api-python-datamodel-eventdescriptiontype"><span class="std std-ref">EventDescriptionType</span></a></p></li>
<li><p><a class="reference internal" href="#api-python-datamodel-eventtype"><span class="std std-ref">EventType</span></a></p></li>
<li><p><a class="reference internal" href="#api-python-datamodel-eventtypecertainty"><span class="std std-ref">EventTypeCertainty</span></a></p></li>
<li><p><a class="reference internal" href="#api-python-datamodel-momenttensormethod"><span class="std std-ref">MomentTensorMethod</span></a></p></li>
<li><p><a class="reference internal" href="#api-python-datamodel-momenttensorstatus"><span class="std std-ref">MomentTensorStatus</span></a></p></li>
<li><p><a class="reference internal" href="#api-python-datamodel-origindepthtype"><span class="std std-ref">OriginDepthType</span></a></p></li>
<li><p><a class="reference internal" href="#api-python-datamodel-origintype"><span class="std std-ref">OriginType</span></a></p></li>
<li><p><a class="reference internal" href="#api-python-datamodel-originuncertaintydescription"><span class="std std-ref">OriginUncertaintyDescription</span></a></p></li>
<li><p><a class="reference internal" href="#api-python-datamodel-pickonset"><span class="std std-ref">PickOnset</span></a></p></li>
<li><p><a class="reference internal" href="#api-python-datamodel-pickpolarity"><span class="std std-ref">PickPolarity</span></a></p></li>
<li><p><a class="reference internal" href="#api-python-datamodel-sourcetimefunctiontype"><span class="std std-ref">SourceTimeFunctionType</span></a></p></li>
<li><p><a class="reference internal" href="#api-python-datamodel-stationgrouptype"><span class="std std-ref">StationGroupType</span></a></p></li>
</ul>
<p id="api-python-datamodel-datausedwavetype"><strong>DataUsedWaveType</strong></p>
<table class="docutils align-default">
<colgroup>
<col style="width: 33%" />
<col style="width: 33%" />
<col style="width: 33%" />
</colgroup>
<thead>
<tr class="row-odd"><th class="head"><p>ID</p></th>
<th class="head"><p>Numeric value</p></th>
<th class="head"><p>String value</p></th>
</tr>
</thead>
<tbody>
<tr class="row-even"><td><p><code class="docutils literal notranslate"><span class="pre">BODY_WAVES</span></code></p></td>
<td><p>0</p></td>
<td><p>body waves</p></td>
</tr>
<tr class="row-odd"><td><p><code class="docutils literal notranslate"><span class="pre">P_BODY_WAVES</span></code></p></td>
<td><p>1</p></td>
<td><p>P body waves</p></td>
</tr>
<tr class="row-even"><td><p><code class="docutils literal notranslate"><span class="pre">LONG_PERIOD_BODY_WAVES</span></code></p></td>
<td><p>2</p></td>
<td><p>long-period body waves</p></td>
</tr>
<tr class="row-odd"><td><p><code class="docutils literal notranslate"><span class="pre">SURFACE_WAVES</span></code></p></td>
<td><p>3</p></td>
<td><p>surface waves</p></td>
</tr>
<tr class="row-even"><td><p><code class="docutils literal notranslate"><span class="pre">INTERMEDIATE_PERIOD_SURFACE_WAVES</span></code></p></td>
<td><p>4</p></td>
<td><p>intermediate-period surface waves</p></td>
</tr>
<tr class="row-odd"><td><p><code class="docutils literal notranslate"><span class="pre">LONG_PERIOD_MANTLE_WAVES</span></code></p></td>
<td><p>5</p></td>
<td><p>long-period mantle waves</p></td>
</tr>
<tr class="row-even"><td><p><code class="docutils literal notranslate"><span class="pre">UNKNOWN_WAVETYPE</span></code></p></td>
<td><p>6</p></td>
<td><p>unknown</p></td>
</tr>
</tbody>
</table>
<p>Used by:</p>
<ul class="simple">
<li><p><a class="reference internal" href="#seiscomp.datamodel.DataUsed.waveType" title="seiscomp.datamodel.DataUsed.waveType"><code class="xref py py-func docutils literal notranslate"><span class="pre">DataUsed.waveType()</span></code></a></p></li>
</ul>
<p id="api-python-datamodel-evaluationmode"><strong>EvaluationMode</strong></p>
<table class="docutils align-default">
<colgroup>
<col style="width: 33%" />
<col style="width: 33%" />
<col style="width: 33%" />
</colgroup>
<thead>
<tr class="row-odd"><th class="head"><p>ID</p></th>
<th class="head"><p>Numeric value</p></th>
<th class="head"><p>String value</p></th>
</tr>
</thead>
<tbody>
<tr class="row-even"><td><p><code class="docutils literal notranslate"><span class="pre">MANUAL</span></code></p></td>
<td><p>0</p></td>
<td><p>manual</p></td>
</tr>
<tr class="row-odd"><td><p><code class="docutils literal notranslate"><span class="pre">AUTOMATIC</span></code></p></td>
<td><p>1</p></td>
<td><p>automatic</p></td>
</tr>
</tbody>
</table>
<p>Used by:</p>
<ul class="simple">
<li><p><a class="reference internal" href="#seiscomp.datamodel.Amplitude.evaluationMode" title="seiscomp.datamodel.Amplitude.evaluationMode"><code class="xref py py-func docutils literal notranslate"><span class="pre">Amplitude.evaluationMode()</span></code></a></p></li>
<li><p><a class="reference internal" href="#seiscomp.datamodel.FocalMechanism.evaluationMode" title="seiscomp.datamodel.FocalMechanism.evaluationMode"><code class="xref py py-func docutils literal notranslate"><span class="pre">FocalMechanism.evaluationMode()</span></code></a></p></li>
<li><p><a class="reference internal" href="#seiscomp.datamodel.Origin.evaluationMode" title="seiscomp.datamodel.Origin.evaluationMode"><code class="xref py py-func docutils literal notranslate"><span class="pre">Origin.evaluationMode()</span></code></a></p></li>
<li><p><a class="reference internal" href="#seiscomp.datamodel.Pick.evaluationMode" title="seiscomp.datamodel.Pick.evaluationMode"><code class="xref py py-func docutils literal notranslate"><span class="pre">Pick.evaluationMode()</span></code></a></p></li>
</ul>
<p id="api-python-datamodel-evaluationstatus"><strong>EvaluationStatus</strong></p>
<table class="docutils align-default">
<colgroup>
<col style="width: 33%" />
<col style="width: 33%" />
<col style="width: 33%" />
</colgroup>
<thead>
<tr class="row-odd"><th class="head"><p>ID</p></th>
<th class="head"><p>Numeric value</p></th>
<th class="head"><p>String value</p></th>
</tr>
</thead>
<tbody>
<tr class="row-even"><td><p><code class="docutils literal notranslate"><span class="pre">PRELIMINARY</span></code></p></td>
<td><p>0</p></td>
<td><p>preliminary</p></td>
</tr>
<tr class="row-odd"><td><p><code class="docutils literal notranslate"><span class="pre">CONFIRMED</span></code></p></td>
<td><p>1</p></td>
<td><p>confirmed</p></td>
</tr>
<tr class="row-even"><td><p><code class="docutils literal notranslate"><span class="pre">REVIEWED</span></code></p></td>
<td><p>2</p></td>
<td><p>reviewed</p></td>
</tr>
<tr class="row-odd"><td><p><code class="docutils literal notranslate"><span class="pre">FINAL</span></code></p></td>
<td><p>3</p></td>
<td><p>final</p></td>
</tr>
<tr class="row-even"><td><p><code class="docutils literal notranslate"><span class="pre">REJECTED</span></code></p></td>
<td><p>4</p></td>
<td><p>rejected</p></td>
</tr>
<tr class="row-odd"><td><p><code class="docutils literal notranslate"><span class="pre">REPORTED</span></code></p></td>
<td><p>5</p></td>
<td><p>reported</p></td>
</tr>
</tbody>
</table>
<p>Used by:</p>
<ul class="simple">
<li><p><a class="reference internal" href="#seiscomp.datamodel.FocalMechanism.evaluationStatus" title="seiscomp.datamodel.FocalMechanism.evaluationStatus"><code class="xref py py-func docutils literal notranslate"><span class="pre">FocalMechanism.evaluationStatus()</span></code></a></p></li>
<li><p><a class="reference internal" href="#seiscomp.datamodel.Magnitude.evaluationStatus" title="seiscomp.datamodel.Magnitude.evaluationStatus"><code class="xref py py-func docutils literal notranslate"><span class="pre">Magnitude.evaluationStatus()</span></code></a></p></li>
<li><p><a class="reference internal" href="#seiscomp.datamodel.Origin.evaluationStatus" title="seiscomp.datamodel.Origin.evaluationStatus"><code class="xref py py-func docutils literal notranslate"><span class="pre">Origin.evaluationStatus()</span></code></a></p></li>
<li><p><a class="reference internal" href="#seiscomp.datamodel.Pick.evaluationStatus" title="seiscomp.datamodel.Pick.evaluationStatus"><code class="xref py py-func docutils literal notranslate"><span class="pre">Pick.evaluationStatus()</span></code></a></p></li>
</ul>
<p id="api-python-datamodel-eventdescriptiontype"><strong>EventDescriptionType</strong></p>
<table class="docutils align-default">
<colgroup>
<col style="width: 33%" />
<col style="width: 33%" />
<col style="width: 33%" />
</colgroup>
<thead>
<tr class="row-odd"><th class="head"><p>ID</p></th>
<th class="head"><p>Numeric value</p></th>
<th class="head"><p>String value</p></th>
</tr>
</thead>
<tbody>
<tr class="row-even"><td><p><code class="docutils literal notranslate"><span class="pre">FELT_REPORT</span></code></p></td>
<td><p>0</p></td>
<td><p>felt report</p></td>
</tr>
<tr class="row-odd"><td><p><code class="docutils literal notranslate"><span class="pre">FLINN_ENGDAHL_REGION</span></code></p></td>
<td><p>1</p></td>
<td><p>Flinn-Engdahl region</p></td>
</tr>
<tr class="row-even"><td><p><code class="docutils literal notranslate"><span class="pre">LOCAL_TIME</span></code></p></td>
<td><p>2</p></td>
<td><p>local time</p></td>
</tr>
<tr class="row-odd"><td><p><code class="docutils literal notranslate"><span class="pre">TECTONIC_SUMMARY</span></code></p></td>
<td><p>3</p></td>
<td><p>tectonic summary</p></td>
</tr>
<tr class="row-even"><td><p><code class="docutils literal notranslate"><span class="pre">NEAREST_CITIES</span></code></p></td>
<td><p>4</p></td>
<td><p>nearest cities</p></td>
</tr>
<tr class="row-odd"><td><p><code class="docutils literal notranslate"><span class="pre">EARTHQUAKE_NAME</span></code></p></td>
<td><p>5</p></td>
<td><p>earthquake name</p></td>
</tr>
<tr class="row-even"><td><p><code class="docutils literal notranslate"><span class="pre">REGION_NAME</span></code></p></td>
<td><p>6</p></td>
<td><p>region name</p></td>
</tr>
</tbody>
</table>
<p>Used by:</p>
<ul class="simple">
<li><p><a class="reference internal" href="#seiscomp.datamodel.EventDescription.type" title="seiscomp.datamodel.EventDescription.type"><code class="xref py py-func docutils literal notranslate"><span class="pre">EventDescription.type()</span></code></a></p></li>
</ul>
<p id="api-python-datamodel-eventtype"><strong>EventType</strong></p>
<table class="docutils align-default">
<colgroup>
<col style="width: 33%" />
<col style="width: 33%" />
<col style="width: 33%" />
</colgroup>
<thead>
<tr class="row-odd"><th class="head"><p>ID</p></th>
<th class="head"><p>Numeric value</p></th>
<th class="head"><p>String value</p></th>
</tr>
</thead>
<tbody>
<tr class="row-even"><td><p><code class="docutils literal notranslate"><span class="pre">NOT_EXISTING</span></code></p></td>
<td><p>0</p></td>
<td><p>not existing</p></td>
</tr>
<tr class="row-odd"><td><p><code class="docutils literal notranslate"><span class="pre">NOT_LOCATABLE</span></code></p></td>
<td><p>1</p></td>
<td><p>not locatable</p></td>
</tr>
<tr class="row-even"><td><p><code class="docutils literal notranslate"><span class="pre">OUTSIDE_OF_NETWORK_INTEREST</span></code></p></td>
<td><p>2</p></td>
<td><p>outside of network interest</p></td>
</tr>
<tr class="row-odd"><td><p><code class="docutils literal notranslate"><span class="pre">EARTHQUAKE</span></code></p></td>
<td><p>3</p></td>
<td><p>earthquake</p></td>
</tr>
<tr class="row-even"><td><p><code class="docutils literal notranslate"><span class="pre">INDUCED_EARTHQUAKE</span></code></p></td>
<td><p>4</p></td>
<td><p>induced earthquake</p></td>
</tr>
<tr class="row-odd"><td><p><code class="docutils literal notranslate"><span class="pre">QUARRY_BLAST</span></code></p></td>
<td><p>5</p></td>
<td><p>quarry blast</p></td>
</tr>
<tr class="row-even"><td><p><code class="docutils literal notranslate"><span class="pre">EXPLOSION</span></code></p></td>
<td><p>6</p></td>
<td><p>explosion</p></td>
</tr>
<tr class="row-odd"><td><p><code class="docutils literal notranslate"><span class="pre">CHEMICAL_EXPLOSION</span></code></p></td>
<td><p>7</p></td>
<td><p>chemical explosion</p></td>
</tr>
<tr class="row-even"><td><p><code class="docutils literal notranslate"><span class="pre">NUCLEAR_EXPLOSION</span></code></p></td>
<td><p>8</p></td>
<td><p>nuclear explosion</p></td>
</tr>
<tr class="row-odd"><td><p><code class="docutils literal notranslate"><span class="pre">LANDSLIDE</span></code></p></td>
<td><p>9</p></td>
<td><p>landslide</p></td>
</tr>
<tr class="row-even"><td><p><code class="docutils literal notranslate"><span class="pre">ROCKSLIDE</span></code></p></td>
<td><p>10</p></td>
<td><p>rockslide</p></td>
</tr>
<tr class="row-odd"><td><p><code class="docutils literal notranslate"><span class="pre">SNOW_AVALANCHE</span></code></p></td>
<td><p>11</p></td>
<td><p>snow avalanche</p></td>
</tr>
<tr class="row-even"><td><p><code class="docutils literal notranslate"><span class="pre">DEBRIS_AVALANCHE</span></code></p></td>
<td><p>12</p></td>
<td><p>debris avalanche</p></td>
</tr>
<tr class="row-odd"><td><p><code class="docutils literal notranslate"><span class="pre">MINE_COLLAPSE</span></code></p></td>
<td><p>13</p></td>
<td><p>mine collapse</p></td>
</tr>
<tr class="row-even"><td><p><code class="docutils literal notranslate"><span class="pre">BUILDING_COLLAPSE</span></code></p></td>
<td><p>14</p></td>
<td><p>building collapse</p></td>
</tr>
<tr class="row-odd"><td><p><code class="docutils literal notranslate"><span class="pre">VOLCANIC_ERUPTION</span></code></p></td>
<td><p>15</p></td>
<td><p>volcanic eruption</p></td>
</tr>
<tr class="row-even"><td><p><code class="docutils literal notranslate"><span class="pre">METEOR_IMPACT</span></code></p></td>
<td><p>16</p></td>
<td><p>meteor impact</p></td>
</tr>
<tr class="row-odd"><td><p><code class="docutils literal notranslate"><span class="pre">PLANE_CRASH</span></code></p></td>
<td><p>17</p></td>
<td><p>plane crash</p></td>
</tr>
<tr class="row-even"><td><p><code class="docutils literal notranslate"><span class="pre">SONIC_BOOM</span></code></p></td>
<td><p>18</p></td>
<td><p>sonic boom</p></td>
</tr>
<tr class="row-odd"><td><p><code class="docutils literal notranslate"><span class="pre">DUPLICATE</span></code></p></td>
<td><p>19</p></td>
<td><p>duplicate</p></td>
</tr>
<tr class="row-even"><td><p><code class="docutils literal notranslate"><span class="pre">OTHER_EVENT</span></code></p></td>
<td><p>20</p></td>
<td><p>other</p></td>
</tr>
<tr class="row-odd"><td><p><code class="docutils literal notranslate"><span class="pre">NOT_REPORTED</span></code></p></td>
<td><p>21</p></td>
<td><p>not reported</p></td>
</tr>
<tr class="row-even"><td><p><code class="docutils literal notranslate"><span class="pre">ANTHROPOGENIC_EVENT</span></code></p></td>
<td><p>22</p></td>
<td><p>anthropogenic event</p></td>
</tr>
<tr class="row-odd"><td><p><code class="docutils literal notranslate"><span class="pre">COLLAPSE</span></code></p></td>
<td><p>23</p></td>
<td><p>collapse</p></td>
</tr>
<tr class="row-even"><td><p><code class="docutils literal notranslate"><span class="pre">CAVITY_COLLAPSE</span></code></p></td>
<td><p>24</p></td>
<td><p>cavity collapse</p></td>
</tr>
<tr class="row-odd"><td><p><code class="docutils literal notranslate"><span class="pre">ACCIDENTAL_EXPLOSION</span></code></p></td>
<td><p>25</p></td>
<td><p>accidental explosion</p></td>
</tr>
<tr class="row-even"><td><p><code class="docutils literal notranslate"><span class="pre">CONTROLLED_EXPLOSION</span></code></p></td>
<td><p>26</p></td>
<td><p>controlled explosion</p></td>
</tr>
<tr class="row-odd"><td><p><code class="docutils literal notranslate"><span class="pre">EXPERIMENTAL_EXPLOSION</span></code></p></td>
<td><p>27</p></td>
<td><p>experimental explosion</p></td>
</tr>
<tr class="row-even"><td><p><code class="docutils literal notranslate"><span class="pre">INDUSTRIAL_EXPLOSION</span></code></p></td>
<td><p>28</p></td>
<td><p>industrial explosion</p></td>
</tr>
<tr class="row-odd"><td><p><code class="docutils literal notranslate"><span class="pre">MINING_EXPLOSION</span></code></p></td>
<td><p>29</p></td>
<td><p>mining explosion</p></td>
</tr>
<tr class="row-even"><td><p><code class="docutils literal notranslate"><span class="pre">ROAD_CUT</span></code></p></td>
<td><p>30</p></td>
<td><p>road cut</p></td>
</tr>
<tr class="row-odd"><td><p><code class="docutils literal notranslate"><span class="pre">BLASTING_LEVEE</span></code></p></td>
<td><p>31</p></td>
<td><p>blasting levee</p></td>
</tr>
<tr class="row-even"><td><p><code class="docutils literal notranslate"><span class="pre">INDUCED_OR_TRIGGERED_EVENT</span></code></p></td>
<td><p>32</p></td>
<td><p>induced or triggered event</p></td>
</tr>
<tr class="row-odd"><td><p><code class="docutils literal notranslate"><span class="pre">ROCK_BURST</span></code></p></td>
<td><p>33</p></td>
<td><p>rock burst</p></td>
</tr>
<tr class="row-even"><td><p><code class="docutils literal notranslate"><span class="pre">RESERVOIR_LOADING</span></code></p></td>
<td><p>34</p></td>
<td><p>reservoir loading</p></td>
</tr>
<tr class="row-odd"><td><p><code class="docutils literal notranslate"><span class="pre">FLUID_INJECTION</span></code></p></td>
<td><p>35</p></td>
<td><p>fluid injection</p></td>
</tr>
<tr class="row-even"><td><p><code class="docutils literal notranslate"><span class="pre">FLUID_EXTRACTION</span></code></p></td>
<td><p>36</p></td>
<td><p>fluid extraction</p></td>
</tr>
<tr class="row-odd"><td><p><code class="docutils literal notranslate"><span class="pre">CRASH</span></code></p></td>
<td><p>37</p></td>
<td><p>crash</p></td>
</tr>
<tr class="row-even"><td><p><code class="docutils literal notranslate"><span class="pre">TRAIN_CRASH</span></code></p></td>
<td><p>38</p></td>
<td><p>train crash</p></td>
</tr>
<tr class="row-odd"><td><p><code class="docutils literal notranslate"><span class="pre">BOAT_CRASH</span></code></p></td>
<td><p>39</p></td>
<td><p>boat crash</p></td>
</tr>
<tr class="row-even"><td><p><code class="docutils literal notranslate"><span class="pre">ATMOSPHERIC_EVENT</span></code></p></td>
<td><p>40</p></td>
<td><p>atmospheric event</p></td>
</tr>
<tr class="row-odd"><td><p><code class="docutils literal notranslate"><span class="pre">SONIC_BLAST</span></code></p></td>
<td><p>41</p></td>
<td><p>sonic blast</p></td>
</tr>
<tr class="row-even"><td><p><code class="docutils literal notranslate"><span class="pre">ACOUSTIC_NOISE</span></code></p></td>
<td><p>42</p></td>
<td><p>acoustic noise</p></td>
</tr>
<tr class="row-odd"><td><p><code class="docutils literal notranslate"><span class="pre">THUNDER</span></code></p></td>
<td><p>43</p></td>
<td><p>thunder</p></td>
</tr>
<tr class="row-even"><td><p><code class="docutils literal notranslate"><span class="pre">AVALANCHE</span></code></p></td>
<td><p>44</p></td>
<td><p>avalanche</p></td>
</tr>
<tr class="row-odd"><td><p><code class="docutils literal notranslate"><span class="pre">HYDROACOUSTIC_EVENT</span></code></p></td>
<td><p>45</p></td>
<td><p>hydroacoustic event</p></td>
</tr>
<tr class="row-even"><td><p><code class="docutils literal notranslate"><span class="pre">ICE_QUAKE</span></code></p></td>
<td><p>46</p></td>
<td><p>ice quake</p></td>
</tr>
<tr class="row-odd"><td><p><code class="docutils literal notranslate"><span class="pre">SLIDE</span></code></p></td>
<td><p>47</p></td>
<td><p>slide</p></td>
</tr>
<tr class="row-even"><td><p><code class="docutils literal notranslate"><span class="pre">METEORITE</span></code></p></td>
<td><p>48</p></td>
<td><p>meteorite</p></td>
</tr>
<tr class="row-odd"><td><p><code class="docutils literal notranslate"><span class="pre">CALVING</span></code></p></td>
<td><p>49</p></td>
<td><p>calving</p></td>
</tr>
<tr class="row-even"><td><p><code class="docutils literal notranslate"><span class="pre">FROST_QUAKE</span></code></p></td>
<td><p>50</p></td>
<td><p>frost quake</p></td>
</tr>
<tr class="row-odd"><td><p><code class="docutils literal notranslate"><span class="pre">TREMOR_PULSE</span></code></p></td>
<td><p>51</p></td>
<td><p>tremor pulse</p></td>
</tr>
<tr class="row-even"><td><p><code class="docutils literal notranslate"><span class="pre">SUBMARINE_LANDSLIDE</span></code></p></td>
<td><p>52</p></td>
<td><p>submarine landslide</p></td>
</tr>
<tr class="row-odd"><td><p><code class="docutils literal notranslate"><span class="pre">ROCKET_LAUNCH</span></code></p></td>
<td><p>53</p></td>
<td><p>rocket launch</p></td>
</tr>
<tr class="row-even"><td><p><code class="docutils literal notranslate"><span class="pre">ROCKET</span></code></p></td>
<td><p>54</p></td>
<td><p>rocket</p></td>
</tr>
<tr class="row-odd"><td><p><code class="docutils literal notranslate"><span class="pre">ROCKET_IMPACT</span></code></p></td>
<td><p>55</p></td>
<td><p>rocket impact</p></td>
</tr>
<tr class="row-even"><td><p><code class="docutils literal notranslate"><span class="pre">ARTILLERY_STRIKE</span></code></p></td>
<td><p>56</p></td>
<td><p>artillery strike</p></td>
</tr>
<tr class="row-odd"><td><p><code class="docutils literal notranslate"><span class="pre">BOMB_DETONATION</span></code></p></td>
<td><p>57</p></td>
<td><p>bomb detonation</p></td>
</tr>
<tr class="row-even"><td><p><code class="docutils literal notranslate"><span class="pre">MOVING_AIRCRAFT</span></code></p></td>
<td><p>58</p></td>
<td><p>moving aircraft</p></td>
</tr>
<tr class="row-odd"><td><p><code class="docutils literal notranslate"><span class="pre">ATMOSPHERIC_METEOR_EXPLOSION</span></code></p></td>
<td><p>59</p></td>
<td><p>atmospheric meteor explosion</p></td>
</tr>
</tbody>
</table>
<p>Used by:</p>
<ul class="simple">
<li><p><a class="reference internal" href="#seiscomp.datamodel.Event.type" title="seiscomp.datamodel.Event.type"><code class="xref py py-func docutils literal notranslate"><span class="pre">Event.type()</span></code></a></p></li>
</ul>
<p id="api-python-datamodel-eventtypecertainty"><strong>EventTypeCertainty</strong></p>
<table class="docutils align-default">
<colgroup>
<col style="width: 33%" />
<col style="width: 33%" />
<col style="width: 33%" />
</colgroup>
<thead>
<tr class="row-odd"><th class="head"><p>ID</p></th>
<th class="head"><p>Numeric value</p></th>
<th class="head"><p>String value</p></th>
</tr>
</thead>
<tbody>
<tr class="row-even"><td><p><code class="docutils literal notranslate"><span class="pre">KNOWN</span></code></p></td>
<td><p>0</p></td>
<td><p>known</p></td>
</tr>
<tr class="row-odd"><td><p><code class="docutils literal notranslate"><span class="pre">SUSPECTED</span></code></p></td>
<td><p>1</p></td>
<td><p>suspected</p></td>
</tr>
<tr class="row-even"><td><p><code class="docutils literal notranslate"><span class="pre">DAMAGING</span></code></p></td>
<td><p>2</p></td>
<td><p>damaging</p></td>
</tr>
<tr class="row-odd"><td><p><code class="docutils literal notranslate"><span class="pre">FELT</span></code></p></td>
<td><p>3</p></td>
<td><p>felt</p></td>
</tr>
</tbody>
</table>
<p>Used by:</p>
<ul class="simple">
<li><p><a class="reference internal" href="#seiscomp.datamodel.Event.typeCertainty" title="seiscomp.datamodel.Event.typeCertainty"><code class="xref py py-func docutils literal notranslate"><span class="pre">Event.typeCertainty()</span></code></a></p></li>
</ul>
<p id="api-python-datamodel-momenttensormethod"><strong>MomentTensorMethod</strong></p>
<table class="docutils align-default">
<colgroup>
<col style="width: 33%" />
<col style="width: 33%" />
<col style="width: 33%" />
</colgroup>
<thead>
<tr class="row-odd"><th class="head"><p>ID</p></th>
<th class="head"><p>Numeric value</p></th>
<th class="head"><p>String value</p></th>
</tr>
</thead>
<tbody>
<tr class="row-even"><td><p><code class="docutils literal notranslate"><span class="pre">CMT_0</span></code></p></td>
<td><p>0</p></td>
<td><p>CMT - general moment tensor</p></td>
</tr>
<tr class="row-odd"><td><p><code class="docutils literal notranslate"><span class="pre">CMT_1</span></code></p></td>
<td><p>1</p></td>
<td><p>CMT - moment tensor with zero trace</p></td>
</tr>
<tr class="row-even"><td><p><code class="docutils literal notranslate"><span class="pre">CMT_2</span></code></p></td>
<td><p>2</p></td>
<td><p>CMT - double-couple source</p></td>
</tr>
<tr class="row-odd"><td><p><code class="docutils literal notranslate"><span class="pre">TELESEISMIC</span></code></p></td>
<td><p>3</p></td>
<td><p>teleseismic</p></td>
</tr>
<tr class="row-even"><td><p><code class="docutils literal notranslate"><span class="pre">REGIONAL</span></code></p></td>
<td><p>4</p></td>
<td><p>regional</p></td>
</tr>
</tbody>
</table>
<p>Used by:</p>
<ul class="simple">
<li><p><a class="reference internal" href="#seiscomp.datamodel.MomentTensor.method" title="seiscomp.datamodel.MomentTensor.method"><code class="xref py py-func docutils literal notranslate"><span class="pre">MomentTensor.method()</span></code></a></p></li>
</ul>
<p id="api-python-datamodel-momenttensorstatus"><strong>MomentTensorStatus</strong></p>
<table class="docutils align-default">
<colgroup>
<col style="width: 33%" />
<col style="width: 33%" />
<col style="width: 33%" />
</colgroup>
<thead>
<tr class="row-odd"><th class="head"><p>ID</p></th>
<th class="head"><p>Numeric value</p></th>
<th class="head"><p>String value</p></th>
</tr>
</thead>
<tbody>
<tr class="row-even"><td><p><code class="docutils literal notranslate"><span class="pre">CMT_S</span></code></p></td>
<td><p>0</p></td>
<td><p>standard CMT solution</p></td>
</tr>
<tr class="row-odd"><td><p><code class="docutils literal notranslate"><span class="pre">CMT_Q</span></code></p></td>
<td><p>1</p></td>
<td><p>quick CMT solution</p></td>
</tr>
</tbody>
</table>
<p>Used by:</p>
<ul class="simple">
<li><p><a class="reference internal" href="#seiscomp.datamodel.MomentTensor.status" title="seiscomp.datamodel.MomentTensor.status"><code class="xref py py-func docutils literal notranslate"><span class="pre">MomentTensor.status()</span></code></a></p></li>
</ul>
<p id="api-python-datamodel-origindepthtype"><strong>OriginDepthType</strong></p>
<table class="docutils align-default">
<colgroup>
<col style="width: 33%" />
<col style="width: 33%" />
<col style="width: 33%" />
</colgroup>
<thead>
<tr class="row-odd"><th class="head"><p>ID</p></th>
<th class="head"><p>Numeric value</p></th>
<th class="head"><p>String value</p></th>
</tr>
</thead>
<tbody>
<tr class="row-even"><td><p><code class="docutils literal notranslate"><span class="pre">FROM_LOCATION</span></code></p></td>
<td><p>0</p></td>
<td><p>from location</p></td>
</tr>
<tr class="row-odd"><td><p><code class="docutils literal notranslate"><span class="pre">FROM_MOMENT_TENSOR_INVERSION</span></code></p></td>
<td><p>1</p></td>
<td><p>from moment tensor inversion</p></td>
</tr>
<tr class="row-even"><td><p><code class="docutils literal notranslate"><span class="pre">BROAD_BAND_P_WAVEFORMS</span></code></p></td>
<td><p>2</p></td>
<td><p>from modeling of broad-band P waveforms</p></td>
</tr>
<tr class="row-odd"><td><p><code class="docutils literal notranslate"><span class="pre">CONSTRAINED_BY_DEPTH_PHASES</span></code></p></td>
<td><p>3</p></td>
<td><p>constrained by depth phases</p></td>
</tr>
<tr class="row-even"><td><p><code class="docutils literal notranslate"><span class="pre">CONSTRAINED_BY_DIRECT_PHASES</span></code></p></td>
<td><p>4</p></td>
<td><p>constrained by direct phases</p></td>
</tr>
<tr class="row-odd"><td><p><code class="docutils literal notranslate"><span class="pre">OPERATOR_ASSIGNED</span></code></p></td>
<td><p>5</p></td>
<td><p>operator assigned</p></td>
</tr>
<tr class="row-even"><td><p><code class="docutils literal notranslate"><span class="pre">OTHER_ORIGIN_DEPTH</span></code></p></td>
<td><p>6</p></td>
<td><p>other</p></td>
</tr>
</tbody>
</table>
<p>Used by:</p>
<ul class="simple">
<li><p><a class="reference internal" href="#seiscomp.datamodel.Origin.depthType" title="seiscomp.datamodel.Origin.depthType"><code class="xref py py-func docutils literal notranslate"><span class="pre">Origin.depthType()</span></code></a></p></li>
</ul>
<p id="api-python-datamodel-origintype"><strong>OriginType</strong></p>
<table class="docutils align-default">
<colgroup>
<col style="width: 33%" />
<col style="width: 33%" />
<col style="width: 33%" />
</colgroup>
<thead>
<tr class="row-odd"><th class="head"><p>ID</p></th>
<th class="head"><p>Numeric value</p></th>
<th class="head"><p>String value</p></th>
</tr>
</thead>
<tbody>
<tr class="row-even"><td><p><code class="docutils literal notranslate"><span class="pre">HYPOCENTER</span></code></p></td>
<td><p>0</p></td>
<td><p>hypocenter</p></td>
</tr>
<tr class="row-odd"><td><p><code class="docutils literal notranslate"><span class="pre">CENTROID</span></code></p></td>
<td><p>1</p></td>
<td><p>centroid</p></td>
</tr>
<tr class="row-even"><td><p><code class="docutils literal notranslate"><span class="pre">AMPLITUDE</span></code></p></td>
<td><p>2</p></td>
<td><p>amplitude</p></td>
</tr>
<tr class="row-odd"><td><p><code class="docutils literal notranslate"><span class="pre">MACROSEISMIC</span></code></p></td>
<td><p>3</p></td>
<td><p>macroseismic</p></td>
</tr>
<tr class="row-even"><td><p><code class="docutils literal notranslate"><span class="pre">RUPTURE_START</span></code></p></td>
<td><p>4</p></td>
<td><p>rupture start</p></td>
</tr>
<tr class="row-odd"><td><p><code class="docutils literal notranslate"><span class="pre">RUPTURE_END</span></code></p></td>
<td><p>5</p></td>
<td><p>rupture end</p></td>
</tr>
</tbody>
</table>
<p>Used by:</p>
<ul class="simple">
<li><p><a class="reference internal" href="#seiscomp.datamodel.Origin.type" title="seiscomp.datamodel.Origin.type"><code class="xref py py-func docutils literal notranslate"><span class="pre">Origin.type()</span></code></a></p></li>
</ul>
<p id="api-python-datamodel-originuncertaintydescription"><strong>OriginUncertaintyDescription</strong></p>
<table class="docutils align-default">
<colgroup>
<col style="width: 33%" />
<col style="width: 33%" />
<col style="width: 33%" />
</colgroup>
<thead>
<tr class="row-odd"><th class="head"><p>ID</p></th>
<th class="head"><p>Numeric value</p></th>
<th class="head"><p>String value</p></th>
</tr>
</thead>
<tbody>
<tr class="row-even"><td><p><code class="docutils literal notranslate"><span class="pre">HORIZONTAL</span></code></p></td>
<td><p>0</p></td>
<td><p>horizontal uncertainty</p></td>
</tr>
<tr class="row-odd"><td><p><code class="docutils literal notranslate"><span class="pre">ELLIPSE</span></code></p></td>
<td><p>1</p></td>
<td><p>uncertainty ellipse</p></td>
</tr>
<tr class="row-even"><td><p><code class="docutils literal notranslate"><span class="pre">ELLIPSOID</span></code></p></td>
<td><p>2</p></td>
<td><p>confidence ellipsoid</p></td>
</tr>
<tr class="row-odd"><td><p><code class="docutils literal notranslate"><span class="pre">PDF</span></code></p></td>
<td><p>3</p></td>
<td><p>probability density function</p></td>
</tr>
</tbody>
</table>
<p>Used by:</p>
<ul class="simple">
<li><p><a class="reference internal" href="#seiscomp.datamodel.OriginUncertainty.preferredDescription" title="seiscomp.datamodel.OriginUncertainty.preferredDescription"><code class="xref py py-func docutils literal notranslate"><span class="pre">OriginUncertainty.preferredDescription()</span></code></a></p></li>
</ul>
<p id="api-python-datamodel-pickonset"><strong>PickOnset</strong></p>
<table class="docutils align-default">
<colgroup>
<col style="width: 33%" />
<col style="width: 33%" />
<col style="width: 33%" />
</colgroup>
<thead>
<tr class="row-odd"><th class="head"><p>ID</p></th>
<th class="head"><p>Numeric value</p></th>
<th class="head"><p>String value</p></th>
</tr>
</thead>
<tbody>
<tr class="row-even"><td><p><code class="docutils literal notranslate"><span class="pre">EMERGENT</span></code></p></td>
<td><p>0</p></td>
<td><p>emergent</p></td>
</tr>
<tr class="row-odd"><td><p><code class="docutils literal notranslate"><span class="pre">IMPULSIVE</span></code></p></td>
<td><p>1</p></td>
<td><p>impulsive</p></td>
</tr>
<tr class="row-even"><td><p><code class="docutils literal notranslate"><span class="pre">QUESTIONABLE</span></code></p></td>
<td><p>2</p></td>
<td><p>questionable</p></td>
</tr>
</tbody>
</table>
<p>Used by:</p>
<ul class="simple">
<li><p><a class="reference internal" href="#seiscomp.datamodel.Pick.onset" title="seiscomp.datamodel.Pick.onset"><code class="xref py py-func docutils literal notranslate"><span class="pre">Pick.onset()</span></code></a></p></li>
</ul>
<p id="api-python-datamodel-pickpolarity"><strong>PickPolarity</strong></p>
<table class="docutils align-default">
<colgroup>
<col style="width: 33%" />
<col style="width: 33%" />
<col style="width: 33%" />
</colgroup>
<thead>
<tr class="row-odd"><th class="head"><p>ID</p></th>
<th class="head"><p>Numeric value</p></th>
<th class="head"><p>String value</p></th>
</tr>
</thead>
<tbody>
<tr class="row-even"><td><p><code class="docutils literal notranslate"><span class="pre">POSITIVE</span></code></p></td>
<td><p>0</p></td>
<td><p>positive</p></td>
</tr>
<tr class="row-odd"><td><p><code class="docutils literal notranslate"><span class="pre">NEGATIVE</span></code></p></td>
<td><p>1</p></td>
<td><p>negative</p></td>
</tr>
<tr class="row-even"><td><p><code class="docutils literal notranslate"><span class="pre">UNDECIDABLE</span></code></p></td>
<td><p>2</p></td>
<td><p>undecidable</p></td>
</tr>
</tbody>
</table>
<p>Used by:</p>
<ul class="simple">
<li><p><a class="reference internal" href="#seiscomp.datamodel.Pick.polarity" title="seiscomp.datamodel.Pick.polarity"><code class="xref py py-func docutils literal notranslate"><span class="pre">Pick.polarity()</span></code></a></p></li>
</ul>
<p id="api-python-datamodel-sourcetimefunctiontype"><strong>SourceTimeFunctionType</strong></p>
<table class="docutils align-default">
<colgroup>
<col style="width: 33%" />
<col style="width: 33%" />
<col style="width: 33%" />
</colgroup>
<thead>
<tr class="row-odd"><th class="head"><p>ID</p></th>
<th class="head"><p>Numeric value</p></th>
<th class="head"><p>String value</p></th>
</tr>
</thead>
<tbody>
<tr class="row-even"><td><p><code class="docutils literal notranslate"><span class="pre">BOX_CAR</span></code></p></td>
<td><p>0</p></td>
<td><p>box car</p></td>
</tr>
<tr class="row-odd"><td><p><code class="docutils literal notranslate"><span class="pre">TRIANGLE</span></code></p></td>
<td><p>1</p></td>
<td><p>triangle</p></td>
</tr>
<tr class="row-even"><td><p><code class="docutils literal notranslate"><span class="pre">TRAPEZOID</span></code></p></td>
<td><p>2</p></td>
<td><p>trapezoid</p></td>
</tr>
<tr class="row-odd"><td><p><code class="docutils literal notranslate"><span class="pre">UNKNOWN_FUNCTION</span></code></p></td>
<td><p>3</p></td>
<td><p>unknown</p></td>
</tr>
</tbody>
</table>
<p>Used by:</p>
<ul class="simple">
<li><p><a class="reference internal" href="#seiscomp.datamodel.SourceTimeFunction.type" title="seiscomp.datamodel.SourceTimeFunction.type"><code class="xref py py-func docutils literal notranslate"><span class="pre">SourceTimeFunction.type()</span></code></a></p></li>
</ul>
<p id="api-python-datamodel-stationgrouptype"><strong>StationGroupType</strong></p>
<table class="docutils align-default">
<colgroup>
<col style="width: 33%" />
<col style="width: 33%" />
<col style="width: 33%" />
</colgroup>
<thead>
<tr class="row-odd"><th class="head"><p>ID</p></th>
<th class="head"><p>Numeric value</p></th>
<th class="head"><p>String value</p></th>
</tr>
</thead>
<tbody>
<tr class="row-even"><td><p><code class="docutils literal notranslate"><span class="pre">DEPLOYMENT</span></code></p></td>
<td><p>0</p></td>
<td><p>deployment</p></td>
</tr>
<tr class="row-odd"><td><p><code class="docutils literal notranslate"><span class="pre">ARRAY</span></code></p></td>
<td><p>1</p></td>
<td><p>array</p></td>
</tr>
</tbody>
</table>
<p>Used by:</p>
<ul class="simple">
<li><p><a class="reference internal" href="#seiscomp.datamodel.StationGroup.type" title="seiscomp.datamodel.StationGroup.type"><code class="xref py py-func docutils literal notranslate"><span class="pre">StationGroup.type()</span></code></a></p></li>
</ul>
</div>
<div class="section" id="reference">
<h2>Reference<a class="headerlink" href="#reference" title="Permalink to this headline"></a></h2>
<div class="section" id="object">
<span id="api-python-datamodel-object"></span><h3>Object<a class="headerlink" href="#object" title="Permalink to this headline"></a></h3>
<dl class="class">
<dt id="seiscomp.datamodel.Object">
<em class="property">class </em><code class="sig-prename descclassname">seiscomp.datamodel.</code><code class="sig-name descname">Object</code><a class="headerlink" href="#seiscomp.datamodel.Object" title="Permalink to this definition"></a></dt>
<dd><dl class="method">
<dt id="seiscomp.datamodel.Object.parent">
<code class="sig-name descname">parent</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.Object.parent" title="Permalink to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Return type</dt>
<dd class="field-odd"><p><a class="reference internal" href="#seiscomp.datamodel.PublicObject" title="seiscomp.datamodel.PublicObject">PublicObject</a></p>
</dd>
</dl>
<p>Returns the <a class="reference internal" href="#api-python-datamodel-publicobject"><span class="std std-ref">PublicObject</span></a>
parent object is available, None otherwise.</p>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.Object.setParent">
<code class="sig-name descname">setParent</code><span class="sig-paren">(</span><em class="sig-param">parent</em><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.Object.setParent" title="Permalink to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>parent</strong> A PublicObject.</p>
</dd>
<dt class="field-even">Return type</dt>
<dd class="field-even"><p>A Boolean flag indicating success with True, False otherwise.</p>
</dd>
</dl>
<p>Sets the parent to <a class="reference internal" href="#api-python-datamodel-publicobject"><span class="std std-ref">PublicObject</span></a>.
This is an internal method and should not be called from applications.
Instead a class should be derived from Object which calls
this method internally when children are being added or removed.</p>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.Object.update">
<code class="sig-name descname">update</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.Object.update" title="Permalink to this definition"></a></dt>
<dd><p>Creates an update notifier for this object ignoring its children. If an
attribute of an object is changed this methods needs to be called
manually since attribute changes are not tracked automatically by the
notifier framework. Only hierarchy modifications such as add and remove
child objects.</p>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.Object.assign">
<code class="sig-name descname">assign</code><span class="sig-paren">(</span><em class="sig-param">other</em><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.Object.assign" title="Permalink to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>other</strong> A Object.</p>
</dd>
<dt class="field-even">Return type</dt>
<dd class="field-even"><p>A Boolean flag indicating success with True, False otherwise.</p>
</dd>
</dl>
<p>Assign the metadata of other to this without others children.
Returns True, if this and other are of same type, False otherwise.</p>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.Object.clone">
<code class="sig-name descname">clone</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.Object.clone" title="Permalink to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Return type</dt>
<dd class="field-odd"><p>A Object.</p>
</dd>
</dl>
<p>Clones an object. If the clonee is a
<a class="reference internal" href="#api-python-datamodel-publicobject"><span class="std std-ref">PublicObject</span></a>
it is not registered in the global instance pool but receives exactly the
same publicID like this.</p>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.Object.attachTo">
<code class="sig-name descname">attachTo</code><span class="sig-paren">(</span><em class="sig-param">parent</em><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.Object.attachTo" title="Permalink to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Return type</dt>
<dd class="field-odd"><p>A Boolean flag indicating success with True, False otherwise.</p>
</dd>
</dl>
<p>Adds the object to a parent. If it has already a parent or is of
wrong type, False is returned.</p>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.Object.detachFrom">
<code class="sig-name descname">detachFrom</code><span class="sig-paren">(</span><em class="sig-param">parent</em><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.Object.detachFrom" title="Permalink to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Return type</dt>
<dd class="field-odd"><p>A Boolean flag indicating success with True, False otherwise.</p>
</dd>
</dl>
<p>Removes the object from a parent. If it has another or no parent,
False is returned.</p>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.Object.detach">
<code class="sig-name descname">detach</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.Object.detach" title="Permalink to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Return type</dt>
<dd class="field-odd"><p>A Boolean flag indicating success with True, False otherwise.</p>
</dd>
</dl>
<p>Removes the object from its parent object if a parent is set.</p>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.Object.accept">
<code class="sig-name descname">accept</code><span class="sig-paren">(</span><em class="sig-param">visitor</em><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.Object.accept" title="Permalink to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>visitor</strong> A visitor.</p>
</dd>
</dl>
</dd></dl>
</dd></dl>
</div>
<div class="section" id="publicobject">
<span id="api-python-datamodel-publicobject"></span><h3>PublicObject<a class="headerlink" href="#publicobject" title="Permalink to this headline"></a></h3>
<dl class="class">
<dt id="seiscomp.datamodel.PublicObject">
<em class="property">class </em><code class="sig-prename descclassname">seiscomp.datamodel.</code><code class="sig-name descname">PublicObject</code><a class="headerlink" href="#seiscomp.datamodel.PublicObject" title="Permalink to this definition"></a></dt>
<dd><p>Inherits <a class="reference internal" href="#api-python-datamodel-object"><span class="std std-ref">Object</span></a>.</p>
<dl class="method">
<dt id="seiscomp.datamodel.PublicObject.setPublicID">
<code class="sig-name descname">setPublicID</code><span class="sig-paren">(</span><em class="sig-param">id</em><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.PublicObject.setPublicID" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
<p>Sets the publicID of the object.</p>
<dl class="method">
<dt id="seiscomp.datamodel.PublicObject.publicID">
<code class="sig-name descname">publicID</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.PublicObject.publicID" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
<p>Returns the publicID of the object.</p>
</dd></dl>
</div>
<div class="section" id="notifier">
<span id="api-python-datamodel-notifier"></span><h3>Notifier<a class="headerlink" href="#notifier" title="Permalink to this headline"></a></h3>
<dl class="class">
<dt id="seiscomp.datamodel.Notifier">
<em class="property">class </em><code class="sig-prename descclassname">seiscomp.datamodel.</code><code class="sig-name descname">Notifier</code><span class="sig-paren">(</span><em class="sig-param">parentID</em>, <em class="sig-param">operation</em>, <em class="sig-param">object</em><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.Notifier" title="Permalink to this definition"></a></dt>
<dd><p>Class to represent a change in the object tree. A notifier takes a parentID,
an operation to apply and a child object. The child object is without children.</p>
<dl class="method">
<dt id="seiscomp.datamodel.Notifier.Enable">
<em class="property">static </em><code class="sig-name descname">Enable</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.Notifier.Enable" title="Permalink to this definition"></a></dt>
<dd><p>Enables the notifier pool. If enabled, notifiers are automatically created
if the object tree is being changed.</p>
</dd></dl>
<dl class="method">
<dt>
<em class="property">static </em><code class="sig-name descname">Enable</code><span class="sig-paren">(</span><span class="sig-paren">)</span></dt>
<dd><p>Disables the notifier pool.</p>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.Notifier.SetEnabled">
<em class="property">static </em><code class="sig-name descname">SetEnabled</code><span class="sig-paren">(</span><em class="sig-param">enable</em><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.Notifier.SetEnabled" title="Permalink to this definition"></a></dt>
<dd><p>Sets the state of the notifier pool.</p>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.Notifier.IsEnabled">
<em class="property">static </em><code class="sig-name descname">IsEnabled</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.Notifier.IsEnabled" title="Permalink to this definition"></a></dt>
<dd><p>Returns the notification pool state. The default is TRUE.</p>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.Notifier.SetCheckEnabled">
<em class="property">static </em><code class="sig-name descname">SetCheckEnabled</code><span class="sig-paren">(</span><em class="sig-param">enable</em><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.Notifier.SetCheckEnabled" title="Permalink to this definition"></a></dt>
<dd><p>Enables/disables checking previous inserted notifiers
when a new notifiers is about to be queued. When
enabled, and OP_ADD and OP_UPDATE of the same object
results in only one OP_ADD notifier.</p>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.Notifier.IsCheckEnabled">
<em class="property">static </em><code class="sig-name descname">IsCheckEnabled</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.Notifier.IsCheckEnabled" title="Permalink to this definition"></a></dt>
<dd><p>Returns the current check state.</p>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.Notifier.GetMessage">
<em class="property">static </em><code class="sig-name descname">GetMessage</code><span class="sig-paren">(</span><em class="sig-param">allNotifier = True</em><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.Notifier.GetMessage" title="Permalink to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>allNotifier</strong> Defines whether to return one message including all
notifiers or one message including one notifier.</p>
</dd>
<dt class="field-even">Return type</dt>
<dd class="field-even"><p>A NotifierMessage object if there is one. If each notifier is
being send by its own message, this method should be called
until it returns None.</p>
</dd>
</dl>
<p>Returns a message holding all notifications since the
last call. All stored notifications will be removed from
the notification pool.</p>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.Notifier.Size">
<em class="property">static </em><code class="sig-name descname">Size</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.Notifier.Size" title="Permalink to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Return type</dt>
<dd class="field-odd"><p>Integer value.</p>
</dd>
</dl>
<p>Returns the size of the notifier objects currently stored.</p>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.Notifier.Clear">
<em class="property">static </em><code class="sig-name descname">Clear</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.Notifier.Clear" title="Permalink to this definition"></a></dt>
<dd><p>Clears all buffered notifiers.</p>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.Notifier.Create">
<em class="property">static </em><code class="sig-name descname">Create</code><span class="sig-paren">(</span><em class="sig-param">parentID</em>, <em class="sig-param">operation</em>, <em class="sig-param">object</em><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.Notifier.Create" title="Permalink to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><ul class="simple">
<li><p><strong>parentID</strong> The publicID of the parent object that is target of the operation.</p></li>
<li><p><strong>operation</strong> The operation applied to the parent object.</p></li>
<li><p><strong>object</strong> The object that is the operations “operand”.</p></li>
</ul>
</dd>
<dt class="field-even">Return type</dt>
<dd class="field-even"><p>The Notifier object.</p>
</dd>
</dl>
<p>Creates a notifier object managed by the global notifier pool.
If the notifier pool is disabled no notifier instance will
be created and None is being returned.</p>
</dd></dl>
<dl class="method">
<dt>
<em class="property">static </em><code class="sig-name descname">Create</code><span class="sig-paren">(</span><em class="sig-param">parent</em>, <em class="sig-param">operation</em>, <em class="sig-param">object</em><span class="sig-paren">)</span></dt>
<dd><p>:param parent The parent object that is target of the operation.
:param operation: The operation applied to the parent object.
:param object: The object that is the operations “operand”.
:rtype: The Notifier object.</p>
<p>Creates a notifier object managed by the global notifier pool.
If the notifier pool is disabled no notifier instance will
be created and None is being returned.</p>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.Notifier.apply">
<code class="sig-name descname">apply</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.Notifier.apply" title="Permalink to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Return type</dt>
<dd class="field-odd"><p>A flag indicating success with True, False otherwise.</p>
</dd>
</dl>
<p>Applies the notifier to the local object tree.</p>
</dd></dl>
</dd></dl>
</div>
<div class="section" id="access">
<span id="api-python-datamodel-access"></span><h3>Access<a class="headerlink" href="#access" title="Permalink to this headline"></a></h3>
<dl class="class">
<dt id="seiscomp.datamodel.Access">
<em class="property">class </em><code class="sig-prename descclassname">seiscomp.datamodel.</code><code class="sig-name descname">Access</code><a class="headerlink" href="#seiscomp.datamodel.Access" title="Permalink to this definition"></a></dt>
<dd><p>Inherits <a class="reference internal" href="#api-python-datamodel-object"><span class="std std-ref">Object</span></a>.</p>
<p>This type describes an ArcLink access rule</p>
<p><strong>Parents</strong>:</p>
<ul class="simple">
<li><p><code class="docutils literal notranslate"><span class="pre">routing</span></code> <a class="reference internal" href="#api-python-datamodel-routing"><span class="std std-ref">Routing</span></a></p></li>
</ul>
<p><strong>Attributes</strong>:</p>
<ul class="simple">
<li><p><code class="docutils literal notranslate"><span class="pre">networkCode</span></code> string</p></li>
<li><p><code class="docutils literal notranslate"><span class="pre">stationCode</span></code> string</p></li>
<li><p><code class="docutils literal notranslate"><span class="pre">locationCode</span></code> string</p></li>
<li><p><code class="docutils literal notranslate"><span class="pre">streamCode</span></code> string</p></li>
<li><p><code class="docutils literal notranslate"><span class="pre">user</span></code> string</p></li>
<li><p><code class="docutils literal notranslate"><span class="pre">start</span></code> seiscomp.core.Time</p></li>
<li><p><code class="docutils literal notranslate"><span class="pre">end</span></code> seiscomp.core.Time (optional)</p></li>
</ul>
<p><strong>Methods</strong>:</p>
<dl class="method">
<dt id="seiscomp.datamodel.Access.Cast">
<em class="property">static </em><code class="sig-name descname">Cast</code><span class="sig-paren">(</span><em class="sig-param">obj</em><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.Access.Cast" title="Permalink to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>obj</strong> The object to be casted.</p>
</dd>
<dt class="field-even">Return type</dt>
<dd class="field-even"><p>An object of type Access if the cast was successful,
None otherwise.</p>
</dd>
</dl>
<p>Cast an arbitrary object to Access if the internal wrapped
representation is an Access object. The cast is important if
instances of type <a class="reference internal" href="#api-python-datamodel-object"><span class="std std-ref">Object</span></a>
are passed to methods which need access to the real type.</p>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.Access.equal">
<code class="sig-name descname">equal</code><span class="sig-paren">(</span><em class="sig-param">other</em><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.Access.equal" title="Permalink to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>other</strong> Another object of type Access to compare this
instance to</p>
</dd>
<dt class="field-even">Return type</dt>
<dd class="field-even"><p>A Boolean value indicating True if both objects are equal or
False otherwise.</p>
</dd>
</dl>
<p>Compares two objects without its child objects. Both objects are compared
by value.</p>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.Access.index">
<code class="sig-name descname">index</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.Access.index" title="Permalink to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Return type</dt>
<dd class="field-odd"><p><p>The objects index of type AccessIndex.</p>
<p>Returns the objects index which is also used for the database as unique
constraint.</p>
</p>
</dd>
</dl>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.Access.equalIndex">
<code class="sig-name descname">equalIndex</code><span class="sig-paren">(</span><em class="sig-param">lhs</em><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.Access.equalIndex" title="Permalink to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>lhs</strong> <a class="reference internal" href="#api-python-datamodel-access"><span class="std std-ref">Access</span></a></p>
</dd>
<dt class="field-even">Return type</dt>
<dd class="field-even"><p>A Boolean value indicating True if both indexes are equal or
False otherwise.</p>
</dd>
</dl>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.Access.setNetworkCode">
<code class="sig-name descname">setNetworkCode</code><span class="sig-paren">(</span><em class="sig-param">networkCode</em><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.Access.setNetworkCode" title="Permalink to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>networkCode</strong> string</p>
</dd>
</dl>
<p>Network code</p>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.Access.networkCode">
<code class="sig-name descname">networkCode</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.Access.networkCode" title="Permalink to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Return type</dt>
<dd class="field-odd"><p>string</p>
</dd>
</dl>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.Access.setStationCode">
<code class="sig-name descname">setStationCode</code><span class="sig-paren">(</span><em class="sig-param">stationCode</em><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.Access.setStationCode" title="Permalink to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>stationCode</strong> string</p>
</dd>
</dl>
<p>Station code (empty for any station)</p>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.Access.stationCode">
<code class="sig-name descname">stationCode</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.Access.stationCode" title="Permalink to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Return type</dt>
<dd class="field-odd"><p>string</p>
</dd>
</dl>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.Access.setLocationCode">
<code class="sig-name descname">setLocationCode</code><span class="sig-paren">(</span><em class="sig-param">locationCode</em><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.Access.setLocationCode" title="Permalink to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>locationCode</strong> string</p>
</dd>
</dl>
<p>Location code (empty for any location)</p>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.Access.locationCode">
<code class="sig-name descname">locationCode</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.Access.locationCode" title="Permalink to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Return type</dt>
<dd class="field-odd"><p>string</p>
</dd>
</dl>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.Access.setStreamCode">
<code class="sig-name descname">setStreamCode</code><span class="sig-paren">(</span><em class="sig-param">streamCode</em><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.Access.setStreamCode" title="Permalink to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>streamCode</strong> string</p>
</dd>
</dl>
<p>Stream (Channel) code (empty for any stream)</p>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.Access.streamCode">
<code class="sig-name descname">streamCode</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.Access.streamCode" title="Permalink to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Return type</dt>
<dd class="field-odd"><p>string</p>
</dd>
</dl>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.Access.setUser">
<code class="sig-name descname">setUser</code><span class="sig-paren">(</span><em class="sig-param">user</em><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.Access.setUser" title="Permalink to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>user</strong> string</p>
</dd>
</dl>
<p>Username (e-mail) or part of it (must match the end)</p>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.Access.user">
<code class="sig-name descname">user</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.Access.user" title="Permalink to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Return type</dt>
<dd class="field-odd"><p>string</p>
</dd>
</dl>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.Access.setStart">
<code class="sig-name descname">setStart</code><span class="sig-paren">(</span><em class="sig-param">start</em><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.Access.setStart" title="Permalink to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>start</strong> seiscomp.core.Time</p>
</dd>
</dl>
<p>Start of validity</p>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.Access.start">
<code class="sig-name descname">start</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.Access.start" title="Permalink to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Return type</dt>
<dd class="field-odd"><p>seiscomp.core.Time</p>
</dd>
</dl>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.Access.setEnd">
<code class="sig-name descname">setEnd</code><span class="sig-paren">(</span><em class="sig-param">end</em><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.Access.setEnd" title="Permalink to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>end</strong> seiscomp.core.Time</p>
</dd>
</dl>
<p>End of validity</p>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.Access.end">
<code class="sig-name descname">end</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.Access.end" title="Permalink to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Return type</dt>
<dd class="field-odd"><p>seiscomp.core.Time</p>
</dd>
</dl>
<div class="admonition note">
<p class="admonition-title">Note</p>
<p>As this attribute is optional, this method throws a ValueError if
the value of the attribute is not set.</p>
</div>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.Access.routing">
<code class="sig-name descname">routing</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.Access.routing" title="Permalink to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Return type</dt>
<dd class="field-odd"><p><a class="reference internal" href="#seiscomp.datamodel.Routing" title="seiscomp.datamodel.Routing">Routing</a></p>
</dd>
</dl>
<p>Returns the parent Routing if available. Returns None
if the parent is not a Routing. This is a convenience wrapper
for parent().</p>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.Access.assign">
<code class="sig-name descname">assign</code><span class="sig-paren">(</span><em class="sig-param">other</em><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.Access.assign" title="Permalink to this definition"></a></dt>
<dd><p>This method implements the <a class="reference internal" href="#api-python-datamodel-object"><span class="std std-ref">Object</span></a> interface.</p>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.Access.attachTo">
<code class="sig-name descname">attachTo</code><span class="sig-paren">(</span><em class="sig-param">parent</em><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.Access.attachTo" title="Permalink to this definition"></a></dt>
<dd><p>This method implements the <a class="reference internal" href="#api-python-datamodel-object"><span class="std std-ref">Object</span></a> interface.</p>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.Access.detachFrom">
<code class="sig-name descname">detachFrom</code><span class="sig-paren">(</span><em class="sig-param">parent</em><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.Access.detachFrom" title="Permalink to this definition"></a></dt>
<dd><p>This method implements the <a class="reference internal" href="#api-python-datamodel-object"><span class="std std-ref">Object</span></a> interface.</p>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.Access.detach">
<code class="sig-name descname">detach</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.Access.detach" title="Permalink to this definition"></a></dt>
<dd><p>This method implements the <a class="reference internal" href="#api-python-datamodel-object"><span class="std std-ref">Object</span></a> interface.</p>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.Access.clone">
<code class="sig-name descname">clone</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.Access.clone" title="Permalink to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Return type</dt>
<dd class="field-odd"><p>A cloned Access.</p>
</dd>
</dl>
<p>Returns a new instance that is a clone of the current instance. Child
objects are being ignored.</p>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.Access.accept">
<code class="sig-name descname">accept</code><span class="sig-paren">(</span><em class="sig-param">visitor</em><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.Access.accept" title="Permalink to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>visitor</strong> A visitor.</p>
</dd>
</dl>
<p>This method implements the <a class="reference internal" href="#api-python-datamodel-publicobject"><span class="std std-ref">PublicObject</span></a> interface.</p>
</dd></dl>
</dd></dl>
</div>
<div class="section" id="amplitude">
<span id="api-python-datamodel-amplitude"></span><h3>Amplitude<a class="headerlink" href="#amplitude" title="Permalink to this headline"></a></h3>
<dl class="class">
<dt id="seiscomp.datamodel.Amplitude">
<em class="property">class </em><code class="sig-prename descclassname">seiscomp.datamodel.</code><code class="sig-name descname">Amplitude</code><a class="headerlink" href="#seiscomp.datamodel.Amplitude" title="Permalink to this definition"></a></dt>
<dd><p>Inherits <a class="reference internal" href="#api-python-datamodel-publicobject"><span class="std std-ref">PublicObject</span></a>.</p>
<p>This class represents a quantification of the waveform anomaly, usually
a single amplitude measurement or a measurement of the visible signal
duration for duration magnitudes.</p>
<p><strong>Parents</strong>:</p>
<ul class="simple">
<li><p><code class="docutils literal notranslate"><span class="pre">eventParameters</span></code> <a class="reference internal" href="#api-python-datamodel-eventparameters"><span class="std std-ref">EventParameters</span></a></p></li>
</ul>
<p><strong>Children</strong>:</p>
<ul class="simple">
<li><p><code class="docutils literal notranslate"><span class="pre">comment</span></code> <a class="reference internal" href="#api-python-datamodel-comment"><span class="std std-ref">Comment</span></a></p></li>
</ul>
<p><strong>Attributes</strong>:</p>
<ul class="simple">
<li><p><code class="docutils literal notranslate"><span class="pre">publicID</span></code>: string</p></li>
<li><p><code class="docutils literal notranslate"><span class="pre">type</span></code> string</p></li>
<li><p><code class="docutils literal notranslate"><span class="pre">amplitude</span></code> <a class="reference internal" href="#api-python-datamodel-realquantity"><span class="std std-ref">RealQuantity</span></a> (optional)</p></li>
<li><p><code class="docutils literal notranslate"><span class="pre">timeWindow</span></code> <a class="reference internal" href="#api-python-datamodel-timewindow"><span class="std std-ref">TimeWindow</span></a> (optional)</p></li>
<li><p><code class="docutils literal notranslate"><span class="pre">period</span></code> <a class="reference internal" href="#api-python-datamodel-realquantity"><span class="std std-ref">RealQuantity</span></a> (optional)</p></li>
<li><p><code class="docutils literal notranslate"><span class="pre">snr</span></code> float (optional)</p></li>
<li><p><code class="docutils literal notranslate"><span class="pre">unit</span></code> string</p></li>
<li><p><code class="docutils literal notranslate"><span class="pre">pickID</span></code> string</p></li>
<li><p><code class="docutils literal notranslate"><span class="pre">waveformID</span></code> <a class="reference internal" href="#api-python-datamodel-waveformstreamid"><span class="std std-ref">WaveformStreamID</span></a> (optional)</p></li>
<li><p><code class="docutils literal notranslate"><span class="pre">filterID</span></code> string</p></li>
<li><p><code class="docutils literal notranslate"><span class="pre">methodID</span></code> string</p></li>
<li><p><code class="docutils literal notranslate"><span class="pre">scalingTime</span></code> <a class="reference internal" href="#api-python-datamodel-timequantity"><span class="std std-ref">TimeQuantity</span></a> (optional)</p></li>
<li><p><code class="docutils literal notranslate"><span class="pre">magnitudeHint</span></code> string</p></li>
<li><p><code class="docutils literal notranslate"><span class="pre">evaluationMode</span></code> <a class="reference internal" href="#api-python-datamodel-evaluationmode"><span class="std std-ref">EvaluationMode</span></a> (optional)</p></li>
<li><p><code class="docutils literal notranslate"><span class="pre">creationInfo</span></code> <a class="reference internal" href="#api-python-datamodel-creationinfo"><span class="std std-ref">CreationInfo</span></a> (optional)</p></li>
</ul>
<p><strong>Referenced by</strong>:</p>
<ul class="simple">
<li><p><a class="reference internal" href="#seiscomp.datamodel.AmplitudeReference.amplitudeID" title="seiscomp.datamodel.AmplitudeReference.amplitudeID"><code class="xref py py-func docutils literal notranslate"><span class="pre">AmplitudeReference.amplitudeID()</span></code></a></p></li>
<li><p><a class="reference internal" href="#seiscomp.datamodel.StationMagnitude.amplitudeID" title="seiscomp.datamodel.StationMagnitude.amplitudeID"><code class="xref py py-func docutils literal notranslate"><span class="pre">StationMagnitude.amplitudeID()</span></code></a></p></li>
</ul>
<p><strong>Methods</strong>:</p>
<dl class="method">
<dt id="seiscomp.datamodel.Amplitude.Cast">
<em class="property">static </em><code class="sig-name descname">Cast</code><span class="sig-paren">(</span><em class="sig-param">obj</em><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.Amplitude.Cast" title="Permalink to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>obj</strong> The object to be casted.</p>
</dd>
<dt class="field-even">Return type</dt>
<dd class="field-even"><p>An object of type Amplitude if the cast was successful,
None otherwise.</p>
</dd>
</dl>
<p>Cast an arbitrary object to Amplitude if the internal wrapped
representation is an Amplitude object. The cast is important if
instances of type <a class="reference internal" href="#api-python-datamodel-object"><span class="std std-ref">Object</span></a>
are passed to methods which need access to the real type.</p>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.Amplitude.Create">
<em class="property">static </em><code class="sig-name descname">Create</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.Amplitude.Create" title="Permalink to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Return type</dt>
<dd class="field-odd"><p>A new object of type Amplitude.</p>
</dd>
</dl>
<p>Creates and registers (if enabled) a Amplitude instance. The
publicID is auto-generated.</p>
</dd></dl>
<dl class="method">
<dt>
<em class="property">static </em><code class="sig-name descname">Create</code><span class="sig-paren">(</span><em class="sig-param">publicID</em><span class="sig-paren">)</span></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Return type</dt>
<dd class="field-odd"><p>A new object of type Amplitude.</p>
</dd>
</dl>
<p>Creates and registers (if enabled) a Amplitude instance with
passed publicID.</p>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.Amplitude.equal">
<code class="sig-name descname">equal</code><span class="sig-paren">(</span><em class="sig-param">other</em><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.Amplitude.equal" title="Permalink to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>other</strong> Another object of type Amplitude to compare this
instance to</p>
</dd>
<dt class="field-even">Return type</dt>
<dd class="field-even"><p>A Boolean value indicating True if both objects are equal or
False otherwise.</p>
</dd>
</dl>
<p>Compares two objects without its child objects. Both objects are compared
by value.</p>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.Amplitude.setType">
<code class="sig-name descname">setType</code><span class="sig-paren">(</span><em class="sig-param">type</em><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.Amplitude.setType" title="Permalink to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>type</strong> string</p>
</dd>
</dl>
<p>String that describes the type of amplitude using the nomenclature
from Storchak et al. (2003). Possible values include unspecified
amplitude reading (A), amplitude reading for local magnitude (ML),
amplitude reading for body wave magnitude (MB), amplitude reading
for surface wave magnitude (MS), and time of visible end of record
for duration magnitude (MD). It has a maximum length of 16 characters.</p>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.Amplitude.type">
<code class="sig-name descname">type</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.Amplitude.type" title="Permalink to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Return type</dt>
<dd class="field-odd"><p>string</p>
</dd>
</dl>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.Amplitude.setAmplitude">
<code class="sig-name descname">setAmplitude</code><span class="sig-paren">(</span><em class="sig-param">amplitude</em><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.Amplitude.setAmplitude" title="Permalink to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>amplitude</strong> <a class="reference internal" href="#api-python-datamodel-realquantity"><span class="std std-ref">RealQuantity</span></a></p>
</dd>
</dl>
<p>Measured amplitude value for the given waveformID. Note that this
attribute can describe different physical quantities, depending on
the type of the amplitude. These can be, e.g., displacement, velocity,
or a period. If the only amplitude information is a period, it has
to specified here, not in the period attribute. The latter can be used
if the amplitude measurement contains information on, e.g.,
displacement and an additional period. Since the physical quantity
described by this attribute is not fixed, the unit of measurement
cannot be defined in advance. However, the quantity has to be
specified in SI base units. The enumeration given in attribute unit
provides the most likely units that could be needed here.
For clarity, using the optional unit attribute is highly encouraged.</p>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.Amplitude.amplitude">
<code class="sig-name descname">amplitude</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.Amplitude.amplitude" title="Permalink to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Return type</dt>
<dd class="field-odd"><p><a class="reference internal" href="#api-python-datamodel-realquantity"><span class="std std-ref">RealQuantity</span></a></p>
</dd>
</dl>
<div class="admonition note">
<p class="admonition-title">Note</p>
<p>As this attribute is optional, this method throws a ValueError if
the value of the attribute is not set.</p>
</div>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.Amplitude.setTimeWindow">
<code class="sig-name descname">setTimeWindow</code><span class="sig-paren">(</span><em class="sig-param">timeWindow</em><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.Amplitude.setTimeWindow" title="Permalink to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>timeWindow</strong> <a class="reference internal" href="#api-python-datamodel-timewindow"><span class="std std-ref">TimeWindow</span></a></p>
</dd>
</dl>
<p>Description of the time window used for amplitude measurement.
Recommended for duration magnitudes.</p>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.Amplitude.timeWindow">
<code class="sig-name descname">timeWindow</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.Amplitude.timeWindow" title="Permalink to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Return type</dt>
<dd class="field-odd"><p><a class="reference internal" href="#api-python-datamodel-timewindow"><span class="std std-ref">TimeWindow</span></a></p>
</dd>
</dl>
<div class="admonition note">
<p class="admonition-title">Note</p>
<p>As this attribute is optional, this method throws a ValueError if
the value of the attribute is not set.</p>
</div>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.Amplitude.setPeriod">
<code class="sig-name descname">setPeriod</code><span class="sig-paren">(</span><em class="sig-param">period</em><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.Amplitude.setPeriod" title="Permalink to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>period</strong> <a class="reference internal" href="#api-python-datamodel-realquantity"><span class="std std-ref">RealQuantity</span></a></p>
</dd>
</dl>
<p>Dominant period in the timeWindow in case of amplitude measurements.
Not used for duration magnitude. The unit is seconds.</p>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.Amplitude.period">
<code class="sig-name descname">period</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.Amplitude.period" title="Permalink to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Return type</dt>
<dd class="field-odd"><p><a class="reference internal" href="#api-python-datamodel-realquantity"><span class="std std-ref">RealQuantity</span></a></p>
</dd>
</dl>
<div class="admonition note">
<p class="admonition-title">Note</p>
<p>As this attribute is optional, this method throws a ValueError if
the value of the attribute is not set.</p>
</div>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.Amplitude.setSnr">
<code class="sig-name descname">setSnr</code><span class="sig-paren">(</span><em class="sig-param">snr</em><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.Amplitude.setSnr" title="Permalink to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>snr</strong> float</p>
</dd>
</dl>
<p>Signal-to-noise ratio of the spectrogram at the location the amplitude was
measured.</p>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.Amplitude.snr">
<code class="sig-name descname">snr</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.Amplitude.snr" title="Permalink to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Return type</dt>
<dd class="field-odd"><p>float</p>
</dd>
</dl>
<div class="admonition note">
<p class="admonition-title">Note</p>
<p>As this attribute is optional, this method throws a ValueError if
the value of the attribute is not set.</p>
</div>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.Amplitude.setUnit">
<code class="sig-name descname">setUnit</code><span class="sig-paren">(</span><em class="sig-param">unit</em><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.Amplitude.setUnit" title="Permalink to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>unit</strong> string</p>
</dd>
</dl>
<p>This attribute provides the most likely measurement units for the
physical quantity described in the amplitude attribute.
Possible values are specified as combinations of SI base units.</p>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.Amplitude.unit">
<code class="sig-name descname">unit</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.Amplitude.unit" title="Permalink to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Return type</dt>
<dd class="field-odd"><p>string</p>
</dd>
</dl>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.Amplitude.setPickID">
<code class="sig-name descname">setPickID</code><span class="sig-paren">(</span><em class="sig-param">pickID</em><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.Amplitude.setPickID" title="Permalink to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>pickID</strong> string</p>
</dd>
</dl>
<p>Refers to the publicID of an associated Pick object.</p>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.Amplitude.pickID">
<code class="sig-name descname">pickID</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.Amplitude.pickID" title="Permalink to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Return type</dt>
<dd class="field-odd"><p>string</p>
</dd>
</dl>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.Amplitude.setWaveformID">
<code class="sig-name descname">setWaveformID</code><span class="sig-paren">(</span><em class="sig-param">waveformID</em><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.Amplitude.setWaveformID" title="Permalink to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>waveformID</strong> <a class="reference internal" href="#api-python-datamodel-waveformstreamid"><span class="std std-ref">WaveformStreamID</span></a></p>
</dd>
</dl>
<p>Identifies the waveform stream on which the amplitude was measured.</p>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.Amplitude.waveformID">
<code class="sig-name descname">waveformID</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.Amplitude.waveformID" title="Permalink to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Return type</dt>
<dd class="field-odd"><p><a class="reference internal" href="#api-python-datamodel-waveformstreamid"><span class="std std-ref">WaveformStreamID</span></a></p>
</dd>
</dl>
<div class="admonition note">
<p class="admonition-title">Note</p>
<p>As this attribute is optional, this method throws a ValueError if
the value of the attribute is not set.</p>
</div>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.Amplitude.setFilterID">
<code class="sig-name descname">setFilterID</code><span class="sig-paren">(</span><em class="sig-param">filterID</em><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.Amplitude.setFilterID" title="Permalink to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>filterID</strong> string</p>
</dd>
</dl>
<p>Identifies the filter or filter setup used for filtering the waveform stream
referenced by waveformID.</p>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.Amplitude.filterID">
<code class="sig-name descname">filterID</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.Amplitude.filterID" title="Permalink to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Return type</dt>
<dd class="field-odd"><p>string</p>
</dd>
</dl>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.Amplitude.setMethodID">
<code class="sig-name descname">setMethodID</code><span class="sig-paren">(</span><em class="sig-param">methodID</em><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.Amplitude.setMethodID" title="Permalink to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>methodID</strong> string</p>
</dd>
</dl>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.Amplitude.methodID">
<code class="sig-name descname">methodID</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.Amplitude.methodID" title="Permalink to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Return type</dt>
<dd class="field-odd"><p>string</p>
</dd>
</dl>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.Amplitude.setScalingTime">
<code class="sig-name descname">setScalingTime</code><span class="sig-paren">(</span><em class="sig-param">scalingTime</em><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.Amplitude.setScalingTime" title="Permalink to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>scalingTime</strong> <a class="reference internal" href="#api-python-datamodel-timequantity"><span class="std std-ref">TimeQuantity</span></a></p>
</dd>
</dl>
<p>Scaling time for amplitude measurement.</p>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.Amplitude.scalingTime">
<code class="sig-name descname">scalingTime</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.Amplitude.scalingTime" title="Permalink to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Return type</dt>
<dd class="field-odd"><p><a class="reference internal" href="#api-python-datamodel-timequantity"><span class="std std-ref">TimeQuantity</span></a></p>
</dd>
</dl>
<div class="admonition note">
<p class="admonition-title">Note</p>
<p>As this attribute is optional, this method throws a ValueError if
the value of the attribute is not set.</p>
</div>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.Amplitude.setMagnitudeHint">
<code class="sig-name descname">setMagnitudeHint</code><span class="sig-paren">(</span><em class="sig-param">magnitudeHint</em><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.Amplitude.setMagnitudeHint" title="Permalink to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>magnitudeHint</strong> string</p>
</dd>
</dl>
<p>Type of magnitude the amplitude measurement is used for. For valid
values see class Magnitude. String value with a maximum length of
16 characters.</p>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.Amplitude.magnitudeHint">
<code class="sig-name descname">magnitudeHint</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.Amplitude.magnitudeHint" title="Permalink to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Return type</dt>
<dd class="field-odd"><p>string</p>
</dd>
</dl>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.Amplitude.setEvaluationMode">
<code class="sig-name descname">setEvaluationMode</code><span class="sig-paren">(</span><em class="sig-param">evaluationMode</em><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.Amplitude.setEvaluationMode" title="Permalink to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>evaluationMode</strong> EvaluationMode</p>
</dd>
</dl>
<p>Evaluation mode of Amplitude.</p>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.Amplitude.evaluationMode">
<code class="sig-name descname">evaluationMode</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.Amplitude.evaluationMode" title="Permalink to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Return type</dt>
<dd class="field-odd"><p>EvaluationMode</p>
</dd>
</dl>
<div class="admonition note">
<p class="admonition-title">Note</p>
<p>As this attribute is optional, this method throws a ValueError if
the value of the attribute is not set.</p>
</div>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.Amplitude.setCreationInfo">
<code class="sig-name descname">setCreationInfo</code><span class="sig-paren">(</span><em class="sig-param">creationInfo</em><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.Amplitude.setCreationInfo" title="Permalink to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>creationInfo</strong> <a class="reference internal" href="#api-python-datamodel-creationinfo"><span class="std std-ref">CreationInfo</span></a></p>
</dd>
</dl>
<p>CreationInfo for the Amplitude object.</p>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.Amplitude.creationInfo">
<code class="sig-name descname">creationInfo</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.Amplitude.creationInfo" title="Permalink to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Return type</dt>
<dd class="field-odd"><p><a class="reference internal" href="#api-python-datamodel-creationinfo"><span class="std std-ref">CreationInfo</span></a></p>
</dd>
</dl>
<div class="admonition note">
<p class="admonition-title">Note</p>
<p>As this attribute is optional, this method throws a ValueError if
the value of the attribute is not set.</p>
</div>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.Amplitude.add">
<code class="sig-name descname">add</code><span class="sig-paren">(</span><em class="sig-param">comment</em><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.Amplitude.add" title="Permalink to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>comment</strong> Object of type <a class="reference internal" href="#api-python-datamodel-comment"><span class="std std-ref">Comment</span></a></p>
</dd>
<dt class="field-even">Return type</dt>
<dd class="field-even"><p>A Boolean value indicating success with True, False otherwise.</p>
</dd>
</dl>
<p>Adds a Comment object to Amplitude. The object is not
copied but managed by this instance. Any change to the passed object
will also change the child.</p>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.Amplitude.remove">
<code class="sig-name descname">remove</code><span class="sig-paren">(</span><em class="sig-param">comment</em><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.Amplitude.remove" title="Permalink to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>comment</strong> Object of type <a class="reference internal" href="#api-python-datamodel-comment"><span class="std std-ref">Comment</span></a></p>
</dd>
<dt class="field-even">Return type</dt>
<dd class="field-even"><p>A Boolean value indicating success with True, False otherwise.</p>
</dd>
</dl>
<p>Removes a previously added Comment object from Amplitude.</p>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.Amplitude.removeComment">
<code class="sig-name descname">removeComment</code><span class="sig-paren">(</span><em class="sig-param">idx</em><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.Amplitude.removeComment" title="Permalink to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>idx</strong> An integer index of the object to be removed.</p>
</dd>
<dt class="field-even">Return type</dt>
<dd class="field-even"><p>A Boolean value indicating success with True, False otherwise.</p>
</dd>
</dl>
</dd></dl>
<dl class="method">
<dt>
<code class="sig-name descname">removeComment(commentIndex);</code></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>commentIndex</strong> The index of the object to be removed of type CommentIndex.</p>
</dd>
<dt class="field-even">Return type</dt>
<dd class="field-even"><p>A Boolean value indicating success with True, False otherwise.</p>
</dd>
</dl>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.Amplitude.commentCount">
<code class="sig-name descname">commentCount</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.Amplitude.commentCount" title="Permalink to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Return type</dt>
<dd class="field-odd"><p>integer value indicating the number of child objects.</p>
</dd>
</dl>
<p>Returns the number of Comment child objects.</p>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.Amplitude.comment">
<code class="sig-name descname">comment</code><span class="sig-paren">(</span><em class="sig-param">idx</em><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.Amplitude.comment" title="Permalink to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>idx</strong> An integer index of the object to be returned.</p>
</dd>
<dt class="field-even">Return type</dt>
<dd class="field-even"><p>Object of type <a class="reference internal" href="#api-python-datamodel-comment"><span class="std std-ref">Comment</span></a>.</p>
</dd>
</dl>
<p>Returns the Comment at index idx.</p>
</dd></dl>
<dl class="method">
<dt>
<code class="sig-name descname">comment</code><span class="sig-paren">(</span><em class="sig-param">commentIndex</em><span class="sig-paren">)</span></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>commentIndex</strong> The index of the object to be removed of type CommentIndex.</p>
</dd>
<dt class="field-even">Return type</dt>
<dd class="field-even"><p>Object of type <a class="reference internal" href="#api-python-datamodel-comment"><span class="std std-ref">Comment</span></a>.</p>
</dd>
</dl>
<p>Returns the Comment at given index. The indexes of all child objects
are compared by value which makes this function slower than the direct
integer index look-up.</p>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.Amplitude.eventParameters">
<code class="sig-name descname">eventParameters</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.Amplitude.eventParameters" title="Permalink to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Return type</dt>
<dd class="field-odd"><p><a class="reference internal" href="#seiscomp.datamodel.EventParameters" title="seiscomp.datamodel.EventParameters">EventParameters</a></p>
</dd>
</dl>
<p>Returns the parent EventParameters if available. Returns None
if the parent is not a EventParameters. This is a convenience wrapper
for parent().</p>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.Amplitude.assign">
<code class="sig-name descname">assign</code><span class="sig-paren">(</span><em class="sig-param">other</em><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.Amplitude.assign" title="Permalink to this definition"></a></dt>
<dd><p>This method implements the <a class="reference internal" href="#api-python-datamodel-object"><span class="std std-ref">Object</span></a> interface.</p>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.Amplitude.attachTo">
<code class="sig-name descname">attachTo</code><span class="sig-paren">(</span><em class="sig-param">parent</em><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.Amplitude.attachTo" title="Permalink to this definition"></a></dt>
<dd><p>This method implements the <a class="reference internal" href="#api-python-datamodel-object"><span class="std std-ref">Object</span></a> interface.</p>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.Amplitude.detachFrom">
<code class="sig-name descname">detachFrom</code><span class="sig-paren">(</span><em class="sig-param">parent</em><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.Amplitude.detachFrom" title="Permalink to this definition"></a></dt>
<dd><p>This method implements the <a class="reference internal" href="#api-python-datamodel-object"><span class="std std-ref">Object</span></a> interface.</p>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.Amplitude.detach">
<code class="sig-name descname">detach</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.Amplitude.detach" title="Permalink to this definition"></a></dt>
<dd><p>This method implements the <a class="reference internal" href="#api-python-datamodel-object"><span class="std std-ref">Object</span></a> interface.</p>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.Amplitude.clone">
<code class="sig-name descname">clone</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.Amplitude.clone" title="Permalink to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Return type</dt>
<dd class="field-odd"><p>A cloned Amplitude.</p>
</dd>
</dl>
<p>Returns a new instance that is a clone of the current instance. Child
objects are being ignored.</p>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.Amplitude.updateChild">
<code class="sig-name descname">updateChild</code><span class="sig-paren">(</span><em class="sig-param">ref</em><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.Amplitude.updateChild" title="Permalink to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>ref</strong> A child object derived from class Object.</p>
</dd>
<dt class="field-even">Return type</dt>
<dd class="field-even"><p>A Boolean flag indicating success with True, False otherwise</p>
</dd>
</dl>
<p>This method takes the passed reference object and searches for a child
with the same publicID (if derived from <a class="reference internal" href="#api-python-datamodel-publicobject"><span class="std std-ref">PublicObject</span></a>)
or the same index (if derived from <a class="reference internal" href="#api-python-datamodel-object"><span class="std std-ref">Object</span></a>).
The the child was found the reference objects attributes are copied to
the child object. Children of child are being ignored during this operation.
This method implements the <a class="reference internal" href="#api-python-datamodel-publicobject"><span class="std std-ref">PublicObject</span></a> interface.</p>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.Amplitude.accept">
<code class="sig-name descname">accept</code><span class="sig-paren">(</span><em class="sig-param">visitor</em><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.Amplitude.accept" title="Permalink to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>visitor</strong> A visitor.</p>
</dd>
</dl>
<p>This method implements the <a class="reference internal" href="#api-python-datamodel-publicobject"><span class="std std-ref">PublicObject</span></a> interface.</p>
</dd></dl>
</dd></dl>
</div>
<div class="section" id="amplitudereference">
<span id="api-python-datamodel-amplitudereference"></span><h3>AmplitudeReference<a class="headerlink" href="#amplitudereference" title="Permalink to this headline"></a></h3>
<dl class="class">
<dt id="seiscomp.datamodel.AmplitudeReference">
<em class="property">class </em><code class="sig-prename descclassname">seiscomp.datamodel.</code><code class="sig-name descname">AmplitudeReference</code><a class="headerlink" href="#seiscomp.datamodel.AmplitudeReference" title="Permalink to this definition"></a></dt>
<dd><p>Inherits <a class="reference internal" href="#api-python-datamodel-object"><span class="std std-ref">Object</span></a>.</p>
<p><strong>Parents</strong>:</p>
<ul class="simple">
<li><p><code class="docutils literal notranslate"><span class="pre">reading</span></code> <a class="reference internal" href="#api-python-datamodel-reading"><span class="std std-ref">Reading</span></a></p></li>
</ul>
<p><strong>Attributes</strong>:</p>
<ul class="simple">
<li><p><code class="docutils literal notranslate"><span class="pre">amplitudeID</span></code> string</p></li>
</ul>
<p><strong>Methods</strong>:</p>
<dl class="method">
<dt id="seiscomp.datamodel.AmplitudeReference.Cast">
<em class="property">static </em><code class="sig-name descname">Cast</code><span class="sig-paren">(</span><em class="sig-param">obj</em><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.AmplitudeReference.Cast" title="Permalink to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>obj</strong> The object to be casted.</p>
</dd>
<dt class="field-even">Return type</dt>
<dd class="field-even"><p>An object of type AmplitudeReference if the cast was successful,
None otherwise.</p>
</dd>
</dl>
<p>Cast an arbitrary object to AmplitudeReference if the internal wrapped
representation is an AmplitudeReference object. The cast is important if
instances of type <a class="reference internal" href="#api-python-datamodel-object"><span class="std std-ref">Object</span></a>
are passed to methods which need access to the real type.</p>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.AmplitudeReference.equal">
<code class="sig-name descname">equal</code><span class="sig-paren">(</span><em class="sig-param">other</em><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.AmplitudeReference.equal" title="Permalink to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>other</strong> Another object of type AmplitudeReference to compare this
instance to</p>
</dd>
<dt class="field-even">Return type</dt>
<dd class="field-even"><p>A Boolean value indicating True if both objects are equal or
False otherwise.</p>
</dd>
</dl>
<p>Compares two objects without its child objects. Both objects are compared
by value.</p>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.AmplitudeReference.index">
<code class="sig-name descname">index</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.AmplitudeReference.index" title="Permalink to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Return type</dt>
<dd class="field-odd"><p><p>The objects index of type AmplitudeReferenceIndex.</p>
<p>Returns the objects index which is also used for the database as unique
constraint.</p>
</p>
</dd>
</dl>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.AmplitudeReference.equalIndex">
<code class="sig-name descname">equalIndex</code><span class="sig-paren">(</span><em class="sig-param">lhs</em><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.AmplitudeReference.equalIndex" title="Permalink to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>lhs</strong> <a class="reference internal" href="#api-python-datamodel-amplitudereference"><span class="std std-ref">AmplitudeReference</span></a></p>
</dd>
<dt class="field-even">Return type</dt>
<dd class="field-even"><p>A Boolean value indicating True if both indexes are equal or
False otherwise.</p>
</dd>
</dl>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.AmplitudeReference.setAmplitudeID">
<code class="sig-name descname">setAmplitudeID</code><span class="sig-paren">(</span><em class="sig-param">amplitudeID</em><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.AmplitudeReference.setAmplitudeID" title="Permalink to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>amplitudeID</strong> string</p>
</dd>
</dl>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.AmplitudeReference.amplitudeID">
<code class="sig-name descname">amplitudeID</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.AmplitudeReference.amplitudeID" title="Permalink to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Return type</dt>
<dd class="field-odd"><p>string</p>
</dd>
</dl>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.AmplitudeReference.reading">
<code class="sig-name descname">reading</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.AmplitudeReference.reading" title="Permalink to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Return type</dt>
<dd class="field-odd"><p><a class="reference internal" href="#seiscomp.datamodel.Reading" title="seiscomp.datamodel.Reading">Reading</a></p>
</dd>
</dl>
<p>Returns the parent Reading if available. Returns None
if the parent is not a Reading. This is a convenience wrapper
for parent().</p>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.AmplitudeReference.assign">
<code class="sig-name descname">assign</code><span class="sig-paren">(</span><em class="sig-param">other</em><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.AmplitudeReference.assign" title="Permalink to this definition"></a></dt>
<dd><p>This method implements the <a class="reference internal" href="#api-python-datamodel-object"><span class="std std-ref">Object</span></a> interface.</p>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.AmplitudeReference.attachTo">
<code class="sig-name descname">attachTo</code><span class="sig-paren">(</span><em class="sig-param">parent</em><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.AmplitudeReference.attachTo" title="Permalink to this definition"></a></dt>
<dd><p>This method implements the <a class="reference internal" href="#api-python-datamodel-object"><span class="std std-ref">Object</span></a> interface.</p>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.AmplitudeReference.detachFrom">
<code class="sig-name descname">detachFrom</code><span class="sig-paren">(</span><em class="sig-param">parent</em><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.AmplitudeReference.detachFrom" title="Permalink to this definition"></a></dt>
<dd><p>This method implements the <a class="reference internal" href="#api-python-datamodel-object"><span class="std std-ref">Object</span></a> interface.</p>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.AmplitudeReference.detach">
<code class="sig-name descname">detach</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.AmplitudeReference.detach" title="Permalink to this definition"></a></dt>
<dd><p>This method implements the <a class="reference internal" href="#api-python-datamodel-object"><span class="std std-ref">Object</span></a> interface.</p>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.AmplitudeReference.clone">
<code class="sig-name descname">clone</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.AmplitudeReference.clone" title="Permalink to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Return type</dt>
<dd class="field-odd"><p>A cloned AmplitudeReference.</p>
</dd>
</dl>
<p>Returns a new instance that is a clone of the current instance. Child
objects are being ignored.</p>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.AmplitudeReference.accept">
<code class="sig-name descname">accept</code><span class="sig-paren">(</span><em class="sig-param">visitor</em><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.AmplitudeReference.accept" title="Permalink to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>visitor</strong> A visitor.</p>
</dd>
</dl>
<p>This method implements the <a class="reference internal" href="#api-python-datamodel-publicobject"><span class="std std-ref">PublicObject</span></a> interface.</p>
</dd></dl>
</dd></dl>
</div>
<div class="section" id="api-python-datamodel-arclinklog">
<span id="id11"></span><h3>ArclinkLog<a class="headerlink" href="#api-python-datamodel-arclinklog" title="Permalink to this headline"></a></h3>
<dl class="class">
<dt id="seiscomp.datamodel.ArclinkLog">
<em class="property">class </em><code class="sig-prename descclassname">seiscomp.datamodel.</code><code class="sig-name descname">ArclinkLog</code><a class="headerlink" href="#seiscomp.datamodel.ArclinkLog" title="Permalink to this definition"></a></dt>
<dd><p>Inherits <a class="reference internal" href="#api-python-datamodel-publicobject"><span class="std std-ref">PublicObject</span></a>.</p>
<p><strong>Children</strong>:</p>
<ul class="simple">
<li><p><code class="docutils literal notranslate"><span class="pre">arclinkRequest</span></code> <a class="reference internal" href="#api-python-datamodel-arclinkrequest"><span class="std std-ref">ArclinkRequest</span></a></p></li>
<li><p><code class="docutils literal notranslate"><span class="pre">arclinkUser</span></code> <a class="reference internal" href="#api-python-datamodel-arclinkuser"><span class="std std-ref">ArclinkUser</span></a></p></li>
</ul>
<p><strong>Attributes</strong>:</p>
<ul class="simple">
<li><p><code class="docutils literal notranslate"><span class="pre">publicID</span></code>: string</p></li>
</ul>
<p><strong>Methods</strong>:</p>
<dl class="method">
<dt id="seiscomp.datamodel.ArclinkLog.Cast">
<em class="property">static </em><code class="sig-name descname">Cast</code><span class="sig-paren">(</span><em class="sig-param">obj</em><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.ArclinkLog.Cast" title="Permalink to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>obj</strong> The object to be casted.</p>
</dd>
<dt class="field-even">Return type</dt>
<dd class="field-even"><p>An object of type ArclinkLog if the cast was successful,
None otherwise.</p>
</dd>
</dl>
<p>Cast an arbitrary object to ArclinkLog if the internal wrapped
representation is an ArclinkLog object. The cast is important if
instances of type <a class="reference internal" href="#api-python-datamodel-object"><span class="std std-ref">Object</span></a>
are passed to methods which need access to the real type.</p>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.ArclinkLog.equal">
<code class="sig-name descname">equal</code><span class="sig-paren">(</span><em class="sig-param">other</em><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.ArclinkLog.equal" title="Permalink to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>other</strong> Another object of type ArclinkLog to compare this
instance to</p>
</dd>
<dt class="field-even">Return type</dt>
<dd class="field-even"><p>A Boolean value indicating True if both objects are equal or
False otherwise.</p>
</dd>
</dl>
<p>Compares two objects without its child objects. Both objects are compared
by value.</p>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.ArclinkLog.add">
<code class="sig-name descname">add</code><span class="sig-paren">(</span><em class="sig-param">arclinkRequest</em><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.ArclinkLog.add" title="Permalink to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>arclinkRequest</strong> Object of type <a class="reference internal" href="#api-python-datamodel-arclinkrequest"><span class="std std-ref">ArclinkRequest</span></a></p>
</dd>
<dt class="field-even">Return type</dt>
<dd class="field-even"><p>A Boolean value indicating success with True, False otherwise.</p>
</dd>
</dl>
<p>Adds a ArclinkRequest object to ArclinkLog. The object is not
copied but managed by this instance. Any change to the passed object
will also change the child.</p>
</dd></dl>
<dl class="method">
<dt>
<code class="sig-name descname">add</code><span class="sig-paren">(</span><em class="sig-param">arclinkUser</em><span class="sig-paren">)</span></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>arclinkUser</strong> Object of type <a class="reference internal" href="#api-python-datamodel-arclinkuser"><span class="std std-ref">ArclinkUser</span></a></p>
</dd>
<dt class="field-even">Return type</dt>
<dd class="field-even"><p>A Boolean value indicating success with True, False otherwise.</p>
</dd>
</dl>
<p>Adds a ArclinkUser object to ArclinkLog. The object is not
copied but managed by this instance. Any change to the passed object
will also change the child.</p>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.ArclinkLog.remove">
<code class="sig-name descname">remove</code><span class="sig-paren">(</span><em class="sig-param">arclinkRequest</em><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.ArclinkLog.remove" title="Permalink to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>arclinkRequest</strong> Object of type <a class="reference internal" href="#api-python-datamodel-arclinkrequest"><span class="std std-ref">ArclinkRequest</span></a></p>
</dd>
<dt class="field-even">Return type</dt>
<dd class="field-even"><p>A Boolean value indicating success with True, False otherwise.</p>
</dd>
</dl>
<p>Removes a previously added ArclinkRequest object from ArclinkLog.</p>
</dd></dl>
<dl class="method">
<dt>
<code class="sig-name descname">remove</code><span class="sig-paren">(</span><em class="sig-param">arclinkUser</em><span class="sig-paren">)</span></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>arclinkUser</strong> Object of type <a class="reference internal" href="#api-python-datamodel-arclinkuser"><span class="std std-ref">ArclinkUser</span></a></p>
</dd>
<dt class="field-even">Return type</dt>
<dd class="field-even"><p>A Boolean value indicating success with True, False otherwise.</p>
</dd>
</dl>
<p>Removes a previously added ArclinkUser object from ArclinkLog.</p>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.ArclinkLog.removeArclinkRequest">
<code class="sig-name descname">removeArclinkRequest</code><span class="sig-paren">(</span><em class="sig-param">idx</em><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.ArclinkLog.removeArclinkRequest" title="Permalink to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>idx</strong> An integer index of the object to be removed.</p>
</dd>
<dt class="field-even">Return type</dt>
<dd class="field-even"><p>A Boolean value indicating success with True, False otherwise.</p>
</dd>
</dl>
</dd></dl>
<dl class="method">
<dt>
<code class="sig-name descname">removeArclinkRequest(arclinkRequestIndex);</code></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>arclinkRequestIndex</strong> The index of the object to be removed of type ArclinkRequestIndex.</p>
</dd>
<dt class="field-even">Return type</dt>
<dd class="field-even"><p>A Boolean value indicating success with True, False otherwise.</p>
</dd>
</dl>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.ArclinkLog.removeArclinkUser">
<code class="sig-name descname">removeArclinkUser</code><span class="sig-paren">(</span><em class="sig-param">idx</em><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.ArclinkLog.removeArclinkUser" title="Permalink to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>idx</strong> An integer index of the object to be removed.</p>
</dd>
<dt class="field-even">Return type</dt>
<dd class="field-even"><p>A Boolean value indicating success with True, False otherwise.</p>
</dd>
</dl>
</dd></dl>
<dl class="method">
<dt>
<code class="sig-name descname">removeArclinkUser(arclinkUserIndex);</code></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>arclinkUserIndex</strong> The index of the object to be removed of type ArclinkUserIndex.</p>
</dd>
<dt class="field-even">Return type</dt>
<dd class="field-even"><p>A Boolean value indicating success with True, False otherwise.</p>
</dd>
</dl>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.ArclinkLog.arclinkRequestCount">
<code class="sig-name descname">arclinkRequestCount</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.ArclinkLog.arclinkRequestCount" title="Permalink to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Return type</dt>
<dd class="field-odd"><p>integer value indicating the number of child objects.</p>
</dd>
</dl>
<p>Returns the number of ArclinkRequest child objects.</p>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.ArclinkLog.arclinkUserCount">
<code class="sig-name descname">arclinkUserCount</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.ArclinkLog.arclinkUserCount" title="Permalink to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Return type</dt>
<dd class="field-odd"><p>integer value indicating the number of child objects.</p>
</dd>
</dl>
<p>Returns the number of ArclinkUser child objects.</p>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.ArclinkLog.arclinkRequest">
<code class="sig-name descname">arclinkRequest</code><span class="sig-paren">(</span><em class="sig-param">idx</em><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.ArclinkLog.arclinkRequest" title="Permalink to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>idx</strong> An integer index of the object to be returned.</p>
</dd>
<dt class="field-even">Return type</dt>
<dd class="field-even"><p>Object of type <a class="reference internal" href="#api-python-datamodel-arclinkrequest"><span class="std std-ref">ArclinkRequest</span></a>.</p>
</dd>
</dl>
<p>Returns the ArclinkRequest at index idx.</p>
</dd></dl>
<dl class="method">
<dt>
<code class="sig-name descname">arclinkRequest</code><span class="sig-paren">(</span><em class="sig-param">arclinkRequestIndex</em><span class="sig-paren">)</span></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>arclinkRequestIndex</strong> The index of the object to be removed of type ArclinkRequestIndex.</p>
</dd>
<dt class="field-even">Return type</dt>
<dd class="field-even"><p>Object of type <a class="reference internal" href="#api-python-datamodel-arclinkrequest"><span class="std std-ref">ArclinkRequest</span></a>.</p>
</dd>
</dl>
<p>Returns the ArclinkRequest at given index. The indexes of all child objects
are compared by value which makes this function slower than the direct
integer index look-up.</p>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.ArclinkLog.arclinkUser">
<code class="sig-name descname">arclinkUser</code><span class="sig-paren">(</span><em class="sig-param">idx</em><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.ArclinkLog.arclinkUser" title="Permalink to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>idx</strong> An integer index of the object to be returned.</p>
</dd>
<dt class="field-even">Return type</dt>
<dd class="field-even"><p>Object of type <a class="reference internal" href="#api-python-datamodel-arclinkuser"><span class="std std-ref">ArclinkUser</span></a>.</p>
</dd>
</dl>
<p>Returns the ArclinkUser at index idx.</p>
</dd></dl>
<dl class="method">
<dt>
<code class="sig-name descname">arclinkUser</code><span class="sig-paren">(</span><em class="sig-param">arclinkUserIndex</em><span class="sig-paren">)</span></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>arclinkUserIndex</strong> The index of the object to be removed of type ArclinkUserIndex.</p>
</dd>
<dt class="field-even">Return type</dt>
<dd class="field-even"><p>Object of type <a class="reference internal" href="#api-python-datamodel-arclinkuser"><span class="std std-ref">ArclinkUser</span></a>.</p>
</dd>
</dl>
<p>Returns the ArclinkUser at given index. The indexes of all child objects
are compared by value which makes this function slower than the direct
integer index look-up.</p>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.ArclinkLog.findArclinkRequest">
<code class="sig-name descname">findArclinkRequest</code><span class="sig-paren">(</span><em class="sig-param">publicID</em><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.ArclinkLog.findArclinkRequest" title="Permalink to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>publicID</strong> The publicID of the object to find.</p>
</dd>
<dt class="field-even">Return type</dt>
<dd class="field-even"><p>Object of type <a class="reference internal" href="#api-python-datamodel-arclinkrequest"><span class="std std-ref">ArclinkRequest</span></a>.</p>
</dd>
</dl>
<p>Returns the child object with a certain publicID, None otherwise.</p>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.ArclinkLog.findArclinkUser">
<code class="sig-name descname">findArclinkUser</code><span class="sig-paren">(</span><em class="sig-param">publicID</em><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.ArclinkLog.findArclinkUser" title="Permalink to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>publicID</strong> The publicID of the object to find.</p>
</dd>
<dt class="field-even">Return type</dt>
<dd class="field-even"><p>Object of type <a class="reference internal" href="#api-python-datamodel-arclinkuser"><span class="std std-ref">ArclinkUser</span></a>.</p>
</dd>
</dl>
<p>Returns the child object with a certain publicID, None otherwise.</p>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.ArclinkLog.assign">
<code class="sig-name descname">assign</code><span class="sig-paren">(</span><em class="sig-param">other</em><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.ArclinkLog.assign" title="Permalink to this definition"></a></dt>
<dd><p>This method implements the <a class="reference internal" href="#api-python-datamodel-object"><span class="std std-ref">Object</span></a> interface.</p>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.ArclinkLog.attachTo">
<code class="sig-name descname">attachTo</code><span class="sig-paren">(</span><em class="sig-param">parent</em><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.ArclinkLog.attachTo" title="Permalink to this definition"></a></dt>
<dd><p>This method implements the <a class="reference internal" href="#api-python-datamodel-object"><span class="std std-ref">Object</span></a> interface.</p>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.ArclinkLog.detachFrom">
<code class="sig-name descname">detachFrom</code><span class="sig-paren">(</span><em class="sig-param">parent</em><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.ArclinkLog.detachFrom" title="Permalink to this definition"></a></dt>
<dd><p>This method implements the <a class="reference internal" href="#api-python-datamodel-object"><span class="std std-ref">Object</span></a> interface.</p>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.ArclinkLog.detach">
<code class="sig-name descname">detach</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.ArclinkLog.detach" title="Permalink to this definition"></a></dt>
<dd><p>This method implements the <a class="reference internal" href="#api-python-datamodel-object"><span class="std std-ref">Object</span></a> interface.</p>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.ArclinkLog.clone">
<code class="sig-name descname">clone</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.ArclinkLog.clone" title="Permalink to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Return type</dt>
<dd class="field-odd"><p>A cloned ArclinkLog.</p>
</dd>
</dl>
<p>Returns a new instance that is a clone of the current instance. Child
objects are being ignored.</p>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.ArclinkLog.updateChild">
<code class="sig-name descname">updateChild</code><span class="sig-paren">(</span><em class="sig-param">ref</em><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.ArclinkLog.updateChild" title="Permalink to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>ref</strong> A child object derived from class Object.</p>
</dd>
<dt class="field-even">Return type</dt>
<dd class="field-even"><p>A Boolean flag indicating success with True, False otherwise</p>
</dd>
</dl>
<p>This method takes the passed reference object and searches for a child
with the same publicID (if derived from <a class="reference internal" href="#api-python-datamodel-publicobject"><span class="std std-ref">PublicObject</span></a>)
or the same index (if derived from <a class="reference internal" href="#api-python-datamodel-object"><span class="std std-ref">Object</span></a>).
The the child was found the reference objects attributes are copied to
the child object. Children of child are being ignored during this operation.
This method implements the <a class="reference internal" href="#api-python-datamodel-publicobject"><span class="std std-ref">PublicObject</span></a> interface.</p>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.ArclinkLog.accept">
<code class="sig-name descname">accept</code><span class="sig-paren">(</span><em class="sig-param">visitor</em><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.ArclinkLog.accept" title="Permalink to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>visitor</strong> A visitor.</p>
</dd>
</dl>
<p>This method implements the <a class="reference internal" href="#api-python-datamodel-publicobject"><span class="std std-ref">PublicObject</span></a> interface.</p>
</dd></dl>
</dd></dl>
</div>
<div class="section" id="arclinkrequest">
<span id="api-python-datamodel-arclinkrequest"></span><h3>ArclinkRequest<a class="headerlink" href="#arclinkrequest" title="Permalink to this headline"></a></h3>
<dl class="class">
<dt id="seiscomp.datamodel.ArclinkRequest">
<em class="property">class </em><code class="sig-prename descclassname">seiscomp.datamodel.</code><code class="sig-name descname">ArclinkRequest</code><a class="headerlink" href="#seiscomp.datamodel.ArclinkRequest" title="Permalink to this definition"></a></dt>
<dd><p>Inherits <a class="reference internal" href="#api-python-datamodel-publicobject"><span class="std std-ref">PublicObject</span></a>.</p>
<p><strong>Parents</strong>:</p>
<ul class="simple">
<li><p><code class="docutils literal notranslate"><span class="pre">arclinkLog</span></code> <a class="reference internal" href="#api-python-datamodel-arclinklog"><span class="std std-ref">ArclinkLog</span></a></p></li>
</ul>
<p><strong>Children</strong>:</p>
<ul class="simple">
<li><p><code class="docutils literal notranslate"><span class="pre">arclinkStatusLine</span></code> <a class="reference internal" href="#api-python-datamodel-arclinkstatusline"><span class="std std-ref">ArclinkStatusLine</span></a></p></li>
<li><p><code class="docutils literal notranslate"><span class="pre">arclinkRequestLine</span></code> <a class="reference internal" href="#api-python-datamodel-arclinkrequestline"><span class="std std-ref">ArclinkRequestLine</span></a></p></li>
</ul>
<p><strong>Attributes</strong>:</p>
<ul class="simple">
<li><p><code class="docutils literal notranslate"><span class="pre">publicID</span></code>: string</p></li>
<li><p><code class="docutils literal notranslate"><span class="pre">requestID</span></code> string</p></li>
<li><p><code class="docutils literal notranslate"><span class="pre">userID</span></code> string</p></li>
<li><p><code class="docutils literal notranslate"><span class="pre">userIP</span></code> string</p></li>
<li><p><code class="docutils literal notranslate"><span class="pre">clientID</span></code> string</p></li>
<li><p><code class="docutils literal notranslate"><span class="pre">clientIP</span></code> string</p></li>
<li><p><code class="docutils literal notranslate"><span class="pre">type</span></code> string</p></li>
<li><p><code class="docutils literal notranslate"><span class="pre">created</span></code> seiscomp.core.Time</p></li>
<li><p><code class="docutils literal notranslate"><span class="pre">status</span></code> string</p></li>
<li><p><code class="docutils literal notranslate"><span class="pre">message</span></code> string</p></li>
<li><p><code class="docutils literal notranslate"><span class="pre">label</span></code> string</p></li>
<li><p><code class="docutils literal notranslate"><span class="pre">header</span></code> string</p></li>
<li><p><code class="docutils literal notranslate"><span class="pre">summary</span></code> <a class="reference internal" href="#api-python-datamodel-arclinkrequestsummary"><span class="std std-ref">ArclinkRequestSummary</span></a> (optional)</p></li>
</ul>
<p><strong>Methods</strong>:</p>
<dl class="method">
<dt id="seiscomp.datamodel.ArclinkRequest.Cast">
<em class="property">static </em><code class="sig-name descname">Cast</code><span class="sig-paren">(</span><em class="sig-param">obj</em><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.ArclinkRequest.Cast" title="Permalink to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>obj</strong> The object to be casted.</p>
</dd>
<dt class="field-even">Return type</dt>
<dd class="field-even"><p>An object of type ArclinkRequest if the cast was successful,
None otherwise.</p>
</dd>
</dl>
<p>Cast an arbitrary object to ArclinkRequest if the internal wrapped
representation is an ArclinkRequest object. The cast is important if
instances of type <a class="reference internal" href="#api-python-datamodel-object"><span class="std std-ref">Object</span></a>
are passed to methods which need access to the real type.</p>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.ArclinkRequest.Create">
<em class="property">static </em><code class="sig-name descname">Create</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.ArclinkRequest.Create" title="Permalink to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Return type</dt>
<dd class="field-odd"><p>A new object of type ArclinkRequest.</p>
</dd>
</dl>
<p>Creates and registers (if enabled) a ArclinkRequest instance. The
publicID is auto-generated.</p>
</dd></dl>
<dl class="method">
<dt>
<em class="property">static </em><code class="sig-name descname">Create</code><span class="sig-paren">(</span><em class="sig-param">publicID</em><span class="sig-paren">)</span></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Return type</dt>
<dd class="field-odd"><p>A new object of type ArclinkRequest.</p>
</dd>
</dl>
<p>Creates and registers (if enabled) a ArclinkRequest instance with
passed publicID.</p>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.ArclinkRequest.equal">
<code class="sig-name descname">equal</code><span class="sig-paren">(</span><em class="sig-param">other</em><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.ArclinkRequest.equal" title="Permalink to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>other</strong> Another object of type ArclinkRequest to compare this
instance to</p>
</dd>
<dt class="field-even">Return type</dt>
<dd class="field-even"><p>A Boolean value indicating True if both objects are equal or
False otherwise.</p>
</dd>
</dl>
<p>Compares two objects without its child objects. Both objects are compared
by value.</p>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.ArclinkRequest.index">
<code class="sig-name descname">index</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.ArclinkRequest.index" title="Permalink to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Return type</dt>
<dd class="field-odd"><p><p>The objects index of type ArclinkRequestIndex.</p>
<p>Returns the objects index which is also used for the database as unique
constraint.</p>
</p>
</dd>
</dl>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.ArclinkRequest.equalIndex">
<code class="sig-name descname">equalIndex</code><span class="sig-paren">(</span><em class="sig-param">lhs</em><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.ArclinkRequest.equalIndex" title="Permalink to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>lhs</strong> <a class="reference internal" href="#api-python-datamodel-arclinkrequest"><span class="std std-ref">ArclinkRequest</span></a></p>
</dd>
<dt class="field-even">Return type</dt>
<dd class="field-even"><p>A Boolean value indicating True if both indexes are equal or
False otherwise.</p>
</dd>
</dl>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.ArclinkRequest.setRequestID">
<code class="sig-name descname">setRequestID</code><span class="sig-paren">(</span><em class="sig-param">requestID</em><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.ArclinkRequest.setRequestID" title="Permalink to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>requestID</strong> string</p>
</dd>
</dl>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.ArclinkRequest.requestID">
<code class="sig-name descname">requestID</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.ArclinkRequest.requestID" title="Permalink to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Return type</dt>
<dd class="field-odd"><p>string</p>
</dd>
</dl>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.ArclinkRequest.setUserID">
<code class="sig-name descname">setUserID</code><span class="sig-paren">(</span><em class="sig-param">userID</em><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.ArclinkRequest.setUserID" title="Permalink to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>userID</strong> string</p>
</dd>
</dl>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.ArclinkRequest.userID">
<code class="sig-name descname">userID</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.ArclinkRequest.userID" title="Permalink to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Return type</dt>
<dd class="field-odd"><p>string</p>
</dd>
</dl>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.ArclinkRequest.setUserIP">
<code class="sig-name descname">setUserIP</code><span class="sig-paren">(</span><em class="sig-param">userIP</em><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.ArclinkRequest.setUserIP" title="Permalink to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>userIP</strong> string</p>
</dd>
</dl>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.ArclinkRequest.userIP">
<code class="sig-name descname">userIP</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.ArclinkRequest.userIP" title="Permalink to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Return type</dt>
<dd class="field-odd"><p>string</p>
</dd>
</dl>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.ArclinkRequest.setClientID">
<code class="sig-name descname">setClientID</code><span class="sig-paren">(</span><em class="sig-param">clientID</em><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.ArclinkRequest.setClientID" title="Permalink to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>clientID</strong> string</p>
</dd>
</dl>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.ArclinkRequest.clientID">
<code class="sig-name descname">clientID</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.ArclinkRequest.clientID" title="Permalink to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Return type</dt>
<dd class="field-odd"><p>string</p>
</dd>
</dl>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.ArclinkRequest.setClientIP">
<code class="sig-name descname">setClientIP</code><span class="sig-paren">(</span><em class="sig-param">clientIP</em><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.ArclinkRequest.setClientIP" title="Permalink to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>clientIP</strong> string</p>
</dd>
</dl>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.ArclinkRequest.clientIP">
<code class="sig-name descname">clientIP</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.ArclinkRequest.clientIP" title="Permalink to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Return type</dt>
<dd class="field-odd"><p>string</p>
</dd>
</dl>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.ArclinkRequest.setType">
<code class="sig-name descname">setType</code><span class="sig-paren">(</span><em class="sig-param">type</em><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.ArclinkRequest.setType" title="Permalink to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>type</strong> string</p>
</dd>
</dl>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.ArclinkRequest.type">
<code class="sig-name descname">type</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.ArclinkRequest.type" title="Permalink to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Return type</dt>
<dd class="field-odd"><p>string</p>
</dd>
</dl>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.ArclinkRequest.setCreated">
<code class="sig-name descname">setCreated</code><span class="sig-paren">(</span><em class="sig-param">created</em><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.ArclinkRequest.setCreated" title="Permalink to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>created</strong> seiscomp.core.Time</p>
</dd>
</dl>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.ArclinkRequest.created">
<code class="sig-name descname">created</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.ArclinkRequest.created" title="Permalink to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Return type</dt>
<dd class="field-odd"><p>seiscomp.core.Time</p>
</dd>
</dl>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.ArclinkRequest.setStatus">
<code class="sig-name descname">setStatus</code><span class="sig-paren">(</span><em class="sig-param">status</em><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.ArclinkRequest.setStatus" title="Permalink to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>status</strong> string</p>
</dd>
</dl>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.ArclinkRequest.status">
<code class="sig-name descname">status</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.ArclinkRequest.status" title="Permalink to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Return type</dt>
<dd class="field-odd"><p>string</p>
</dd>
</dl>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.ArclinkRequest.setMessage">
<code class="sig-name descname">setMessage</code><span class="sig-paren">(</span><em class="sig-param">message</em><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.ArclinkRequest.setMessage" title="Permalink to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>message</strong> string</p>
</dd>
</dl>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.ArclinkRequest.message">
<code class="sig-name descname">message</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.ArclinkRequest.message" title="Permalink to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Return type</dt>
<dd class="field-odd"><p>string</p>
</dd>
</dl>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.ArclinkRequest.setLabel">
<code class="sig-name descname">setLabel</code><span class="sig-paren">(</span><em class="sig-param">label</em><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.ArclinkRequest.setLabel" title="Permalink to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>label</strong> string</p>
</dd>
</dl>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.ArclinkRequest.label">
<code class="sig-name descname">label</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.ArclinkRequest.label" title="Permalink to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Return type</dt>
<dd class="field-odd"><p>string</p>
</dd>
</dl>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.ArclinkRequest.setHeader">
<code class="sig-name descname">setHeader</code><span class="sig-paren">(</span><em class="sig-param">header</em><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.ArclinkRequest.setHeader" title="Permalink to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>header</strong> string</p>
</dd>
</dl>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.ArclinkRequest.header">
<code class="sig-name descname">header</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.ArclinkRequest.header" title="Permalink to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Return type</dt>
<dd class="field-odd"><p>string</p>
</dd>
</dl>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.ArclinkRequest.setSummary">
<code class="sig-name descname">setSummary</code><span class="sig-paren">(</span><em class="sig-param">summary</em><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.ArclinkRequest.setSummary" title="Permalink to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>summary</strong> <a class="reference internal" href="#api-python-datamodel-arclinkrequestsummary"><span class="std std-ref">ArclinkRequestSummary</span></a></p>
</dd>
</dl>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.ArclinkRequest.summary">
<code class="sig-name descname">summary</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.ArclinkRequest.summary" title="Permalink to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Return type</dt>
<dd class="field-odd"><p><a class="reference internal" href="#api-python-datamodel-arclinkrequestsummary"><span class="std std-ref">ArclinkRequestSummary</span></a></p>
</dd>
</dl>
<div class="admonition note">
<p class="admonition-title">Note</p>
<p>As this attribute is optional, this method throws a ValueError if
the value of the attribute is not set.</p>
</div>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.ArclinkRequest.add">
<code class="sig-name descname">add</code><span class="sig-paren">(</span><em class="sig-param">arclinkStatusLine</em><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.ArclinkRequest.add" title="Permalink to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>arclinkStatusLine</strong> Object of type <a class="reference internal" href="#api-python-datamodel-arclinkstatusline"><span class="std std-ref">ArclinkStatusLine</span></a></p>
</dd>
<dt class="field-even">Return type</dt>
<dd class="field-even"><p>A Boolean value indicating success with True, False otherwise.</p>
</dd>
</dl>
<p>Adds a ArclinkStatusLine object to ArclinkRequest. The object is not
copied but managed by this instance. Any change to the passed object
will also change the child.</p>
</dd></dl>
<dl class="method">
<dt>
<code class="sig-name descname">add</code><span class="sig-paren">(</span><em class="sig-param">arclinkRequestLine</em><span class="sig-paren">)</span></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>arclinkRequestLine</strong> Object of type <a class="reference internal" href="#api-python-datamodel-arclinkrequestline"><span class="std std-ref">ArclinkRequestLine</span></a></p>
</dd>
<dt class="field-even">Return type</dt>
<dd class="field-even"><p>A Boolean value indicating success with True, False otherwise.</p>
</dd>
</dl>
<p>Adds a ArclinkRequestLine object to ArclinkRequest. The object is not
copied but managed by this instance. Any change to the passed object
will also change the child.</p>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.ArclinkRequest.remove">
<code class="sig-name descname">remove</code><span class="sig-paren">(</span><em class="sig-param">arclinkStatusLine</em><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.ArclinkRequest.remove" title="Permalink to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>arclinkStatusLine</strong> Object of type <a class="reference internal" href="#api-python-datamodel-arclinkstatusline"><span class="std std-ref">ArclinkStatusLine</span></a></p>
</dd>
<dt class="field-even">Return type</dt>
<dd class="field-even"><p>A Boolean value indicating success with True, False otherwise.</p>
</dd>
</dl>
<p>Removes a previously added ArclinkStatusLine object from ArclinkRequest.</p>
</dd></dl>
<dl class="method">
<dt>
<code class="sig-name descname">remove</code><span class="sig-paren">(</span><em class="sig-param">arclinkRequestLine</em><span class="sig-paren">)</span></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>arclinkRequestLine</strong> Object of type <a class="reference internal" href="#api-python-datamodel-arclinkrequestline"><span class="std std-ref">ArclinkRequestLine</span></a></p>
</dd>
<dt class="field-even">Return type</dt>
<dd class="field-even"><p>A Boolean value indicating success with True, False otherwise.</p>
</dd>
</dl>
<p>Removes a previously added ArclinkRequestLine object from ArclinkRequest.</p>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.ArclinkRequest.removeArclinkStatusLine">
<code class="sig-name descname">removeArclinkStatusLine</code><span class="sig-paren">(</span><em class="sig-param">idx</em><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.ArclinkRequest.removeArclinkStatusLine" title="Permalink to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>idx</strong> An integer index of the object to be removed.</p>
</dd>
<dt class="field-even">Return type</dt>
<dd class="field-even"><p>A Boolean value indicating success with True, False otherwise.</p>
</dd>
</dl>
</dd></dl>
<dl class="method">
<dt>
<code class="sig-name descname">removeArclinkStatusLine(arclinkStatusLineIndex);</code></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>arclinkStatusLineIndex</strong> The index of the object to be removed of type ArclinkStatusLineIndex.</p>
</dd>
<dt class="field-even">Return type</dt>
<dd class="field-even"><p>A Boolean value indicating success with True, False otherwise.</p>
</dd>
</dl>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.ArclinkRequest.removeArclinkRequestLine">
<code class="sig-name descname">removeArclinkRequestLine</code><span class="sig-paren">(</span><em class="sig-param">idx</em><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.ArclinkRequest.removeArclinkRequestLine" title="Permalink to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>idx</strong> An integer index of the object to be removed.</p>
</dd>
<dt class="field-even">Return type</dt>
<dd class="field-even"><p>A Boolean value indicating success with True, False otherwise.</p>
</dd>
</dl>
</dd></dl>
<dl class="method">
<dt>
<code class="sig-name descname">removeArclinkRequestLine(arclinkRequestLineIndex);</code></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>arclinkRequestLineIndex</strong> The index of the object to be removed of type ArclinkRequestLineIndex.</p>
</dd>
<dt class="field-even">Return type</dt>
<dd class="field-even"><p>A Boolean value indicating success with True, False otherwise.</p>
</dd>
</dl>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.ArclinkRequest.arclinkStatusLineCount">
<code class="sig-name descname">arclinkStatusLineCount</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.ArclinkRequest.arclinkStatusLineCount" title="Permalink to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Return type</dt>
<dd class="field-odd"><p>integer value indicating the number of child objects.</p>
</dd>
</dl>
<p>Returns the number of ArclinkStatusLine child objects.</p>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.ArclinkRequest.arclinkRequestLineCount">
<code class="sig-name descname">arclinkRequestLineCount</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.ArclinkRequest.arclinkRequestLineCount" title="Permalink to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Return type</dt>
<dd class="field-odd"><p>integer value indicating the number of child objects.</p>
</dd>
</dl>
<p>Returns the number of ArclinkRequestLine child objects.</p>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.ArclinkRequest.arclinkStatusLine">
<code class="sig-name descname">arclinkStatusLine</code><span class="sig-paren">(</span><em class="sig-param">idx</em><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.ArclinkRequest.arclinkStatusLine" title="Permalink to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>idx</strong> An integer index of the object to be returned.</p>
</dd>
<dt class="field-even">Return type</dt>
<dd class="field-even"><p>Object of type <a class="reference internal" href="#api-python-datamodel-arclinkstatusline"><span class="std std-ref">ArclinkStatusLine</span></a>.</p>
</dd>
</dl>
<p>Returns the ArclinkStatusLine at index idx.</p>
</dd></dl>
<dl class="method">
<dt>
<code class="sig-name descname">arclinkStatusLine</code><span class="sig-paren">(</span><em class="sig-param">arclinkStatusLineIndex</em><span class="sig-paren">)</span></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>arclinkStatusLineIndex</strong> The index of the object to be removed of type ArclinkStatusLineIndex.</p>
</dd>
<dt class="field-even">Return type</dt>
<dd class="field-even"><p>Object of type <a class="reference internal" href="#api-python-datamodel-arclinkstatusline"><span class="std std-ref">ArclinkStatusLine</span></a>.</p>
</dd>
</dl>
<p>Returns the ArclinkStatusLine at given index. The indexes of all child objects
are compared by value which makes this function slower than the direct
integer index look-up.</p>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.ArclinkRequest.arclinkRequestLine">
<code class="sig-name descname">arclinkRequestLine</code><span class="sig-paren">(</span><em class="sig-param">idx</em><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.ArclinkRequest.arclinkRequestLine" title="Permalink to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>idx</strong> An integer index of the object to be returned.</p>
</dd>
<dt class="field-even">Return type</dt>
<dd class="field-even"><p>Object of type <a class="reference internal" href="#api-python-datamodel-arclinkrequestline"><span class="std std-ref">ArclinkRequestLine</span></a>.</p>
</dd>
</dl>
<p>Returns the ArclinkRequestLine at index idx.</p>
</dd></dl>
<dl class="method">
<dt>
<code class="sig-name descname">arclinkRequestLine</code><span class="sig-paren">(</span><em class="sig-param">arclinkRequestLineIndex</em><span class="sig-paren">)</span></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>arclinkRequestLineIndex</strong> The index of the object to be removed of type ArclinkRequestLineIndex.</p>
</dd>
<dt class="field-even">Return type</dt>
<dd class="field-even"><p>Object of type <a class="reference internal" href="#api-python-datamodel-arclinkrequestline"><span class="std std-ref">ArclinkRequestLine</span></a>.</p>
</dd>
</dl>
<p>Returns the ArclinkRequestLine at given index. The indexes of all child objects
are compared by value which makes this function slower than the direct
integer index look-up.</p>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.ArclinkRequest.arclinkLog">
<code class="sig-name descname">arclinkLog</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.ArclinkRequest.arclinkLog" title="Permalink to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Return type</dt>
<dd class="field-odd"><p><a class="reference internal" href="#seiscomp.datamodel.ArclinkLog" title="seiscomp.datamodel.ArclinkLog">ArclinkLog</a></p>
</dd>
</dl>
<p>Returns the parent ArclinkLog if available. Returns None
if the parent is not a ArclinkLog. This is a convenience wrapper
for parent().</p>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.ArclinkRequest.assign">
<code class="sig-name descname">assign</code><span class="sig-paren">(</span><em class="sig-param">other</em><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.ArclinkRequest.assign" title="Permalink to this definition"></a></dt>
<dd><p>This method implements the <a class="reference internal" href="#api-python-datamodel-object"><span class="std std-ref">Object</span></a> interface.</p>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.ArclinkRequest.attachTo">
<code class="sig-name descname">attachTo</code><span class="sig-paren">(</span><em class="sig-param">parent</em><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.ArclinkRequest.attachTo" title="Permalink to this definition"></a></dt>
<dd><p>This method implements the <a class="reference internal" href="#api-python-datamodel-object"><span class="std std-ref">Object</span></a> interface.</p>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.ArclinkRequest.detachFrom">
<code class="sig-name descname">detachFrom</code><span class="sig-paren">(</span><em class="sig-param">parent</em><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.ArclinkRequest.detachFrom" title="Permalink to this definition"></a></dt>
<dd><p>This method implements the <a class="reference internal" href="#api-python-datamodel-object"><span class="std std-ref">Object</span></a> interface.</p>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.ArclinkRequest.detach">
<code class="sig-name descname">detach</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.ArclinkRequest.detach" title="Permalink to this definition"></a></dt>
<dd><p>This method implements the <a class="reference internal" href="#api-python-datamodel-object"><span class="std std-ref">Object</span></a> interface.</p>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.ArclinkRequest.clone">
<code class="sig-name descname">clone</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.ArclinkRequest.clone" title="Permalink to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Return type</dt>
<dd class="field-odd"><p>A cloned ArclinkRequest.</p>
</dd>
</dl>
<p>Returns a new instance that is a clone of the current instance. Child
objects are being ignored.</p>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.ArclinkRequest.updateChild">
<code class="sig-name descname">updateChild</code><span class="sig-paren">(</span><em class="sig-param">ref</em><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.ArclinkRequest.updateChild" title="Permalink to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>ref</strong> A child object derived from class Object.</p>
</dd>
<dt class="field-even">Return type</dt>
<dd class="field-even"><p>A Boolean flag indicating success with True, False otherwise</p>
</dd>
</dl>
<p>This method takes the passed reference object and searches for a child
with the same publicID (if derived from <a class="reference internal" href="#api-python-datamodel-publicobject"><span class="std std-ref">PublicObject</span></a>)
or the same index (if derived from <a class="reference internal" href="#api-python-datamodel-object"><span class="std std-ref">Object</span></a>).
The the child was found the reference objects attributes are copied to
the child object. Children of child are being ignored during this operation.
This method implements the <a class="reference internal" href="#api-python-datamodel-publicobject"><span class="std std-ref">PublicObject</span></a> interface.</p>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.ArclinkRequest.accept">
<code class="sig-name descname">accept</code><span class="sig-paren">(</span><em class="sig-param">visitor</em><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.ArclinkRequest.accept" title="Permalink to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>visitor</strong> A visitor.</p>
</dd>
</dl>
<p>This method implements the <a class="reference internal" href="#api-python-datamodel-publicobject"><span class="std std-ref">PublicObject</span></a> interface.</p>
</dd></dl>
</dd></dl>
</div>
<div class="section" id="arclinkrequestline">
<span id="api-python-datamodel-arclinkrequestline"></span><h3>ArclinkRequestLine<a class="headerlink" href="#arclinkrequestline" title="Permalink to this headline"></a></h3>
<dl class="class">
<dt id="seiscomp.datamodel.ArclinkRequestLine">
<em class="property">class </em><code class="sig-prename descclassname">seiscomp.datamodel.</code><code class="sig-name descname">ArclinkRequestLine</code><a class="headerlink" href="#seiscomp.datamodel.ArclinkRequestLine" title="Permalink to this definition"></a></dt>
<dd><p>Inherits <a class="reference internal" href="#api-python-datamodel-object"><span class="std std-ref">Object</span></a>.</p>
<p><strong>Parents</strong>:</p>
<ul class="simple">
<li><p><code class="docutils literal notranslate"><span class="pre">arclinkRequest</span></code> <a class="reference internal" href="#api-python-datamodel-arclinkrequest"><span class="std std-ref">ArclinkRequest</span></a></p></li>
</ul>
<p><strong>Attributes</strong>:</p>
<ul class="simple">
<li><p><code class="docutils literal notranslate"><span class="pre">start</span></code> seiscomp.core.Time</p></li>
<li><p><code class="docutils literal notranslate"><span class="pre">end</span></code> seiscomp.core.Time</p></li>
<li><p><code class="docutils literal notranslate"><span class="pre">streamID</span></code> <a class="reference internal" href="#api-python-datamodel-waveformstreamid"><span class="std std-ref">WaveformStreamID</span></a></p></li>
<li><p><code class="docutils literal notranslate"><span class="pre">restricted</span></code> boolean (optional)</p></li>
<li><p><code class="docutils literal notranslate"><span class="pre">shared</span></code> boolean (optional)</p></li>
<li><p><code class="docutils literal notranslate"><span class="pre">netClass</span></code> string</p></li>
<li><p><code class="docutils literal notranslate"><span class="pre">constraints</span></code> string</p></li>
<li><p><code class="docutils literal notranslate"><span class="pre">status</span></code> <a class="reference internal" href="#api-python-datamodel-arclinkstatusline"><span class="std std-ref">ArclinkStatusLine</span></a></p></li>
</ul>
<p><strong>Methods</strong>:</p>
<dl class="method">
<dt id="seiscomp.datamodel.ArclinkRequestLine.Cast">
<em class="property">static </em><code class="sig-name descname">Cast</code><span class="sig-paren">(</span><em class="sig-param">obj</em><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.ArclinkRequestLine.Cast" title="Permalink to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>obj</strong> The object to be casted.</p>
</dd>
<dt class="field-even">Return type</dt>
<dd class="field-even"><p>An object of type ArclinkRequestLine if the cast was successful,
None otherwise.</p>
</dd>
</dl>
<p>Cast an arbitrary object to ArclinkRequestLine if the internal wrapped
representation is an ArclinkRequestLine object. The cast is important if
instances of type <a class="reference internal" href="#api-python-datamodel-object"><span class="std std-ref">Object</span></a>
are passed to methods which need access to the real type.</p>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.ArclinkRequestLine.equal">
<code class="sig-name descname">equal</code><span class="sig-paren">(</span><em class="sig-param">other</em><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.ArclinkRequestLine.equal" title="Permalink to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>other</strong> Another object of type ArclinkRequestLine to compare this
instance to</p>
</dd>
<dt class="field-even">Return type</dt>
<dd class="field-even"><p>A Boolean value indicating True if both objects are equal or
False otherwise.</p>
</dd>
</dl>
<p>Compares two objects without its child objects. Both objects are compared
by value.</p>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.ArclinkRequestLine.index">
<code class="sig-name descname">index</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.ArclinkRequestLine.index" title="Permalink to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Return type</dt>
<dd class="field-odd"><p><p>The objects index of type ArclinkRequestLineIndex.</p>
<p>Returns the objects index which is also used for the database as unique
constraint.</p>
</p>
</dd>
</dl>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.ArclinkRequestLine.equalIndex">
<code class="sig-name descname">equalIndex</code><span class="sig-paren">(</span><em class="sig-param">lhs</em><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.ArclinkRequestLine.equalIndex" title="Permalink to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>lhs</strong> <a class="reference internal" href="#api-python-datamodel-arclinkrequestline"><span class="std std-ref">ArclinkRequestLine</span></a></p>
</dd>
<dt class="field-even">Return type</dt>
<dd class="field-even"><p>A Boolean value indicating True if both indexes are equal or
False otherwise.</p>
</dd>
</dl>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.ArclinkRequestLine.setStart">
<code class="sig-name descname">setStart</code><span class="sig-paren">(</span><em class="sig-param">start</em><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.ArclinkRequestLine.setStart" title="Permalink to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>start</strong> seiscomp.core.Time</p>
</dd>
</dl>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.ArclinkRequestLine.start">
<code class="sig-name descname">start</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.ArclinkRequestLine.start" title="Permalink to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Return type</dt>
<dd class="field-odd"><p>seiscomp.core.Time</p>
</dd>
</dl>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.ArclinkRequestLine.setEnd">
<code class="sig-name descname">setEnd</code><span class="sig-paren">(</span><em class="sig-param">end</em><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.ArclinkRequestLine.setEnd" title="Permalink to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>end</strong> seiscomp.core.Time</p>
</dd>
</dl>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.ArclinkRequestLine.end">
<code class="sig-name descname">end</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.ArclinkRequestLine.end" title="Permalink to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Return type</dt>
<dd class="field-odd"><p>seiscomp.core.Time</p>
</dd>
</dl>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.ArclinkRequestLine.setStreamID">
<code class="sig-name descname">setStreamID</code><span class="sig-paren">(</span><em class="sig-param">streamID</em><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.ArclinkRequestLine.setStreamID" title="Permalink to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>streamID</strong> <a class="reference internal" href="#api-python-datamodel-waveformstreamid"><span class="std std-ref">WaveformStreamID</span></a></p>
</dd>
</dl>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.ArclinkRequestLine.streamID">
<code class="sig-name descname">streamID</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.ArclinkRequestLine.streamID" title="Permalink to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Return type</dt>
<dd class="field-odd"><p><a class="reference internal" href="#api-python-datamodel-waveformstreamid"><span class="std std-ref">WaveformStreamID</span></a></p>
</dd>
</dl>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.ArclinkRequestLine.setRestricted">
<code class="sig-name descname">setRestricted</code><span class="sig-paren">(</span><em class="sig-param">restricted</em><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.ArclinkRequestLine.setRestricted" title="Permalink to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>restricted</strong> boolean</p>
</dd>
</dl>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.ArclinkRequestLine.restricted">
<code class="sig-name descname">restricted</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.ArclinkRequestLine.restricted" title="Permalink to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Return type</dt>
<dd class="field-odd"><p>boolean</p>
</dd>
</dl>
<div class="admonition note">
<p class="admonition-title">Note</p>
<p>As this attribute is optional, this method throws a ValueError if
the value of the attribute is not set.</p>
</div>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.ArclinkRequestLine.setShared">
<code class="sig-name descname">setShared</code><span class="sig-paren">(</span><em class="sig-param">shared</em><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.ArclinkRequestLine.setShared" title="Permalink to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>shared</strong> boolean</p>
</dd>
</dl>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.ArclinkRequestLine.shared">
<code class="sig-name descname">shared</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.ArclinkRequestLine.shared" title="Permalink to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Return type</dt>
<dd class="field-odd"><p>boolean</p>
</dd>
</dl>
<div class="admonition note">
<p class="admonition-title">Note</p>
<p>As this attribute is optional, this method throws a ValueError if
the value of the attribute is not set.</p>
</div>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.ArclinkRequestLine.setNetClass">
<code class="sig-name descname">setNetClass</code><span class="sig-paren">(</span><em class="sig-param">netClass</em><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.ArclinkRequestLine.setNetClass" title="Permalink to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>netClass</strong> string</p>
</dd>
</dl>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.ArclinkRequestLine.netClass">
<code class="sig-name descname">netClass</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.ArclinkRequestLine.netClass" title="Permalink to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Return type</dt>
<dd class="field-odd"><p>string</p>
</dd>
</dl>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.ArclinkRequestLine.setConstraints">
<code class="sig-name descname">setConstraints</code><span class="sig-paren">(</span><em class="sig-param">constraints</em><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.ArclinkRequestLine.setConstraints" title="Permalink to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>constraints</strong> string</p>
</dd>
</dl>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.ArclinkRequestLine.constraints">
<code class="sig-name descname">constraints</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.ArclinkRequestLine.constraints" title="Permalink to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Return type</dt>
<dd class="field-odd"><p>string</p>
</dd>
</dl>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.ArclinkRequestLine.setStatus">
<code class="sig-name descname">setStatus</code><span class="sig-paren">(</span><em class="sig-param">status</em><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.ArclinkRequestLine.setStatus" title="Permalink to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>status</strong> <a class="reference internal" href="#api-python-datamodel-arclinkstatusline"><span class="std std-ref">ArclinkStatusLine</span></a></p>
</dd>
</dl>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.ArclinkRequestLine.status">
<code class="sig-name descname">status</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.ArclinkRequestLine.status" title="Permalink to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Return type</dt>
<dd class="field-odd"><p><a class="reference internal" href="#api-python-datamodel-arclinkstatusline"><span class="std std-ref">ArclinkStatusLine</span></a></p>
</dd>
</dl>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.ArclinkRequestLine.arclinkRequest">
<code class="sig-name descname">arclinkRequest</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.ArclinkRequestLine.arclinkRequest" title="Permalink to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Return type</dt>
<dd class="field-odd"><p><a class="reference internal" href="#seiscomp.datamodel.ArclinkRequest" title="seiscomp.datamodel.ArclinkRequest">ArclinkRequest</a></p>
</dd>
</dl>
<p>Returns the parent ArclinkRequest if available. Returns None
if the parent is not a ArclinkRequest. This is a convenience wrapper
for parent().</p>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.ArclinkRequestLine.assign">
<code class="sig-name descname">assign</code><span class="sig-paren">(</span><em class="sig-param">other</em><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.ArclinkRequestLine.assign" title="Permalink to this definition"></a></dt>
<dd><p>This method implements the <a class="reference internal" href="#api-python-datamodel-object"><span class="std std-ref">Object</span></a> interface.</p>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.ArclinkRequestLine.attachTo">
<code class="sig-name descname">attachTo</code><span class="sig-paren">(</span><em class="sig-param">parent</em><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.ArclinkRequestLine.attachTo" title="Permalink to this definition"></a></dt>
<dd><p>This method implements the <a class="reference internal" href="#api-python-datamodel-object"><span class="std std-ref">Object</span></a> interface.</p>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.ArclinkRequestLine.detachFrom">
<code class="sig-name descname">detachFrom</code><span class="sig-paren">(</span><em class="sig-param">parent</em><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.ArclinkRequestLine.detachFrom" title="Permalink to this definition"></a></dt>
<dd><p>This method implements the <a class="reference internal" href="#api-python-datamodel-object"><span class="std std-ref">Object</span></a> interface.</p>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.ArclinkRequestLine.detach">
<code class="sig-name descname">detach</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.ArclinkRequestLine.detach" title="Permalink to this definition"></a></dt>
<dd><p>This method implements the <a class="reference internal" href="#api-python-datamodel-object"><span class="std std-ref">Object</span></a> interface.</p>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.ArclinkRequestLine.clone">
<code class="sig-name descname">clone</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.ArclinkRequestLine.clone" title="Permalink to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Return type</dt>
<dd class="field-odd"><p>A cloned ArclinkRequestLine.</p>
</dd>
</dl>
<p>Returns a new instance that is a clone of the current instance. Child
objects are being ignored.</p>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.ArclinkRequestLine.accept">
<code class="sig-name descname">accept</code><span class="sig-paren">(</span><em class="sig-param">visitor</em><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.ArclinkRequestLine.accept" title="Permalink to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>visitor</strong> A visitor.</p>
</dd>
</dl>
<p>This method implements the <a class="reference internal" href="#api-python-datamodel-publicobject"><span class="std std-ref">PublicObject</span></a> interface.</p>
</dd></dl>
</dd></dl>
</div>
<div class="section" id="arclinkrequestsummary">
<span id="api-python-datamodel-arclinkrequestsummary"></span><h3>ArclinkRequestSummary<a class="headerlink" href="#arclinkrequestsummary" title="Permalink to this headline"></a></h3>
<dl class="class">
<dt id="seiscomp.datamodel.ArclinkRequestSummary">
<em class="property">class </em><code class="sig-prename descclassname">seiscomp.datamodel.</code><code class="sig-name descname">ArclinkRequestSummary</code><a class="headerlink" href="#seiscomp.datamodel.ArclinkRequestSummary" title="Permalink to this definition"></a></dt>
<dd><p>Inherits <a class="reference internal" href="#api-python-datamodel-object"><span class="std std-ref">Object</span></a>.</p>
<p><strong>Attributes</strong>:</p>
<ul class="simple">
<li><p><code class="docutils literal notranslate"><span class="pre">okLineCount</span></code> int</p></li>
<li><p><code class="docutils literal notranslate"><span class="pre">totalLineCount</span></code> int</p></li>
<li><p><code class="docutils literal notranslate"><span class="pre">averageTimeWindow</span></code> int</p></li>
</ul>
<p><strong>Used by</strong>:</p>
<ul class="simple">
<li><p><a class="reference internal" href="#seiscomp.datamodel.ArclinkRequest.summary" title="seiscomp.datamodel.ArclinkRequest.summary"><code class="xref py py-func docutils literal notranslate"><span class="pre">ArclinkRequest.summary()</span></code></a></p></li>
</ul>
<p><strong>Methods</strong>:</p>
<dl class="method">
<dt id="seiscomp.datamodel.ArclinkRequestSummary.Cast">
<em class="property">static </em><code class="sig-name descname">Cast</code><span class="sig-paren">(</span><em class="sig-param">obj</em><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.ArclinkRequestSummary.Cast" title="Permalink to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>obj</strong> The object to be casted.</p>
</dd>
<dt class="field-even">Return type</dt>
<dd class="field-even"><p>An object of type ArclinkRequestSummary if the cast was successful,
None otherwise.</p>
</dd>
</dl>
<p>Cast an arbitrary object to ArclinkRequestSummary if the internal wrapped
representation is an ArclinkRequestSummary object. The cast is important if
instances of type <a class="reference internal" href="#api-python-datamodel-object"><span class="std std-ref">Object</span></a>
are passed to methods which need access to the real type.</p>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.ArclinkRequestSummary.equal">
<code class="sig-name descname">equal</code><span class="sig-paren">(</span><em class="sig-param">other</em><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.ArclinkRequestSummary.equal" title="Permalink to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>other</strong> Another object of type ArclinkRequestSummary to compare this
instance to</p>
</dd>
<dt class="field-even">Return type</dt>
<dd class="field-even"><p>A Boolean value indicating True if both objects are equal or
False otherwise.</p>
</dd>
</dl>
<p>Compares two objects without its child objects. Both objects are compared
by value.</p>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.ArclinkRequestSummary.setOkLineCount">
<code class="sig-name descname">setOkLineCount</code><span class="sig-paren">(</span><em class="sig-param">okLineCount</em><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.ArclinkRequestSummary.setOkLineCount" title="Permalink to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>okLineCount</strong> int</p>
</dd>
</dl>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.ArclinkRequestSummary.okLineCount">
<code class="sig-name descname">okLineCount</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.ArclinkRequestSummary.okLineCount" title="Permalink to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Return type</dt>
<dd class="field-odd"><p>int</p>
</dd>
</dl>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.ArclinkRequestSummary.setTotalLineCount">
<code class="sig-name descname">setTotalLineCount</code><span class="sig-paren">(</span><em class="sig-param">totalLineCount</em><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.ArclinkRequestSummary.setTotalLineCount" title="Permalink to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>totalLineCount</strong> int</p>
</dd>
</dl>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.ArclinkRequestSummary.totalLineCount">
<code class="sig-name descname">totalLineCount</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.ArclinkRequestSummary.totalLineCount" title="Permalink to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Return type</dt>
<dd class="field-odd"><p>int</p>
</dd>
</dl>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.ArclinkRequestSummary.setAverageTimeWindow">
<code class="sig-name descname">setAverageTimeWindow</code><span class="sig-paren">(</span><em class="sig-param">averageTimeWindow</em><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.ArclinkRequestSummary.setAverageTimeWindow" title="Permalink to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>averageTimeWindow</strong> int</p>
</dd>
</dl>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.ArclinkRequestSummary.averageTimeWindow">
<code class="sig-name descname">averageTimeWindow</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.ArclinkRequestSummary.averageTimeWindow" title="Permalink to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Return type</dt>
<dd class="field-odd"><p>int</p>
</dd>
</dl>
</dd></dl>
</dd></dl>
</div>
<div class="section" id="arclinkstatusline">
<span id="api-python-datamodel-arclinkstatusline"></span><h3>ArclinkStatusLine<a class="headerlink" href="#arclinkstatusline" title="Permalink to this headline"></a></h3>
<dl class="class">
<dt id="seiscomp.datamodel.ArclinkStatusLine">
<em class="property">class </em><code class="sig-prename descclassname">seiscomp.datamodel.</code><code class="sig-name descname">ArclinkStatusLine</code><a class="headerlink" href="#seiscomp.datamodel.ArclinkStatusLine" title="Permalink to this definition"></a></dt>
<dd><p>Inherits <a class="reference internal" href="#api-python-datamodel-object"><span class="std std-ref">Object</span></a>.</p>
<p><strong>Parents</strong>:</p>
<ul class="simple">
<li><p><code class="docutils literal notranslate"><span class="pre">arclinkRequest</span></code> <a class="reference internal" href="#api-python-datamodel-arclinkrequest"><span class="std std-ref">ArclinkRequest</span></a></p></li>
</ul>
<p><strong>Attributes</strong>:</p>
<ul class="simple">
<li><p><code class="docutils literal notranslate"><span class="pre">type</span></code> string</p></li>
<li><p><code class="docutils literal notranslate"><span class="pre">status</span></code> string</p></li>
<li><p><code class="docutils literal notranslate"><span class="pre">size</span></code> int (optional)</p></li>
<li><p><code class="docutils literal notranslate"><span class="pre">message</span></code> string</p></li>
<li><p><code class="docutils literal notranslate"><span class="pre">volumeID</span></code> string</p></li>
</ul>
<p><strong>Used by</strong>:</p>
<ul class="simple">
<li><p><a class="reference internal" href="#seiscomp.datamodel.ArclinkRequestLine.status" title="seiscomp.datamodel.ArclinkRequestLine.status"><code class="xref py py-func docutils literal notranslate"><span class="pre">ArclinkRequestLine.status()</span></code></a></p></li>
</ul>
<p><strong>Methods</strong>:</p>
<dl class="method">
<dt id="seiscomp.datamodel.ArclinkStatusLine.Cast">
<em class="property">static </em><code class="sig-name descname">Cast</code><span class="sig-paren">(</span><em class="sig-param">obj</em><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.ArclinkStatusLine.Cast" title="Permalink to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>obj</strong> The object to be casted.</p>
</dd>
<dt class="field-even">Return type</dt>
<dd class="field-even"><p>An object of type ArclinkStatusLine if the cast was successful,
None otherwise.</p>
</dd>
</dl>
<p>Cast an arbitrary object to ArclinkStatusLine if the internal wrapped
representation is an ArclinkStatusLine object. The cast is important if
instances of type <a class="reference internal" href="#api-python-datamodel-object"><span class="std std-ref">Object</span></a>
are passed to methods which need access to the real type.</p>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.ArclinkStatusLine.equal">
<code class="sig-name descname">equal</code><span class="sig-paren">(</span><em class="sig-param">other</em><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.ArclinkStatusLine.equal" title="Permalink to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>other</strong> Another object of type ArclinkStatusLine to compare this
instance to</p>
</dd>
<dt class="field-even">Return type</dt>
<dd class="field-even"><p>A Boolean value indicating True if both objects are equal or
False otherwise.</p>
</dd>
</dl>
<p>Compares two objects without its child objects. Both objects are compared
by value.</p>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.ArclinkStatusLine.index">
<code class="sig-name descname">index</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.ArclinkStatusLine.index" title="Permalink to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Return type</dt>
<dd class="field-odd"><p><p>The objects index of type ArclinkStatusLineIndex.</p>
<p>Returns the objects index which is also used for the database as unique
constraint.</p>
</p>
</dd>
</dl>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.ArclinkStatusLine.equalIndex">
<code class="sig-name descname">equalIndex</code><span class="sig-paren">(</span><em class="sig-param">lhs</em><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.ArclinkStatusLine.equalIndex" title="Permalink to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>lhs</strong> <a class="reference internal" href="#api-python-datamodel-arclinkstatusline"><span class="std std-ref">ArclinkStatusLine</span></a></p>
</dd>
<dt class="field-even">Return type</dt>
<dd class="field-even"><p>A Boolean value indicating True if both indexes are equal or
False otherwise.</p>
</dd>
</dl>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.ArclinkStatusLine.setType">
<code class="sig-name descname">setType</code><span class="sig-paren">(</span><em class="sig-param">type</em><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.ArclinkStatusLine.setType" title="Permalink to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>type</strong> string</p>
</dd>
</dl>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.ArclinkStatusLine.type">
<code class="sig-name descname">type</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.ArclinkStatusLine.type" title="Permalink to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Return type</dt>
<dd class="field-odd"><p>string</p>
</dd>
</dl>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.ArclinkStatusLine.setStatus">
<code class="sig-name descname">setStatus</code><span class="sig-paren">(</span><em class="sig-param">status</em><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.ArclinkStatusLine.setStatus" title="Permalink to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>status</strong> string</p>
</dd>
</dl>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.ArclinkStatusLine.status">
<code class="sig-name descname">status</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.ArclinkStatusLine.status" title="Permalink to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Return type</dt>
<dd class="field-odd"><p>string</p>
</dd>
</dl>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.ArclinkStatusLine.setSize">
<code class="sig-name descname">setSize</code><span class="sig-paren">(</span><em class="sig-param">size</em><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.ArclinkStatusLine.setSize" title="Permalink to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>size</strong> int</p>
</dd>
</dl>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.ArclinkStatusLine.size">
<code class="sig-name descname">size</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.ArclinkStatusLine.size" title="Permalink to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Return type</dt>
<dd class="field-odd"><p>int</p>
</dd>
</dl>
<div class="admonition note">
<p class="admonition-title">Note</p>
<p>As this attribute is optional, this method throws a ValueError if
the value of the attribute is not set.</p>
</div>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.ArclinkStatusLine.setMessage">
<code class="sig-name descname">setMessage</code><span class="sig-paren">(</span><em class="sig-param">message</em><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.ArclinkStatusLine.setMessage" title="Permalink to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>message</strong> string</p>
</dd>
</dl>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.ArclinkStatusLine.message">
<code class="sig-name descname">message</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.ArclinkStatusLine.message" title="Permalink to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Return type</dt>
<dd class="field-odd"><p>string</p>
</dd>
</dl>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.ArclinkStatusLine.setVolumeID">
<code class="sig-name descname">setVolumeID</code><span class="sig-paren">(</span><em class="sig-param">volumeID</em><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.ArclinkStatusLine.setVolumeID" title="Permalink to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>volumeID</strong> string</p>
</dd>
</dl>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.ArclinkStatusLine.volumeID">
<code class="sig-name descname">volumeID</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.ArclinkStatusLine.volumeID" title="Permalink to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Return type</dt>
<dd class="field-odd"><p>string</p>
</dd>
</dl>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.ArclinkStatusLine.arclinkRequest">
<code class="sig-name descname">arclinkRequest</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.ArclinkStatusLine.arclinkRequest" title="Permalink to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Return type</dt>
<dd class="field-odd"><p><a class="reference internal" href="#seiscomp.datamodel.ArclinkRequest" title="seiscomp.datamodel.ArclinkRequest">ArclinkRequest</a></p>
</dd>
</dl>
<p>Returns the parent ArclinkRequest if available. Returns None
if the parent is not a ArclinkRequest. This is a convenience wrapper
for parent().</p>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.ArclinkStatusLine.assign">
<code class="sig-name descname">assign</code><span class="sig-paren">(</span><em class="sig-param">other</em><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.ArclinkStatusLine.assign" title="Permalink to this definition"></a></dt>
<dd><p>This method implements the <a class="reference internal" href="#api-python-datamodel-object"><span class="std std-ref">Object</span></a> interface.</p>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.ArclinkStatusLine.attachTo">
<code class="sig-name descname">attachTo</code><span class="sig-paren">(</span><em class="sig-param">parent</em><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.ArclinkStatusLine.attachTo" title="Permalink to this definition"></a></dt>
<dd><p>This method implements the <a class="reference internal" href="#api-python-datamodel-object"><span class="std std-ref">Object</span></a> interface.</p>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.ArclinkStatusLine.detachFrom">
<code class="sig-name descname">detachFrom</code><span class="sig-paren">(</span><em class="sig-param">parent</em><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.ArclinkStatusLine.detachFrom" title="Permalink to this definition"></a></dt>
<dd><p>This method implements the <a class="reference internal" href="#api-python-datamodel-object"><span class="std std-ref">Object</span></a> interface.</p>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.ArclinkStatusLine.detach">
<code class="sig-name descname">detach</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.ArclinkStatusLine.detach" title="Permalink to this definition"></a></dt>
<dd><p>This method implements the <a class="reference internal" href="#api-python-datamodel-object"><span class="std std-ref">Object</span></a> interface.</p>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.ArclinkStatusLine.clone">
<code class="sig-name descname">clone</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.ArclinkStatusLine.clone" title="Permalink to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Return type</dt>
<dd class="field-odd"><p>A cloned ArclinkStatusLine.</p>
</dd>
</dl>
<p>Returns a new instance that is a clone of the current instance. Child
objects are being ignored.</p>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.ArclinkStatusLine.accept">
<code class="sig-name descname">accept</code><span class="sig-paren">(</span><em class="sig-param">visitor</em><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.ArclinkStatusLine.accept" title="Permalink to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>visitor</strong> A visitor.</p>
</dd>
</dl>
<p>This method implements the <a class="reference internal" href="#api-python-datamodel-publicobject"><span class="std std-ref">PublicObject</span></a> interface.</p>
</dd></dl>
</dd></dl>
</div>
<div class="section" id="arclinkuser">
<span id="api-python-datamodel-arclinkuser"></span><h3>ArclinkUser<a class="headerlink" href="#arclinkuser" title="Permalink to this headline"></a></h3>
<dl class="class">
<dt id="seiscomp.datamodel.ArclinkUser">
<em class="property">class </em><code class="sig-prename descclassname">seiscomp.datamodel.</code><code class="sig-name descname">ArclinkUser</code><a class="headerlink" href="#seiscomp.datamodel.ArclinkUser" title="Permalink to this definition"></a></dt>
<dd><p>Inherits <a class="reference internal" href="#api-python-datamodel-publicobject"><span class="std std-ref">PublicObject</span></a>.</p>
<p><strong>Parents</strong>:</p>
<ul class="simple">
<li><p><code class="docutils literal notranslate"><span class="pre">arclinkLog</span></code> <a class="reference internal" href="#api-python-datamodel-arclinklog"><span class="std std-ref">ArclinkLog</span></a></p></li>
</ul>
<p><strong>Attributes</strong>:</p>
<ul class="simple">
<li><p><code class="docutils literal notranslate"><span class="pre">publicID</span></code>: string</p></li>
<li><p><code class="docutils literal notranslate"><span class="pre">name</span></code> string</p></li>
<li><p><code class="docutils literal notranslate"><span class="pre">email</span></code> string</p></li>
<li><p><code class="docutils literal notranslate"><span class="pre">password</span></code> string</p></li>
</ul>
<p><strong>Methods</strong>:</p>
<dl class="method">
<dt id="seiscomp.datamodel.ArclinkUser.Cast">
<em class="property">static </em><code class="sig-name descname">Cast</code><span class="sig-paren">(</span><em class="sig-param">obj</em><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.ArclinkUser.Cast" title="Permalink to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>obj</strong> The object to be casted.</p>
</dd>
<dt class="field-even">Return type</dt>
<dd class="field-even"><p>An object of type ArclinkUser if the cast was successful,
None otherwise.</p>
</dd>
</dl>
<p>Cast an arbitrary object to ArclinkUser if the internal wrapped
representation is an ArclinkUser object. The cast is important if
instances of type <a class="reference internal" href="#api-python-datamodel-object"><span class="std std-ref">Object</span></a>
are passed to methods which need access to the real type.</p>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.ArclinkUser.Create">
<em class="property">static </em><code class="sig-name descname">Create</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.ArclinkUser.Create" title="Permalink to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Return type</dt>
<dd class="field-odd"><p>A new object of type ArclinkUser.</p>
</dd>
</dl>
<p>Creates and registers (if enabled) a ArclinkUser instance. The
publicID is auto-generated.</p>
</dd></dl>
<dl class="method">
<dt>
<em class="property">static </em><code class="sig-name descname">Create</code><span class="sig-paren">(</span><em class="sig-param">publicID</em><span class="sig-paren">)</span></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Return type</dt>
<dd class="field-odd"><p>A new object of type ArclinkUser.</p>
</dd>
</dl>
<p>Creates and registers (if enabled) a ArclinkUser instance with
passed publicID.</p>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.ArclinkUser.equal">
<code class="sig-name descname">equal</code><span class="sig-paren">(</span><em class="sig-param">other</em><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.ArclinkUser.equal" title="Permalink to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>other</strong> Another object of type ArclinkUser to compare this
instance to</p>
</dd>
<dt class="field-even">Return type</dt>
<dd class="field-even"><p>A Boolean value indicating True if both objects are equal or
False otherwise.</p>
</dd>
</dl>
<p>Compares two objects without its child objects. Both objects are compared
by value.</p>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.ArclinkUser.index">
<code class="sig-name descname">index</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.ArclinkUser.index" title="Permalink to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Return type</dt>
<dd class="field-odd"><p><p>The objects index of type ArclinkUserIndex.</p>
<p>Returns the objects index which is also used for the database as unique
constraint.</p>
</p>
</dd>
</dl>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.ArclinkUser.equalIndex">
<code class="sig-name descname">equalIndex</code><span class="sig-paren">(</span><em class="sig-param">lhs</em><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.ArclinkUser.equalIndex" title="Permalink to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>lhs</strong> <a class="reference internal" href="#api-python-datamodel-arclinkuser"><span class="std std-ref">ArclinkUser</span></a></p>
</dd>
<dt class="field-even">Return type</dt>
<dd class="field-even"><p>A Boolean value indicating True if both indexes are equal or
False otherwise.</p>
</dd>
</dl>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.ArclinkUser.setName">
<code class="sig-name descname">setName</code><span class="sig-paren">(</span><em class="sig-param">name</em><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.ArclinkUser.setName" title="Permalink to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>name</strong> string</p>
</dd>
</dl>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.ArclinkUser.name">
<code class="sig-name descname">name</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.ArclinkUser.name" title="Permalink to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Return type</dt>
<dd class="field-odd"><p>string</p>
</dd>
</dl>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.ArclinkUser.setEmail">
<code class="sig-name descname">setEmail</code><span class="sig-paren">(</span><em class="sig-param">email</em><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.ArclinkUser.setEmail" title="Permalink to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>email</strong> string</p>
</dd>
</dl>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.ArclinkUser.email">
<code class="sig-name descname">email</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.ArclinkUser.email" title="Permalink to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Return type</dt>
<dd class="field-odd"><p>string</p>
</dd>
</dl>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.ArclinkUser.setPassword">
<code class="sig-name descname">setPassword</code><span class="sig-paren">(</span><em class="sig-param">password</em><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.ArclinkUser.setPassword" title="Permalink to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>password</strong> string</p>
</dd>
</dl>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.ArclinkUser.password">
<code class="sig-name descname">password</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.ArclinkUser.password" title="Permalink to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Return type</dt>
<dd class="field-odd"><p>string</p>
</dd>
</dl>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.ArclinkUser.arclinkLog">
<code class="sig-name descname">arclinkLog</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.ArclinkUser.arclinkLog" title="Permalink to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Return type</dt>
<dd class="field-odd"><p><a class="reference internal" href="#seiscomp.datamodel.ArclinkLog" title="seiscomp.datamodel.ArclinkLog">ArclinkLog</a></p>
</dd>
</dl>
<p>Returns the parent ArclinkLog if available. Returns None
if the parent is not a ArclinkLog. This is a convenience wrapper
for parent().</p>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.ArclinkUser.assign">
<code class="sig-name descname">assign</code><span class="sig-paren">(</span><em class="sig-param">other</em><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.ArclinkUser.assign" title="Permalink to this definition"></a></dt>
<dd><p>This method implements the <a class="reference internal" href="#api-python-datamodel-object"><span class="std std-ref">Object</span></a> interface.</p>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.ArclinkUser.attachTo">
<code class="sig-name descname">attachTo</code><span class="sig-paren">(</span><em class="sig-param">parent</em><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.ArclinkUser.attachTo" title="Permalink to this definition"></a></dt>
<dd><p>This method implements the <a class="reference internal" href="#api-python-datamodel-object"><span class="std std-ref">Object</span></a> interface.</p>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.ArclinkUser.detachFrom">
<code class="sig-name descname">detachFrom</code><span class="sig-paren">(</span><em class="sig-param">parent</em><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.ArclinkUser.detachFrom" title="Permalink to this definition"></a></dt>
<dd><p>This method implements the <a class="reference internal" href="#api-python-datamodel-object"><span class="std std-ref">Object</span></a> interface.</p>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.ArclinkUser.detach">
<code class="sig-name descname">detach</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.ArclinkUser.detach" title="Permalink to this definition"></a></dt>
<dd><p>This method implements the <a class="reference internal" href="#api-python-datamodel-object"><span class="std std-ref">Object</span></a> interface.</p>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.ArclinkUser.clone">
<code class="sig-name descname">clone</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.ArclinkUser.clone" title="Permalink to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Return type</dt>
<dd class="field-odd"><p>A cloned ArclinkUser.</p>
</dd>
</dl>
<p>Returns a new instance that is a clone of the current instance. Child
objects are being ignored.</p>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.ArclinkUser.updateChild">
<code class="sig-name descname">updateChild</code><span class="sig-paren">(</span><em class="sig-param">ref</em><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.ArclinkUser.updateChild" title="Permalink to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>ref</strong> A child object derived from class Object.</p>
</dd>
<dt class="field-even">Return type</dt>
<dd class="field-even"><p>A Boolean flag indicating success with True, False otherwise</p>
</dd>
</dl>
<p>This method takes the passed reference object and searches for a child
with the same publicID (if derived from <a class="reference internal" href="#api-python-datamodel-publicobject"><span class="std std-ref">PublicObject</span></a>)
or the same index (if derived from <a class="reference internal" href="#api-python-datamodel-object"><span class="std std-ref">Object</span></a>).
The the child was found the reference objects attributes are copied to
the child object. Children of child are being ignored during this operation.
This method implements the <a class="reference internal" href="#api-python-datamodel-publicobject"><span class="std std-ref">PublicObject</span></a> interface.</p>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.ArclinkUser.accept">
<code class="sig-name descname">accept</code><span class="sig-paren">(</span><em class="sig-param">visitor</em><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.ArclinkUser.accept" title="Permalink to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>visitor</strong> A visitor.</p>
</dd>
</dl>
<p>This method implements the <a class="reference internal" href="#api-python-datamodel-publicobject"><span class="std std-ref">PublicObject</span></a> interface.</p>
</dd></dl>
</dd></dl>
</div>
<div class="section" id="arrival">
<span id="api-python-datamodel-arrival"></span><h3>Arrival<a class="headerlink" href="#arrival" title="Permalink to this headline"></a></h3>
<dl class="class">
<dt id="seiscomp.datamodel.Arrival">
<em class="property">class </em><code class="sig-prename descclassname">seiscomp.datamodel.</code><code class="sig-name descname">Arrival</code><a class="headerlink" href="#seiscomp.datamodel.Arrival" title="Permalink to this definition"></a></dt>
<dd><p>Inherits <a class="reference internal" href="#api-python-datamodel-object"><span class="std std-ref">Object</span></a>.</p>
<p>Successful association of a pick with an origin qualifies this pick as
an arrival. An arrival thus connects a pick with an origin and provides
additional attributes that describe this relationship. Usually qualification
of a pick as an arrival for a given origin is a hypothesis, which is
based on assumptions about the type of arrival (phase) as well as
observed and (on the basis of an earth model) computed arrival times,
or the residual, respectively. Additional pick attributes like the
horizontal slowness and backazimuth of the observed wave-especially if
derived from array data-may further constrain the nature of the arrival.</p>
<p><strong>Parents</strong>:</p>
<ul class="simple">
<li><p><code class="docutils literal notranslate"><span class="pre">origin</span></code> <a class="reference internal" href="#api-python-datamodel-origin"><span class="std std-ref">Origin</span></a></p></li>
</ul>
<p><strong>Attributes</strong>:</p>
<ul class="simple">
<li><p><code class="docutils literal notranslate"><span class="pre">pickID</span></code> string</p></li>
<li><p><code class="docutils literal notranslate"><span class="pre">phase</span></code> <a class="reference internal" href="#api-python-datamodel-phase"><span class="std std-ref">Phase</span></a></p></li>
<li><p><code class="docutils literal notranslate"><span class="pre">timeCorrection</span></code> float (optional)</p></li>
<li><p><code class="docutils literal notranslate"><span class="pre">azimuth</span></code> float (optional)</p></li>
<li><p><code class="docutils literal notranslate"><span class="pre">distance</span></code> float (optional)</p></li>
<li><p><code class="docutils literal notranslate"><span class="pre">takeOffAngle</span></code> float (optional)</p></li>
<li><p><code class="docutils literal notranslate"><span class="pre">timeResidual</span></code> float (optional)</p></li>
<li><p><code class="docutils literal notranslate"><span class="pre">horizontalSlownessResidual</span></code> float (optional)</p></li>
<li><p><code class="docutils literal notranslate"><span class="pre">backazimuthResidual</span></code> float (optional)</p></li>
<li><p><code class="docutils literal notranslate"><span class="pre">timeUsed</span></code> boolean (optional)</p></li>
<li><p><code class="docutils literal notranslate"><span class="pre">horizontalSlownessUsed</span></code> boolean (optional)</p></li>
<li><p><code class="docutils literal notranslate"><span class="pre">backazimuthUsed</span></code> boolean (optional)</p></li>
<li><p><code class="docutils literal notranslate"><span class="pre">weight</span></code> float (optional)</p></li>
<li><p><code class="docutils literal notranslate"><span class="pre">earthModelID</span></code> string</p></li>
<li><p><code class="docutils literal notranslate"><span class="pre">preliminary</span></code> boolean (optional)</p></li>
<li><p><code class="docutils literal notranslate"><span class="pre">creationInfo</span></code> <a class="reference internal" href="#api-python-datamodel-creationinfo"><span class="std std-ref">CreationInfo</span></a> (optional)</p></li>
</ul>
<p><strong>Methods</strong>:</p>
<dl class="method">
<dt id="seiscomp.datamodel.Arrival.Cast">
<em class="property">static </em><code class="sig-name descname">Cast</code><span class="sig-paren">(</span><em class="sig-param">obj</em><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.Arrival.Cast" title="Permalink to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>obj</strong> The object to be casted.</p>
</dd>
<dt class="field-even">Return type</dt>
<dd class="field-even"><p>An object of type Arrival if the cast was successful,
None otherwise.</p>
</dd>
</dl>
<p>Cast an arbitrary object to Arrival if the internal wrapped
representation is an Arrival object. The cast is important if
instances of type <a class="reference internal" href="#api-python-datamodel-object"><span class="std std-ref">Object</span></a>
are passed to methods which need access to the real type.</p>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.Arrival.equal">
<code class="sig-name descname">equal</code><span class="sig-paren">(</span><em class="sig-param">other</em><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.Arrival.equal" title="Permalink to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>other</strong> Another object of type Arrival to compare this
instance to</p>
</dd>
<dt class="field-even">Return type</dt>
<dd class="field-even"><p>A Boolean value indicating True if both objects are equal or
False otherwise.</p>
</dd>
</dl>
<p>Compares two objects without its child objects. Both objects are compared
by value.</p>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.Arrival.index">
<code class="sig-name descname">index</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.Arrival.index" title="Permalink to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Return type</dt>
<dd class="field-odd"><p><p>The objects index of type ArrivalIndex.</p>
<p>Returns the objects index which is also used for the database as unique
constraint.</p>
</p>
</dd>
</dl>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.Arrival.equalIndex">
<code class="sig-name descname">equalIndex</code><span class="sig-paren">(</span><em class="sig-param">lhs</em><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.Arrival.equalIndex" title="Permalink to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>lhs</strong> <a class="reference internal" href="#api-python-datamodel-arrival"><span class="std std-ref">Arrival</span></a></p>
</dd>
<dt class="field-even">Return type</dt>
<dd class="field-even"><p>A Boolean value indicating True if both indexes are equal or
False otherwise.</p>
</dd>
</dl>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.Arrival.setPickID">
<code class="sig-name descname">setPickID</code><span class="sig-paren">(</span><em class="sig-param">pickID</em><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.Arrival.setPickID" title="Permalink to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>pickID</strong> string</p>
</dd>
</dl>
<p>Refers to a publicID of a Pick.</p>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.Arrival.pickID">
<code class="sig-name descname">pickID</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.Arrival.pickID" title="Permalink to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Return type</dt>
<dd class="field-odd"><p>string</p>
</dd>
</dl>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.Arrival.setPhase">
<code class="sig-name descname">setPhase</code><span class="sig-paren">(</span><em class="sig-param">phase</em><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.Arrival.setPhase" title="Permalink to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>phase</strong> <a class="reference internal" href="#api-python-datamodel-phase"><span class="std std-ref">Phase</span></a></p>
</dd>
</dl>
<p>Phase identification. For possible values, please refer to the description
of the Phase type.</p>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.Arrival.phase">
<code class="sig-name descname">phase</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.Arrival.phase" title="Permalink to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Return type</dt>
<dd class="field-odd"><p><a class="reference internal" href="#api-python-datamodel-phase"><span class="std std-ref">Phase</span></a></p>
</dd>
</dl>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.Arrival.setTimeCorrection">
<code class="sig-name descname">setTimeCorrection</code><span class="sig-paren">(</span><em class="sig-param">timeCorrection</em><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.Arrival.setTimeCorrection" title="Permalink to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>timeCorrection</strong> float</p>
</dd>
</dl>
<p>Time correction value. Usually, a value characteristic for the station
at which the pick was detected, sometimes also characteristic for the
phase type or the slowness in seconds.</p>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.Arrival.timeCorrection">
<code class="sig-name descname">timeCorrection</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.Arrival.timeCorrection" title="Permalink to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Return type</dt>
<dd class="field-odd"><p>float</p>
</dd>
</dl>
<div class="admonition note">
<p class="admonition-title">Note</p>
<p>As this attribute is optional, this method throws a ValueError if
the value of the attribute is not set.</p>
</div>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.Arrival.setAzimuth">
<code class="sig-name descname">setAzimuth</code><span class="sig-paren">(</span><em class="sig-param">azimuth</em><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.Arrival.setAzimuth" title="Permalink to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>azimuth</strong> float</p>
</dd>
</dl>
<p>Azimuth of station as seen from the epicenter in degrees.</p>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.Arrival.azimuth">
<code class="sig-name descname">azimuth</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.Arrival.azimuth" title="Permalink to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Return type</dt>
<dd class="field-odd"><p>float</p>
</dd>
</dl>
<div class="admonition note">
<p class="admonition-title">Note</p>
<p>As this attribute is optional, this method throws a ValueError if
the value of the attribute is not set.</p>
</div>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.Arrival.setDistance">
<code class="sig-name descname">setDistance</code><span class="sig-paren">(</span><em class="sig-param">distance</em><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.Arrival.setDistance" title="Permalink to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>distance</strong> float</p>
</dd>
</dl>
<p>Epicentral distance in degrees.</p>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.Arrival.distance">
<code class="sig-name descname">distance</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.Arrival.distance" title="Permalink to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Return type</dt>
<dd class="field-odd"><p>float</p>
</dd>
</dl>
<div class="admonition note">
<p class="admonition-title">Note</p>
<p>As this attribute is optional, this method throws a ValueError if
the value of the attribute is not set.</p>
</div>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.Arrival.setTakeOffAngle">
<code class="sig-name descname">setTakeOffAngle</code><span class="sig-paren">(</span><em class="sig-param">takeOffAngle</em><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.Arrival.setTakeOffAngle" title="Permalink to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>takeOffAngle</strong> float</p>
</dd>
</dl>
<p>Angle of emerging ray at the source, measured against the downward
normal direction in degrees.</p>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.Arrival.takeOffAngle">
<code class="sig-name descname">takeOffAngle</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.Arrival.takeOffAngle" title="Permalink to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Return type</dt>
<dd class="field-odd"><p>float</p>
</dd>
</dl>
<div class="admonition note">
<p class="admonition-title">Note</p>
<p>As this attribute is optional, this method throws a ValueError if
the value of the attribute is not set.</p>
</div>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.Arrival.setTimeResidual">
<code class="sig-name descname">setTimeResidual</code><span class="sig-paren">(</span><em class="sig-param">timeResidual</em><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.Arrival.setTimeResidual" title="Permalink to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>timeResidual</strong> float</p>
</dd>
</dl>
<p>Residual between observed and expected arrival time assuming proper
phase identification and given the earthModelID of the Origin,
taking into account the timeCorrection in seconds.</p>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.Arrival.timeResidual">
<code class="sig-name descname">timeResidual</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.Arrival.timeResidual" title="Permalink to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Return type</dt>
<dd class="field-odd"><p>float</p>
</dd>
</dl>
<div class="admonition note">
<p class="admonition-title">Note</p>
<p>As this attribute is optional, this method throws a ValueError if
the value of the attribute is not set.</p>
</div>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.Arrival.setHorizontalSlownessResidual">
<code class="sig-name descname">setHorizontalSlownessResidual</code><span class="sig-paren">(</span><em class="sig-param">horizontalSlownessResidual</em><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.Arrival.setHorizontalSlownessResidual" title="Permalink to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>horizontalSlownessResidual</strong> float</p>
</dd>
</dl>
<p>Residual of horizontal slowness and the expected slowness given the
current origin (refers to attribute horizontalSlowness of class Pick)
in s/deg.</p>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.Arrival.horizontalSlownessResidual">
<code class="sig-name descname">horizontalSlownessResidual</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.Arrival.horizontalSlownessResidual" title="Permalink to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Return type</dt>
<dd class="field-odd"><p>float</p>
</dd>
</dl>
<div class="admonition note">
<p class="admonition-title">Note</p>
<p>As this attribute is optional, this method throws a ValueError if
the value of the attribute is not set.</p>
</div>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.Arrival.setBackazimuthResidual">
<code class="sig-name descname">setBackazimuthResidual</code><span class="sig-paren">(</span><em class="sig-param">backazimuthResidual</em><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.Arrival.setBackazimuthResidual" title="Permalink to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>backazimuthResidual</strong> float</p>
</dd>
</dl>
<p>Residual of backazimuth and the backazimuth computed for the current
origin (refers to attribute backazimuth of class Pick) in degrees.</p>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.Arrival.backazimuthResidual">
<code class="sig-name descname">backazimuthResidual</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.Arrival.backazimuthResidual" title="Permalink to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Return type</dt>
<dd class="field-odd"><p>float</p>
</dd>
</dl>
<div class="admonition note">
<p class="admonition-title">Note</p>
<p>As this attribute is optional, this method throws a ValueError if
the value of the attribute is not set.</p>
</div>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.Arrival.setTimeUsed">
<code class="sig-name descname">setTimeUsed</code><span class="sig-paren">(</span><em class="sig-param">timeUsed</em><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.Arrival.setTimeUsed" title="Permalink to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>timeUsed</strong> boolean</p>
</dd>
</dl>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.Arrival.timeUsed">
<code class="sig-name descname">timeUsed</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.Arrival.timeUsed" title="Permalink to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Return type</dt>
<dd class="field-odd"><p>boolean</p>
</dd>
</dl>
<div class="admonition note">
<p class="admonition-title">Note</p>
<p>As this attribute is optional, this method throws a ValueError if
the value of the attribute is not set.</p>
</div>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.Arrival.setHorizontalSlownessUsed">
<code class="sig-name descname">setHorizontalSlownessUsed</code><span class="sig-paren">(</span><em class="sig-param">horizontalSlownessUsed</em><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.Arrival.setHorizontalSlownessUsed" title="Permalink to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>horizontalSlownessUsed</strong> boolean</p>
</dd>
</dl>
<p>Weight of the horizontal slowness for computation of the associated Origin.
Note that the sum of all weights is not required to be unity.</p>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.Arrival.horizontalSlownessUsed">
<code class="sig-name descname">horizontalSlownessUsed</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.Arrival.horizontalSlownessUsed" title="Permalink to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Return type</dt>
<dd class="field-odd"><p>boolean</p>
</dd>
</dl>
<div class="admonition note">
<p class="admonition-title">Note</p>
<p>As this attribute is optional, this method throws a ValueError if
the value of the attribute is not set.</p>
</div>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.Arrival.setBackazimuthUsed">
<code class="sig-name descname">setBackazimuthUsed</code><span class="sig-paren">(</span><em class="sig-param">backazimuthUsed</em><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.Arrival.setBackazimuthUsed" title="Permalink to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>backazimuthUsed</strong> boolean</p>
</dd>
</dl>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.Arrival.backazimuthUsed">
<code class="sig-name descname">backazimuthUsed</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.Arrival.backazimuthUsed" title="Permalink to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Return type</dt>
<dd class="field-odd"><p>boolean</p>
</dd>
</dl>
<div class="admonition note">
<p class="admonition-title">Note</p>
<p>As this attribute is optional, this method throws a ValueError if
the value of the attribute is not set.</p>
</div>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.Arrival.setWeight">
<code class="sig-name descname">setWeight</code><span class="sig-paren">(</span><em class="sig-param">weight</em><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.Arrival.setWeight" title="Permalink to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>weight</strong> float</p>
</dd>
</dl>
<p>Weight of the arrival time for computation of the associated Origin.
Note that the sum of all weights is not required to be unity.</p>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.Arrival.weight">
<code class="sig-name descname">weight</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.Arrival.weight" title="Permalink to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Return type</dt>
<dd class="field-odd"><p>float</p>
</dd>
</dl>
<div class="admonition note">
<p class="admonition-title">Note</p>
<p>As this attribute is optional, this method throws a ValueError if
the value of the attribute is not set.</p>
</div>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.Arrival.setEarthModelID">
<code class="sig-name descname">setEarthModelID</code><span class="sig-paren">(</span><em class="sig-param">earthModelID</em><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.Arrival.setEarthModelID" title="Permalink to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>earthModelID</strong> string</p>
</dd>
</dl>
<p>Earth model which is used for the association of Arrival to Pick and
computation of the
residuals.</p>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.Arrival.earthModelID">
<code class="sig-name descname">earthModelID</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.Arrival.earthModelID" title="Permalink to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Return type</dt>
<dd class="field-odd"><p>string</p>
</dd>
</dl>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.Arrival.setPreliminary">
<code class="sig-name descname">setPreliminary</code><span class="sig-paren">(</span><em class="sig-param">preliminary</em><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.Arrival.setPreliminary" title="Permalink to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>preliminary</strong> boolean</p>
</dd>
</dl>
<p>Indicates if the arrival is preliminary.</p>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.Arrival.preliminary">
<code class="sig-name descname">preliminary</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.Arrival.preliminary" title="Permalink to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Return type</dt>
<dd class="field-odd"><p>boolean</p>
</dd>
</dl>
<div class="admonition note">
<p class="admonition-title">Note</p>
<p>As this attribute is optional, this method throws a ValueError if
the value of the attribute is not set.</p>
</div>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.Arrival.setCreationInfo">
<code class="sig-name descname">setCreationInfo</code><span class="sig-paren">(</span><em class="sig-param">creationInfo</em><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.Arrival.setCreationInfo" title="Permalink to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>creationInfo</strong> <a class="reference internal" href="#api-python-datamodel-creationinfo"><span class="std std-ref">CreationInfo</span></a></p>
</dd>
</dl>
<p>CreationInfo for the Arrival object.</p>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.Arrival.creationInfo">
<code class="sig-name descname">creationInfo</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.Arrival.creationInfo" title="Permalink to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Return type</dt>
<dd class="field-odd"><p><a class="reference internal" href="#api-python-datamodel-creationinfo"><span class="std std-ref">CreationInfo</span></a></p>
</dd>
</dl>
<div class="admonition note">
<p class="admonition-title">Note</p>
<p>As this attribute is optional, this method throws a ValueError if
the value of the attribute is not set.</p>
</div>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.Arrival.origin">
<code class="sig-name descname">origin</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.Arrival.origin" title="Permalink to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Return type</dt>
<dd class="field-odd"><p><a class="reference internal" href="#seiscomp.datamodel.Origin" title="seiscomp.datamodel.Origin">Origin</a></p>
</dd>
</dl>
<p>Returns the parent Origin if available. Returns None
if the parent is not a Origin. This is a convenience wrapper
for parent().</p>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.Arrival.assign">
<code class="sig-name descname">assign</code><span class="sig-paren">(</span><em class="sig-param">other</em><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.Arrival.assign" title="Permalink to this definition"></a></dt>
<dd><p>This method implements the <a class="reference internal" href="#api-python-datamodel-object"><span class="std std-ref">Object</span></a> interface.</p>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.Arrival.attachTo">
<code class="sig-name descname">attachTo</code><span class="sig-paren">(</span><em class="sig-param">parent</em><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.Arrival.attachTo" title="Permalink to this definition"></a></dt>
<dd><p>This method implements the <a class="reference internal" href="#api-python-datamodel-object"><span class="std std-ref">Object</span></a> interface.</p>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.Arrival.detachFrom">
<code class="sig-name descname">detachFrom</code><span class="sig-paren">(</span><em class="sig-param">parent</em><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.Arrival.detachFrom" title="Permalink to this definition"></a></dt>
<dd><p>This method implements the <a class="reference internal" href="#api-python-datamodel-object"><span class="std std-ref">Object</span></a> interface.</p>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.Arrival.detach">
<code class="sig-name descname">detach</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.Arrival.detach" title="Permalink to this definition"></a></dt>
<dd><p>This method implements the <a class="reference internal" href="#api-python-datamodel-object"><span class="std std-ref">Object</span></a> interface.</p>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.Arrival.clone">
<code class="sig-name descname">clone</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.Arrival.clone" title="Permalink to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Return type</dt>
<dd class="field-odd"><p>A cloned Arrival.</p>
</dd>
</dl>
<p>Returns a new instance that is a clone of the current instance. Child
objects are being ignored.</p>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.Arrival.accept">
<code class="sig-name descname">accept</code><span class="sig-paren">(</span><em class="sig-param">visitor</em><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.Arrival.accept" title="Permalink to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>visitor</strong> A visitor.</p>
</dd>
</dl>
<p>This method implements the <a class="reference internal" href="#api-python-datamodel-publicobject"><span class="std std-ref">PublicObject</span></a> interface.</p>
</dd></dl>
</dd></dl>
</div>
<div class="section" id="auxdevice">
<span id="api-python-datamodel-auxdevice"></span><h3>AuxDevice<a class="headerlink" href="#auxdevice" title="Permalink to this headline"></a></h3>
<dl class="class">
<dt id="seiscomp.datamodel.AuxDevice">
<em class="property">class </em><code class="sig-prename descclassname">seiscomp.datamodel.</code><code class="sig-name descname">AuxDevice</code><a class="headerlink" href="#seiscomp.datamodel.AuxDevice" title="Permalink to this definition"></a></dt>
<dd><p>Inherits <a class="reference internal" href="#api-python-datamodel-publicobject"><span class="std std-ref">PublicObject</span></a>.</p>
<p>This type describes an auxilliary device</p>
<p><strong>Parents</strong>:</p>
<ul class="simple">
<li><p><code class="docutils literal notranslate"><span class="pre">inventory</span></code> <a class="reference internal" href="#api-python-datamodel-inventory"><span class="std std-ref">Inventory</span></a></p></li>
</ul>
<p><strong>Children</strong>:</p>
<ul class="simple">
<li><p><code class="docutils literal notranslate"><span class="pre">auxSource</span></code> <a class="reference internal" href="#api-python-datamodel-auxsource"><span class="std std-ref">AuxSource</span></a></p></li>
</ul>
<p><strong>Attributes</strong>:</p>
<ul class="simple">
<li><p><code class="docutils literal notranslate"><span class="pre">publicID</span></code>: string</p></li>
<li><p><code class="docutils literal notranslate"><span class="pre">name</span></code> string</p></li>
<li><p><code class="docutils literal notranslate"><span class="pre">description</span></code> string</p></li>
<li><p><code class="docutils literal notranslate"><span class="pre">model</span></code> string</p></li>
<li><p><code class="docutils literal notranslate"><span class="pre">manufacturer</span></code> string</p></li>
<li><p><code class="docutils literal notranslate"><span class="pre">remark</span></code> <a class="reference internal" href="#api-python-datamodel-blob"><span class="std std-ref">Blob</span></a> (optional)</p></li>
</ul>
<p><strong>Referenced by</strong>:</p>
<ul class="simple">
<li><p><a class="reference internal" href="#seiscomp.datamodel.AuxStream.device" title="seiscomp.datamodel.AuxStream.device"><code class="xref py py-func docutils literal notranslate"><span class="pre">AuxStream.device()</span></code></a></p></li>
</ul>
<p><strong>Methods</strong>:</p>
<dl class="method">
<dt id="seiscomp.datamodel.AuxDevice.Cast">
<em class="property">static </em><code class="sig-name descname">Cast</code><span class="sig-paren">(</span><em class="sig-param">obj</em><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.AuxDevice.Cast" title="Permalink to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>obj</strong> The object to be casted.</p>
</dd>
<dt class="field-even">Return type</dt>
<dd class="field-even"><p>An object of type AuxDevice if the cast was successful,
None otherwise.</p>
</dd>
</dl>
<p>Cast an arbitrary object to AuxDevice if the internal wrapped
representation is an AuxDevice object. The cast is important if
instances of type <a class="reference internal" href="#api-python-datamodel-object"><span class="std std-ref">Object</span></a>
are passed to methods which need access to the real type.</p>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.AuxDevice.Create">
<em class="property">static </em><code class="sig-name descname">Create</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.AuxDevice.Create" title="Permalink to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Return type</dt>
<dd class="field-odd"><p>A new object of type AuxDevice.</p>
</dd>
</dl>
<p>Creates and registers (if enabled) a AuxDevice instance. The
publicID is auto-generated.</p>
</dd></dl>
<dl class="method">
<dt>
<em class="property">static </em><code class="sig-name descname">Create</code><span class="sig-paren">(</span><em class="sig-param">publicID</em><span class="sig-paren">)</span></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Return type</dt>
<dd class="field-odd"><p>A new object of type AuxDevice.</p>
</dd>
</dl>
<p>Creates and registers (if enabled) a AuxDevice instance with
passed publicID.</p>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.AuxDevice.equal">
<code class="sig-name descname">equal</code><span class="sig-paren">(</span><em class="sig-param">other</em><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.AuxDevice.equal" title="Permalink to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>other</strong> Another object of type AuxDevice to compare this
instance to</p>
</dd>
<dt class="field-even">Return type</dt>
<dd class="field-even"><p>A Boolean value indicating True if both objects are equal or
False otherwise.</p>
</dd>
</dl>
<p>Compares two objects without its child objects. Both objects are compared
by value.</p>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.AuxDevice.index">
<code class="sig-name descname">index</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.AuxDevice.index" title="Permalink to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Return type</dt>
<dd class="field-odd"><p><p>The objects index of type AuxDeviceIndex.</p>
<p>Returns the objects index which is also used for the database as unique
constraint.</p>
</p>
</dd>
</dl>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.AuxDevice.equalIndex">
<code class="sig-name descname">equalIndex</code><span class="sig-paren">(</span><em class="sig-param">lhs</em><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.AuxDevice.equalIndex" title="Permalink to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>lhs</strong> <a class="reference internal" href="#api-python-datamodel-auxdevice"><span class="std std-ref">AuxDevice</span></a></p>
</dd>
<dt class="field-even">Return type</dt>
<dd class="field-even"><p>A Boolean value indicating True if both indexes are equal or
False otherwise.</p>
</dd>
</dl>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.AuxDevice.setName">
<code class="sig-name descname">setName</code><span class="sig-paren">(</span><em class="sig-param">name</em><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.AuxDevice.setName" title="Permalink to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>name</strong> string</p>
</dd>
</dl>
<p>Unique device name</p>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.AuxDevice.name">
<code class="sig-name descname">name</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.AuxDevice.name" title="Permalink to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Return type</dt>
<dd class="field-odd"><p>string</p>
</dd>
</dl>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.AuxDevice.setDescription">
<code class="sig-name descname">setDescription</code><span class="sig-paren">(</span><em class="sig-param">description</em><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.AuxDevice.setDescription" title="Permalink to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>description</strong> string</p>
</dd>
</dl>
<p>Device description</p>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.AuxDevice.description">
<code class="sig-name descname">description</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.AuxDevice.description" title="Permalink to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Return type</dt>
<dd class="field-odd"><p>string</p>
</dd>
</dl>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.AuxDevice.setModel">
<code class="sig-name descname">setModel</code><span class="sig-paren">(</span><em class="sig-param">model</em><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.AuxDevice.setModel" title="Permalink to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>model</strong> string</p>
</dd>
</dl>
<p>Device model</p>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.AuxDevice.model">
<code class="sig-name descname">model</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.AuxDevice.model" title="Permalink to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Return type</dt>
<dd class="field-odd"><p>string</p>
</dd>
</dl>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.AuxDevice.setManufacturer">
<code class="sig-name descname">setManufacturer</code><span class="sig-paren">(</span><em class="sig-param">manufacturer</em><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.AuxDevice.setManufacturer" title="Permalink to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>manufacturer</strong> string</p>
</dd>
</dl>
<p>Device manufacturer</p>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.AuxDevice.manufacturer">
<code class="sig-name descname">manufacturer</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.AuxDevice.manufacturer" title="Permalink to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Return type</dt>
<dd class="field-odd"><p>string</p>
</dd>
</dl>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.AuxDevice.setRemark">
<code class="sig-name descname">setRemark</code><span class="sig-paren">(</span><em class="sig-param">remark</em><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.AuxDevice.setRemark" title="Permalink to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>remark</strong> <a class="reference internal" href="#api-python-datamodel-blob"><span class="std std-ref">Blob</span></a></p>
</dd>
</dl>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.AuxDevice.remark">
<code class="sig-name descname">remark</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.AuxDevice.remark" title="Permalink to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Return type</dt>
<dd class="field-odd"><p><a class="reference internal" href="#api-python-datamodel-blob"><span class="std std-ref">Blob</span></a></p>
</dd>
</dl>
<div class="admonition note">
<p class="admonition-title">Note</p>
<p>As this attribute is optional, this method throws a ValueError if
the value of the attribute is not set.</p>
</div>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.AuxDevice.add">
<code class="sig-name descname">add</code><span class="sig-paren">(</span><em class="sig-param">auxSource</em><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.AuxDevice.add" title="Permalink to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>auxSource</strong> Object of type <a class="reference internal" href="#api-python-datamodel-auxsource"><span class="std std-ref">AuxSource</span></a></p>
</dd>
<dt class="field-even">Return type</dt>
<dd class="field-even"><p>A Boolean value indicating success with True, False otherwise.</p>
</dd>
</dl>
<p>Adds a AuxSource object to AuxDevice. The object is not
copied but managed by this instance. Any change to the passed object
will also change the child.</p>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.AuxDevice.remove">
<code class="sig-name descname">remove</code><span class="sig-paren">(</span><em class="sig-param">auxSource</em><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.AuxDevice.remove" title="Permalink to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>auxSource</strong> Object of type <a class="reference internal" href="#api-python-datamodel-auxsource"><span class="std std-ref">AuxSource</span></a></p>
</dd>
<dt class="field-even">Return type</dt>
<dd class="field-even"><p>A Boolean value indicating success with True, False otherwise.</p>
</dd>
</dl>
<p>Removes a previously added AuxSource object from AuxDevice.</p>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.AuxDevice.removeAuxSource">
<code class="sig-name descname">removeAuxSource</code><span class="sig-paren">(</span><em class="sig-param">idx</em><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.AuxDevice.removeAuxSource" title="Permalink to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>idx</strong> An integer index of the object to be removed.</p>
</dd>
<dt class="field-even">Return type</dt>
<dd class="field-even"><p>A Boolean value indicating success with True, False otherwise.</p>
</dd>
</dl>
</dd></dl>
<dl class="method">
<dt>
<code class="sig-name descname">removeAuxSource(auxSourceIndex);</code></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>auxSourceIndex</strong> The index of the object to be removed of type AuxSourceIndex.</p>
</dd>
<dt class="field-even">Return type</dt>
<dd class="field-even"><p>A Boolean value indicating success with True, False otherwise.</p>
</dd>
</dl>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.AuxDevice.auxSourceCount">
<code class="sig-name descname">auxSourceCount</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.AuxDevice.auxSourceCount" title="Permalink to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Return type</dt>
<dd class="field-odd"><p>integer value indicating the number of child objects.</p>
</dd>
</dl>
<p>Returns the number of AuxSource child objects.</p>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.AuxDevice.auxSource">
<code class="sig-name descname">auxSource</code><span class="sig-paren">(</span><em class="sig-param">idx</em><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.AuxDevice.auxSource" title="Permalink to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>idx</strong> An integer index of the object to be returned.</p>
</dd>
<dt class="field-even">Return type</dt>
<dd class="field-even"><p>Object of type <a class="reference internal" href="#api-python-datamodel-auxsource"><span class="std std-ref">AuxSource</span></a>.</p>
</dd>
</dl>
<p>Returns the AuxSource at index idx.</p>
</dd></dl>
<dl class="method">
<dt>
<code class="sig-name descname">auxSource</code><span class="sig-paren">(</span><em class="sig-param">auxSourceIndex</em><span class="sig-paren">)</span></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>auxSourceIndex</strong> The index of the object to be removed of type AuxSourceIndex.</p>
</dd>
<dt class="field-even">Return type</dt>
<dd class="field-even"><p>Object of type <a class="reference internal" href="#api-python-datamodel-auxsource"><span class="std std-ref">AuxSource</span></a>.</p>
</dd>
</dl>
<p>Returns the AuxSource at given index. The indexes of all child objects
are compared by value which makes this function slower than the direct
integer index look-up.</p>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.AuxDevice.inventory">
<code class="sig-name descname">inventory</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.AuxDevice.inventory" title="Permalink to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Return type</dt>
<dd class="field-odd"><p><a class="reference internal" href="#seiscomp.datamodel.Inventory" title="seiscomp.datamodel.Inventory">Inventory</a></p>
</dd>
</dl>
<p>Returns the parent Inventory if available. Returns None
if the parent is not a Inventory. This is a convenience wrapper
for parent().</p>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.AuxDevice.assign">
<code class="sig-name descname">assign</code><span class="sig-paren">(</span><em class="sig-param">other</em><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.AuxDevice.assign" title="Permalink to this definition"></a></dt>
<dd><p>This method implements the <a class="reference internal" href="#api-python-datamodel-object"><span class="std std-ref">Object</span></a> interface.</p>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.AuxDevice.attachTo">
<code class="sig-name descname">attachTo</code><span class="sig-paren">(</span><em class="sig-param">parent</em><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.AuxDevice.attachTo" title="Permalink to this definition"></a></dt>
<dd><p>This method implements the <a class="reference internal" href="#api-python-datamodel-object"><span class="std std-ref">Object</span></a> interface.</p>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.AuxDevice.detachFrom">
<code class="sig-name descname">detachFrom</code><span class="sig-paren">(</span><em class="sig-param">parent</em><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.AuxDevice.detachFrom" title="Permalink to this definition"></a></dt>
<dd><p>This method implements the <a class="reference internal" href="#api-python-datamodel-object"><span class="std std-ref">Object</span></a> interface.</p>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.AuxDevice.detach">
<code class="sig-name descname">detach</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.AuxDevice.detach" title="Permalink to this definition"></a></dt>
<dd><p>This method implements the <a class="reference internal" href="#api-python-datamodel-object"><span class="std std-ref">Object</span></a> interface.</p>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.AuxDevice.clone">
<code class="sig-name descname">clone</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.AuxDevice.clone" title="Permalink to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Return type</dt>
<dd class="field-odd"><p>A cloned AuxDevice.</p>
</dd>
</dl>
<p>Returns a new instance that is a clone of the current instance. Child
objects are being ignored.</p>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.AuxDevice.updateChild">
<code class="sig-name descname">updateChild</code><span class="sig-paren">(</span><em class="sig-param">ref</em><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.AuxDevice.updateChild" title="Permalink to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>ref</strong> A child object derived from class Object.</p>
</dd>
<dt class="field-even">Return type</dt>
<dd class="field-even"><p>A Boolean flag indicating success with True, False otherwise</p>
</dd>
</dl>
<p>This method takes the passed reference object and searches for a child
with the same publicID (if derived from <a class="reference internal" href="#api-python-datamodel-publicobject"><span class="std std-ref">PublicObject</span></a>)
or the same index (if derived from <a class="reference internal" href="#api-python-datamodel-object"><span class="std std-ref">Object</span></a>).
The the child was found the reference objects attributes are copied to
the child object. Children of child are being ignored during this operation.
This method implements the <a class="reference internal" href="#api-python-datamodel-publicobject"><span class="std std-ref">PublicObject</span></a> interface.</p>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.AuxDevice.accept">
<code class="sig-name descname">accept</code><span class="sig-paren">(</span><em class="sig-param">visitor</em><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.AuxDevice.accept" title="Permalink to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>visitor</strong> A visitor.</p>
</dd>
</dl>
<p>This method implements the <a class="reference internal" href="#api-python-datamodel-publicobject"><span class="std std-ref">PublicObject</span></a> interface.</p>
</dd></dl>
</dd></dl>
</div>
<div class="section" id="auxsource">
<span id="api-python-datamodel-auxsource"></span><h3>AuxSource<a class="headerlink" href="#auxsource" title="Permalink to this headline"></a></h3>
<dl class="class">
<dt id="seiscomp.datamodel.AuxSource">
<em class="property">class </em><code class="sig-prename descclassname">seiscomp.datamodel.</code><code class="sig-name descname">AuxSource</code><a class="headerlink" href="#seiscomp.datamodel.AuxSource" title="Permalink to this definition"></a></dt>
<dd><p>Inherits <a class="reference internal" href="#api-python-datamodel-object"><span class="std std-ref">Object</span></a>.</p>
<p>This type describes a channel of an auxilliary device</p>
<p><strong>Parents</strong>:</p>
<ul class="simple">
<li><p><code class="docutils literal notranslate"><span class="pre">auxDevice</span></code> <a class="reference internal" href="#api-python-datamodel-auxdevice"><span class="std std-ref">AuxDevice</span></a></p></li>
</ul>
<p><strong>Attributes</strong>:</p>
<ul class="simple">
<li><p><code class="docutils literal notranslate"><span class="pre">name</span></code> string</p></li>
<li><p><code class="docutils literal notranslate"><span class="pre">description</span></code> string</p></li>
<li><p><code class="docutils literal notranslate"><span class="pre">unit</span></code> string</p></li>
<li><p><code class="docutils literal notranslate"><span class="pre">conversion</span></code> string</p></li>
<li><p><code class="docutils literal notranslate"><span class="pre">sampleRateNumerator</span></code> int (optional)</p></li>
<li><p><code class="docutils literal notranslate"><span class="pre">sampleRateDenominator</span></code> int (optional)</p></li>
<li><p><code class="docutils literal notranslate"><span class="pre">remark</span></code> <a class="reference internal" href="#api-python-datamodel-blob"><span class="std std-ref">Blob</span></a> (optional)</p></li>
</ul>
<p><strong>Methods</strong>:</p>
<dl class="method">
<dt id="seiscomp.datamodel.AuxSource.Cast">
<em class="property">static </em><code class="sig-name descname">Cast</code><span class="sig-paren">(</span><em class="sig-param">obj</em><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.AuxSource.Cast" title="Permalink to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>obj</strong> The object to be casted.</p>
</dd>
<dt class="field-even">Return type</dt>
<dd class="field-even"><p>An object of type AuxSource if the cast was successful,
None otherwise.</p>
</dd>
</dl>
<p>Cast an arbitrary object to AuxSource if the internal wrapped
representation is an AuxSource object. The cast is important if
instances of type <a class="reference internal" href="#api-python-datamodel-object"><span class="std std-ref">Object</span></a>
are passed to methods which need access to the real type.</p>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.AuxSource.equal">
<code class="sig-name descname">equal</code><span class="sig-paren">(</span><em class="sig-param">other</em><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.AuxSource.equal" title="Permalink to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>other</strong> Another object of type AuxSource to compare this
instance to</p>
</dd>
<dt class="field-even">Return type</dt>
<dd class="field-even"><p>A Boolean value indicating True if both objects are equal or
False otherwise.</p>
</dd>
</dl>
<p>Compares two objects without its child objects. Both objects are compared
by value.</p>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.AuxSource.index">
<code class="sig-name descname">index</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.AuxSource.index" title="Permalink to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Return type</dt>
<dd class="field-odd"><p><p>The objects index of type AuxSourceIndex.</p>
<p>Returns the objects index which is also used for the database as unique
constraint.</p>
</p>
</dd>
</dl>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.AuxSource.equalIndex">
<code class="sig-name descname">equalIndex</code><span class="sig-paren">(</span><em class="sig-param">lhs</em><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.AuxSource.equalIndex" title="Permalink to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>lhs</strong> <a class="reference internal" href="#api-python-datamodel-auxsource"><span class="std std-ref">AuxSource</span></a></p>
</dd>
<dt class="field-even">Return type</dt>
<dd class="field-even"><p>A Boolean value indicating True if both indexes are equal or
False otherwise.</p>
</dd>
</dl>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.AuxSource.setName">
<code class="sig-name descname">setName</code><span class="sig-paren">(</span><em class="sig-param">name</em><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.AuxSource.setName" title="Permalink to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>name</strong> string</p>
</dd>
</dl>
<p>Referred from network/station/auxStream/&#64;source</p>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.AuxSource.name">
<code class="sig-name descname">name</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.AuxSource.name" title="Permalink to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Return type</dt>
<dd class="field-odd"><p>string</p>
</dd>
</dl>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.AuxSource.setDescription">
<code class="sig-name descname">setDescription</code><span class="sig-paren">(</span><em class="sig-param">description</em><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.AuxSource.setDescription" title="Permalink to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>description</strong> string</p>
</dd>
</dl>
<p>Description</p>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.AuxSource.description">
<code class="sig-name descname">description</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.AuxSource.description" title="Permalink to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Return type</dt>
<dd class="field-odd"><p>string</p>
</dd>
</dl>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.AuxSource.setUnit">
<code class="sig-name descname">setUnit</code><span class="sig-paren">(</span><em class="sig-param">unit</em><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.AuxSource.setUnit" title="Permalink to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>unit</strong> string</p>
</dd>
</dl>
<p>Unit of mesurement</p>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.AuxSource.unit">
<code class="sig-name descname">unit</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.AuxSource.unit" title="Permalink to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Return type</dt>
<dd class="field-odd"><p>string</p>
</dd>
</dl>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.AuxSource.setConversion">
<code class="sig-name descname">setConversion</code><span class="sig-paren">(</span><em class="sig-param">conversion</em><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.AuxSource.setConversion" title="Permalink to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>conversion</strong> string</p>
</dd>
</dl>
<p>Conversion formula from counts to unit of measurement</p>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.AuxSource.conversion">
<code class="sig-name descname">conversion</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.AuxSource.conversion" title="Permalink to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Return type</dt>
<dd class="field-odd"><p>string</p>
</dd>
</dl>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.AuxSource.setSampleRateNumerator">
<code class="sig-name descname">setSampleRateNumerator</code><span class="sig-paren">(</span><em class="sig-param">sampleRateNumerator</em><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.AuxSource.setSampleRateNumerator" title="Permalink to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>sampleRateNumerator</strong> int</p>
</dd>
</dl>
<p>Output sample rate (numerator); referred from
network/station/AuxStream/&#64;sampleRateNumerator</p>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.AuxSource.sampleRateNumerator">
<code class="sig-name descname">sampleRateNumerator</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.AuxSource.sampleRateNumerator" title="Permalink to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Return type</dt>
<dd class="field-odd"><p>int</p>
</dd>
</dl>
<div class="admonition note">
<p class="admonition-title">Note</p>
<p>As this attribute is optional, this method throws a ValueError if
the value of the attribute is not set.</p>
</div>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.AuxSource.setSampleRateDenominator">
<code class="sig-name descname">setSampleRateDenominator</code><span class="sig-paren">(</span><em class="sig-param">sampleRateDenominator</em><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.AuxSource.setSampleRateDenominator" title="Permalink to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>sampleRateDenominator</strong> int</p>
</dd>
</dl>
<p>Output sample rate (denominator); referred from
network/station/AuxStream/&#64;sampleRateDenominator</p>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.AuxSource.sampleRateDenominator">
<code class="sig-name descname">sampleRateDenominator</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.AuxSource.sampleRateDenominator" title="Permalink to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Return type</dt>
<dd class="field-odd"><p>int</p>
</dd>
</dl>
<div class="admonition note">
<p class="admonition-title">Note</p>
<p>As this attribute is optional, this method throws a ValueError if
the value of the attribute is not set.</p>
</div>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.AuxSource.setRemark">
<code class="sig-name descname">setRemark</code><span class="sig-paren">(</span><em class="sig-param">remark</em><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.AuxSource.setRemark" title="Permalink to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>remark</strong> <a class="reference internal" href="#api-python-datamodel-blob"><span class="std std-ref">Blob</span></a></p>
</dd>
</dl>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.AuxSource.remark">
<code class="sig-name descname">remark</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.AuxSource.remark" title="Permalink to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Return type</dt>
<dd class="field-odd"><p><a class="reference internal" href="#api-python-datamodel-blob"><span class="std std-ref">Blob</span></a></p>
</dd>
</dl>
<div class="admonition note">
<p class="admonition-title">Note</p>
<p>As this attribute is optional, this method throws a ValueError if
the value of the attribute is not set.</p>
</div>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.AuxSource.auxDevice">
<code class="sig-name descname">auxDevice</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.AuxSource.auxDevice" title="Permalink to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Return type</dt>
<dd class="field-odd"><p><a class="reference internal" href="#seiscomp.datamodel.AuxDevice" title="seiscomp.datamodel.AuxDevice">AuxDevice</a></p>
</dd>
</dl>
<p>Returns the parent AuxDevice if available. Returns None
if the parent is not a AuxDevice. This is a convenience wrapper
for parent().</p>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.AuxSource.assign">
<code class="sig-name descname">assign</code><span class="sig-paren">(</span><em class="sig-param">other</em><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.AuxSource.assign" title="Permalink to this definition"></a></dt>
<dd><p>This method implements the <a class="reference internal" href="#api-python-datamodel-object"><span class="std std-ref">Object</span></a> interface.</p>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.AuxSource.attachTo">
<code class="sig-name descname">attachTo</code><span class="sig-paren">(</span><em class="sig-param">parent</em><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.AuxSource.attachTo" title="Permalink to this definition"></a></dt>
<dd><p>This method implements the <a class="reference internal" href="#api-python-datamodel-object"><span class="std std-ref">Object</span></a> interface.</p>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.AuxSource.detachFrom">
<code class="sig-name descname">detachFrom</code><span class="sig-paren">(</span><em class="sig-param">parent</em><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.AuxSource.detachFrom" title="Permalink to this definition"></a></dt>
<dd><p>This method implements the <a class="reference internal" href="#api-python-datamodel-object"><span class="std std-ref">Object</span></a> interface.</p>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.AuxSource.detach">
<code class="sig-name descname">detach</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.AuxSource.detach" title="Permalink to this definition"></a></dt>
<dd><p>This method implements the <a class="reference internal" href="#api-python-datamodel-object"><span class="std std-ref">Object</span></a> interface.</p>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.AuxSource.clone">
<code class="sig-name descname">clone</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.AuxSource.clone" title="Permalink to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Return type</dt>
<dd class="field-odd"><p>A cloned AuxSource.</p>
</dd>
</dl>
<p>Returns a new instance that is a clone of the current instance. Child
objects are being ignored.</p>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.AuxSource.accept">
<code class="sig-name descname">accept</code><span class="sig-paren">(</span><em class="sig-param">visitor</em><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.AuxSource.accept" title="Permalink to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>visitor</strong> A visitor.</p>
</dd>
</dl>
<p>This method implements the <a class="reference internal" href="#api-python-datamodel-publicobject"><span class="std std-ref">PublicObject</span></a> interface.</p>
</dd></dl>
</dd></dl>
</div>
<div class="section" id="auxstream">
<span id="api-python-datamodel-auxstream"></span><h3>AuxStream<a class="headerlink" href="#auxstream" title="Permalink to this headline"></a></h3>
<dl class="class">
<dt id="seiscomp.datamodel.AuxStream">
<em class="property">class </em><code class="sig-prename descclassname">seiscomp.datamodel.</code><code class="sig-name descname">AuxStream</code><a class="headerlink" href="#seiscomp.datamodel.AuxStream" title="Permalink to this definition"></a></dt>
<dd><p>Inherits <a class="reference internal" href="#api-python-datamodel-object"><span class="std std-ref">Object</span></a>.</p>
<p>This type describes a stream (channel) without defined frequency response</p>
<p><strong>Parents</strong>:</p>
<ul class="simple">
<li><p><code class="docutils literal notranslate"><span class="pre">sensorLocation</span></code> <a class="reference internal" href="#api-python-datamodel-sensorlocation"><span class="std std-ref">SensorLocation</span></a></p></li>
</ul>
<p><strong>Attributes</strong>:</p>
<ul class="simple">
<li><p><code class="docutils literal notranslate"><span class="pre">code</span></code> string</p></li>
<li><p><code class="docutils literal notranslate"><span class="pre">start</span></code> seiscomp.core.Time</p></li>
<li><p><code class="docutils literal notranslate"><span class="pre">end</span></code> seiscomp.core.Time (optional)</p></li>
<li><p><code class="docutils literal notranslate"><span class="pre">device</span></code> string</p></li>
<li><p><code class="docutils literal notranslate"><span class="pre">deviceSerialNumber</span></code> string</p></li>
<li><p><code class="docutils literal notranslate"><span class="pre">source</span></code> string</p></li>
<li><p><code class="docutils literal notranslate"><span class="pre">format</span></code> string</p></li>
<li><p><code class="docutils literal notranslate"><span class="pre">flags</span></code> string</p></li>
<li><p><code class="docutils literal notranslate"><span class="pre">restricted</span></code> boolean (optional)</p></li>
<li><p><code class="docutils literal notranslate"><span class="pre">shared</span></code> boolean (optional)</p></li>
</ul>
<p><strong>Methods</strong>:</p>
<dl class="method">
<dt id="seiscomp.datamodel.AuxStream.Cast">
<em class="property">static </em><code class="sig-name descname">Cast</code><span class="sig-paren">(</span><em class="sig-param">obj</em><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.AuxStream.Cast" title="Permalink to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>obj</strong> The object to be casted.</p>
</dd>
<dt class="field-even">Return type</dt>
<dd class="field-even"><p>An object of type AuxStream if the cast was successful,
None otherwise.</p>
</dd>
</dl>
<p>Cast an arbitrary object to AuxStream if the internal wrapped
representation is an AuxStream object. The cast is important if
instances of type <a class="reference internal" href="#api-python-datamodel-object"><span class="std std-ref">Object</span></a>
are passed to methods which need access to the real type.</p>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.AuxStream.equal">
<code class="sig-name descname">equal</code><span class="sig-paren">(</span><em class="sig-param">other</em><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.AuxStream.equal" title="Permalink to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>other</strong> Another object of type AuxStream to compare this
instance to</p>
</dd>
<dt class="field-even">Return type</dt>
<dd class="field-even"><p>A Boolean value indicating True if both objects are equal or
False otherwise.</p>
</dd>
</dl>
<p>Compares two objects without its child objects. Both objects are compared
by value.</p>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.AuxStream.index">
<code class="sig-name descname">index</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.AuxStream.index" title="Permalink to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Return type</dt>
<dd class="field-odd"><p><p>The objects index of type AuxStreamIndex.</p>
<p>Returns the objects index which is also used for the database as unique
constraint.</p>
</p>
</dd>
</dl>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.AuxStream.equalIndex">
<code class="sig-name descname">equalIndex</code><span class="sig-paren">(</span><em class="sig-param">lhs</em><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.AuxStream.equalIndex" title="Permalink to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>lhs</strong> <a class="reference internal" href="#api-python-datamodel-auxstream"><span class="std std-ref">AuxStream</span></a></p>
</dd>
<dt class="field-even">Return type</dt>
<dd class="field-even"><p>A Boolean value indicating True if both indexes are equal or
False otherwise.</p>
</dd>
</dl>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.AuxStream.setCode">
<code class="sig-name descname">setCode</code><span class="sig-paren">(</span><em class="sig-param">code</em><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.AuxStream.setCode" title="Permalink to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>code</strong> string</p>
</dd>
</dl>
<p>Stream code (52.04)</p>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.AuxStream.code">
<code class="sig-name descname">code</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.AuxStream.code" title="Permalink to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Return type</dt>
<dd class="field-odd"><p>string</p>
</dd>
</dl>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.AuxStream.setStart">
<code class="sig-name descname">setStart</code><span class="sig-paren">(</span><em class="sig-param">start</em><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.AuxStream.setStart" title="Permalink to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>start</strong> seiscomp.core.Time</p>
</dd>
</dl>
<p>Start of epoch in ISO datetime format (52.22)</p>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.AuxStream.start">
<code class="sig-name descname">start</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.AuxStream.start" title="Permalink to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Return type</dt>
<dd class="field-odd"><p>seiscomp.core.Time</p>
</dd>
</dl>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.AuxStream.setEnd">
<code class="sig-name descname">setEnd</code><span class="sig-paren">(</span><em class="sig-param">end</em><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.AuxStream.setEnd" title="Permalink to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>end</strong> seiscomp.core.Time</p>
</dd>
</dl>
<p>End of epoch (52.23)</p>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.AuxStream.end">
<code class="sig-name descname">end</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.AuxStream.end" title="Permalink to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Return type</dt>
<dd class="field-odd"><p>seiscomp.core.Time</p>
</dd>
</dl>
<div class="admonition note">
<p class="admonition-title">Note</p>
<p>As this attribute is optional, this method throws a ValueError if
the value of the attribute is not set.</p>
</div>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.AuxStream.setDevice">
<code class="sig-name descname">setDevice</code><span class="sig-paren">(</span><em class="sig-param">device</em><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.AuxStream.setDevice" title="Permalink to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>device</strong> string</p>
</dd>
</dl>
<p>Reference to auxDevice/&#64;publicID</p>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.AuxStream.device">
<code class="sig-name descname">device</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.AuxStream.device" title="Permalink to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Return type</dt>
<dd class="field-odd"><p>string</p>
</dd>
</dl>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.AuxStream.setDeviceSerialNumber">
<code class="sig-name descname">setDeviceSerialNumber</code><span class="sig-paren">(</span><em class="sig-param">deviceSerialNumber</em><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.AuxStream.setDeviceSerialNumber" title="Permalink to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>deviceSerialNumber</strong> string</p>
</dd>
</dl>
<p>Serial number of device</p>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.AuxStream.deviceSerialNumber">
<code class="sig-name descname">deviceSerialNumber</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.AuxStream.deviceSerialNumber" title="Permalink to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Return type</dt>
<dd class="field-odd"><p>string</p>
</dd>
</dl>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.AuxStream.setSource">
<code class="sig-name descname">setSource</code><span class="sig-paren">(</span><em class="sig-param">source</em><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.AuxStream.setSource" title="Permalink to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>source</strong> string</p>
</dd>
</dl>
<p>Reference to auxSource/&#64;name</p>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.AuxStream.source">
<code class="sig-name descname">source</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.AuxStream.source" title="Permalink to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Return type</dt>
<dd class="field-odd"><p>string</p>
</dd>
</dl>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.AuxStream.setFormat">
<code class="sig-name descname">setFormat</code><span class="sig-paren">(</span><em class="sig-param">format</em><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.AuxStream.setFormat" title="Permalink to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>format</strong> string</p>
</dd>
</dl>
<p>Data format, eg.: “steim1”, “steim2”, “mseedN” (N = encoding format
in blockette 1000)</p>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.AuxStream.format">
<code class="sig-name descname">format</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.AuxStream.format" title="Permalink to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Return type</dt>
<dd class="field-odd"><p>string</p>
</dd>
</dl>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.AuxStream.setFlags">
<code class="sig-name descname">setFlags</code><span class="sig-paren">(</span><em class="sig-param">flags</em><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.AuxStream.setFlags" title="Permalink to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>flags</strong> string</p>
</dd>
</dl>
<p>Channel flags (52.21)</p>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.AuxStream.flags">
<code class="sig-name descname">flags</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.AuxStream.flags" title="Permalink to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Return type</dt>
<dd class="field-odd"><p>string</p>
</dd>
</dl>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.AuxStream.setRestricted">
<code class="sig-name descname">setRestricted</code><span class="sig-paren">(</span><em class="sig-param">restricted</em><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.AuxStream.setRestricted" title="Permalink to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>restricted</strong> boolean</p>
</dd>
</dl>
<p>Whether the stream is “restricted”</p>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.AuxStream.restricted">
<code class="sig-name descname">restricted</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.AuxStream.restricted" title="Permalink to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Return type</dt>
<dd class="field-odd"><p>boolean</p>
</dd>
</dl>
<div class="admonition note">
<p class="admonition-title">Note</p>
<p>As this attribute is optional, this method throws a ValueError if
the value of the attribute is not set.</p>
</div>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.AuxStream.setShared">
<code class="sig-name descname">setShared</code><span class="sig-paren">(</span><em class="sig-param">shared</em><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.AuxStream.setShared" title="Permalink to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>shared</strong> boolean</p>
</dd>
</dl>
<p>Whether the metadata is synchronized with other datacenters</p>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.AuxStream.shared">
<code class="sig-name descname">shared</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.AuxStream.shared" title="Permalink to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Return type</dt>
<dd class="field-odd"><p>boolean</p>
</dd>
</dl>
<div class="admonition note">
<p class="admonition-title">Note</p>
<p>As this attribute is optional, this method throws a ValueError if
the value of the attribute is not set.</p>
</div>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.AuxStream.sensorLocation">
<code class="sig-name descname">sensorLocation</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.AuxStream.sensorLocation" title="Permalink to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Return type</dt>
<dd class="field-odd"><p><a class="reference internal" href="#seiscomp.datamodel.SensorLocation" title="seiscomp.datamodel.SensorLocation">SensorLocation</a></p>
</dd>
</dl>
<p>Returns the parent SensorLocation if available. Returns None
if the parent is not a SensorLocation. This is a convenience wrapper
for parent().</p>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.AuxStream.assign">
<code class="sig-name descname">assign</code><span class="sig-paren">(</span><em class="sig-param">other</em><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.AuxStream.assign" title="Permalink to this definition"></a></dt>
<dd><p>This method implements the <a class="reference internal" href="#api-python-datamodel-object"><span class="std std-ref">Object</span></a> interface.</p>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.AuxStream.attachTo">
<code class="sig-name descname">attachTo</code><span class="sig-paren">(</span><em class="sig-param">parent</em><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.AuxStream.attachTo" title="Permalink to this definition"></a></dt>
<dd><p>This method implements the <a class="reference internal" href="#api-python-datamodel-object"><span class="std std-ref">Object</span></a> interface.</p>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.AuxStream.detachFrom">
<code class="sig-name descname">detachFrom</code><span class="sig-paren">(</span><em class="sig-param">parent</em><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.AuxStream.detachFrom" title="Permalink to this definition"></a></dt>
<dd><p>This method implements the <a class="reference internal" href="#api-python-datamodel-object"><span class="std std-ref">Object</span></a> interface.</p>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.AuxStream.detach">
<code class="sig-name descname">detach</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.AuxStream.detach" title="Permalink to this definition"></a></dt>
<dd><p>This method implements the <a class="reference internal" href="#api-python-datamodel-object"><span class="std std-ref">Object</span></a> interface.</p>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.AuxStream.clone">
<code class="sig-name descname">clone</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.AuxStream.clone" title="Permalink to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Return type</dt>
<dd class="field-odd"><p>A cloned AuxStream.</p>
</dd>
</dl>
<p>Returns a new instance that is a clone of the current instance. Child
objects are being ignored.</p>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.AuxStream.accept">
<code class="sig-name descname">accept</code><span class="sig-paren">(</span><em class="sig-param">visitor</em><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.AuxStream.accept" title="Permalink to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>visitor</strong> A visitor.</p>
</dd>
</dl>
<p>This method implements the <a class="reference internal" href="#api-python-datamodel-publicobject"><span class="std std-ref">PublicObject</span></a> interface.</p>
</dd></dl>
</dd></dl>
</div>
<div class="section" id="axis">
<span id="api-python-datamodel-axis"></span><h3>Axis<a class="headerlink" href="#axis" title="Permalink to this headline"></a></h3>
<dl class="class">
<dt id="seiscomp.datamodel.Axis">
<em class="property">class </em><code class="sig-prename descclassname">seiscomp.datamodel.</code><code class="sig-name descname">Axis</code><a class="headerlink" href="#seiscomp.datamodel.Axis" title="Permalink to this definition"></a></dt>
<dd><p>Inherits <a class="reference internal" href="#api-python-datamodel-object"><span class="std std-ref">Object</span></a>.</p>
<p>This class describes an eigenvector of a moment tensor expressed in its
principal-axes system. It uses the angles azimuth, plunge, and the
eigenvalue length.</p>
<p><strong>Attributes</strong>:</p>
<ul class="simple">
<li><p><code class="docutils literal notranslate"><span class="pre">azimuth</span></code> <a class="reference internal" href="#api-python-datamodel-realquantity"><span class="std std-ref">RealQuantity</span></a></p></li>
<li><p><code class="docutils literal notranslate"><span class="pre">plunge</span></code> <a class="reference internal" href="#api-python-datamodel-realquantity"><span class="std std-ref">RealQuantity</span></a></p></li>
<li><p><code class="docutils literal notranslate"><span class="pre">length</span></code> <a class="reference internal" href="#api-python-datamodel-realquantity"><span class="std std-ref">RealQuantity</span></a></p></li>
</ul>
<p><strong>Used by</strong>:</p>
<ul class="simple">
<li><p><a class="reference internal" href="#seiscomp.datamodel.PrincipalAxes.tAxis" title="seiscomp.datamodel.PrincipalAxes.tAxis"><code class="xref py py-func docutils literal notranslate"><span class="pre">PrincipalAxes.tAxis()</span></code></a></p></li>
<li><p><a class="reference internal" href="#seiscomp.datamodel.PrincipalAxes.pAxis" title="seiscomp.datamodel.PrincipalAxes.pAxis"><code class="xref py py-func docutils literal notranslate"><span class="pre">PrincipalAxes.pAxis()</span></code></a></p></li>
<li><p><a class="reference internal" href="#seiscomp.datamodel.PrincipalAxes.nAxis" title="seiscomp.datamodel.PrincipalAxes.nAxis"><code class="xref py py-func docutils literal notranslate"><span class="pre">PrincipalAxes.nAxis()</span></code></a></p></li>
</ul>
<p><strong>Methods</strong>:</p>
<dl class="method">
<dt id="seiscomp.datamodel.Axis.Cast">
<em class="property">static </em><code class="sig-name descname">Cast</code><span class="sig-paren">(</span><em class="sig-param">obj</em><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.Axis.Cast" title="Permalink to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>obj</strong> The object to be casted.</p>
</dd>
<dt class="field-even">Return type</dt>
<dd class="field-even"><p>An object of type Axis if the cast was successful,
None otherwise.</p>
</dd>
</dl>
<p>Cast an arbitrary object to Axis if the internal wrapped
representation is an Axis object. The cast is important if
instances of type <a class="reference internal" href="#api-python-datamodel-object"><span class="std std-ref">Object</span></a>
are passed to methods which need access to the real type.</p>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.Axis.equal">
<code class="sig-name descname">equal</code><span class="sig-paren">(</span><em class="sig-param">other</em><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.Axis.equal" title="Permalink to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>other</strong> Another object of type Axis to compare this
instance to</p>
</dd>
<dt class="field-even">Return type</dt>
<dd class="field-even"><p>A Boolean value indicating True if both objects are equal or
False otherwise.</p>
</dd>
</dl>
<p>Compares two objects without its child objects. Both objects are compared
by value.</p>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.Axis.setAzimuth">
<code class="sig-name descname">setAzimuth</code><span class="sig-paren">(</span><em class="sig-param">azimuth</em><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.Axis.setAzimuth" title="Permalink to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>azimuth</strong> <a class="reference internal" href="#api-python-datamodel-realquantity"><span class="std std-ref">RealQuantity</span></a></p>
</dd>
</dl>
<p>Azimuth of eigenvector of moment tensor expressed in principal-axes system.
Measured clockwise
from South-North direction at epicenter in degrees.</p>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.Axis.azimuth">
<code class="sig-name descname">azimuth</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.Axis.azimuth" title="Permalink to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Return type</dt>
<dd class="field-odd"><p><a class="reference internal" href="#api-python-datamodel-realquantity"><span class="std std-ref">RealQuantity</span></a></p>
</dd>
</dl>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.Axis.setPlunge">
<code class="sig-name descname">setPlunge</code><span class="sig-paren">(</span><em class="sig-param">plunge</em><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.Axis.setPlunge" title="Permalink to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>plunge</strong> <a class="reference internal" href="#api-python-datamodel-realquantity"><span class="std std-ref">RealQuantity</span></a></p>
</dd>
</dl>
<p>Plunge of eigenvector of moment tensor expressed in principal-axes system.
Measured against downward
vertical direction at epicenter in degrees.</p>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.Axis.plunge">
<code class="sig-name descname">plunge</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.Axis.plunge" title="Permalink to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Return type</dt>
<dd class="field-odd"><p><a class="reference internal" href="#api-python-datamodel-realquantity"><span class="std std-ref">RealQuantity</span></a></p>
</dd>
</dl>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.Axis.setLength">
<code class="sig-name descname">setLength</code><span class="sig-paren">(</span><em class="sig-param">length</em><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.Axis.setLength" title="Permalink to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>length</strong> <a class="reference internal" href="#api-python-datamodel-realquantity"><span class="std std-ref">RealQuantity</span></a></p>
</dd>
</dl>
<p>Eigenvalue of moment tensor expressed in principal-axes system in Nm.</p>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.Axis.length">
<code class="sig-name descname">length</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.Axis.length" title="Permalink to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Return type</dt>
<dd class="field-odd"><p><a class="reference internal" href="#api-python-datamodel-realquantity"><span class="std std-ref">RealQuantity</span></a></p>
</dd>
</dl>
</dd></dl>
</dd></dl>
</div>
<div class="section" id="blob">
<span id="api-python-datamodel-blob"></span><h3>Blob<a class="headerlink" href="#blob" title="Permalink to this headline"></a></h3>
<dl class="class">
<dt id="seiscomp.datamodel.Blob">
<em class="property">class </em><code class="sig-prename descclassname">seiscomp.datamodel.</code><code class="sig-name descname">Blob</code><a class="headerlink" href="#seiscomp.datamodel.Blob" title="Permalink to this definition"></a></dt>
<dd><p>Inherits <a class="reference internal" href="#api-python-datamodel-object"><span class="std std-ref">Object</span></a>.</p>
<p><strong>Attributes</strong>:</p>
<ul class="simple">
<li><p><code class="docutils literal notranslate"><span class="pre">content</span></code> string</p></li>
</ul>
<p><strong>Used by</strong>:</p>
<ul class="simple">
<li><p><a class="reference internal" href="#seiscomp.datamodel.AuxDevice.remark" title="seiscomp.datamodel.AuxDevice.remark"><code class="xref py py-func docutils literal notranslate"><span class="pre">AuxDevice.remark()</span></code></a></p></li>
<li><p><a class="reference internal" href="#seiscomp.datamodel.AuxSource.remark" title="seiscomp.datamodel.AuxSource.remark"><code class="xref py py-func docutils literal notranslate"><span class="pre">AuxSource.remark()</span></code></a></p></li>
<li><p><a class="reference internal" href="#seiscomp.datamodel.Datalogger.remark" title="seiscomp.datamodel.Datalogger.remark"><code class="xref py py-func docutils literal notranslate"><span class="pre">Datalogger.remark()</span></code></a></p></li>
<li><p><a class="reference internal" href="#seiscomp.datamodel.DataloggerCalibration.remark" title="seiscomp.datamodel.DataloggerCalibration.remark"><code class="xref py py-func docutils literal notranslate"><span class="pre">DataloggerCalibration.remark()</span></code></a></p></li>
<li><p><a class="reference internal" href="#seiscomp.datamodel.Decimation.analogueFilterChain" title="seiscomp.datamodel.Decimation.analogueFilterChain"><code class="xref py py-func docutils literal notranslate"><span class="pre">Decimation.analogueFilterChain()</span></code></a></p></li>
<li><p><a class="reference internal" href="#seiscomp.datamodel.Decimation.digitalFilterChain" title="seiscomp.datamodel.Decimation.digitalFilterChain"><code class="xref py py-func docutils literal notranslate"><span class="pre">Decimation.digitalFilterChain()</span></code></a></p></li>
<li><p><a class="reference internal" href="#seiscomp.datamodel.Network.remark" title="seiscomp.datamodel.Network.remark"><code class="xref py py-func docutils literal notranslate"><span class="pre">Network.remark()</span></code></a></p></li>
<li><p><a class="reference internal" href="#seiscomp.datamodel.ResponseFAP.remark" title="seiscomp.datamodel.ResponseFAP.remark"><code class="xref py py-func docutils literal notranslate"><span class="pre">ResponseFAP.remark()</span></code></a></p></li>
<li><p><a class="reference internal" href="#seiscomp.datamodel.ResponseFIR.remark" title="seiscomp.datamodel.ResponseFIR.remark"><code class="xref py py-func docutils literal notranslate"><span class="pre">ResponseFIR.remark()</span></code></a></p></li>
<li><p><a class="reference internal" href="#seiscomp.datamodel.ResponseIIR.remark" title="seiscomp.datamodel.ResponseIIR.remark"><code class="xref py py-func docutils literal notranslate"><span class="pre">ResponseIIR.remark()</span></code></a></p></li>
<li><p><a class="reference internal" href="#seiscomp.datamodel.ResponsePAZ.remark" title="seiscomp.datamodel.ResponsePAZ.remark"><code class="xref py py-func docutils literal notranslate"><span class="pre">ResponsePAZ.remark()</span></code></a></p></li>
<li><p><a class="reference internal" href="#seiscomp.datamodel.ResponsePolynomial.remark" title="seiscomp.datamodel.ResponsePolynomial.remark"><code class="xref py py-func docutils literal notranslate"><span class="pre">ResponsePolynomial.remark()</span></code></a></p></li>
<li><p><a class="reference internal" href="#seiscomp.datamodel.Sensor.remark" title="seiscomp.datamodel.Sensor.remark"><code class="xref py py-func docutils literal notranslate"><span class="pre">Sensor.remark()</span></code></a></p></li>
<li><p><a class="reference internal" href="#seiscomp.datamodel.SensorCalibration.remark" title="seiscomp.datamodel.SensorCalibration.remark"><code class="xref py py-func docutils literal notranslate"><span class="pre">SensorCalibration.remark()</span></code></a></p></li>
<li><p><a class="reference internal" href="#seiscomp.datamodel.Station.remark" title="seiscomp.datamodel.Station.remark"><code class="xref py py-func docutils literal notranslate"><span class="pre">Station.remark()</span></code></a></p></li>
</ul>
<p><strong>Methods</strong>:</p>
<dl class="method">
<dt id="seiscomp.datamodel.Blob.Cast">
<em class="property">static </em><code class="sig-name descname">Cast</code><span class="sig-paren">(</span><em class="sig-param">obj</em><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.Blob.Cast" title="Permalink to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>obj</strong> The object to be casted.</p>
</dd>
<dt class="field-even">Return type</dt>
<dd class="field-even"><p>An object of type Blob if the cast was successful,
None otherwise.</p>
</dd>
</dl>
<p>Cast an arbitrary object to Blob if the internal wrapped
representation is an Blob object. The cast is important if
instances of type <a class="reference internal" href="#api-python-datamodel-object"><span class="std std-ref">Object</span></a>
are passed to methods which need access to the real type.</p>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.Blob.equal">
<code class="sig-name descname">equal</code><span class="sig-paren">(</span><em class="sig-param">other</em><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.Blob.equal" title="Permalink to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>other</strong> Another object of type Blob to compare this
instance to</p>
</dd>
<dt class="field-even">Return type</dt>
<dd class="field-even"><p>A Boolean value indicating True if both objects are equal or
False otherwise.</p>
</dd>
</dl>
<p>Compares two objects without its child objects. Both objects are compared
by value.</p>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.Blob.setContent">
<code class="sig-name descname">setContent</code><span class="sig-paren">(</span><em class="sig-param">content</em><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.Blob.setContent" title="Permalink to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>content</strong> string</p>
</dd>
</dl>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.Blob.content">
<code class="sig-name descname">content</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.Blob.content" title="Permalink to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Return type</dt>
<dd class="field-odd"><p>string</p>
</dd>
</dl>
</dd></dl>
</dd></dl>
</div>
<div class="section" id="comment">
<span id="api-python-datamodel-comment"></span><h3>Comment<a class="headerlink" href="#comment" title="Permalink to this headline"></a></h3>
<dl class="class">
<dt id="seiscomp.datamodel.Comment">
<em class="property">class </em><code class="sig-prename descclassname">seiscomp.datamodel.</code><code class="sig-name descname">Comment</code><a class="headerlink" href="#seiscomp.datamodel.Comment" title="Permalink to this definition"></a></dt>
<dd><p>Inherits <a class="reference internal" href="#api-python-datamodel-object"><span class="std std-ref">Object</span></a>.</p>
<p>Comment holds information on comments to a resource as well as author and
creation time information.</p>
<p><strong>Parents</strong>:</p>
<ul class="simple">
<li><p><code class="docutils literal notranslate"><span class="pre">momentTensor</span></code> <a class="reference internal" href="#api-python-datamodel-momenttensor"><span class="std std-ref">MomentTensor</span></a></p></li>
<li><p><code class="docutils literal notranslate"><span class="pre">focalMechanism</span></code> <a class="reference internal" href="#api-python-datamodel-focalmechanism"><span class="std std-ref">FocalMechanism</span></a></p></li>
<li><p><code class="docutils literal notranslate"><span class="pre">amplitude</span></code> <a class="reference internal" href="#api-python-datamodel-amplitude"><span class="std std-ref">Amplitude</span></a></p></li>
<li><p><code class="docutils literal notranslate"><span class="pre">magnitude</span></code> <a class="reference internal" href="#api-python-datamodel-magnitude"><span class="std std-ref">Magnitude</span></a></p></li>
<li><p><code class="docutils literal notranslate"><span class="pre">stationMagnitude</span></code> <a class="reference internal" href="#api-python-datamodel-stationmagnitude"><span class="std std-ref">StationMagnitude</span></a></p></li>
<li><p><code class="docutils literal notranslate"><span class="pre">pick</span></code> <a class="reference internal" href="#api-python-datamodel-pick"><span class="std std-ref">Pick</span></a></p></li>
<li><p><code class="docutils literal notranslate"><span class="pre">event</span></code> <a class="reference internal" href="#api-python-datamodel-event"><span class="std std-ref">Event</span></a></p></li>
<li><p><code class="docutils literal notranslate"><span class="pre">origin</span></code> <a class="reference internal" href="#api-python-datamodel-origin"><span class="std std-ref">Origin</span></a></p></li>
<li><p><code class="docutils literal notranslate"><span class="pre">parameter</span></code> <a class="reference internal" href="#api-python-datamodel-parameter"><span class="std std-ref">Parameter</span></a></p></li>
<li><p><code class="docutils literal notranslate"><span class="pre">parameterSet</span></code> <a class="reference internal" href="#api-python-datamodel-parameterset"><span class="std std-ref">ParameterSet</span></a></p></li>
<li><p><code class="docutils literal notranslate"><span class="pre">stream</span></code> <a class="reference internal" href="#api-python-datamodel-stream"><span class="std std-ref">Stream</span></a></p></li>
<li><p><code class="docutils literal notranslate"><span class="pre">sensorLocation</span></code> <a class="reference internal" href="#api-python-datamodel-sensorlocation"><span class="std std-ref">SensorLocation</span></a></p></li>
<li><p><code class="docutils literal notranslate"><span class="pre">station</span></code> <a class="reference internal" href="#api-python-datamodel-station"><span class="std std-ref">Station</span></a></p></li>
<li><p><code class="docutils literal notranslate"><span class="pre">network</span></code> <a class="reference internal" href="#api-python-datamodel-network"><span class="std std-ref">Network</span></a></p></li>
</ul>
<p><strong>Attributes</strong>:</p>
<ul class="simple">
<li><p><code class="docutils literal notranslate"><span class="pre">text</span></code> string</p></li>
<li><p><code class="docutils literal notranslate"><span class="pre">id</span></code> string</p></li>
<li><p><code class="docutils literal notranslate"><span class="pre">start</span></code> seiscomp.core.Time (optional)</p></li>
<li><p><code class="docutils literal notranslate"><span class="pre">end</span></code> seiscomp.core.Time (optional)</p></li>
<li><p><code class="docutils literal notranslate"><span class="pre">creationInfo</span></code> <a class="reference internal" href="#api-python-datamodel-creationinfo"><span class="std std-ref">CreationInfo</span></a> (optional)</p></li>
</ul>
<p><strong>Methods</strong>:</p>
<dl class="method">
<dt id="seiscomp.datamodel.Comment.Cast">
<em class="property">static </em><code class="sig-name descname">Cast</code><span class="sig-paren">(</span><em class="sig-param">obj</em><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.Comment.Cast" title="Permalink to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>obj</strong> The object to be casted.</p>
</dd>
<dt class="field-even">Return type</dt>
<dd class="field-even"><p>An object of type Comment if the cast was successful,
None otherwise.</p>
</dd>
</dl>
<p>Cast an arbitrary object to Comment if the internal wrapped
representation is an Comment object. The cast is important if
instances of type <a class="reference internal" href="#api-python-datamodel-object"><span class="std std-ref">Object</span></a>
are passed to methods which need access to the real type.</p>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.Comment.equal">
<code class="sig-name descname">equal</code><span class="sig-paren">(</span><em class="sig-param">other</em><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.Comment.equal" title="Permalink to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>other</strong> Another object of type Comment to compare this
instance to</p>
</dd>
<dt class="field-even">Return type</dt>
<dd class="field-even"><p>A Boolean value indicating True if both objects are equal or
False otherwise.</p>
</dd>
</dl>
<p>Compares two objects without its child objects. Both objects are compared
by value.</p>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.Comment.index">
<code class="sig-name descname">index</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.Comment.index" title="Permalink to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Return type</dt>
<dd class="field-odd"><p><p>The objects index of type CommentIndex.</p>
<p>Returns the objects index which is also used for the database as unique
constraint.</p>
</p>
</dd>
</dl>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.Comment.equalIndex">
<code class="sig-name descname">equalIndex</code><span class="sig-paren">(</span><em class="sig-param">lhs</em><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.Comment.equalIndex" title="Permalink to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>lhs</strong> <a class="reference internal" href="#api-python-datamodel-comment"><span class="std std-ref">Comment</span></a></p>
</dd>
<dt class="field-even">Return type</dt>
<dd class="field-even"><p>A Boolean value indicating True if both indexes are equal or
False otherwise.</p>
</dd>
</dl>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.Comment.setText">
<code class="sig-name descname">setText</code><span class="sig-paren">(</span><em class="sig-param">text</em><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.Comment.setText" title="Permalink to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>text</strong> string</p>
</dd>
</dl>
<p>Text of comment.</p>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.Comment.text">
<code class="sig-name descname">text</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.Comment.text" title="Permalink to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Return type</dt>
<dd class="field-odd"><p>string</p>
</dd>
</dl>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.Comment.setId">
<code class="sig-name descname">setId</code><span class="sig-paren">(</span><em class="sig-param">id</em><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.Comment.setId" title="Permalink to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>id</strong> string</p>
</dd>
</dl>
<p>Identifier of comment, possibly in QuakeML RI format.</p>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.Comment.id">
<code class="sig-name descname">id</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.Comment.id" title="Permalink to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Return type</dt>
<dd class="field-odd"><p>string</p>
</dd>
</dl>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.Comment.setStart">
<code class="sig-name descname">setStart</code><span class="sig-paren">(</span><em class="sig-param">start</em><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.Comment.setStart" title="Permalink to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>start</strong> seiscomp.core.Time</p>
</dd>
</dl>
<p>Start of epoch in ISO datetime format</p>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.Comment.start">
<code class="sig-name descname">start</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.Comment.start" title="Permalink to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Return type</dt>
<dd class="field-odd"><p>seiscomp.core.Time</p>
</dd>
</dl>
<div class="admonition note">
<p class="admonition-title">Note</p>
<p>As this attribute is optional, this method throws a ValueError if
the value of the attribute is not set.</p>
</div>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.Comment.setEnd">
<code class="sig-name descname">setEnd</code><span class="sig-paren">(</span><em class="sig-param">end</em><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.Comment.setEnd" title="Permalink to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>end</strong> seiscomp.core.Time</p>
</dd>
</dl>
<p>End of epoch (empty if the comment epoch is open)</p>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.Comment.end">
<code class="sig-name descname">end</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.Comment.end" title="Permalink to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Return type</dt>
<dd class="field-odd"><p>seiscomp.core.Time</p>
</dd>
</dl>
<div class="admonition note">
<p class="admonition-title">Note</p>
<p>As this attribute is optional, this method throws a ValueError if
the value of the attribute is not set.</p>
</div>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.Comment.setCreationInfo">
<code class="sig-name descname">setCreationInfo</code><span class="sig-paren">(</span><em class="sig-param">creationInfo</em><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.Comment.setCreationInfo" title="Permalink to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>creationInfo</strong> <a class="reference internal" href="#api-python-datamodel-creationinfo"><span class="std std-ref">CreationInfo</span></a></p>
</dd>
</dl>
<p>CreationInfo for the Comment object.</p>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.Comment.creationInfo">
<code class="sig-name descname">creationInfo</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.Comment.creationInfo" title="Permalink to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Return type</dt>
<dd class="field-odd"><p><a class="reference internal" href="#api-python-datamodel-creationinfo"><span class="std std-ref">CreationInfo</span></a></p>
</dd>
</dl>
<div class="admonition note">
<p class="admonition-title">Note</p>
<p>As this attribute is optional, this method throws a ValueError if
the value of the attribute is not set.</p>
</div>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.Comment.momentTensor">
<code class="sig-name descname">momentTensor</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.Comment.momentTensor" title="Permalink to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Return type</dt>
<dd class="field-odd"><p><a class="reference internal" href="#seiscomp.datamodel.MomentTensor" title="seiscomp.datamodel.MomentTensor">MomentTensor</a></p>
</dd>
</dl>
<p>Returns the parent MomentTensor if available. Returns None
if the parent is not a MomentTensor. This is a convenience wrapper
for parent().</p>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.Comment.focalMechanism">
<code class="sig-name descname">focalMechanism</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.Comment.focalMechanism" title="Permalink to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Return type</dt>
<dd class="field-odd"><p><a class="reference internal" href="#seiscomp.datamodel.FocalMechanism" title="seiscomp.datamodel.FocalMechanism">FocalMechanism</a></p>
</dd>
</dl>
<p>Returns the parent FocalMechanism if available. Returns None
if the parent is not a FocalMechanism. This is a convenience wrapper
for parent().</p>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.Comment.amplitude">
<code class="sig-name descname">amplitude</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.Comment.amplitude" title="Permalink to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Return type</dt>
<dd class="field-odd"><p><a class="reference internal" href="#seiscomp.datamodel.Amplitude" title="seiscomp.datamodel.Amplitude">Amplitude</a></p>
</dd>
</dl>
<p>Returns the parent Amplitude if available. Returns None
if the parent is not a Amplitude. This is a convenience wrapper
for parent().</p>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.Comment.magnitude">
<code class="sig-name descname">magnitude</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.Comment.magnitude" title="Permalink to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Return type</dt>
<dd class="field-odd"><p><a class="reference internal" href="#seiscomp.datamodel.Magnitude" title="seiscomp.datamodel.Magnitude">Magnitude</a></p>
</dd>
</dl>
<p>Returns the parent Magnitude if available. Returns None
if the parent is not a Magnitude. This is a convenience wrapper
for parent().</p>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.Comment.stationMagnitude">
<code class="sig-name descname">stationMagnitude</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.Comment.stationMagnitude" title="Permalink to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Return type</dt>
<dd class="field-odd"><p><a class="reference internal" href="#seiscomp.datamodel.StationMagnitude" title="seiscomp.datamodel.StationMagnitude">StationMagnitude</a></p>
</dd>
</dl>
<p>Returns the parent StationMagnitude if available. Returns None
if the parent is not a StationMagnitude. This is a convenience wrapper
for parent().</p>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.Comment.pick">
<code class="sig-name descname">pick</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.Comment.pick" title="Permalink to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Return type</dt>
<dd class="field-odd"><p><a class="reference internal" href="#seiscomp.datamodel.Pick" title="seiscomp.datamodel.Pick">Pick</a></p>
</dd>
</dl>
<p>Returns the parent Pick if available. Returns None
if the parent is not a Pick. This is a convenience wrapper
for parent().</p>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.Comment.event">
<code class="sig-name descname">event</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.Comment.event" title="Permalink to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Return type</dt>
<dd class="field-odd"><p><a class="reference internal" href="#seiscomp.datamodel.Event" title="seiscomp.datamodel.Event">Event</a></p>
</dd>
</dl>
<p>Returns the parent Event if available. Returns None
if the parent is not a Event. This is a convenience wrapper
for parent().</p>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.Comment.origin">
<code class="sig-name descname">origin</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.Comment.origin" title="Permalink to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Return type</dt>
<dd class="field-odd"><p><a class="reference internal" href="#seiscomp.datamodel.Origin" title="seiscomp.datamodel.Origin">Origin</a></p>
</dd>
</dl>
<p>Returns the parent Origin if available. Returns None
if the parent is not a Origin. This is a convenience wrapper
for parent().</p>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.Comment.parameter">
<code class="sig-name descname">parameter</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.Comment.parameter" title="Permalink to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Return type</dt>
<dd class="field-odd"><p><a class="reference internal" href="#seiscomp.datamodel.Parameter" title="seiscomp.datamodel.Parameter">Parameter</a></p>
</dd>
</dl>
<p>Returns the parent Parameter if available. Returns None
if the parent is not a Parameter. This is a convenience wrapper
for parent().</p>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.Comment.parameterSet">
<code class="sig-name descname">parameterSet</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.Comment.parameterSet" title="Permalink to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Return type</dt>
<dd class="field-odd"><p><a class="reference internal" href="#seiscomp.datamodel.ParameterSet" title="seiscomp.datamodel.ParameterSet">ParameterSet</a></p>
</dd>
</dl>
<p>Returns the parent ParameterSet if available. Returns None
if the parent is not a ParameterSet. This is a convenience wrapper
for parent().</p>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.Comment.stream">
<code class="sig-name descname">stream</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.Comment.stream" title="Permalink to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Return type</dt>
<dd class="field-odd"><p><a class="reference internal" href="#seiscomp.datamodel.Stream" title="seiscomp.datamodel.Stream">Stream</a></p>
</dd>
</dl>
<p>Returns the parent Stream if available. Returns None
if the parent is not a Stream. This is a convenience wrapper
for parent().</p>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.Comment.sensorLocation">
<code class="sig-name descname">sensorLocation</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.Comment.sensorLocation" title="Permalink to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Return type</dt>
<dd class="field-odd"><p><a class="reference internal" href="#seiscomp.datamodel.SensorLocation" title="seiscomp.datamodel.SensorLocation">SensorLocation</a></p>
</dd>
</dl>
<p>Returns the parent SensorLocation if available. Returns None
if the parent is not a SensorLocation. This is a convenience wrapper
for parent().</p>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.Comment.station">
<code class="sig-name descname">station</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.Comment.station" title="Permalink to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Return type</dt>
<dd class="field-odd"><p><a class="reference internal" href="#seiscomp.datamodel.Station" title="seiscomp.datamodel.Station">Station</a></p>
</dd>
</dl>
<p>Returns the parent Station if available. Returns None
if the parent is not a Station. This is a convenience wrapper
for parent().</p>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.Comment.network">
<code class="sig-name descname">network</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.Comment.network" title="Permalink to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Return type</dt>
<dd class="field-odd"><p><a class="reference internal" href="#seiscomp.datamodel.Network" title="seiscomp.datamodel.Network">Network</a></p>
</dd>
</dl>
<p>Returns the parent Network if available. Returns None
if the parent is not a Network. This is a convenience wrapper
for parent().</p>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.Comment.assign">
<code class="sig-name descname">assign</code><span class="sig-paren">(</span><em class="sig-param">other</em><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.Comment.assign" title="Permalink to this definition"></a></dt>
<dd><p>This method implements the <a class="reference internal" href="#api-python-datamodel-object"><span class="std std-ref">Object</span></a> interface.</p>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.Comment.attachTo">
<code class="sig-name descname">attachTo</code><span class="sig-paren">(</span><em class="sig-param">parent</em><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.Comment.attachTo" title="Permalink to this definition"></a></dt>
<dd><p>This method implements the <a class="reference internal" href="#api-python-datamodel-object"><span class="std std-ref">Object</span></a> interface.</p>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.Comment.detachFrom">
<code class="sig-name descname">detachFrom</code><span class="sig-paren">(</span><em class="sig-param">parent</em><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.Comment.detachFrom" title="Permalink to this definition"></a></dt>
<dd><p>This method implements the <a class="reference internal" href="#api-python-datamodel-object"><span class="std std-ref">Object</span></a> interface.</p>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.Comment.detach">
<code class="sig-name descname">detach</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.Comment.detach" title="Permalink to this definition"></a></dt>
<dd><p>This method implements the <a class="reference internal" href="#api-python-datamodel-object"><span class="std std-ref">Object</span></a> interface.</p>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.Comment.clone">
<code class="sig-name descname">clone</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.Comment.clone" title="Permalink to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Return type</dt>
<dd class="field-odd"><p>A cloned Comment.</p>
</dd>
</dl>
<p>Returns a new instance that is a clone of the current instance. Child
objects are being ignored.</p>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.Comment.accept">
<code class="sig-name descname">accept</code><span class="sig-paren">(</span><em class="sig-param">visitor</em><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.Comment.accept" title="Permalink to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>visitor</strong> A visitor.</p>
</dd>
</dl>
<p>This method implements the <a class="reference internal" href="#api-python-datamodel-publicobject"><span class="std std-ref">PublicObject</span></a> interface.</p>
</dd></dl>
</dd></dl>
</div>
<div class="section" id="complexarray">
<span id="api-python-datamodel-complexarray"></span><h3>ComplexArray<a class="headerlink" href="#complexarray" title="Permalink to this headline"></a></h3>
<dl class="class">
<dt id="seiscomp.datamodel.ComplexArray">
<em class="property">class </em><code class="sig-prename descclassname">seiscomp.datamodel.</code><code class="sig-name descname">ComplexArray</code><a class="headerlink" href="#seiscomp.datamodel.ComplexArray" title="Permalink to this definition"></a></dt>
<dd><p>Inherits <a class="reference internal" href="#api-python-datamodel-object"><span class="std std-ref">Object</span></a>.</p>
<p><strong>Attributes</strong>:</p>
<ul class="simple">
<li><p><code class="docutils literal notranslate"><span class="pre">content</span></code> complex (optional)</p></li>
</ul>
<p><strong>Used by</strong>:</p>
<ul class="simple">
<li><p><a class="reference internal" href="#seiscomp.datamodel.ResponsePAZ.zeros" title="seiscomp.datamodel.ResponsePAZ.zeros"><code class="xref py py-func docutils literal notranslate"><span class="pre">ResponsePAZ.zeros()</span></code></a></p></li>
<li><p><a class="reference internal" href="#seiscomp.datamodel.ResponsePAZ.poles" title="seiscomp.datamodel.ResponsePAZ.poles"><code class="xref py py-func docutils literal notranslate"><span class="pre">ResponsePAZ.poles()</span></code></a></p></li>
</ul>
<p><strong>Methods</strong>:</p>
<dl class="method">
<dt id="seiscomp.datamodel.ComplexArray.Cast">
<em class="property">static </em><code class="sig-name descname">Cast</code><span class="sig-paren">(</span><em class="sig-param">obj</em><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.ComplexArray.Cast" title="Permalink to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>obj</strong> The object to be casted.</p>
</dd>
<dt class="field-even">Return type</dt>
<dd class="field-even"><p>An object of type ComplexArray if the cast was successful,
None otherwise.</p>
</dd>
</dl>
<p>Cast an arbitrary object to ComplexArray if the internal wrapped
representation is an ComplexArray object. The cast is important if
instances of type <a class="reference internal" href="#api-python-datamodel-object"><span class="std std-ref">Object</span></a>
are passed to methods which need access to the real type.</p>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.ComplexArray.equal">
<code class="sig-name descname">equal</code><span class="sig-paren">(</span><em class="sig-param">other</em><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.ComplexArray.equal" title="Permalink to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>other</strong> Another object of type ComplexArray to compare this
instance to</p>
</dd>
<dt class="field-even">Return type</dt>
<dd class="field-even"><p>A Boolean value indicating True if both objects are equal or
False otherwise.</p>
</dd>
</dl>
<p>Compares two objects without its child objects. Both objects are compared
by value.</p>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.ComplexArray.setContent">
<code class="sig-name descname">setContent</code><span class="sig-paren">(</span><em class="sig-param">content</em><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.ComplexArray.setContent" title="Permalink to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>content</strong> complex</p>
</dd>
</dl>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.ComplexArray.content">
<code class="sig-name descname">content</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.ComplexArray.content" title="Permalink to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Return type</dt>
<dd class="field-odd"><p>complex</p>
</dd>
</dl>
<div class="admonition note">
<p class="admonition-title">Note</p>
<p>As this attribute is optional, this method throws a ValueError if
the value of the attribute is not set.</p>
</div>
</dd></dl>
</dd></dl>
</div>
<div class="section" id="compositetime">
<span id="api-python-datamodel-compositetime"></span><h3>CompositeTime<a class="headerlink" href="#compositetime" title="Permalink to this headline"></a></h3>
<dl class="class">
<dt id="seiscomp.datamodel.CompositeTime">
<em class="property">class </em><code class="sig-prename descclassname">seiscomp.datamodel.</code><code class="sig-name descname">CompositeTime</code><a class="headerlink" href="#seiscomp.datamodel.CompositeTime" title="Permalink to this definition"></a></dt>
<dd><p>Inherits <a class="reference internal" href="#api-python-datamodel-object"><span class="std std-ref">Object</span></a>.</p>
<p>Focal times differ significantly in their precision. While focal times
of instrumentally located earthquakes are estimated precisely down to
seconds, historic events have only incomplete time descriptions. Sometimes,
even contradictory information about the rupture time exist. The
CompositeTime type allows for such complex descriptions. If the specification
is given with no greater accuracy than days (i.e., no time components are
given), the date refers to local time. However, if time components are
given, they have to refer to UTC. As an example, consider a historic
earthquake in California, e.g., on 28 February 1730, with no time information
given. Expressed in UTC, this day extends from 1730-02-28T08:00:00Z
until 1730-03-01T08:00:00Z. Such a specification would be against intuition.
Therefore, for date-time specifications without time components, local
time is used. In the example, the CompositeTime attributes are simply
year 1730, month 2, and day 28. In the corresponding time attribute of
the origin, however, UTC has to be used. If the unknown time components
are assumed to be zero, the value is 1730-02-28T08:00:00Z.</p>
<p><strong>Parents</strong>:</p>
<ul class="simple">
<li><p><code class="docutils literal notranslate"><span class="pre">origin</span></code> <a class="reference internal" href="#api-python-datamodel-origin"><span class="std std-ref">Origin</span></a></p></li>
</ul>
<p><strong>Attributes</strong>:</p>
<ul class="simple">
<li><p><code class="docutils literal notranslate"><span class="pre">year</span></code> <a class="reference internal" href="#api-python-datamodel-integerquantity"><span class="std std-ref">IntegerQuantity</span></a> (optional)</p></li>
<li><p><code class="docutils literal notranslate"><span class="pre">month</span></code> <a class="reference internal" href="#api-python-datamodel-integerquantity"><span class="std std-ref">IntegerQuantity</span></a> (optional)</p></li>
<li><p><code class="docutils literal notranslate"><span class="pre">day</span></code> <a class="reference internal" href="#api-python-datamodel-integerquantity"><span class="std std-ref">IntegerQuantity</span></a> (optional)</p></li>
<li><p><code class="docutils literal notranslate"><span class="pre">hour</span></code> <a class="reference internal" href="#api-python-datamodel-integerquantity"><span class="std std-ref">IntegerQuantity</span></a> (optional)</p></li>
<li><p><code class="docutils literal notranslate"><span class="pre">minute</span></code> <a class="reference internal" href="#api-python-datamodel-integerquantity"><span class="std std-ref">IntegerQuantity</span></a> (optional)</p></li>
<li><p><code class="docutils literal notranslate"><span class="pre">second</span></code> <a class="reference internal" href="#api-python-datamodel-realquantity"><span class="std std-ref">RealQuantity</span></a> (optional)</p></li>
</ul>
<p><strong>Methods</strong>:</p>
<dl class="method">
<dt id="seiscomp.datamodel.CompositeTime.Cast">
<em class="property">static </em><code class="sig-name descname">Cast</code><span class="sig-paren">(</span><em class="sig-param">obj</em><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.CompositeTime.Cast" title="Permalink to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>obj</strong> The object to be casted.</p>
</dd>
<dt class="field-even">Return type</dt>
<dd class="field-even"><p>An object of type CompositeTime if the cast was successful,
None otherwise.</p>
</dd>
</dl>
<p>Cast an arbitrary object to CompositeTime if the internal wrapped
representation is an CompositeTime object. The cast is important if
instances of type <a class="reference internal" href="#api-python-datamodel-object"><span class="std std-ref">Object</span></a>
are passed to methods which need access to the real type.</p>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.CompositeTime.equal">
<code class="sig-name descname">equal</code><span class="sig-paren">(</span><em class="sig-param">other</em><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.CompositeTime.equal" title="Permalink to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>other</strong> Another object of type CompositeTime to compare this
instance to</p>
</dd>
<dt class="field-even">Return type</dt>
<dd class="field-even"><p>A Boolean value indicating True if both objects are equal or
False otherwise.</p>
</dd>
</dl>
<p>Compares two objects without its child objects. Both objects are compared
by value.</p>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.CompositeTime.setYear">
<code class="sig-name descname">setYear</code><span class="sig-paren">(</span><em class="sig-param">year</em><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.CompositeTime.setYear" title="Permalink to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>year</strong> <a class="reference internal" href="#api-python-datamodel-integerquantity"><span class="std std-ref">IntegerQuantity</span></a></p>
</dd>
</dl>
<p>Year or range of years of the events focal time.</p>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.CompositeTime.year">
<code class="sig-name descname">year</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.CompositeTime.year" title="Permalink to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Return type</dt>
<dd class="field-odd"><p><a class="reference internal" href="#api-python-datamodel-integerquantity"><span class="std std-ref">IntegerQuantity</span></a></p>
</dd>
</dl>
<div class="admonition note">
<p class="admonition-title">Note</p>
<p>As this attribute is optional, this method throws a ValueError if
the value of the attribute is not set.</p>
</div>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.CompositeTime.setMonth">
<code class="sig-name descname">setMonth</code><span class="sig-paren">(</span><em class="sig-param">month</em><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.CompositeTime.setMonth" title="Permalink to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>month</strong> <a class="reference internal" href="#api-python-datamodel-integerquantity"><span class="std std-ref">IntegerQuantity</span></a></p>
</dd>
</dl>
<p>Month or range of months of the events focal time.</p>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.CompositeTime.month">
<code class="sig-name descname">month</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.CompositeTime.month" title="Permalink to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Return type</dt>
<dd class="field-odd"><p><a class="reference internal" href="#api-python-datamodel-integerquantity"><span class="std std-ref">IntegerQuantity</span></a></p>
</dd>
</dl>
<div class="admonition note">
<p class="admonition-title">Note</p>
<p>As this attribute is optional, this method throws a ValueError if
the value of the attribute is not set.</p>
</div>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.CompositeTime.setDay">
<code class="sig-name descname">setDay</code><span class="sig-paren">(</span><em class="sig-param">day</em><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.CompositeTime.setDay" title="Permalink to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>day</strong> <a class="reference internal" href="#api-python-datamodel-integerquantity"><span class="std std-ref">IntegerQuantity</span></a></p>
</dd>
</dl>
<p>Day or range of days of the events focal time.</p>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.CompositeTime.day">
<code class="sig-name descname">day</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.CompositeTime.day" title="Permalink to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Return type</dt>
<dd class="field-odd"><p><a class="reference internal" href="#api-python-datamodel-integerquantity"><span class="std std-ref">IntegerQuantity</span></a></p>
</dd>
</dl>
<div class="admonition note">
<p class="admonition-title">Note</p>
<p>As this attribute is optional, this method throws a ValueError if
the value of the attribute is not set.</p>
</div>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.CompositeTime.setHour">
<code class="sig-name descname">setHour</code><span class="sig-paren">(</span><em class="sig-param">hour</em><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.CompositeTime.setHour" title="Permalink to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>hour</strong> <a class="reference internal" href="#api-python-datamodel-integerquantity"><span class="std std-ref">IntegerQuantity</span></a></p>
</dd>
</dl>
<p>Hour or range of hours of the events focal time.</p>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.CompositeTime.hour">
<code class="sig-name descname">hour</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.CompositeTime.hour" title="Permalink to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Return type</dt>
<dd class="field-odd"><p><a class="reference internal" href="#api-python-datamodel-integerquantity"><span class="std std-ref">IntegerQuantity</span></a></p>
</dd>
</dl>
<div class="admonition note">
<p class="admonition-title">Note</p>
<p>As this attribute is optional, this method throws a ValueError if
the value of the attribute is not set.</p>
</div>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.CompositeTime.setMinute">
<code class="sig-name descname">setMinute</code><span class="sig-paren">(</span><em class="sig-param">minute</em><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.CompositeTime.setMinute" title="Permalink to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>minute</strong> <a class="reference internal" href="#api-python-datamodel-integerquantity"><span class="std std-ref">IntegerQuantity</span></a></p>
</dd>
</dl>
<p>Minute or range of minutes of the events focal time.</p>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.CompositeTime.minute">
<code class="sig-name descname">minute</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.CompositeTime.minute" title="Permalink to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Return type</dt>
<dd class="field-odd"><p><a class="reference internal" href="#api-python-datamodel-integerquantity"><span class="std std-ref">IntegerQuantity</span></a></p>
</dd>
</dl>
<div class="admonition note">
<p class="admonition-title">Note</p>
<p>As this attribute is optional, this method throws a ValueError if
the value of the attribute is not set.</p>
</div>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.CompositeTime.setSecond">
<code class="sig-name descname">setSecond</code><span class="sig-paren">(</span><em class="sig-param">second</em><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.CompositeTime.setSecond" title="Permalink to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>second</strong> <a class="reference internal" href="#api-python-datamodel-realquantity"><span class="std std-ref">RealQuantity</span></a></p>
</dd>
</dl>
<p>Second and fraction of seconds or range of seconds with fraction of the
events focal time.</p>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.CompositeTime.second">
<code class="sig-name descname">second</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.CompositeTime.second" title="Permalink to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Return type</dt>
<dd class="field-odd"><p><a class="reference internal" href="#api-python-datamodel-realquantity"><span class="std std-ref">RealQuantity</span></a></p>
</dd>
</dl>
<div class="admonition note">
<p class="admonition-title">Note</p>
<p>As this attribute is optional, this method throws a ValueError if
the value of the attribute is not set.</p>
</div>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.CompositeTime.origin">
<code class="sig-name descname">origin</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.CompositeTime.origin" title="Permalink to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Return type</dt>
<dd class="field-odd"><p><a class="reference internal" href="#seiscomp.datamodel.Origin" title="seiscomp.datamodel.Origin">Origin</a></p>
</dd>
</dl>
<p>Returns the parent Origin if available. Returns None
if the parent is not a Origin. This is a convenience wrapper
for parent().</p>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.CompositeTime.assign">
<code class="sig-name descname">assign</code><span class="sig-paren">(</span><em class="sig-param">other</em><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.CompositeTime.assign" title="Permalink to this definition"></a></dt>
<dd><p>This method implements the <a class="reference internal" href="#api-python-datamodel-object"><span class="std std-ref">Object</span></a> interface.</p>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.CompositeTime.attachTo">
<code class="sig-name descname">attachTo</code><span class="sig-paren">(</span><em class="sig-param">parent</em><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.CompositeTime.attachTo" title="Permalink to this definition"></a></dt>
<dd><p>This method implements the <a class="reference internal" href="#api-python-datamodel-object"><span class="std std-ref">Object</span></a> interface.</p>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.CompositeTime.detachFrom">
<code class="sig-name descname">detachFrom</code><span class="sig-paren">(</span><em class="sig-param">parent</em><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.CompositeTime.detachFrom" title="Permalink to this definition"></a></dt>
<dd><p>This method implements the <a class="reference internal" href="#api-python-datamodel-object"><span class="std std-ref">Object</span></a> interface.</p>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.CompositeTime.detach">
<code class="sig-name descname">detach</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.CompositeTime.detach" title="Permalink to this definition"></a></dt>
<dd><p>This method implements the <a class="reference internal" href="#api-python-datamodel-object"><span class="std std-ref">Object</span></a> interface.</p>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.CompositeTime.clone">
<code class="sig-name descname">clone</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.CompositeTime.clone" title="Permalink to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Return type</dt>
<dd class="field-odd"><p>A cloned CompositeTime.</p>
</dd>
</dl>
<p>Returns a new instance that is a clone of the current instance. Child
objects are being ignored.</p>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.CompositeTime.accept">
<code class="sig-name descname">accept</code><span class="sig-paren">(</span><em class="sig-param">visitor</em><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.CompositeTime.accept" title="Permalink to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>visitor</strong> A visitor.</p>
</dd>
</dl>
<p>This method implements the <a class="reference internal" href="#api-python-datamodel-publicobject"><span class="std std-ref">PublicObject</span></a> interface.</p>
</dd></dl>
</dd></dl>
</div>
<div class="section" id="confidenceellipsoid">
<span id="api-python-datamodel-confidenceellipsoid"></span><h3>ConfidenceEllipsoid<a class="headerlink" href="#confidenceellipsoid" title="Permalink to this headline"></a></h3>
<dl class="class">
<dt id="seiscomp.datamodel.ConfidenceEllipsoid">
<em class="property">class </em><code class="sig-prename descclassname">seiscomp.datamodel.</code><code class="sig-name descname">ConfidenceEllipsoid</code><a class="headerlink" href="#seiscomp.datamodel.ConfidenceEllipsoid" title="Permalink to this definition"></a></dt>
<dd><p>Inherits <a class="reference internal" href="#api-python-datamodel-object"><span class="std std-ref">Object</span></a>.</p>
<p>This class represents a description of the location uncertainty as a confidence
ellipsoid with arbitrary orientation in space. The orientation of a rigid
body in three-dimensional Euclidean space can be described by three
parameters. We use the convention of Euler angles, which can be interpreted
as a composition of three elemental rotations (i.e., rotations around a single
axis).
In the special case of Euler angles we use here, the angles are referred
to as Tait-Bryan (or Cardan) angles. These angles may be familiar to
the reader from their application in flight dynamics, and are referred
to as heading (yaw, psi), elevation (attitude, pitch, phi), and bank
(roll, theta).
For a definition of the angles, see Figure 4. Through the three elemental
rotations, a Cartesian system (x, y, z) centered at the epicenter, with
the South-North direction x, the West-East direction y, and the downward
vertical direction z, is transferred into a different Cartesian system
(X, Y , Z) centered on the confidence ellipsoid. Here, X denotes the direction
of the major axis, and Y denotes the direction of the minor axis of the
ellipsoid. Note that Figure 4 can be interpreted as a hypothetical view
from the interior of the Earth to the inner face of a shell representing
Earths surface. The three Tait-Bryan rotations are performed as follows:
(i) a rotation about the Z axis with angle psi (heading, or azimuth);
(ii) a rotation about the Y axis with angle phi (elevation, or plunge);
and (iii) a rotation about the X axis with angle theta (bank). Note that in
the case of Tait-Bryan angles, the rotations are performed about the
ellipsoids axes, not about the axes of the fixed (x, y, z) Cartesian system.
In the following list the correspondence of the attributes of class
ConfidenceEllipsoid to the respective Tait-Bryan angles is listed:
majorAxisPlunge: elevation (pitch, phi), majorAxisAzimuth: heading (yaw,
psi), majorAxisRotation: bank (roll, theta)</p>
<p><strong>Attributes</strong>:</p>
<ul class="simple">
<li><p><code class="docutils literal notranslate"><span class="pre">semiMajorAxisLength</span></code> float</p></li>
<li><p><code class="docutils literal notranslate"><span class="pre">semiMinorAxisLength</span></code> float</p></li>
<li><p><code class="docutils literal notranslate"><span class="pre">semiIntermediateAxisLength</span></code> float</p></li>
<li><p><code class="docutils literal notranslate"><span class="pre">majorAxisPlunge</span></code> float</p></li>
<li><p><code class="docutils literal notranslate"><span class="pre">majorAxisAzimuth</span></code> float</p></li>
<li><p><code class="docutils literal notranslate"><span class="pre">majorAxisRotation</span></code> float</p></li>
</ul>
<p><strong>Used by</strong>:</p>
<ul class="simple">
<li><p><a class="reference internal" href="#seiscomp.datamodel.OriginUncertainty.confidenceEllipsoid" title="seiscomp.datamodel.OriginUncertainty.confidenceEllipsoid"><code class="xref py py-func docutils literal notranslate"><span class="pre">OriginUncertainty.confidenceEllipsoid()</span></code></a></p></li>
</ul>
<p><strong>Methods</strong>:</p>
<dl class="method">
<dt id="seiscomp.datamodel.ConfidenceEllipsoid.Cast">
<em class="property">static </em><code class="sig-name descname">Cast</code><span class="sig-paren">(</span><em class="sig-param">obj</em><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.ConfidenceEllipsoid.Cast" title="Permalink to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>obj</strong> The object to be casted.</p>
</dd>
<dt class="field-even">Return type</dt>
<dd class="field-even"><p>An object of type ConfidenceEllipsoid if the cast was successful,
None otherwise.</p>
</dd>
</dl>
<p>Cast an arbitrary object to ConfidenceEllipsoid if the internal wrapped
representation is an ConfidenceEllipsoid object. The cast is important if
instances of type <a class="reference internal" href="#api-python-datamodel-object"><span class="std std-ref">Object</span></a>
are passed to methods which need access to the real type.</p>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.ConfidenceEllipsoid.equal">
<code class="sig-name descname">equal</code><span class="sig-paren">(</span><em class="sig-param">other</em><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.ConfidenceEllipsoid.equal" title="Permalink to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>other</strong> Another object of type ConfidenceEllipsoid to compare this
instance to</p>
</dd>
<dt class="field-even">Return type</dt>
<dd class="field-even"><p>A Boolean value indicating True if both objects are equal or
False otherwise.</p>
</dd>
</dl>
<p>Compares two objects without its child objects. Both objects are compared
by value.</p>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.ConfidenceEllipsoid.setSemiMajorAxisLength">
<code class="sig-name descname">setSemiMajorAxisLength</code><span class="sig-paren">(</span><em class="sig-param">semiMajorAxisLength</em><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.ConfidenceEllipsoid.setSemiMajorAxisLength" title="Permalink to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>semiMajorAxisLength</strong> float</p>
</dd>
</dl>
<p>Largest uncertainty, corresponding to the semi-major axis of the confidence
ellipsoid in meter.</p>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.ConfidenceEllipsoid.semiMajorAxisLength">
<code class="sig-name descname">semiMajorAxisLength</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.ConfidenceEllipsoid.semiMajorAxisLength" title="Permalink to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Return type</dt>
<dd class="field-odd"><p>float</p>
</dd>
</dl>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.ConfidenceEllipsoid.setSemiMinorAxisLength">
<code class="sig-name descname">setSemiMinorAxisLength</code><span class="sig-paren">(</span><em class="sig-param">semiMinorAxisLength</em><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.ConfidenceEllipsoid.setSemiMinorAxisLength" title="Permalink to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>semiMinorAxisLength</strong> float</p>
</dd>
</dl>
<p>Smallest uncertainty, corresponding to the semi-minor axis of the
confidence ellipsoid in meter.</p>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.ConfidenceEllipsoid.semiMinorAxisLength">
<code class="sig-name descname">semiMinorAxisLength</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.ConfidenceEllipsoid.semiMinorAxisLength" title="Permalink to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Return type</dt>
<dd class="field-odd"><p>float</p>
</dd>
</dl>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.ConfidenceEllipsoid.setSemiIntermediateAxisLength">
<code class="sig-name descname">setSemiIntermediateAxisLength</code><span class="sig-paren">(</span><em class="sig-param">semiIntermediateAxisLength</em><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.ConfidenceEllipsoid.setSemiIntermediateAxisLength" title="Permalink to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>semiIntermediateAxisLength</strong> float</p>
</dd>
</dl>
<p>Uncertainty in direction orthogonal to major and minor axes of the
confidence ellipsoid in meter.</p>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.ConfidenceEllipsoid.semiIntermediateAxisLength">
<code class="sig-name descname">semiIntermediateAxisLength</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.ConfidenceEllipsoid.semiIntermediateAxisLength" title="Permalink to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Return type</dt>
<dd class="field-odd"><p>float</p>
</dd>
</dl>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.ConfidenceEllipsoid.setMajorAxisPlunge">
<code class="sig-name descname">setMajorAxisPlunge</code><span class="sig-paren">(</span><em class="sig-param">majorAxisPlunge</em><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.ConfidenceEllipsoid.setMajorAxisPlunge" title="Permalink to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>majorAxisPlunge</strong> float</p>
</dd>
</dl>
<p>Plunge angle of major axis of confidence ellipsoid. Corresponds to
Tait-Bryan angle phi
in degrees.</p>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.ConfidenceEllipsoid.majorAxisPlunge">
<code class="sig-name descname">majorAxisPlunge</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.ConfidenceEllipsoid.majorAxisPlunge" title="Permalink to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Return type</dt>
<dd class="field-odd"><p>float</p>
</dd>
</dl>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.ConfidenceEllipsoid.setMajorAxisAzimuth">
<code class="sig-name descname">setMajorAxisAzimuth</code><span class="sig-paren">(</span><em class="sig-param">majorAxisAzimuth</em><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.ConfidenceEllipsoid.setMajorAxisAzimuth" title="Permalink to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>majorAxisAzimuth</strong> float</p>
</dd>
</dl>
<p>Azimuth angle of major axis of confidence ellipsoid. Corresponds to
Tait-Bryan angle psi
in degrees.</p>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.ConfidenceEllipsoid.majorAxisAzimuth">
<code class="sig-name descname">majorAxisAzimuth</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.ConfidenceEllipsoid.majorAxisAzimuth" title="Permalink to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Return type</dt>
<dd class="field-odd"><p>float</p>
</dd>
</dl>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.ConfidenceEllipsoid.setMajorAxisRotation">
<code class="sig-name descname">setMajorAxisRotation</code><span class="sig-paren">(</span><em class="sig-param">majorAxisRotation</em><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.ConfidenceEllipsoid.setMajorAxisRotation" title="Permalink to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>majorAxisRotation</strong> float</p>
</dd>
</dl>
<p>This angle describes a rotation about the confidence ellipsoids major axis
which is required
to define the direction of the ellipsoids minor axis. Corresponds to
Tait-Bryan angle theta
in degrees.</p>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.ConfidenceEllipsoid.majorAxisRotation">
<code class="sig-name descname">majorAxisRotation</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.ConfidenceEllipsoid.majorAxisRotation" title="Permalink to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Return type</dt>
<dd class="field-odd"><p>float</p>
</dd>
</dl>
</dd></dl>
</dd></dl>
</div>
<div class="section" id="api-python-datamodel-config">
<span id="id12"></span><h3>Config<a class="headerlink" href="#api-python-datamodel-config" title="Permalink to this headline"></a></h3>
<dl class="class">
<dt id="seiscomp.datamodel.Config">
<em class="property">class </em><code class="sig-prename descclassname">seiscomp.datamodel.</code><code class="sig-name descname">Config</code><a class="headerlink" href="#seiscomp.datamodel.Config" title="Permalink to this definition"></a></dt>
<dd><p>Inherits <a class="reference internal" href="#api-python-datamodel-publicobject"><span class="std std-ref">PublicObject</span></a>.</p>
<p><strong>Children</strong>:</p>
<ul class="simple">
<li><p><code class="docutils literal notranslate"><span class="pre">parameterSet</span></code> <a class="reference internal" href="#api-python-datamodel-parameterset"><span class="std std-ref">ParameterSet</span></a></p></li>
<li><p><code class="docutils literal notranslate"><span class="pre">configModule</span></code> <a class="reference internal" href="#api-python-datamodel-configmodule"><span class="std std-ref">ConfigModule</span></a></p></li>
</ul>
<p><strong>Attributes</strong>:</p>
<ul class="simple">
<li><p><code class="docutils literal notranslate"><span class="pre">publicID</span></code>: string</p></li>
</ul>
<p><strong>Methods</strong>:</p>
<dl class="method">
<dt id="seiscomp.datamodel.Config.Cast">
<em class="property">static </em><code class="sig-name descname">Cast</code><span class="sig-paren">(</span><em class="sig-param">obj</em><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.Config.Cast" title="Permalink to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>obj</strong> The object to be casted.</p>
</dd>
<dt class="field-even">Return type</dt>
<dd class="field-even"><p>An object of type Config if the cast was successful,
None otherwise.</p>
</dd>
</dl>
<p>Cast an arbitrary object to Config if the internal wrapped
representation is an Config object. The cast is important if
instances of type <a class="reference internal" href="#api-python-datamodel-object"><span class="std std-ref">Object</span></a>
are passed to methods which need access to the real type.</p>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.Config.equal">
<code class="sig-name descname">equal</code><span class="sig-paren">(</span><em class="sig-param">other</em><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.Config.equal" title="Permalink to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>other</strong> Another object of type Config to compare this
instance to</p>
</dd>
<dt class="field-even">Return type</dt>
<dd class="field-even"><p>A Boolean value indicating True if both objects are equal or
False otherwise.</p>
</dd>
</dl>
<p>Compares two objects without its child objects. Both objects are compared
by value.</p>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.Config.add">
<code class="sig-name descname">add</code><span class="sig-paren">(</span><em class="sig-param">parameterSet</em><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.Config.add" title="Permalink to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>parameterSet</strong> Object of type <a class="reference internal" href="#api-python-datamodel-parameterset"><span class="std std-ref">ParameterSet</span></a></p>
</dd>
<dt class="field-even">Return type</dt>
<dd class="field-even"><p>A Boolean value indicating success with True, False otherwise.</p>
</dd>
</dl>
<p>Adds a ParameterSet object to Config. The object is not
copied but managed by this instance. Any change to the passed object
will also change the child.</p>
</dd></dl>
<dl class="method">
<dt>
<code class="sig-name descname">add</code><span class="sig-paren">(</span><em class="sig-param">configModule</em><span class="sig-paren">)</span></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>configModule</strong> Object of type <a class="reference internal" href="#api-python-datamodel-configmodule"><span class="std std-ref">ConfigModule</span></a></p>
</dd>
<dt class="field-even">Return type</dt>
<dd class="field-even"><p>A Boolean value indicating success with True, False otherwise.</p>
</dd>
</dl>
<p>Adds a ConfigModule object to Config. The object is not
copied but managed by this instance. Any change to the passed object
will also change the child.</p>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.Config.remove">
<code class="sig-name descname">remove</code><span class="sig-paren">(</span><em class="sig-param">parameterSet</em><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.Config.remove" title="Permalink to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>parameterSet</strong> Object of type <a class="reference internal" href="#api-python-datamodel-parameterset"><span class="std std-ref">ParameterSet</span></a></p>
</dd>
<dt class="field-even">Return type</dt>
<dd class="field-even"><p>A Boolean value indicating success with True, False otherwise.</p>
</dd>
</dl>
<p>Removes a previously added ParameterSet object from Config.</p>
</dd></dl>
<dl class="method">
<dt>
<code class="sig-name descname">remove</code><span class="sig-paren">(</span><em class="sig-param">configModule</em><span class="sig-paren">)</span></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>configModule</strong> Object of type <a class="reference internal" href="#api-python-datamodel-configmodule"><span class="std std-ref">ConfigModule</span></a></p>
</dd>
<dt class="field-even">Return type</dt>
<dd class="field-even"><p>A Boolean value indicating success with True, False otherwise.</p>
</dd>
</dl>
<p>Removes a previously added ConfigModule object from Config.</p>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.Config.removeParameterSet">
<code class="sig-name descname">removeParameterSet</code><span class="sig-paren">(</span><em class="sig-param">idx</em><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.Config.removeParameterSet" title="Permalink to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>idx</strong> An integer index of the object to be removed.</p>
</dd>
<dt class="field-even">Return type</dt>
<dd class="field-even"><p>A Boolean value indicating success with True, False otherwise.</p>
</dd>
</dl>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.Config.removeConfigModule">
<code class="sig-name descname">removeConfigModule</code><span class="sig-paren">(</span><em class="sig-param">idx</em><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.Config.removeConfigModule" title="Permalink to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>idx</strong> An integer index of the object to be removed.</p>
</dd>
<dt class="field-even">Return type</dt>
<dd class="field-even"><p>A Boolean value indicating success with True, False otherwise.</p>
</dd>
</dl>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.Config.parameterSetCount">
<code class="sig-name descname">parameterSetCount</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.Config.parameterSetCount" title="Permalink to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Return type</dt>
<dd class="field-odd"><p>integer value indicating the number of child objects.</p>
</dd>
</dl>
<p>Returns the number of ParameterSet child objects.</p>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.Config.configModuleCount">
<code class="sig-name descname">configModuleCount</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.Config.configModuleCount" title="Permalink to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Return type</dt>
<dd class="field-odd"><p>integer value indicating the number of child objects.</p>
</dd>
</dl>
<p>Returns the number of ConfigModule child objects.</p>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.Config.parameterSet">
<code class="sig-name descname">parameterSet</code><span class="sig-paren">(</span><em class="sig-param">idx</em><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.Config.parameterSet" title="Permalink to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>idx</strong> An integer index of the object to be returned.</p>
</dd>
<dt class="field-even">Return type</dt>
<dd class="field-even"><p>Object of type <a class="reference internal" href="#api-python-datamodel-parameterset"><span class="std std-ref">ParameterSet</span></a>.</p>
</dd>
</dl>
<p>Returns the ParameterSet at index idx.</p>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.Config.configModule">
<code class="sig-name descname">configModule</code><span class="sig-paren">(</span><em class="sig-param">idx</em><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.Config.configModule" title="Permalink to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>idx</strong> An integer index of the object to be returned.</p>
</dd>
<dt class="field-even">Return type</dt>
<dd class="field-even"><p>Object of type <a class="reference internal" href="#api-python-datamodel-configmodule"><span class="std std-ref">ConfigModule</span></a>.</p>
</dd>
</dl>
<p>Returns the ConfigModule at index idx.</p>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.Config.findParameterSet">
<code class="sig-name descname">findParameterSet</code><span class="sig-paren">(</span><em class="sig-param">publicID</em><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.Config.findParameterSet" title="Permalink to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>publicID</strong> The publicID of the object to find.</p>
</dd>
<dt class="field-even">Return type</dt>
<dd class="field-even"><p>Object of type <a class="reference internal" href="#api-python-datamodel-parameterset"><span class="std std-ref">ParameterSet</span></a>.</p>
</dd>
</dl>
<p>Returns the child object with a certain publicID, None otherwise.</p>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.Config.findConfigModule">
<code class="sig-name descname">findConfigModule</code><span class="sig-paren">(</span><em class="sig-param">publicID</em><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.Config.findConfigModule" title="Permalink to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>publicID</strong> The publicID of the object to find.</p>
</dd>
<dt class="field-even">Return type</dt>
<dd class="field-even"><p>Object of type <a class="reference internal" href="#api-python-datamodel-configmodule"><span class="std std-ref">ConfigModule</span></a>.</p>
</dd>
</dl>
<p>Returns the child object with a certain publicID, None otherwise.</p>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.Config.assign">
<code class="sig-name descname">assign</code><span class="sig-paren">(</span><em class="sig-param">other</em><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.Config.assign" title="Permalink to this definition"></a></dt>
<dd><p>This method implements the <a class="reference internal" href="#api-python-datamodel-object"><span class="std std-ref">Object</span></a> interface.</p>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.Config.attachTo">
<code class="sig-name descname">attachTo</code><span class="sig-paren">(</span><em class="sig-param">parent</em><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.Config.attachTo" title="Permalink to this definition"></a></dt>
<dd><p>This method implements the <a class="reference internal" href="#api-python-datamodel-object"><span class="std std-ref">Object</span></a> interface.</p>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.Config.detachFrom">
<code class="sig-name descname">detachFrom</code><span class="sig-paren">(</span><em class="sig-param">parent</em><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.Config.detachFrom" title="Permalink to this definition"></a></dt>
<dd><p>This method implements the <a class="reference internal" href="#api-python-datamodel-object"><span class="std std-ref">Object</span></a> interface.</p>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.Config.detach">
<code class="sig-name descname">detach</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.Config.detach" title="Permalink to this definition"></a></dt>
<dd><p>This method implements the <a class="reference internal" href="#api-python-datamodel-object"><span class="std std-ref">Object</span></a> interface.</p>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.Config.clone">
<code class="sig-name descname">clone</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.Config.clone" title="Permalink to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Return type</dt>
<dd class="field-odd"><p>A cloned Config.</p>
</dd>
</dl>
<p>Returns a new instance that is a clone of the current instance. Child
objects are being ignored.</p>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.Config.updateChild">
<code class="sig-name descname">updateChild</code><span class="sig-paren">(</span><em class="sig-param">ref</em><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.Config.updateChild" title="Permalink to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>ref</strong> A child object derived from class Object.</p>
</dd>
<dt class="field-even">Return type</dt>
<dd class="field-even"><p>A Boolean flag indicating success with True, False otherwise</p>
</dd>
</dl>
<p>This method takes the passed reference object and searches for a child
with the same publicID (if derived from <a class="reference internal" href="#api-python-datamodel-publicobject"><span class="std std-ref">PublicObject</span></a>)
or the same index (if derived from <a class="reference internal" href="#api-python-datamodel-object"><span class="std std-ref">Object</span></a>).
The the child was found the reference objects attributes are copied to
the child object. Children of child are being ignored during this operation.
This method implements the <a class="reference internal" href="#api-python-datamodel-publicobject"><span class="std std-ref">PublicObject</span></a> interface.</p>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.Config.accept">
<code class="sig-name descname">accept</code><span class="sig-paren">(</span><em class="sig-param">visitor</em><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.Config.accept" title="Permalink to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>visitor</strong> A visitor.</p>
</dd>
</dl>
<p>This method implements the <a class="reference internal" href="#api-python-datamodel-publicobject"><span class="std std-ref">PublicObject</span></a> interface.</p>
</dd></dl>
</dd></dl>
</div>
<div class="section" id="configmodule">
<span id="api-python-datamodel-configmodule"></span><h3>ConfigModule<a class="headerlink" href="#configmodule" title="Permalink to this headline"></a></h3>
<dl class="class">
<dt id="seiscomp.datamodel.ConfigModule">
<em class="property">class </em><code class="sig-prename descclassname">seiscomp.datamodel.</code><code class="sig-name descname">ConfigModule</code><a class="headerlink" href="#seiscomp.datamodel.ConfigModule" title="Permalink to this definition"></a></dt>
<dd><p>Inherits <a class="reference internal" href="#api-python-datamodel-publicobject"><span class="std std-ref">PublicObject</span></a>.</p>
<p><strong>Parents</strong>:</p>
<ul class="simple">
<li><p><code class="docutils literal notranslate"><span class="pre">config</span></code> <a class="reference internal" href="#api-python-datamodel-config"><span class="std std-ref">Config</span></a></p></li>
</ul>
<p><strong>Children</strong>:</p>
<ul class="simple">
<li><p><code class="docutils literal notranslate"><span class="pre">configStation</span></code> <a class="reference internal" href="#api-python-datamodel-configstation"><span class="std std-ref">ConfigStation</span></a></p></li>
</ul>
<p><strong>Attributes</strong>:</p>
<ul class="simple">
<li><p><code class="docutils literal notranslate"><span class="pre">publicID</span></code>: string</p></li>
<li><p><code class="docutils literal notranslate"><span class="pre">name</span></code> string</p></li>
<li><p><code class="docutils literal notranslate"><span class="pre">parameterSetID</span></code> string</p></li>
<li><p><code class="docutils literal notranslate"><span class="pre">enabled</span></code> boolean</p></li>
</ul>
<p><strong>Referenced by</strong>:</p>
<ul class="simple">
<li><p><a class="reference internal" href="#seiscomp.datamodel.ParameterSet.moduleID" title="seiscomp.datamodel.ParameterSet.moduleID"><code class="xref py py-func docutils literal notranslate"><span class="pre">ParameterSet.moduleID()</span></code></a></p></li>
</ul>
<p><strong>Methods</strong>:</p>
<dl class="method">
<dt id="seiscomp.datamodel.ConfigModule.Cast">
<em class="property">static </em><code class="sig-name descname">Cast</code><span class="sig-paren">(</span><em class="sig-param">obj</em><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.ConfigModule.Cast" title="Permalink to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>obj</strong> The object to be casted.</p>
</dd>
<dt class="field-even">Return type</dt>
<dd class="field-even"><p>An object of type ConfigModule if the cast was successful,
None otherwise.</p>
</dd>
</dl>
<p>Cast an arbitrary object to ConfigModule if the internal wrapped
representation is an ConfigModule object. The cast is important if
instances of type <a class="reference internal" href="#api-python-datamodel-object"><span class="std std-ref">Object</span></a>
are passed to methods which need access to the real type.</p>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.ConfigModule.Create">
<em class="property">static </em><code class="sig-name descname">Create</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.ConfigModule.Create" title="Permalink to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Return type</dt>
<dd class="field-odd"><p>A new object of type ConfigModule.</p>
</dd>
</dl>
<p>Creates and registers (if enabled) a ConfigModule instance. The
publicID is auto-generated.</p>
</dd></dl>
<dl class="method">
<dt>
<em class="property">static </em><code class="sig-name descname">Create</code><span class="sig-paren">(</span><em class="sig-param">publicID</em><span class="sig-paren">)</span></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Return type</dt>
<dd class="field-odd"><p>A new object of type ConfigModule.</p>
</dd>
</dl>
<p>Creates and registers (if enabled) a ConfigModule instance with
passed publicID.</p>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.ConfigModule.equal">
<code class="sig-name descname">equal</code><span class="sig-paren">(</span><em class="sig-param">other</em><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.ConfigModule.equal" title="Permalink to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>other</strong> Another object of type ConfigModule to compare this
instance to</p>
</dd>
<dt class="field-even">Return type</dt>
<dd class="field-even"><p>A Boolean value indicating True if both objects are equal or
False otherwise.</p>
</dd>
</dl>
<p>Compares two objects without its child objects. Both objects are compared
by value.</p>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.ConfigModule.setName">
<code class="sig-name descname">setName</code><span class="sig-paren">(</span><em class="sig-param">name</em><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.ConfigModule.setName" title="Permalink to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>name</strong> string</p>
</dd>
</dl>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.ConfigModule.name">
<code class="sig-name descname">name</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.ConfigModule.name" title="Permalink to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Return type</dt>
<dd class="field-odd"><p>string</p>
</dd>
</dl>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.ConfigModule.setParameterSetID">
<code class="sig-name descname">setParameterSetID</code><span class="sig-paren">(</span><em class="sig-param">parameterSetID</em><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.ConfigModule.setParameterSetID" title="Permalink to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>parameterSetID</strong> string</p>
</dd>
</dl>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.ConfigModule.parameterSetID">
<code class="sig-name descname">parameterSetID</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.ConfigModule.parameterSetID" title="Permalink to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Return type</dt>
<dd class="field-odd"><p>string</p>
</dd>
</dl>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.ConfigModule.setEnabled">
<code class="sig-name descname">setEnabled</code><span class="sig-paren">(</span><em class="sig-param">enabled</em><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.ConfigModule.setEnabled" title="Permalink to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>enabled</strong> boolean</p>
</dd>
</dl>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.ConfigModule.enabled">
<code class="sig-name descname">enabled</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.ConfigModule.enabled" title="Permalink to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Return type</dt>
<dd class="field-odd"><p>boolean</p>
</dd>
</dl>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.ConfigModule.add">
<code class="sig-name descname">add</code><span class="sig-paren">(</span><em class="sig-param">configStation</em><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.ConfigModule.add" title="Permalink to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>configStation</strong> Object of type <a class="reference internal" href="#api-python-datamodel-configstation"><span class="std std-ref">ConfigStation</span></a></p>
</dd>
<dt class="field-even">Return type</dt>
<dd class="field-even"><p>A Boolean value indicating success with True, False otherwise.</p>
</dd>
</dl>
<p>Adds a ConfigStation object to ConfigModule. The object is not
copied but managed by this instance. Any change to the passed object
will also change the child.</p>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.ConfigModule.remove">
<code class="sig-name descname">remove</code><span class="sig-paren">(</span><em class="sig-param">configStation</em><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.ConfigModule.remove" title="Permalink to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>configStation</strong> Object of type <a class="reference internal" href="#api-python-datamodel-configstation"><span class="std std-ref">ConfigStation</span></a></p>
</dd>
<dt class="field-even">Return type</dt>
<dd class="field-even"><p>A Boolean value indicating success with True, False otherwise.</p>
</dd>
</dl>
<p>Removes a previously added ConfigStation object from ConfigModule.</p>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.ConfigModule.removeConfigStation">
<code class="sig-name descname">removeConfigStation</code><span class="sig-paren">(</span><em class="sig-param">idx</em><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.ConfigModule.removeConfigStation" title="Permalink to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>idx</strong> An integer index of the object to be removed.</p>
</dd>
<dt class="field-even">Return type</dt>
<dd class="field-even"><p>A Boolean value indicating success with True, False otherwise.</p>
</dd>
</dl>
</dd></dl>
<dl class="method">
<dt>
<code class="sig-name descname">removeConfigStation(configStationIndex);</code></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>configStationIndex</strong> The index of the object to be removed of type ConfigStationIndex.</p>
</dd>
<dt class="field-even">Return type</dt>
<dd class="field-even"><p>A Boolean value indicating success with True, False otherwise.</p>
</dd>
</dl>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.ConfigModule.configStationCount">
<code class="sig-name descname">configStationCount</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.ConfigModule.configStationCount" title="Permalink to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Return type</dt>
<dd class="field-odd"><p>integer value indicating the number of child objects.</p>
</dd>
</dl>
<p>Returns the number of ConfigStation child objects.</p>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.ConfigModule.configStation">
<code class="sig-name descname">configStation</code><span class="sig-paren">(</span><em class="sig-param">idx</em><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.ConfigModule.configStation" title="Permalink to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>idx</strong> An integer index of the object to be returned.</p>
</dd>
<dt class="field-even">Return type</dt>
<dd class="field-even"><p>Object of type <a class="reference internal" href="#api-python-datamodel-configstation"><span class="std std-ref">ConfigStation</span></a>.</p>
</dd>
</dl>
<p>Returns the ConfigStation at index idx.</p>
</dd></dl>
<dl class="method">
<dt>
<code class="sig-name descname">configStation</code><span class="sig-paren">(</span><em class="sig-param">configStationIndex</em><span class="sig-paren">)</span></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>configStationIndex</strong> The index of the object to be removed of type ConfigStationIndex.</p>
</dd>
<dt class="field-even">Return type</dt>
<dd class="field-even"><p>Object of type <a class="reference internal" href="#api-python-datamodel-configstation"><span class="std std-ref">ConfigStation</span></a>.</p>
</dd>
</dl>
<p>Returns the ConfigStation at given index. The indexes of all child objects
are compared by value which makes this function slower than the direct
integer index look-up.</p>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.ConfigModule.findConfigStation">
<code class="sig-name descname">findConfigStation</code><span class="sig-paren">(</span><em class="sig-param">publicID</em><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.ConfigModule.findConfigStation" title="Permalink to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>publicID</strong> The publicID of the object to find.</p>
</dd>
<dt class="field-even">Return type</dt>
<dd class="field-even"><p>Object of type <a class="reference internal" href="#api-python-datamodel-configstation"><span class="std std-ref">ConfigStation</span></a>.</p>
</dd>
</dl>
<p>Returns the child object with a certain publicID, None otherwise.</p>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.ConfigModule.config">
<code class="sig-name descname">config</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.ConfigModule.config" title="Permalink to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Return type</dt>
<dd class="field-odd"><p><a class="reference internal" href="#seiscomp.datamodel.Config" title="seiscomp.datamodel.Config">Config</a></p>
</dd>
</dl>
<p>Returns the parent Config if available. Returns None
if the parent is not a Config. This is a convenience wrapper
for parent().</p>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.ConfigModule.assign">
<code class="sig-name descname">assign</code><span class="sig-paren">(</span><em class="sig-param">other</em><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.ConfigModule.assign" title="Permalink to this definition"></a></dt>
<dd><p>This method implements the <a class="reference internal" href="#api-python-datamodel-object"><span class="std std-ref">Object</span></a> interface.</p>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.ConfigModule.attachTo">
<code class="sig-name descname">attachTo</code><span class="sig-paren">(</span><em class="sig-param">parent</em><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.ConfigModule.attachTo" title="Permalink to this definition"></a></dt>
<dd><p>This method implements the <a class="reference internal" href="#api-python-datamodel-object"><span class="std std-ref">Object</span></a> interface.</p>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.ConfigModule.detachFrom">
<code class="sig-name descname">detachFrom</code><span class="sig-paren">(</span><em class="sig-param">parent</em><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.ConfigModule.detachFrom" title="Permalink to this definition"></a></dt>
<dd><p>This method implements the <a class="reference internal" href="#api-python-datamodel-object"><span class="std std-ref">Object</span></a> interface.</p>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.ConfigModule.detach">
<code class="sig-name descname">detach</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.ConfigModule.detach" title="Permalink to this definition"></a></dt>
<dd><p>This method implements the <a class="reference internal" href="#api-python-datamodel-object"><span class="std std-ref">Object</span></a> interface.</p>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.ConfigModule.clone">
<code class="sig-name descname">clone</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.ConfigModule.clone" title="Permalink to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Return type</dt>
<dd class="field-odd"><p>A cloned ConfigModule.</p>
</dd>
</dl>
<p>Returns a new instance that is a clone of the current instance. Child
objects are being ignored.</p>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.ConfigModule.updateChild">
<code class="sig-name descname">updateChild</code><span class="sig-paren">(</span><em class="sig-param">ref</em><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.ConfigModule.updateChild" title="Permalink to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>ref</strong> A child object derived from class Object.</p>
</dd>
<dt class="field-even">Return type</dt>
<dd class="field-even"><p>A Boolean flag indicating success with True, False otherwise</p>
</dd>
</dl>
<p>This method takes the passed reference object and searches for a child
with the same publicID (if derived from <a class="reference internal" href="#api-python-datamodel-publicobject"><span class="std std-ref">PublicObject</span></a>)
or the same index (if derived from <a class="reference internal" href="#api-python-datamodel-object"><span class="std std-ref">Object</span></a>).
The the child was found the reference objects attributes are copied to
the child object. Children of child are being ignored during this operation.
This method implements the <a class="reference internal" href="#api-python-datamodel-publicobject"><span class="std std-ref">PublicObject</span></a> interface.</p>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.ConfigModule.accept">
<code class="sig-name descname">accept</code><span class="sig-paren">(</span><em class="sig-param">visitor</em><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.ConfigModule.accept" title="Permalink to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>visitor</strong> A visitor.</p>
</dd>
</dl>
<p>This method implements the <a class="reference internal" href="#api-python-datamodel-publicobject"><span class="std std-ref">PublicObject</span></a> interface.</p>
</dd></dl>
</dd></dl>
</div>
<div class="section" id="configstation">
<span id="api-python-datamodel-configstation"></span><h3>ConfigStation<a class="headerlink" href="#configstation" title="Permalink to this headline"></a></h3>
<dl class="class">
<dt id="seiscomp.datamodel.ConfigStation">
<em class="property">class </em><code class="sig-prename descclassname">seiscomp.datamodel.</code><code class="sig-name descname">ConfigStation</code><a class="headerlink" href="#seiscomp.datamodel.ConfigStation" title="Permalink to this definition"></a></dt>
<dd><p>Inherits <a class="reference internal" href="#api-python-datamodel-publicobject"><span class="std std-ref">PublicObject</span></a>.</p>
<p><strong>Parents</strong>:</p>
<ul class="simple">
<li><p><code class="docutils literal notranslate"><span class="pre">configModule</span></code> <a class="reference internal" href="#api-python-datamodel-configmodule"><span class="std std-ref">ConfigModule</span></a></p></li>
</ul>
<p><strong>Children</strong>:</p>
<ul class="simple">
<li><p><code class="docutils literal notranslate"><span class="pre">setup</span></code> <a class="reference internal" href="#api-python-datamodel-setup"><span class="std std-ref">Setup</span></a></p></li>
</ul>
<p><strong>Attributes</strong>:</p>
<ul class="simple">
<li><p><code class="docutils literal notranslate"><span class="pre">publicID</span></code>: string</p></li>
<li><p><code class="docutils literal notranslate"><span class="pre">networkCode</span></code> string</p></li>
<li><p><code class="docutils literal notranslate"><span class="pre">stationCode</span></code> string</p></li>
<li><p><code class="docutils literal notranslate"><span class="pre">enabled</span></code> boolean</p></li>
<li><p><code class="docutils literal notranslate"><span class="pre">creationInfo</span></code> <a class="reference internal" href="#api-python-datamodel-creationinfo"><span class="std std-ref">CreationInfo</span></a> (optional)</p></li>
</ul>
<p><strong>Methods</strong>:</p>
<dl class="method">
<dt id="seiscomp.datamodel.ConfigStation.Cast">
<em class="property">static </em><code class="sig-name descname">Cast</code><span class="sig-paren">(</span><em class="sig-param">obj</em><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.ConfigStation.Cast" title="Permalink to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>obj</strong> The object to be casted.</p>
</dd>
<dt class="field-even">Return type</dt>
<dd class="field-even"><p>An object of type ConfigStation if the cast was successful,
None otherwise.</p>
</dd>
</dl>
<p>Cast an arbitrary object to ConfigStation if the internal wrapped
representation is an ConfigStation object. The cast is important if
instances of type <a class="reference internal" href="#api-python-datamodel-object"><span class="std std-ref">Object</span></a>
are passed to methods which need access to the real type.</p>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.ConfigStation.Create">
<em class="property">static </em><code class="sig-name descname">Create</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.ConfigStation.Create" title="Permalink to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Return type</dt>
<dd class="field-odd"><p>A new object of type ConfigStation.</p>
</dd>
</dl>
<p>Creates and registers (if enabled) a ConfigStation instance. The
publicID is auto-generated.</p>
</dd></dl>
<dl class="method">
<dt>
<em class="property">static </em><code class="sig-name descname">Create</code><span class="sig-paren">(</span><em class="sig-param">publicID</em><span class="sig-paren">)</span></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Return type</dt>
<dd class="field-odd"><p>A new object of type ConfigStation.</p>
</dd>
</dl>
<p>Creates and registers (if enabled) a ConfigStation instance with
passed publicID.</p>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.ConfigStation.equal">
<code class="sig-name descname">equal</code><span class="sig-paren">(</span><em class="sig-param">other</em><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.ConfigStation.equal" title="Permalink to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>other</strong> Another object of type ConfigStation to compare this
instance to</p>
</dd>
<dt class="field-even">Return type</dt>
<dd class="field-even"><p>A Boolean value indicating True if both objects are equal or
False otherwise.</p>
</dd>
</dl>
<p>Compares two objects without its child objects. Both objects are compared
by value.</p>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.ConfigStation.index">
<code class="sig-name descname">index</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.ConfigStation.index" title="Permalink to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Return type</dt>
<dd class="field-odd"><p><p>The objects index of type ConfigStationIndex.</p>
<p>Returns the objects index which is also used for the database as unique
constraint.</p>
</p>
</dd>
</dl>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.ConfigStation.equalIndex">
<code class="sig-name descname">equalIndex</code><span class="sig-paren">(</span><em class="sig-param">lhs</em><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.ConfigStation.equalIndex" title="Permalink to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>lhs</strong> <a class="reference internal" href="#api-python-datamodel-configstation"><span class="std std-ref">ConfigStation</span></a></p>
</dd>
<dt class="field-even">Return type</dt>
<dd class="field-even"><p>A Boolean value indicating True if both indexes are equal or
False otherwise.</p>
</dd>
</dl>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.ConfigStation.setNetworkCode">
<code class="sig-name descname">setNetworkCode</code><span class="sig-paren">(</span><em class="sig-param">networkCode</em><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.ConfigStation.setNetworkCode" title="Permalink to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>networkCode</strong> string</p>
</dd>
</dl>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.ConfigStation.networkCode">
<code class="sig-name descname">networkCode</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.ConfigStation.networkCode" title="Permalink to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Return type</dt>
<dd class="field-odd"><p>string</p>
</dd>
</dl>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.ConfigStation.setStationCode">
<code class="sig-name descname">setStationCode</code><span class="sig-paren">(</span><em class="sig-param">stationCode</em><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.ConfigStation.setStationCode" title="Permalink to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>stationCode</strong> string</p>
</dd>
</dl>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.ConfigStation.stationCode">
<code class="sig-name descname">stationCode</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.ConfigStation.stationCode" title="Permalink to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Return type</dt>
<dd class="field-odd"><p>string</p>
</dd>
</dl>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.ConfigStation.setEnabled">
<code class="sig-name descname">setEnabled</code><span class="sig-paren">(</span><em class="sig-param">enabled</em><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.ConfigStation.setEnabled" title="Permalink to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>enabled</strong> boolean</p>
</dd>
</dl>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.ConfigStation.enabled">
<code class="sig-name descname">enabled</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.ConfigStation.enabled" title="Permalink to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Return type</dt>
<dd class="field-odd"><p>boolean</p>
</dd>
</dl>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.ConfigStation.setCreationInfo">
<code class="sig-name descname">setCreationInfo</code><span class="sig-paren">(</span><em class="sig-param">creationInfo</em><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.ConfigStation.setCreationInfo" title="Permalink to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>creationInfo</strong> <a class="reference internal" href="#api-python-datamodel-creationinfo"><span class="std std-ref">CreationInfo</span></a></p>
</dd>
</dl>
<p>CreationInfo for the ConfigStation object.</p>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.ConfigStation.creationInfo">
<code class="sig-name descname">creationInfo</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.ConfigStation.creationInfo" title="Permalink to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Return type</dt>
<dd class="field-odd"><p><a class="reference internal" href="#api-python-datamodel-creationinfo"><span class="std std-ref">CreationInfo</span></a></p>
</dd>
</dl>
<div class="admonition note">
<p class="admonition-title">Note</p>
<p>As this attribute is optional, this method throws a ValueError if
the value of the attribute is not set.</p>
</div>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.ConfigStation.add">
<code class="sig-name descname">add</code><span class="sig-paren">(</span><em class="sig-param">setup</em><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.ConfigStation.add" title="Permalink to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>setup</strong> Object of type <a class="reference internal" href="#api-python-datamodel-setup"><span class="std std-ref">Setup</span></a></p>
</dd>
<dt class="field-even">Return type</dt>
<dd class="field-even"><p>A Boolean value indicating success with True, False otherwise.</p>
</dd>
</dl>
<p>Adds a Setup object to ConfigStation. The object is not
copied but managed by this instance. Any change to the passed object
will also change the child.</p>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.ConfigStation.remove">
<code class="sig-name descname">remove</code><span class="sig-paren">(</span><em class="sig-param">setup</em><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.ConfigStation.remove" title="Permalink to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>setup</strong> Object of type <a class="reference internal" href="#api-python-datamodel-setup"><span class="std std-ref">Setup</span></a></p>
</dd>
<dt class="field-even">Return type</dt>
<dd class="field-even"><p>A Boolean value indicating success with True, False otherwise.</p>
</dd>
</dl>
<p>Removes a previously added Setup object from ConfigStation.</p>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.ConfigStation.removeSetup">
<code class="sig-name descname">removeSetup</code><span class="sig-paren">(</span><em class="sig-param">idx</em><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.ConfigStation.removeSetup" title="Permalink to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>idx</strong> An integer index of the object to be removed.</p>
</dd>
<dt class="field-even">Return type</dt>
<dd class="field-even"><p>A Boolean value indicating success with True, False otherwise.</p>
</dd>
</dl>
</dd></dl>
<dl class="method">
<dt>
<code class="sig-name descname">removeSetup(setupIndex);</code></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>setupIndex</strong> The index of the object to be removed of type SetupIndex.</p>
</dd>
<dt class="field-even">Return type</dt>
<dd class="field-even"><p>A Boolean value indicating success with True, False otherwise.</p>
</dd>
</dl>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.ConfigStation.setupCount">
<code class="sig-name descname">setupCount</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.ConfigStation.setupCount" title="Permalink to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Return type</dt>
<dd class="field-odd"><p>integer value indicating the number of child objects.</p>
</dd>
</dl>
<p>Returns the number of Setup child objects.</p>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.ConfigStation.setup">
<code class="sig-name descname">setup</code><span class="sig-paren">(</span><em class="sig-param">idx</em><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.ConfigStation.setup" title="Permalink to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>idx</strong> An integer index of the object to be returned.</p>
</dd>
<dt class="field-even">Return type</dt>
<dd class="field-even"><p>Object of type <a class="reference internal" href="#api-python-datamodel-setup"><span class="std std-ref">Setup</span></a>.</p>
</dd>
</dl>
<p>Returns the Setup at index idx.</p>
</dd></dl>
<dl class="method">
<dt>
<code class="sig-name descname">setup</code><span class="sig-paren">(</span><em class="sig-param">setupIndex</em><span class="sig-paren">)</span></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>setupIndex</strong> The index of the object to be removed of type SetupIndex.</p>
</dd>
<dt class="field-even">Return type</dt>
<dd class="field-even"><p>Object of type <a class="reference internal" href="#api-python-datamodel-setup"><span class="std std-ref">Setup</span></a>.</p>
</dd>
</dl>
<p>Returns the Setup at given index. The indexes of all child objects
are compared by value which makes this function slower than the direct
integer index look-up.</p>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.ConfigStation.configModule">
<code class="sig-name descname">configModule</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.ConfigStation.configModule" title="Permalink to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Return type</dt>
<dd class="field-odd"><p><a class="reference internal" href="#seiscomp.datamodel.ConfigModule" title="seiscomp.datamodel.ConfigModule">ConfigModule</a></p>
</dd>
</dl>
<p>Returns the parent ConfigModule if available. Returns None
if the parent is not a ConfigModule. This is a convenience wrapper
for parent().</p>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.ConfigStation.assign">
<code class="sig-name descname">assign</code><span class="sig-paren">(</span><em class="sig-param">other</em><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.ConfigStation.assign" title="Permalink to this definition"></a></dt>
<dd><p>This method implements the <a class="reference internal" href="#api-python-datamodel-object"><span class="std std-ref">Object</span></a> interface.</p>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.ConfigStation.attachTo">
<code class="sig-name descname">attachTo</code><span class="sig-paren">(</span><em class="sig-param">parent</em><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.ConfigStation.attachTo" title="Permalink to this definition"></a></dt>
<dd><p>This method implements the <a class="reference internal" href="#api-python-datamodel-object"><span class="std std-ref">Object</span></a> interface.</p>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.ConfigStation.detachFrom">
<code class="sig-name descname">detachFrom</code><span class="sig-paren">(</span><em class="sig-param">parent</em><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.ConfigStation.detachFrom" title="Permalink to this definition"></a></dt>
<dd><p>This method implements the <a class="reference internal" href="#api-python-datamodel-object"><span class="std std-ref">Object</span></a> interface.</p>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.ConfigStation.detach">
<code class="sig-name descname">detach</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.ConfigStation.detach" title="Permalink to this definition"></a></dt>
<dd><p>This method implements the <a class="reference internal" href="#api-python-datamodel-object"><span class="std std-ref">Object</span></a> interface.</p>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.ConfigStation.clone">
<code class="sig-name descname">clone</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.ConfigStation.clone" title="Permalink to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Return type</dt>
<dd class="field-odd"><p>A cloned ConfigStation.</p>
</dd>
</dl>
<p>Returns a new instance that is a clone of the current instance. Child
objects are being ignored.</p>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.ConfigStation.updateChild">
<code class="sig-name descname">updateChild</code><span class="sig-paren">(</span><em class="sig-param">ref</em><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.ConfigStation.updateChild" title="Permalink to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>ref</strong> A child object derived from class Object.</p>
</dd>
<dt class="field-even">Return type</dt>
<dd class="field-even"><p>A Boolean flag indicating success with True, False otherwise</p>
</dd>
</dl>
<p>This method takes the passed reference object and searches for a child
with the same publicID (if derived from <a class="reference internal" href="#api-python-datamodel-publicobject"><span class="std std-ref">PublicObject</span></a>)
or the same index (if derived from <a class="reference internal" href="#api-python-datamodel-object"><span class="std std-ref">Object</span></a>).
The the child was found the reference objects attributes are copied to
the child object. Children of child are being ignored during this operation.
This method implements the <a class="reference internal" href="#api-python-datamodel-publicobject"><span class="std std-ref">PublicObject</span></a> interface.</p>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.ConfigStation.accept">
<code class="sig-name descname">accept</code><span class="sig-paren">(</span><em class="sig-param">visitor</em><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.ConfigStation.accept" title="Permalink to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>visitor</strong> A visitor.</p>
</dd>
</dl>
<p>This method implements the <a class="reference internal" href="#api-python-datamodel-publicobject"><span class="std std-ref">PublicObject</span></a> interface.</p>
</dd></dl>
</dd></dl>
</div>
<div class="section" id="creationinfo">
<span id="api-python-datamodel-creationinfo"></span><h3>CreationInfo<a class="headerlink" href="#creationinfo" title="Permalink to this headline"></a></h3>
<dl class="class">
<dt id="seiscomp.datamodel.CreationInfo">
<em class="property">class </em><code class="sig-prename descclassname">seiscomp.datamodel.</code><code class="sig-name descname">CreationInfo</code><a class="headerlink" href="#seiscomp.datamodel.CreationInfo" title="Permalink to this definition"></a></dt>
<dd><p>Inherits <a class="reference internal" href="#api-python-datamodel-object"><span class="std std-ref">Object</span></a>.</p>
<p>CreationInfo is used to describe creation metadata (author, version, and
creation time) of a resource.</p>
<p><strong>Attributes</strong>:</p>
<ul class="simple">
<li><p><code class="docutils literal notranslate"><span class="pre">agencyID</span></code> string</p></li>
<li><p><code class="docutils literal notranslate"><span class="pre">agencyURI</span></code> string</p></li>
<li><p><code class="docutils literal notranslate"><span class="pre">author</span></code> string</p></li>
<li><p><code class="docutils literal notranslate"><span class="pre">authorURI</span></code> string</p></li>
<li><p><code class="docutils literal notranslate"><span class="pre">creationTime</span></code> seiscomp.core.Time (optional)</p></li>
<li><p><code class="docutils literal notranslate"><span class="pre">modificationTime</span></code> seiscomp.core.Time (optional)</p></li>
<li><p><code class="docutils literal notranslate"><span class="pre">version</span></code> string</p></li>
</ul>
<p><strong>Used by</strong>:</p>
<ul class="simple">
<li><p><a class="reference internal" href="#seiscomp.datamodel.Amplitude.creationInfo" title="seiscomp.datamodel.Amplitude.creationInfo"><code class="xref py py-func docutils literal notranslate"><span class="pre">Amplitude.creationInfo()</span></code></a></p></li>
<li><p><a class="reference internal" href="#seiscomp.datamodel.Arrival.creationInfo" title="seiscomp.datamodel.Arrival.creationInfo"><code class="xref py py-func docutils literal notranslate"><span class="pre">Arrival.creationInfo()</span></code></a></p></li>
<li><p><a class="reference internal" href="#seiscomp.datamodel.Comment.creationInfo" title="seiscomp.datamodel.Comment.creationInfo"><code class="xref py py-func docutils literal notranslate"><span class="pre">Comment.creationInfo()</span></code></a></p></li>
<li><p><a class="reference internal" href="#seiscomp.datamodel.ConfigStation.creationInfo" title="seiscomp.datamodel.ConfigStation.creationInfo"><code class="xref py py-func docutils literal notranslate"><span class="pre">ConfigStation.creationInfo()</span></code></a></p></li>
<li><p><a class="reference internal" href="#seiscomp.datamodel.Event.creationInfo" title="seiscomp.datamodel.Event.creationInfo"><code class="xref py py-func docutils literal notranslate"><span class="pre">Event.creationInfo()</span></code></a></p></li>
<li><p><a class="reference internal" href="#seiscomp.datamodel.FocalMechanism.creationInfo" title="seiscomp.datamodel.FocalMechanism.creationInfo"><code class="xref py py-func docutils literal notranslate"><span class="pre">FocalMechanism.creationInfo()</span></code></a></p></li>
<li><p><a class="reference internal" href="#seiscomp.datamodel.Magnitude.creationInfo" title="seiscomp.datamodel.Magnitude.creationInfo"><code class="xref py py-func docutils literal notranslate"><span class="pre">Magnitude.creationInfo()</span></code></a></p></li>
<li><p><a class="reference internal" href="#seiscomp.datamodel.MomentTensor.creationInfo" title="seiscomp.datamodel.MomentTensor.creationInfo"><code class="xref py py-func docutils literal notranslate"><span class="pre">MomentTensor.creationInfo()</span></code></a></p></li>
<li><p><a class="reference internal" href="#seiscomp.datamodel.Origin.creationInfo" title="seiscomp.datamodel.Origin.creationInfo"><code class="xref py py-func docutils literal notranslate"><span class="pre">Origin.creationInfo()</span></code></a></p></li>
<li><p><a class="reference internal" href="#seiscomp.datamodel.Pick.creationInfo" title="seiscomp.datamodel.Pick.creationInfo"><code class="xref py py-func docutils literal notranslate"><span class="pre">Pick.creationInfo()</span></code></a></p></li>
<li><p><a class="reference internal" href="#seiscomp.datamodel.StationMagnitude.creationInfo" title="seiscomp.datamodel.StationMagnitude.creationInfo"><code class="xref py py-func docutils literal notranslate"><span class="pre">StationMagnitude.creationInfo()</span></code></a></p></li>
</ul>
<p><strong>Methods</strong>:</p>
<dl class="method">
<dt id="seiscomp.datamodel.CreationInfo.Cast">
<em class="property">static </em><code class="sig-name descname">Cast</code><span class="sig-paren">(</span><em class="sig-param">obj</em><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.CreationInfo.Cast" title="Permalink to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>obj</strong> The object to be casted.</p>
</dd>
<dt class="field-even">Return type</dt>
<dd class="field-even"><p>An object of type CreationInfo if the cast was successful,
None otherwise.</p>
</dd>
</dl>
<p>Cast an arbitrary object to CreationInfo if the internal wrapped
representation is an CreationInfo object. The cast is important if
instances of type <a class="reference internal" href="#api-python-datamodel-object"><span class="std std-ref">Object</span></a>
are passed to methods which need access to the real type.</p>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.CreationInfo.equal">
<code class="sig-name descname">equal</code><span class="sig-paren">(</span><em class="sig-param">other</em><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.CreationInfo.equal" title="Permalink to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>other</strong> Another object of type CreationInfo to compare this
instance to</p>
</dd>
<dt class="field-even">Return type</dt>
<dd class="field-even"><p>A Boolean value indicating True if both objects are equal or
False otherwise.</p>
</dd>
</dl>
<p>Compares two objects without its child objects. Both objects are compared
by value.</p>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.CreationInfo.setAgencyID">
<code class="sig-name descname">setAgencyID</code><span class="sig-paren">(</span><em class="sig-param">agencyID</em><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.CreationInfo.setAgencyID" title="Permalink to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>agencyID</strong> string</p>
</dd>
</dl>
<p>Designation of agency that published a resource. The string has a maximum
length of 64 characters.</p>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.CreationInfo.agencyID">
<code class="sig-name descname">agencyID</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.CreationInfo.agencyID" title="Permalink to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Return type</dt>
<dd class="field-odd"><p>string</p>
</dd>
</dl>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.CreationInfo.setAgencyURI">
<code class="sig-name descname">setAgencyURI</code><span class="sig-paren">(</span><em class="sig-param">agencyURI</em><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.CreationInfo.setAgencyURI" title="Permalink to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>agencyURI</strong> string</p>
</dd>
</dl>
<p>RI of the agency that published a resource.</p>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.CreationInfo.agencyURI">
<code class="sig-name descname">agencyURI</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.CreationInfo.agencyURI" title="Permalink to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Return type</dt>
<dd class="field-odd"><p>string</p>
</dd>
</dl>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.CreationInfo.setAuthor">
<code class="sig-name descname">setAuthor</code><span class="sig-paren">(</span><em class="sig-param">author</em><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.CreationInfo.setAuthor" title="Permalink to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>author</strong> string</p>
</dd>
</dl>
<p>Name describing the author of a resource. The string has a maximum length of
128 characters.</p>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.CreationInfo.author">
<code class="sig-name descname">author</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.CreationInfo.author" title="Permalink to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Return type</dt>
<dd class="field-odd"><p>string</p>
</dd>
</dl>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.CreationInfo.setAuthorURI">
<code class="sig-name descname">setAuthorURI</code><span class="sig-paren">(</span><em class="sig-param">authorURI</em><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.CreationInfo.setAuthorURI" title="Permalink to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>authorURI</strong> string</p>
</dd>
</dl>
<p>RI of the author of a resource.</p>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.CreationInfo.authorURI">
<code class="sig-name descname">authorURI</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.CreationInfo.authorURI" title="Permalink to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Return type</dt>
<dd class="field-odd"><p>string</p>
</dd>
</dl>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.CreationInfo.setCreationTime">
<code class="sig-name descname">setCreationTime</code><span class="sig-paren">(</span><em class="sig-param">creationTime</em><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.CreationInfo.setCreationTime" title="Permalink to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>creationTime</strong> seiscomp.core.Time</p>
</dd>
</dl>
<p>Time of creation of a resource, in ISO 8601 format. It has to be given in
UTC.</p>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.CreationInfo.creationTime">
<code class="sig-name descname">creationTime</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.CreationInfo.creationTime" title="Permalink to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Return type</dt>
<dd class="field-odd"><p>seiscomp.core.Time</p>
</dd>
</dl>
<div class="admonition note">
<p class="admonition-title">Note</p>
<p>As this attribute is optional, this method throws a ValueError if
the value of the attribute is not set.</p>
</div>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.CreationInfo.setModificationTime">
<code class="sig-name descname">setModificationTime</code><span class="sig-paren">(</span><em class="sig-param">modificationTime</em><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.CreationInfo.setModificationTime" title="Permalink to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>modificationTime</strong> seiscomp.core.Time</p>
</dd>
</dl>
<p>Time of last modification of a resource, in ISO 8601 format. It has to be
given in UTC.</p>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.CreationInfo.modificationTime">
<code class="sig-name descname">modificationTime</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.CreationInfo.modificationTime" title="Permalink to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Return type</dt>
<dd class="field-odd"><p>seiscomp.core.Time</p>
</dd>
</dl>
<div class="admonition note">
<p class="admonition-title">Note</p>
<p>As this attribute is optional, this method throws a ValueError if
the value of the attribute is not set.</p>
</div>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.CreationInfo.setVersion">
<code class="sig-name descname">setVersion</code><span class="sig-paren">(</span><em class="sig-param">version</em><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.CreationInfo.setVersion" title="Permalink to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>version</strong> string</p>
</dd>
</dl>
<p>Version string of a resource.</p>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.CreationInfo.version">
<code class="sig-name descname">version</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.CreationInfo.version" title="Permalink to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Return type</dt>
<dd class="field-odd"><p>string</p>
</dd>
</dl>
</dd></dl>
</dd></dl>
</div>
<div class="section" id="dataattributeextent">
<span id="api-python-datamodel-dataattributeextent"></span><h3>DataAttributeExtent<a class="headerlink" href="#dataattributeextent" title="Permalink to this headline"></a></h3>
<dl class="class">
<dt id="seiscomp.datamodel.DataAttributeExtent">
<em class="property">class </em><code class="sig-prename descclassname">seiscomp.datamodel.</code><code class="sig-name descname">DataAttributeExtent</code><a class="headerlink" href="#seiscomp.datamodel.DataAttributeExtent" title="Permalink to this definition"></a></dt>
<dd><p>Inherits <a class="reference internal" href="#api-python-datamodel-object"><span class="std std-ref">Object</span></a>.</p>
<p><strong>Parents</strong>:</p>
<ul class="simple">
<li><p><code class="docutils literal notranslate"><span class="pre">dataExtent</span></code> <a class="reference internal" href="#api-python-datamodel-dataextent"><span class="std std-ref">DataExtent</span></a></p></li>
</ul>
<p><strong>Attributes</strong>:</p>
<ul class="simple">
<li><p><code class="docutils literal notranslate"><span class="pre">start</span></code> seiscomp.core.Time</p></li>
<li><p><code class="docutils literal notranslate"><span class="pre">end</span></code> seiscomp.core.Time</p></li>
<li><p><code class="docutils literal notranslate"><span class="pre">sampleRate</span></code> double</p></li>
<li><p><code class="docutils literal notranslate"><span class="pre">quality</span></code> string</p></li>
<li><p><code class="docutils literal notranslate"><span class="pre">updated</span></code> seiscomp.core.Time</p></li>
<li><p><code class="docutils literal notranslate"><span class="pre">segmentCount</span></code> int</p></li>
</ul>
<p><strong>Methods</strong>:</p>
<dl class="method">
<dt id="seiscomp.datamodel.DataAttributeExtent.Cast">
<em class="property">static </em><code class="sig-name descname">Cast</code><span class="sig-paren">(</span><em class="sig-param">obj</em><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.DataAttributeExtent.Cast" title="Permalink to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>obj</strong> The object to be casted.</p>
</dd>
<dt class="field-even">Return type</dt>
<dd class="field-even"><p>An object of type DataAttributeExtent if the cast was successful,
None otherwise.</p>
</dd>
</dl>
<p>Cast an arbitrary object to DataAttributeExtent if the internal wrapped
representation is an DataAttributeExtent object. The cast is important if
instances of type <a class="reference internal" href="#api-python-datamodel-object"><span class="std std-ref">Object</span></a>
are passed to methods which need access to the real type.</p>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.DataAttributeExtent.equal">
<code class="sig-name descname">equal</code><span class="sig-paren">(</span><em class="sig-param">other</em><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.DataAttributeExtent.equal" title="Permalink to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>other</strong> Another object of type DataAttributeExtent to compare this
instance to</p>
</dd>
<dt class="field-even">Return type</dt>
<dd class="field-even"><p>A Boolean value indicating True if both objects are equal or
False otherwise.</p>
</dd>
</dl>
<p>Compares two objects without its child objects. Both objects are compared
by value.</p>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.DataAttributeExtent.index">
<code class="sig-name descname">index</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.DataAttributeExtent.index" title="Permalink to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Return type</dt>
<dd class="field-odd"><p><p>The objects index of type DataAttributeExtentIndex.</p>
<p>Returns the objects index which is also used for the database as unique
constraint.</p>
</p>
</dd>
</dl>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.DataAttributeExtent.equalIndex">
<code class="sig-name descname">equalIndex</code><span class="sig-paren">(</span><em class="sig-param">lhs</em><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.DataAttributeExtent.equalIndex" title="Permalink to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>lhs</strong> <a class="reference internal" href="#api-python-datamodel-dataattributeextent"><span class="std std-ref">DataAttributeExtent</span></a></p>
</dd>
<dt class="field-even">Return type</dt>
<dd class="field-even"><p>A Boolean value indicating True if both indexes are equal or
False otherwise.</p>
</dd>
</dl>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.DataAttributeExtent.setStart">
<code class="sig-name descname">setStart</code><span class="sig-paren">(</span><em class="sig-param">start</em><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.DataAttributeExtent.setStart" title="Permalink to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>start</strong> seiscomp.core.Time</p>
</dd>
</dl>
<p>Time of first sample of data attribute extent.</p>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.DataAttributeExtent.start">
<code class="sig-name descname">start</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.DataAttributeExtent.start" title="Permalink to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Return type</dt>
<dd class="field-odd"><p>seiscomp.core.Time</p>
</dd>
</dl>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.DataAttributeExtent.setEnd">
<code class="sig-name descname">setEnd</code><span class="sig-paren">(</span><em class="sig-param">end</em><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.DataAttributeExtent.setEnd" title="Permalink to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>end</strong> seiscomp.core.Time</p>
</dd>
</dl>
<p>Time after last sample of data attribute extent.</p>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.DataAttributeExtent.end">
<code class="sig-name descname">end</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.DataAttributeExtent.end" title="Permalink to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Return type</dt>
<dd class="field-odd"><p>seiscomp.core.Time</p>
</dd>
</dl>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.DataAttributeExtent.setSampleRate">
<code class="sig-name descname">setSampleRate</code><span class="sig-paren">(</span><em class="sig-param">sampleRate</em><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.DataAttributeExtent.setSampleRate" title="Permalink to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>sampleRate</strong> double</p>
</dd>
</dl>
<p>Sample rate of the current data attribute extent.</p>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.DataAttributeExtent.sampleRate">
<code class="sig-name descname">sampleRate</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.DataAttributeExtent.sampleRate" title="Permalink to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Return type</dt>
<dd class="field-odd"><p>double</p>
</dd>
</dl>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.DataAttributeExtent.setQuality">
<code class="sig-name descname">setQuality</code><span class="sig-paren">(</span><em class="sig-param">quality</em><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.DataAttributeExtent.setQuality" title="Permalink to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>quality</strong> string</p>
</dd>
</dl>
<p>Quality indicator of current data attribute extent.</p>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.DataAttributeExtent.quality">
<code class="sig-name descname">quality</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.DataAttributeExtent.quality" title="Permalink to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Return type</dt>
<dd class="field-odd"><p>string</p>
</dd>
</dl>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.DataAttributeExtent.setUpdated">
<code class="sig-name descname">setUpdated</code><span class="sig-paren">(</span><em class="sig-param">updated</em><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.DataAttributeExtent.setUpdated" title="Permalink to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>updated</strong> seiscomp.core.Time</p>
</dd>
</dl>
<p>The time of the last update or creation of this data attribute extent.</p>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.DataAttributeExtent.updated">
<code class="sig-name descname">updated</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.DataAttributeExtent.updated" title="Permalink to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Return type</dt>
<dd class="field-odd"><p>seiscomp.core.Time</p>
</dd>
</dl>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.DataAttributeExtent.setSegmentCount">
<code class="sig-name descname">setSegmentCount</code><span class="sig-paren">(</span><em class="sig-param">segmentCount</em><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.DataAttributeExtent.setSegmentCount" title="Permalink to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>segmentCount</strong> int</p>
</dd>
</dl>
<p>Number of data segments covered by this data attribute extent.</p>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.DataAttributeExtent.segmentCount">
<code class="sig-name descname">segmentCount</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.DataAttributeExtent.segmentCount" title="Permalink to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Return type</dt>
<dd class="field-odd"><p>int</p>
</dd>
</dl>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.DataAttributeExtent.dataExtent">
<code class="sig-name descname">dataExtent</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.DataAttributeExtent.dataExtent" title="Permalink to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Return type</dt>
<dd class="field-odd"><p><a class="reference internal" href="#seiscomp.datamodel.DataExtent" title="seiscomp.datamodel.DataExtent">DataExtent</a></p>
</dd>
</dl>
<p>Returns the parent DataExtent if available. Returns None
if the parent is not a DataExtent. This is a convenience wrapper
for parent().</p>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.DataAttributeExtent.assign">
<code class="sig-name descname">assign</code><span class="sig-paren">(</span><em class="sig-param">other</em><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.DataAttributeExtent.assign" title="Permalink to this definition"></a></dt>
<dd><p>This method implements the <a class="reference internal" href="#api-python-datamodel-object"><span class="std std-ref">Object</span></a> interface.</p>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.DataAttributeExtent.attachTo">
<code class="sig-name descname">attachTo</code><span class="sig-paren">(</span><em class="sig-param">parent</em><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.DataAttributeExtent.attachTo" title="Permalink to this definition"></a></dt>
<dd><p>This method implements the <a class="reference internal" href="#api-python-datamodel-object"><span class="std std-ref">Object</span></a> interface.</p>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.DataAttributeExtent.detachFrom">
<code class="sig-name descname">detachFrom</code><span class="sig-paren">(</span><em class="sig-param">parent</em><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.DataAttributeExtent.detachFrom" title="Permalink to this definition"></a></dt>
<dd><p>This method implements the <a class="reference internal" href="#api-python-datamodel-object"><span class="std std-ref">Object</span></a> interface.</p>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.DataAttributeExtent.detach">
<code class="sig-name descname">detach</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.DataAttributeExtent.detach" title="Permalink to this definition"></a></dt>
<dd><p>This method implements the <a class="reference internal" href="#api-python-datamodel-object"><span class="std std-ref">Object</span></a> interface.</p>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.DataAttributeExtent.clone">
<code class="sig-name descname">clone</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.DataAttributeExtent.clone" title="Permalink to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Return type</dt>
<dd class="field-odd"><p>A cloned DataAttributeExtent.</p>
</dd>
</dl>
<p>Returns a new instance that is a clone of the current instance. Child
objects are being ignored.</p>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.DataAttributeExtent.accept">
<code class="sig-name descname">accept</code><span class="sig-paren">(</span><em class="sig-param">visitor</em><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.DataAttributeExtent.accept" title="Permalink to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>visitor</strong> A visitor.</p>
</dd>
</dl>
<p>This method implements the <a class="reference internal" href="#api-python-datamodel-publicobject"><span class="std std-ref">PublicObject</span></a> interface.</p>
</dd></dl>
</dd></dl>
</div>
<div class="section" id="api-python-datamodel-dataavailability">
<span id="id13"></span><h3>DataAvailability<a class="headerlink" href="#api-python-datamodel-dataavailability" title="Permalink to this headline"></a></h3>
<dl class="class">
<dt id="seiscomp.datamodel.DataAvailability">
<em class="property">class </em><code class="sig-prename descclassname">seiscomp.datamodel.</code><code class="sig-name descname">DataAvailability</code><a class="headerlink" href="#seiscomp.datamodel.DataAvailability" title="Permalink to this definition"></a></dt>
<dd><p>Inherits <a class="reference internal" href="#api-python-datamodel-publicobject"><span class="std std-ref">PublicObject</span></a>.</p>
<p>This type can hold data availability related objects (extent and segment).</p>
<p><strong>Children</strong>:</p>
<ul class="simple">
<li><p><code class="docutils literal notranslate"><span class="pre">dataExtent</span></code> <a class="reference internal" href="#api-python-datamodel-dataextent"><span class="std std-ref">DataExtent</span></a></p></li>
</ul>
<p><strong>Attributes</strong>:</p>
<ul class="simple">
<li><p><code class="docutils literal notranslate"><span class="pre">publicID</span></code>: string</p></li>
</ul>
<p><strong>Methods</strong>:</p>
<dl class="method">
<dt id="seiscomp.datamodel.DataAvailability.Cast">
<em class="property">static </em><code class="sig-name descname">Cast</code><span class="sig-paren">(</span><em class="sig-param">obj</em><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.DataAvailability.Cast" title="Permalink to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>obj</strong> The object to be casted.</p>
</dd>
<dt class="field-even">Return type</dt>
<dd class="field-even"><p>An object of type DataAvailability if the cast was successful,
None otherwise.</p>
</dd>
</dl>
<p>Cast an arbitrary object to DataAvailability if the internal wrapped
representation is an DataAvailability object. The cast is important if
instances of type <a class="reference internal" href="#api-python-datamodel-object"><span class="std std-ref">Object</span></a>
are passed to methods which need access to the real type.</p>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.DataAvailability.equal">
<code class="sig-name descname">equal</code><span class="sig-paren">(</span><em class="sig-param">other</em><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.DataAvailability.equal" title="Permalink to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>other</strong> Another object of type DataAvailability to compare this
instance to</p>
</dd>
<dt class="field-even">Return type</dt>
<dd class="field-even"><p>A Boolean value indicating True if both objects are equal or
False otherwise.</p>
</dd>
</dl>
<p>Compares two objects without its child objects. Both objects are compared
by value.</p>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.DataAvailability.add">
<code class="sig-name descname">add</code><span class="sig-paren">(</span><em class="sig-param">dataExtent</em><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.DataAvailability.add" title="Permalink to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>dataExtent</strong> Object of type <a class="reference internal" href="#api-python-datamodel-dataextent"><span class="std std-ref">DataExtent</span></a></p>
</dd>
<dt class="field-even">Return type</dt>
<dd class="field-even"><p>A Boolean value indicating success with True, False otherwise.</p>
</dd>
</dl>
<p>Adds a DataExtent object to DataAvailability. The object is not
copied but managed by this instance. Any change to the passed object
will also change the child.</p>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.DataAvailability.remove">
<code class="sig-name descname">remove</code><span class="sig-paren">(</span><em class="sig-param">dataExtent</em><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.DataAvailability.remove" title="Permalink to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>dataExtent</strong> Object of type <a class="reference internal" href="#api-python-datamodel-dataextent"><span class="std std-ref">DataExtent</span></a></p>
</dd>
<dt class="field-even">Return type</dt>
<dd class="field-even"><p>A Boolean value indicating success with True, False otherwise.</p>
</dd>
</dl>
<p>Removes a previously added DataExtent object from DataAvailability.</p>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.DataAvailability.removeDataExtent">
<code class="sig-name descname">removeDataExtent</code><span class="sig-paren">(</span><em class="sig-param">idx</em><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.DataAvailability.removeDataExtent" title="Permalink to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>idx</strong> An integer index of the object to be removed.</p>
</dd>
<dt class="field-even">Return type</dt>
<dd class="field-even"><p>A Boolean value indicating success with True, False otherwise.</p>
</dd>
</dl>
</dd></dl>
<dl class="method">
<dt>
<code class="sig-name descname">removeDataExtent(dataExtentIndex);</code></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>dataExtentIndex</strong> The index of the object to be removed of type DataExtentIndex.</p>
</dd>
<dt class="field-even">Return type</dt>
<dd class="field-even"><p>A Boolean value indicating success with True, False otherwise.</p>
</dd>
</dl>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.DataAvailability.dataExtentCount">
<code class="sig-name descname">dataExtentCount</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.DataAvailability.dataExtentCount" title="Permalink to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Return type</dt>
<dd class="field-odd"><p>integer value indicating the number of child objects.</p>
</dd>
</dl>
<p>Returns the number of DataExtent child objects.</p>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.DataAvailability.dataExtent">
<code class="sig-name descname">dataExtent</code><span class="sig-paren">(</span><em class="sig-param">idx</em><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.DataAvailability.dataExtent" title="Permalink to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>idx</strong> An integer index of the object to be returned.</p>
</dd>
<dt class="field-even">Return type</dt>
<dd class="field-even"><p>Object of type <a class="reference internal" href="#api-python-datamodel-dataextent"><span class="std std-ref">DataExtent</span></a>.</p>
</dd>
</dl>
<p>Returns the DataExtent at index idx.</p>
</dd></dl>
<dl class="method">
<dt>
<code class="sig-name descname">dataExtent</code><span class="sig-paren">(</span><em class="sig-param">dataExtentIndex</em><span class="sig-paren">)</span></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>dataExtentIndex</strong> The index of the object to be removed of type DataExtentIndex.</p>
</dd>
<dt class="field-even">Return type</dt>
<dd class="field-even"><p>Object of type <a class="reference internal" href="#api-python-datamodel-dataextent"><span class="std std-ref">DataExtent</span></a>.</p>
</dd>
</dl>
<p>Returns the DataExtent at given index. The indexes of all child objects
are compared by value which makes this function slower than the direct
integer index look-up.</p>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.DataAvailability.findDataExtent">
<code class="sig-name descname">findDataExtent</code><span class="sig-paren">(</span><em class="sig-param">publicID</em><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.DataAvailability.findDataExtent" title="Permalink to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>publicID</strong> The publicID of the object to find.</p>
</dd>
<dt class="field-even">Return type</dt>
<dd class="field-even"><p>Object of type <a class="reference internal" href="#api-python-datamodel-dataextent"><span class="std std-ref">DataExtent</span></a>.</p>
</dd>
</dl>
<p>Returns the child object with a certain publicID, None otherwise.</p>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.DataAvailability.assign">
<code class="sig-name descname">assign</code><span class="sig-paren">(</span><em class="sig-param">other</em><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.DataAvailability.assign" title="Permalink to this definition"></a></dt>
<dd><p>This method implements the <a class="reference internal" href="#api-python-datamodel-object"><span class="std std-ref">Object</span></a> interface.</p>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.DataAvailability.attachTo">
<code class="sig-name descname">attachTo</code><span class="sig-paren">(</span><em class="sig-param">parent</em><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.DataAvailability.attachTo" title="Permalink to this definition"></a></dt>
<dd><p>This method implements the <a class="reference internal" href="#api-python-datamodel-object"><span class="std std-ref">Object</span></a> interface.</p>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.DataAvailability.detachFrom">
<code class="sig-name descname">detachFrom</code><span class="sig-paren">(</span><em class="sig-param">parent</em><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.DataAvailability.detachFrom" title="Permalink to this definition"></a></dt>
<dd><p>This method implements the <a class="reference internal" href="#api-python-datamodel-object"><span class="std std-ref">Object</span></a> interface.</p>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.DataAvailability.detach">
<code class="sig-name descname">detach</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.DataAvailability.detach" title="Permalink to this definition"></a></dt>
<dd><p>This method implements the <a class="reference internal" href="#api-python-datamodel-object"><span class="std std-ref">Object</span></a> interface.</p>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.DataAvailability.clone">
<code class="sig-name descname">clone</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.DataAvailability.clone" title="Permalink to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Return type</dt>
<dd class="field-odd"><p>A cloned DataAvailability.</p>
</dd>
</dl>
<p>Returns a new instance that is a clone of the current instance. Child
objects are being ignored.</p>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.DataAvailability.updateChild">
<code class="sig-name descname">updateChild</code><span class="sig-paren">(</span><em class="sig-param">ref</em><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.DataAvailability.updateChild" title="Permalink to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>ref</strong> A child object derived from class Object.</p>
</dd>
<dt class="field-even">Return type</dt>
<dd class="field-even"><p>A Boolean flag indicating success with True, False otherwise</p>
</dd>
</dl>
<p>This method takes the passed reference object and searches for a child
with the same publicID (if derived from <a class="reference internal" href="#api-python-datamodel-publicobject"><span class="std std-ref">PublicObject</span></a>)
or the same index (if derived from <a class="reference internal" href="#api-python-datamodel-object"><span class="std std-ref">Object</span></a>).
The the child was found the reference objects attributes are copied to
the child object. Children of child are being ignored during this operation.
This method implements the <a class="reference internal" href="#api-python-datamodel-publicobject"><span class="std std-ref">PublicObject</span></a> interface.</p>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.DataAvailability.accept">
<code class="sig-name descname">accept</code><span class="sig-paren">(</span><em class="sig-param">visitor</em><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.DataAvailability.accept" title="Permalink to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>visitor</strong> A visitor.</p>
</dd>
</dl>
<p>This method implements the <a class="reference internal" href="#api-python-datamodel-publicobject"><span class="std std-ref">PublicObject</span></a> interface.</p>
</dd></dl>
</dd></dl>
</div>
<div class="section" id="dataextent">
<span id="api-python-datamodel-dataextent"></span><h3>DataExtent<a class="headerlink" href="#dataextent" title="Permalink to this headline"></a></h3>
<dl class="class">
<dt id="seiscomp.datamodel.DataExtent">
<em class="property">class </em><code class="sig-prename descclassname">seiscomp.datamodel.</code><code class="sig-name descname">DataExtent</code><a class="headerlink" href="#seiscomp.datamodel.DataExtent" title="Permalink to this definition"></a></dt>
<dd><p>Inherits <a class="reference internal" href="#api-python-datamodel-publicobject"><span class="std std-ref">PublicObject</span></a>.</p>
<p><strong>Parents</strong>:</p>
<ul class="simple">
<li><p><code class="docutils literal notranslate"><span class="pre">dataAvailability</span></code> <a class="reference internal" href="#api-python-datamodel-dataavailability"><span class="std std-ref">DataAvailability</span></a></p></li>
</ul>
<p><strong>Children</strong>:</p>
<ul class="simple">
<li><p><code class="docutils literal notranslate"><span class="pre">dataSegment</span></code> <a class="reference internal" href="#api-python-datamodel-datasegment"><span class="std std-ref">DataSegment</span></a></p></li>
<li><p><code class="docutils literal notranslate"><span class="pre">dataAttributeExtent</span></code> <a class="reference internal" href="#api-python-datamodel-dataattributeextent"><span class="std std-ref">DataAttributeExtent</span></a></p></li>
</ul>
<p><strong>Attributes</strong>:</p>
<ul class="simple">
<li><p><code class="docutils literal notranslate"><span class="pre">publicID</span></code>: string</p></li>
<li><p><code class="docutils literal notranslate"><span class="pre">waveformID</span></code> <a class="reference internal" href="#api-python-datamodel-waveformstreamid"><span class="std std-ref">WaveformStreamID</span></a></p></li>
<li><p><code class="docutils literal notranslate"><span class="pre">start</span></code> seiscomp.core.Time</p></li>
<li><p><code class="docutils literal notranslate"><span class="pre">end</span></code> seiscomp.core.Time</p></li>
<li><p><code class="docutils literal notranslate"><span class="pre">updated</span></code> seiscomp.core.Time</p></li>
<li><p><code class="docutils literal notranslate"><span class="pre">lastScan</span></code> seiscomp.core.Time</p></li>
<li><p><code class="docutils literal notranslate"><span class="pre">segmentOverflow</span></code> boolean</p></li>
</ul>
<p><strong>Methods</strong>:</p>
<dl class="method">
<dt id="seiscomp.datamodel.DataExtent.Cast">
<em class="property">static </em><code class="sig-name descname">Cast</code><span class="sig-paren">(</span><em class="sig-param">obj</em><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.DataExtent.Cast" title="Permalink to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>obj</strong> The object to be casted.</p>
</dd>
<dt class="field-even">Return type</dt>
<dd class="field-even"><p>An object of type DataExtent if the cast was successful,
None otherwise.</p>
</dd>
</dl>
<p>Cast an arbitrary object to DataExtent if the internal wrapped
representation is an DataExtent object. The cast is important if
instances of type <a class="reference internal" href="#api-python-datamodel-object"><span class="std std-ref">Object</span></a>
are passed to methods which need access to the real type.</p>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.DataExtent.Create">
<em class="property">static </em><code class="sig-name descname">Create</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.DataExtent.Create" title="Permalink to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Return type</dt>
<dd class="field-odd"><p>A new object of type DataExtent.</p>
</dd>
</dl>
<p>Creates and registers (if enabled) a DataExtent instance. The
publicID is auto-generated.</p>
</dd></dl>
<dl class="method">
<dt>
<em class="property">static </em><code class="sig-name descname">Create</code><span class="sig-paren">(</span><em class="sig-param">publicID</em><span class="sig-paren">)</span></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Return type</dt>
<dd class="field-odd"><p>A new object of type DataExtent.</p>
</dd>
</dl>
<p>Creates and registers (if enabled) a DataExtent instance with
passed publicID.</p>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.DataExtent.equal">
<code class="sig-name descname">equal</code><span class="sig-paren">(</span><em class="sig-param">other</em><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.DataExtent.equal" title="Permalink to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>other</strong> Another object of type DataExtent to compare this
instance to</p>
</dd>
<dt class="field-even">Return type</dt>
<dd class="field-even"><p>A Boolean value indicating True if both objects are equal or
False otherwise.</p>
</dd>
</dl>
<p>Compares two objects without its child objects. Both objects are compared
by value.</p>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.DataExtent.index">
<code class="sig-name descname">index</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.DataExtent.index" title="Permalink to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Return type</dt>
<dd class="field-odd"><p><p>The objects index of type DataExtentIndex.</p>
<p>Returns the objects index which is also used for the database as unique
constraint.</p>
</p>
</dd>
</dl>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.DataExtent.equalIndex">
<code class="sig-name descname">equalIndex</code><span class="sig-paren">(</span><em class="sig-param">lhs</em><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.DataExtent.equalIndex" title="Permalink to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>lhs</strong> <a class="reference internal" href="#api-python-datamodel-dataextent"><span class="std std-ref">DataExtent</span></a></p>
</dd>
<dt class="field-even">Return type</dt>
<dd class="field-even"><p>A Boolean value indicating True if both indexes are equal or
False otherwise.</p>
</dd>
</dl>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.DataExtent.setWaveformID">
<code class="sig-name descname">setWaveformID</code><span class="sig-paren">(</span><em class="sig-param">waveformID</em><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.DataExtent.setWaveformID" title="Permalink to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>waveformID</strong> <a class="reference internal" href="#api-python-datamodel-waveformstreamid"><span class="std std-ref">WaveformStreamID</span></a></p>
</dd>
</dl>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.DataExtent.waveformID">
<code class="sig-name descname">waveformID</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.DataExtent.waveformID" title="Permalink to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Return type</dt>
<dd class="field-odd"><p><a class="reference internal" href="#api-python-datamodel-waveformstreamid"><span class="std std-ref">WaveformStreamID</span></a></p>
</dd>
</dl>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.DataExtent.setStart">
<code class="sig-name descname">setStart</code><span class="sig-paren">(</span><em class="sig-param">start</em><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.DataExtent.setStart" title="Permalink to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>start</strong> seiscomp.core.Time</p>
</dd>
</dl>
<p>Time of first sample of data available</p>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.DataExtent.start">
<code class="sig-name descname">start</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.DataExtent.start" title="Permalink to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Return type</dt>
<dd class="field-odd"><p>seiscomp.core.Time</p>
</dd>
</dl>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.DataExtent.setEnd">
<code class="sig-name descname">setEnd</code><span class="sig-paren">(</span><em class="sig-param">end</em><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.DataExtent.setEnd" title="Permalink to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>end</strong> seiscomp.core.Time</p>
</dd>
</dl>
<p>Time after last sample of data available</p>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.DataExtent.end">
<code class="sig-name descname">end</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.DataExtent.end" title="Permalink to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Return type</dt>
<dd class="field-odd"><p>seiscomp.core.Time</p>
</dd>
</dl>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.DataExtent.setUpdated">
<code class="sig-name descname">setUpdated</code><span class="sig-paren">(</span><em class="sig-param">updated</em><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.DataExtent.setUpdated" title="Permalink to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>updated</strong> seiscomp.core.Time</p>
</dd>
</dl>
<p>The time of the last update or creation of this segment</p>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.DataExtent.updated">
<code class="sig-name descname">updated</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.DataExtent.updated" title="Permalink to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Return type</dt>
<dd class="field-odd"><p>seiscomp.core.Time</p>
</dd>
</dl>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.DataExtent.setLastScan">
<code class="sig-name descname">setLastScan</code><span class="sig-paren">(</span><em class="sig-param">lastScan</em><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.DataExtent.setLastScan" title="Permalink to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>lastScan</strong> seiscomp.core.Time</p>
</dd>
</dl>
<p>The time of the last waveform archive scan</p>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.DataExtent.lastScan">
<code class="sig-name descname">lastScan</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.DataExtent.lastScan" title="Permalink to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Return type</dt>
<dd class="field-odd"><p>seiscomp.core.Time</p>
</dd>
</dl>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.DataExtent.setSegmentOverflow">
<code class="sig-name descname">setSegmentOverflow</code><span class="sig-paren">(</span><em class="sig-param">segmentOverflow</em><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.DataExtent.setSegmentOverflow" title="Permalink to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>segmentOverflow</strong> boolean</p>
</dd>
</dl>
<p>Flags the stream to be to fragmented for processing.</p>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.DataExtent.segmentOverflow">
<code class="sig-name descname">segmentOverflow</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.DataExtent.segmentOverflow" title="Permalink to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Return type</dt>
<dd class="field-odd"><p>boolean</p>
</dd>
</dl>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.DataExtent.add">
<code class="sig-name descname">add</code><span class="sig-paren">(</span><em class="sig-param">dataSegment</em><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.DataExtent.add" title="Permalink to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>dataSegment</strong> Object of type <a class="reference internal" href="#api-python-datamodel-datasegment"><span class="std std-ref">DataSegment</span></a></p>
</dd>
<dt class="field-even">Return type</dt>
<dd class="field-even"><p>A Boolean value indicating success with True, False otherwise.</p>
</dd>
</dl>
<p>Adds a DataSegment object to DataExtent. The object is not
copied but managed by this instance. Any change to the passed object
will also change the child.</p>
</dd></dl>
<dl class="method">
<dt>
<code class="sig-name descname">add</code><span class="sig-paren">(</span><em class="sig-param">dataAttributeExtent</em><span class="sig-paren">)</span></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>dataAttributeExtent</strong> Object of type <a class="reference internal" href="#api-python-datamodel-dataattributeextent"><span class="std std-ref">DataAttributeExtent</span></a></p>
</dd>
<dt class="field-even">Return type</dt>
<dd class="field-even"><p>A Boolean value indicating success with True, False otherwise.</p>
</dd>
</dl>
<p>Adds a DataAttributeExtent object to DataExtent. The object is not
copied but managed by this instance. Any change to the passed object
will also change the child.</p>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.DataExtent.remove">
<code class="sig-name descname">remove</code><span class="sig-paren">(</span><em class="sig-param">dataSegment</em><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.DataExtent.remove" title="Permalink to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>dataSegment</strong> Object of type <a class="reference internal" href="#api-python-datamodel-datasegment"><span class="std std-ref">DataSegment</span></a></p>
</dd>
<dt class="field-even">Return type</dt>
<dd class="field-even"><p>A Boolean value indicating success with True, False otherwise.</p>
</dd>
</dl>
<p>Removes a previously added DataSegment object from DataExtent.</p>
</dd></dl>
<dl class="method">
<dt>
<code class="sig-name descname">remove</code><span class="sig-paren">(</span><em class="sig-param">dataAttributeExtent</em><span class="sig-paren">)</span></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>dataAttributeExtent</strong> Object of type <a class="reference internal" href="#api-python-datamodel-dataattributeextent"><span class="std std-ref">DataAttributeExtent</span></a></p>
</dd>
<dt class="field-even">Return type</dt>
<dd class="field-even"><p>A Boolean value indicating success with True, False otherwise.</p>
</dd>
</dl>
<p>Removes a previously added DataAttributeExtent object from DataExtent.</p>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.DataExtent.removeDataSegment">
<code class="sig-name descname">removeDataSegment</code><span class="sig-paren">(</span><em class="sig-param">idx</em><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.DataExtent.removeDataSegment" title="Permalink to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>idx</strong> An integer index of the object to be removed.</p>
</dd>
<dt class="field-even">Return type</dt>
<dd class="field-even"><p>A Boolean value indicating success with True, False otherwise.</p>
</dd>
</dl>
</dd></dl>
<dl class="method">
<dt>
<code class="sig-name descname">removeDataSegment(dataSegmentIndex);</code></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>dataSegmentIndex</strong> The index of the object to be removed of type DataSegmentIndex.</p>
</dd>
<dt class="field-even">Return type</dt>
<dd class="field-even"><p>A Boolean value indicating success with True, False otherwise.</p>
</dd>
</dl>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.DataExtent.removeDataAttributeExtent">
<code class="sig-name descname">removeDataAttributeExtent</code><span class="sig-paren">(</span><em class="sig-param">idx</em><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.DataExtent.removeDataAttributeExtent" title="Permalink to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>idx</strong> An integer index of the object to be removed.</p>
</dd>
<dt class="field-even">Return type</dt>
<dd class="field-even"><p>A Boolean value indicating success with True, False otherwise.</p>
</dd>
</dl>
</dd></dl>
<dl class="method">
<dt>
<code class="sig-name descname">removeDataAttributeExtent(dataAttributeExtentIndex);</code></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>dataAttributeExtentIndex</strong> The index of the object to be removed of type DataAttributeExtentIndex.</p>
</dd>
<dt class="field-even">Return type</dt>
<dd class="field-even"><p>A Boolean value indicating success with True, False otherwise.</p>
</dd>
</dl>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.DataExtent.dataSegmentCount">
<code class="sig-name descname">dataSegmentCount</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.DataExtent.dataSegmentCount" title="Permalink to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Return type</dt>
<dd class="field-odd"><p>integer value indicating the number of child objects.</p>
</dd>
</dl>
<p>Returns the number of DataSegment child objects.</p>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.DataExtent.dataAttributeExtentCount">
<code class="sig-name descname">dataAttributeExtentCount</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.DataExtent.dataAttributeExtentCount" title="Permalink to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Return type</dt>
<dd class="field-odd"><p>integer value indicating the number of child objects.</p>
</dd>
</dl>
<p>Returns the number of DataAttributeExtent child objects.</p>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.DataExtent.dataSegment">
<code class="sig-name descname">dataSegment</code><span class="sig-paren">(</span><em class="sig-param">idx</em><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.DataExtent.dataSegment" title="Permalink to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>idx</strong> An integer index of the object to be returned.</p>
</dd>
<dt class="field-even">Return type</dt>
<dd class="field-even"><p>Object of type <a class="reference internal" href="#api-python-datamodel-datasegment"><span class="std std-ref">DataSegment</span></a>.</p>
</dd>
</dl>
<p>Returns the DataSegment at index idx.</p>
</dd></dl>
<dl class="method">
<dt>
<code class="sig-name descname">dataSegment</code><span class="sig-paren">(</span><em class="sig-param">dataSegmentIndex</em><span class="sig-paren">)</span></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>dataSegmentIndex</strong> The index of the object to be removed of type DataSegmentIndex.</p>
</dd>
<dt class="field-even">Return type</dt>
<dd class="field-even"><p>Object of type <a class="reference internal" href="#api-python-datamodel-datasegment"><span class="std std-ref">DataSegment</span></a>.</p>
</dd>
</dl>
<p>Returns the DataSegment at given index. The indexes of all child objects
are compared by value which makes this function slower than the direct
integer index look-up.</p>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.DataExtent.dataAttributeExtent">
<code class="sig-name descname">dataAttributeExtent</code><span class="sig-paren">(</span><em class="sig-param">idx</em><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.DataExtent.dataAttributeExtent" title="Permalink to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>idx</strong> An integer index of the object to be returned.</p>
</dd>
<dt class="field-even">Return type</dt>
<dd class="field-even"><p>Object of type <a class="reference internal" href="#api-python-datamodel-dataattributeextent"><span class="std std-ref">DataAttributeExtent</span></a>.</p>
</dd>
</dl>
<p>Returns the DataAttributeExtent at index idx.</p>
</dd></dl>
<dl class="method">
<dt>
<code class="sig-name descname">dataAttributeExtent</code><span class="sig-paren">(</span><em class="sig-param">dataAttributeExtentIndex</em><span class="sig-paren">)</span></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>dataAttributeExtentIndex</strong> The index of the object to be removed of type DataAttributeExtentIndex.</p>
</dd>
<dt class="field-even">Return type</dt>
<dd class="field-even"><p>Object of type <a class="reference internal" href="#api-python-datamodel-dataattributeextent"><span class="std std-ref">DataAttributeExtent</span></a>.</p>
</dd>
</dl>
<p>Returns the DataAttributeExtent at given index. The indexes of all child objects
are compared by value which makes this function slower than the direct
integer index look-up.</p>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.DataExtent.dataAvailability">
<code class="sig-name descname">dataAvailability</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.DataExtent.dataAvailability" title="Permalink to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Return type</dt>
<dd class="field-odd"><p><a class="reference internal" href="#seiscomp.datamodel.DataAvailability" title="seiscomp.datamodel.DataAvailability">DataAvailability</a></p>
</dd>
</dl>
<p>Returns the parent DataAvailability if available. Returns None
if the parent is not a DataAvailability. This is a convenience wrapper
for parent().</p>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.DataExtent.assign">
<code class="sig-name descname">assign</code><span class="sig-paren">(</span><em class="sig-param">other</em><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.DataExtent.assign" title="Permalink to this definition"></a></dt>
<dd><p>This method implements the <a class="reference internal" href="#api-python-datamodel-object"><span class="std std-ref">Object</span></a> interface.</p>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.DataExtent.attachTo">
<code class="sig-name descname">attachTo</code><span class="sig-paren">(</span><em class="sig-param">parent</em><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.DataExtent.attachTo" title="Permalink to this definition"></a></dt>
<dd><p>This method implements the <a class="reference internal" href="#api-python-datamodel-object"><span class="std std-ref">Object</span></a> interface.</p>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.DataExtent.detachFrom">
<code class="sig-name descname">detachFrom</code><span class="sig-paren">(</span><em class="sig-param">parent</em><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.DataExtent.detachFrom" title="Permalink to this definition"></a></dt>
<dd><p>This method implements the <a class="reference internal" href="#api-python-datamodel-object"><span class="std std-ref">Object</span></a> interface.</p>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.DataExtent.detach">
<code class="sig-name descname">detach</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.DataExtent.detach" title="Permalink to this definition"></a></dt>
<dd><p>This method implements the <a class="reference internal" href="#api-python-datamodel-object"><span class="std std-ref">Object</span></a> interface.</p>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.DataExtent.clone">
<code class="sig-name descname">clone</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.DataExtent.clone" title="Permalink to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Return type</dt>
<dd class="field-odd"><p>A cloned DataExtent.</p>
</dd>
</dl>
<p>Returns a new instance that is a clone of the current instance. Child
objects are being ignored.</p>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.DataExtent.updateChild">
<code class="sig-name descname">updateChild</code><span class="sig-paren">(</span><em class="sig-param">ref</em><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.DataExtent.updateChild" title="Permalink to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>ref</strong> A child object derived from class Object.</p>
</dd>
<dt class="field-even">Return type</dt>
<dd class="field-even"><p>A Boolean flag indicating success with True, False otherwise</p>
</dd>
</dl>
<p>This method takes the passed reference object and searches for a child
with the same publicID (if derived from <a class="reference internal" href="#api-python-datamodel-publicobject"><span class="std std-ref">PublicObject</span></a>)
or the same index (if derived from <a class="reference internal" href="#api-python-datamodel-object"><span class="std std-ref">Object</span></a>).
The the child was found the reference objects attributes are copied to
the child object. Children of child are being ignored during this operation.
This method implements the <a class="reference internal" href="#api-python-datamodel-publicobject"><span class="std std-ref">PublicObject</span></a> interface.</p>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.DataExtent.accept">
<code class="sig-name descname">accept</code><span class="sig-paren">(</span><em class="sig-param">visitor</em><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.DataExtent.accept" title="Permalink to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>visitor</strong> A visitor.</p>
</dd>
</dl>
<p>This method implements the <a class="reference internal" href="#api-python-datamodel-publicobject"><span class="std std-ref">PublicObject</span></a> interface.</p>
</dd></dl>
</dd></dl>
</div>
<div class="section" id="datasegment">
<span id="api-python-datamodel-datasegment"></span><h3>DataSegment<a class="headerlink" href="#datasegment" title="Permalink to this headline"></a></h3>
<dl class="class">
<dt id="seiscomp.datamodel.DataSegment">
<em class="property">class </em><code class="sig-prename descclassname">seiscomp.datamodel.</code><code class="sig-name descname">DataSegment</code><a class="headerlink" href="#seiscomp.datamodel.DataSegment" title="Permalink to this definition"></a></dt>
<dd><p>Inherits <a class="reference internal" href="#api-python-datamodel-object"><span class="std std-ref">Object</span></a>.</p>
<p><strong>Parents</strong>:</p>
<ul class="simple">
<li><p><code class="docutils literal notranslate"><span class="pre">dataExtent</span></code> <a class="reference internal" href="#api-python-datamodel-dataextent"><span class="std std-ref">DataExtent</span></a></p></li>
</ul>
<p><strong>Attributes</strong>:</p>
<ul class="simple">
<li><p><code class="docutils literal notranslate"><span class="pre">start</span></code> seiscomp.core.Time</p></li>
<li><p><code class="docutils literal notranslate"><span class="pre">end</span></code> seiscomp.core.Time</p></li>
<li><p><code class="docutils literal notranslate"><span class="pre">updated</span></code> seiscomp.core.Time</p></li>
<li><p><code class="docutils literal notranslate"><span class="pre">sampleRate</span></code> double</p></li>
<li><p><code class="docutils literal notranslate"><span class="pre">quality</span></code> string</p></li>
<li><p><code class="docutils literal notranslate"><span class="pre">outOfOrder</span></code> boolean</p></li>
</ul>
<p><strong>Methods</strong>:</p>
<dl class="method">
<dt id="seiscomp.datamodel.DataSegment.Cast">
<em class="property">static </em><code class="sig-name descname">Cast</code><span class="sig-paren">(</span><em class="sig-param">obj</em><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.DataSegment.Cast" title="Permalink to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>obj</strong> The object to be casted.</p>
</dd>
<dt class="field-even">Return type</dt>
<dd class="field-even"><p>An object of type DataSegment if the cast was successful,
None otherwise.</p>
</dd>
</dl>
<p>Cast an arbitrary object to DataSegment if the internal wrapped
representation is an DataSegment object. The cast is important if
instances of type <a class="reference internal" href="#api-python-datamodel-object"><span class="std std-ref">Object</span></a>
are passed to methods which need access to the real type.</p>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.DataSegment.equal">
<code class="sig-name descname">equal</code><span class="sig-paren">(</span><em class="sig-param">other</em><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.DataSegment.equal" title="Permalink to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>other</strong> Another object of type DataSegment to compare this
instance to</p>
</dd>
<dt class="field-even">Return type</dt>
<dd class="field-even"><p>A Boolean value indicating True if both objects are equal or
False otherwise.</p>
</dd>
</dl>
<p>Compares two objects without its child objects. Both objects are compared
by value.</p>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.DataSegment.index">
<code class="sig-name descname">index</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.DataSegment.index" title="Permalink to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Return type</dt>
<dd class="field-odd"><p><p>The objects index of type DataSegmentIndex.</p>
<p>Returns the objects index which is also used for the database as unique
constraint.</p>
</p>
</dd>
</dl>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.DataSegment.equalIndex">
<code class="sig-name descname">equalIndex</code><span class="sig-paren">(</span><em class="sig-param">lhs</em><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.DataSegment.equalIndex" title="Permalink to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>lhs</strong> <a class="reference internal" href="#api-python-datamodel-datasegment"><span class="std std-ref">DataSegment</span></a></p>
</dd>
<dt class="field-even">Return type</dt>
<dd class="field-even"><p>A Boolean value indicating True if both indexes are equal or
False otherwise.</p>
</dd>
</dl>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.DataSegment.setStart">
<code class="sig-name descname">setStart</code><span class="sig-paren">(</span><em class="sig-param">start</em><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.DataSegment.setStart" title="Permalink to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>start</strong> seiscomp.core.Time</p>
</dd>
</dl>
<p>Time of first sample of data segment.</p>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.DataSegment.start">
<code class="sig-name descname">start</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.DataSegment.start" title="Permalink to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Return type</dt>
<dd class="field-odd"><p>seiscomp.core.Time</p>
</dd>
</dl>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.DataSegment.setEnd">
<code class="sig-name descname">setEnd</code><span class="sig-paren">(</span><em class="sig-param">end</em><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.DataSegment.setEnd" title="Permalink to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>end</strong> seiscomp.core.Time</p>
</dd>
</dl>
<p>Time after last sample of data segment.</p>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.DataSegment.end">
<code class="sig-name descname">end</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.DataSegment.end" title="Permalink to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Return type</dt>
<dd class="field-odd"><p>seiscomp.core.Time</p>
</dd>
</dl>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.DataSegment.setUpdated">
<code class="sig-name descname">setUpdated</code><span class="sig-paren">(</span><em class="sig-param">updated</em><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.DataSegment.setUpdated" title="Permalink to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>updated</strong> seiscomp.core.Time</p>
</dd>
</dl>
<p>The time of the last update or creation of this data segment.</p>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.DataSegment.updated">
<code class="sig-name descname">updated</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.DataSegment.updated" title="Permalink to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Return type</dt>
<dd class="field-odd"><p>seiscomp.core.Time</p>
</dd>
</dl>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.DataSegment.setSampleRate">
<code class="sig-name descname">setSampleRate</code><span class="sig-paren">(</span><em class="sig-param">sampleRate</em><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.DataSegment.setSampleRate" title="Permalink to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>sampleRate</strong> double</p>
</dd>
</dl>
<p>Sample rate of the current data segment.</p>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.DataSegment.sampleRate">
<code class="sig-name descname">sampleRate</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.DataSegment.sampleRate" title="Permalink to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Return type</dt>
<dd class="field-odd"><p>double</p>
</dd>
</dl>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.DataSegment.setQuality">
<code class="sig-name descname">setQuality</code><span class="sig-paren">(</span><em class="sig-param">quality</em><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.DataSegment.setQuality" title="Permalink to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>quality</strong> string</p>
</dd>
</dl>
<p>Quality indicator of current data segment.</p>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.DataSegment.quality">
<code class="sig-name descname">quality</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.DataSegment.quality" title="Permalink to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Return type</dt>
<dd class="field-odd"><p>string</p>
</dd>
</dl>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.DataSegment.setOutOfOrder">
<code class="sig-name descname">setOutOfOrder</code><span class="sig-paren">(</span><em class="sig-param">outOfOrder</em><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.DataSegment.setOutOfOrder" title="Permalink to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>outOfOrder</strong> boolean</p>
</dd>
</dl>
<p>Whether this segment is an out-of-order segment or not.</p>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.DataSegment.outOfOrder">
<code class="sig-name descname">outOfOrder</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.DataSegment.outOfOrder" title="Permalink to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Return type</dt>
<dd class="field-odd"><p>boolean</p>
</dd>
</dl>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.DataSegment.dataExtent">
<code class="sig-name descname">dataExtent</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.DataSegment.dataExtent" title="Permalink to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Return type</dt>
<dd class="field-odd"><p><a class="reference internal" href="#seiscomp.datamodel.DataExtent" title="seiscomp.datamodel.DataExtent">DataExtent</a></p>
</dd>
</dl>
<p>Returns the parent DataExtent if available. Returns None
if the parent is not a DataExtent. This is a convenience wrapper
for parent().</p>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.DataSegment.assign">
<code class="sig-name descname">assign</code><span class="sig-paren">(</span><em class="sig-param">other</em><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.DataSegment.assign" title="Permalink to this definition"></a></dt>
<dd><p>This method implements the <a class="reference internal" href="#api-python-datamodel-object"><span class="std std-ref">Object</span></a> interface.</p>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.DataSegment.attachTo">
<code class="sig-name descname">attachTo</code><span class="sig-paren">(</span><em class="sig-param">parent</em><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.DataSegment.attachTo" title="Permalink to this definition"></a></dt>
<dd><p>This method implements the <a class="reference internal" href="#api-python-datamodel-object"><span class="std std-ref">Object</span></a> interface.</p>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.DataSegment.detachFrom">
<code class="sig-name descname">detachFrom</code><span class="sig-paren">(</span><em class="sig-param">parent</em><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.DataSegment.detachFrom" title="Permalink to this definition"></a></dt>
<dd><p>This method implements the <a class="reference internal" href="#api-python-datamodel-object"><span class="std std-ref">Object</span></a> interface.</p>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.DataSegment.detach">
<code class="sig-name descname">detach</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.DataSegment.detach" title="Permalink to this definition"></a></dt>
<dd><p>This method implements the <a class="reference internal" href="#api-python-datamodel-object"><span class="std std-ref">Object</span></a> interface.</p>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.DataSegment.clone">
<code class="sig-name descname">clone</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.DataSegment.clone" title="Permalink to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Return type</dt>
<dd class="field-odd"><p>A cloned DataSegment.</p>
</dd>
</dl>
<p>Returns a new instance that is a clone of the current instance. Child
objects are being ignored.</p>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.DataSegment.accept">
<code class="sig-name descname">accept</code><span class="sig-paren">(</span><em class="sig-param">visitor</em><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.DataSegment.accept" title="Permalink to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>visitor</strong> A visitor.</p>
</dd>
</dl>
<p>This method implements the <a class="reference internal" href="#api-python-datamodel-publicobject"><span class="std std-ref">PublicObject</span></a> interface.</p>
</dd></dl>
</dd></dl>
</div>
<div class="section" id="dataused">
<span id="api-python-datamodel-dataused"></span><h3>DataUsed<a class="headerlink" href="#dataused" title="Permalink to this headline"></a></h3>
<dl class="class">
<dt id="seiscomp.datamodel.DataUsed">
<em class="property">class </em><code class="sig-prename descclassname">seiscomp.datamodel.</code><code class="sig-name descname">DataUsed</code><a class="headerlink" href="#seiscomp.datamodel.DataUsed" title="Permalink to this definition"></a></dt>
<dd><p>Inherits <a class="reference internal" href="#api-python-datamodel-object"><span class="std std-ref">Object</span></a>.</p>
<p>The DataUsed class describes the type of data that has been used for a
moment-tensor inversion.</p>
<p><strong>Parents</strong>:</p>
<ul class="simple">
<li><p><code class="docutils literal notranslate"><span class="pre">momentTensor</span></code> <a class="reference internal" href="#api-python-datamodel-momenttensor"><span class="std std-ref">MomentTensor</span></a></p></li>
</ul>
<p><strong>Attributes</strong>:</p>
<ul class="simple">
<li><p><code class="docutils literal notranslate"><span class="pre">waveType</span></code> <a class="reference internal" href="#api-python-datamodel-datausedwavetype"><span class="std std-ref">DataUsedWaveType</span></a></p></li>
<li><p><code class="docutils literal notranslate"><span class="pre">stationCount</span></code> int</p></li>
<li><p><code class="docutils literal notranslate"><span class="pre">componentCount</span></code> int</p></li>
<li><p><code class="docutils literal notranslate"><span class="pre">shortestPeriod</span></code> float (optional)</p></li>
</ul>
<p><strong>Methods</strong>:</p>
<dl class="method">
<dt id="seiscomp.datamodel.DataUsed.Cast">
<em class="property">static </em><code class="sig-name descname">Cast</code><span class="sig-paren">(</span><em class="sig-param">obj</em><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.DataUsed.Cast" title="Permalink to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>obj</strong> The object to be casted.</p>
</dd>
<dt class="field-even">Return type</dt>
<dd class="field-even"><p>An object of type DataUsed if the cast was successful,
None otherwise.</p>
</dd>
</dl>
<p>Cast an arbitrary object to DataUsed if the internal wrapped
representation is an DataUsed object. The cast is important if
instances of type <a class="reference internal" href="#api-python-datamodel-object"><span class="std std-ref">Object</span></a>
are passed to methods which need access to the real type.</p>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.DataUsed.equal">
<code class="sig-name descname">equal</code><span class="sig-paren">(</span><em class="sig-param">other</em><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.DataUsed.equal" title="Permalink to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>other</strong> Another object of type DataUsed to compare this
instance to</p>
</dd>
<dt class="field-even">Return type</dt>
<dd class="field-even"><p>A Boolean value indicating True if both objects are equal or
False otherwise.</p>
</dd>
</dl>
<p>Compares two objects without its child objects. Both objects are compared
by value.</p>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.DataUsed.setWaveType">
<code class="sig-name descname">setWaveType</code><span class="sig-paren">(</span><em class="sig-param">waveType</em><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.DataUsed.setWaveType" title="Permalink to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>waveType</strong> DataUsedWaveType</p>
</dd>
</dl>
<p>Type of waveform data.</p>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.DataUsed.waveType">
<code class="sig-name descname">waveType</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.DataUsed.waveType" title="Permalink to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Return type</dt>
<dd class="field-odd"><p>DataUsedWaveType</p>
</dd>
</dl>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.DataUsed.setStationCount">
<code class="sig-name descname">setStationCount</code><span class="sig-paren">(</span><em class="sig-param">stationCount</em><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.DataUsed.setStationCount" title="Permalink to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>stationCount</strong> int</p>
</dd>
</dl>
<p>Number of stations that have contributed data of the type given in waveType.</p>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.DataUsed.stationCount">
<code class="sig-name descname">stationCount</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.DataUsed.stationCount" title="Permalink to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Return type</dt>
<dd class="field-odd"><p>int</p>
</dd>
</dl>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.DataUsed.setComponentCount">
<code class="sig-name descname">setComponentCount</code><span class="sig-paren">(</span><em class="sig-param">componentCount</em><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.DataUsed.setComponentCount" title="Permalink to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>componentCount</strong> int</p>
</dd>
</dl>
<p>Number of data components of the type given in waveType.</p>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.DataUsed.componentCount">
<code class="sig-name descname">componentCount</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.DataUsed.componentCount" title="Permalink to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Return type</dt>
<dd class="field-odd"><p>int</p>
</dd>
</dl>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.DataUsed.setShortestPeriod">
<code class="sig-name descname">setShortestPeriod</code><span class="sig-paren">(</span><em class="sig-param">shortestPeriod</em><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.DataUsed.setShortestPeriod" title="Permalink to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>shortestPeriod</strong> float</p>
</dd>
</dl>
<p>Shortest period present in data in seconds.</p>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.DataUsed.shortestPeriod">
<code class="sig-name descname">shortestPeriod</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.DataUsed.shortestPeriod" title="Permalink to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Return type</dt>
<dd class="field-odd"><p>float</p>
</dd>
</dl>
<div class="admonition note">
<p class="admonition-title">Note</p>
<p>As this attribute is optional, this method throws a ValueError if
the value of the attribute is not set.</p>
</div>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.DataUsed.momentTensor">
<code class="sig-name descname">momentTensor</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.DataUsed.momentTensor" title="Permalink to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Return type</dt>
<dd class="field-odd"><p><a class="reference internal" href="#seiscomp.datamodel.MomentTensor" title="seiscomp.datamodel.MomentTensor">MomentTensor</a></p>
</dd>
</dl>
<p>Returns the parent MomentTensor if available. Returns None
if the parent is not a MomentTensor. This is a convenience wrapper
for parent().</p>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.DataUsed.assign">
<code class="sig-name descname">assign</code><span class="sig-paren">(</span><em class="sig-param">other</em><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.DataUsed.assign" title="Permalink to this definition"></a></dt>
<dd><p>This method implements the <a class="reference internal" href="#api-python-datamodel-object"><span class="std std-ref">Object</span></a> interface.</p>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.DataUsed.attachTo">
<code class="sig-name descname">attachTo</code><span class="sig-paren">(</span><em class="sig-param">parent</em><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.DataUsed.attachTo" title="Permalink to this definition"></a></dt>
<dd><p>This method implements the <a class="reference internal" href="#api-python-datamodel-object"><span class="std std-ref">Object</span></a> interface.</p>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.DataUsed.detachFrom">
<code class="sig-name descname">detachFrom</code><span class="sig-paren">(</span><em class="sig-param">parent</em><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.DataUsed.detachFrom" title="Permalink to this definition"></a></dt>
<dd><p>This method implements the <a class="reference internal" href="#api-python-datamodel-object"><span class="std std-ref">Object</span></a> interface.</p>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.DataUsed.detach">
<code class="sig-name descname">detach</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.DataUsed.detach" title="Permalink to this definition"></a></dt>
<dd><p>This method implements the <a class="reference internal" href="#api-python-datamodel-object"><span class="std std-ref">Object</span></a> interface.</p>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.DataUsed.clone">
<code class="sig-name descname">clone</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.DataUsed.clone" title="Permalink to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Return type</dt>
<dd class="field-odd"><p>A cloned DataUsed.</p>
</dd>
</dl>
<p>Returns a new instance that is a clone of the current instance. Child
objects are being ignored.</p>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.DataUsed.accept">
<code class="sig-name descname">accept</code><span class="sig-paren">(</span><em class="sig-param">visitor</em><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.DataUsed.accept" title="Permalink to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>visitor</strong> A visitor.</p>
</dd>
</dl>
<p>This method implements the <a class="reference internal" href="#api-python-datamodel-publicobject"><span class="std std-ref">PublicObject</span></a> interface.</p>
</dd></dl>
</dd></dl>
</div>
<div class="section" id="datalogger">
<span id="api-python-datamodel-datalogger"></span><h3>Datalogger<a class="headerlink" href="#datalogger" title="Permalink to this headline"></a></h3>
<dl class="class">
<dt id="seiscomp.datamodel.Datalogger">
<em class="property">class </em><code class="sig-prename descclassname">seiscomp.datamodel.</code><code class="sig-name descname">Datalogger</code><a class="headerlink" href="#seiscomp.datamodel.Datalogger" title="Permalink to this definition"></a></dt>
<dd><p>Inherits <a class="reference internal" href="#api-python-datamodel-publicobject"><span class="std std-ref">PublicObject</span></a>.</p>
<p>This type describes a datalogger (digitizer and recorder)</p>
<p><strong>Parents</strong>:</p>
<ul class="simple">
<li><p><code class="docutils literal notranslate"><span class="pre">inventory</span></code> <a class="reference internal" href="#api-python-datamodel-inventory"><span class="std std-ref">Inventory</span></a></p></li>
</ul>
<p><strong>Children</strong>:</p>
<ul class="simple">
<li><p><code class="docutils literal notranslate"><span class="pre">dataloggerCalibration</span></code> <a class="reference internal" href="#api-python-datamodel-dataloggercalibration"><span class="std std-ref">DataloggerCalibration</span></a></p></li>
<li><p><code class="docutils literal notranslate"><span class="pre">decimation</span></code> <a class="reference internal" href="#api-python-datamodel-decimation"><span class="std std-ref">Decimation</span></a></p></li>
</ul>
<p><strong>Attributes</strong>:</p>
<ul class="simple">
<li><p><code class="docutils literal notranslate"><span class="pre">publicID</span></code>: string</p></li>
<li><p><code class="docutils literal notranslate"><span class="pre">name</span></code> string</p></li>
<li><p><code class="docutils literal notranslate"><span class="pre">description</span></code> string</p></li>
<li><p><code class="docutils literal notranslate"><span class="pre">digitizerModel</span></code> string</p></li>
<li><p><code class="docutils literal notranslate"><span class="pre">digitizerManufacturer</span></code> string</p></li>
<li><p><code class="docutils literal notranslate"><span class="pre">recorderModel</span></code> string</p></li>
<li><p><code class="docutils literal notranslate"><span class="pre">recorderManufacturer</span></code> string</p></li>
<li><p><code class="docutils literal notranslate"><span class="pre">clockModel</span></code> string</p></li>
<li><p><code class="docutils literal notranslate"><span class="pre">clockManufacturer</span></code> string</p></li>
<li><p><code class="docutils literal notranslate"><span class="pre">clockType</span></code> string</p></li>
<li><p><code class="docutils literal notranslate"><span class="pre">gain</span></code> float (optional)</p></li>
<li><p><code class="docutils literal notranslate"><span class="pre">maxClockDrift</span></code> float (optional)</p></li>
<li><p><code class="docutils literal notranslate"><span class="pre">remark</span></code> <a class="reference internal" href="#api-python-datamodel-blob"><span class="std std-ref">Blob</span></a> (optional)</p></li>
</ul>
<p><strong>Referenced by</strong>:</p>
<ul class="simple">
<li><p><a class="reference internal" href="#seiscomp.datamodel.Stream.datalogger" title="seiscomp.datamodel.Stream.datalogger"><code class="xref py py-func docutils literal notranslate"><span class="pre">Stream.datalogger()</span></code></a></p></li>
</ul>
<p><strong>Methods</strong>:</p>
<dl class="method">
<dt id="seiscomp.datamodel.Datalogger.Cast">
<em class="property">static </em><code class="sig-name descname">Cast</code><span class="sig-paren">(</span><em class="sig-param">obj</em><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.Datalogger.Cast" title="Permalink to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>obj</strong> The object to be casted.</p>
</dd>
<dt class="field-even">Return type</dt>
<dd class="field-even"><p>An object of type Datalogger if the cast was successful,
None otherwise.</p>
</dd>
</dl>
<p>Cast an arbitrary object to Datalogger if the internal wrapped
representation is an Datalogger object. The cast is important if
instances of type <a class="reference internal" href="#api-python-datamodel-object"><span class="std std-ref">Object</span></a>
are passed to methods which need access to the real type.</p>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.Datalogger.Create">
<em class="property">static </em><code class="sig-name descname">Create</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.Datalogger.Create" title="Permalink to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Return type</dt>
<dd class="field-odd"><p>A new object of type Datalogger.</p>
</dd>
</dl>
<p>Creates and registers (if enabled) a Datalogger instance. The
publicID is auto-generated.</p>
</dd></dl>
<dl class="method">
<dt>
<em class="property">static </em><code class="sig-name descname">Create</code><span class="sig-paren">(</span><em class="sig-param">publicID</em><span class="sig-paren">)</span></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Return type</dt>
<dd class="field-odd"><p>A new object of type Datalogger.</p>
</dd>
</dl>
<p>Creates and registers (if enabled) a Datalogger instance with
passed publicID.</p>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.Datalogger.equal">
<code class="sig-name descname">equal</code><span class="sig-paren">(</span><em class="sig-param">other</em><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.Datalogger.equal" title="Permalink to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>other</strong> Another object of type Datalogger to compare this
instance to</p>
</dd>
<dt class="field-even">Return type</dt>
<dd class="field-even"><p>A Boolean value indicating True if both objects are equal or
False otherwise.</p>
</dd>
</dl>
<p>Compares two objects without its child objects. Both objects are compared
by value.</p>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.Datalogger.index">
<code class="sig-name descname">index</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.Datalogger.index" title="Permalink to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Return type</dt>
<dd class="field-odd"><p><p>The objects index of type DataloggerIndex.</p>
<p>Returns the objects index which is also used for the database as unique
constraint.</p>
</p>
</dd>
</dl>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.Datalogger.equalIndex">
<code class="sig-name descname">equalIndex</code><span class="sig-paren">(</span><em class="sig-param">lhs</em><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.Datalogger.equalIndex" title="Permalink to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>lhs</strong> <a class="reference internal" href="#api-python-datamodel-datalogger"><span class="std std-ref">Datalogger</span></a></p>
</dd>
<dt class="field-even">Return type</dt>
<dd class="field-even"><p>A Boolean value indicating True if both indexes are equal or
False otherwise.</p>
</dd>
</dl>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.Datalogger.setName">
<code class="sig-name descname">setName</code><span class="sig-paren">(</span><em class="sig-param">name</em><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.Datalogger.setName" title="Permalink to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>name</strong> string</p>
</dd>
</dl>
<p>Unique datalogger name</p>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.Datalogger.name">
<code class="sig-name descname">name</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.Datalogger.name" title="Permalink to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Return type</dt>
<dd class="field-odd"><p>string</p>
</dd>
</dl>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.Datalogger.setDescription">
<code class="sig-name descname">setDescription</code><span class="sig-paren">(</span><em class="sig-param">description</em><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.Datalogger.setDescription" title="Permalink to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>description</strong> string</p>
</dd>
</dl>
<p>Datalogger description</p>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.Datalogger.description">
<code class="sig-name descname">description</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.Datalogger.description" title="Permalink to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Return type</dt>
<dd class="field-odd"><p>string</p>
</dd>
</dl>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.Datalogger.setDigitizerModel">
<code class="sig-name descname">setDigitizerModel</code><span class="sig-paren">(</span><em class="sig-param">digitizerModel</em><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.Datalogger.setDigitizerModel" title="Permalink to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>digitizerModel</strong> string</p>
</dd>
</dl>
<p>Digitizer model</p>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.Datalogger.digitizerModel">
<code class="sig-name descname">digitizerModel</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.Datalogger.digitizerModel" title="Permalink to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Return type</dt>
<dd class="field-odd"><p>string</p>
</dd>
</dl>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.Datalogger.setDigitizerManufacturer">
<code class="sig-name descname">setDigitizerManufacturer</code><span class="sig-paren">(</span><em class="sig-param">digitizerManufacturer</em><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.Datalogger.setDigitizerManufacturer" title="Permalink to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>digitizerManufacturer</strong> string</p>
</dd>
</dl>
<p>Digitizer manufacturer</p>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.Datalogger.digitizerManufacturer">
<code class="sig-name descname">digitizerManufacturer</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.Datalogger.digitizerManufacturer" title="Permalink to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Return type</dt>
<dd class="field-odd"><p>string</p>
</dd>
</dl>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.Datalogger.setRecorderModel">
<code class="sig-name descname">setRecorderModel</code><span class="sig-paren">(</span><em class="sig-param">recorderModel</em><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.Datalogger.setRecorderModel" title="Permalink to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>recorderModel</strong> string</p>
</dd>
</dl>
<p>Recorder model</p>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.Datalogger.recorderModel">
<code class="sig-name descname">recorderModel</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.Datalogger.recorderModel" title="Permalink to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Return type</dt>
<dd class="field-odd"><p>string</p>
</dd>
</dl>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.Datalogger.setRecorderManufacturer">
<code class="sig-name descname">setRecorderManufacturer</code><span class="sig-paren">(</span><em class="sig-param">recorderManufacturer</em><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.Datalogger.setRecorderManufacturer" title="Permalink to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>recorderManufacturer</strong> string</p>
</dd>
</dl>
<p>Recorder manufacturer</p>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.Datalogger.recorderManufacturer">
<code class="sig-name descname">recorderManufacturer</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.Datalogger.recorderManufacturer" title="Permalink to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Return type</dt>
<dd class="field-odd"><p>string</p>
</dd>
</dl>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.Datalogger.setClockModel">
<code class="sig-name descname">setClockModel</code><span class="sig-paren">(</span><em class="sig-param">clockModel</em><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.Datalogger.setClockModel" title="Permalink to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>clockModel</strong> string</p>
</dd>
</dl>
<p>Clock model (mostly unused)</p>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.Datalogger.clockModel">
<code class="sig-name descname">clockModel</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.Datalogger.clockModel" title="Permalink to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Return type</dt>
<dd class="field-odd"><p>string</p>
</dd>
</dl>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.Datalogger.setClockManufacturer">
<code class="sig-name descname">setClockManufacturer</code><span class="sig-paren">(</span><em class="sig-param">clockManufacturer</em><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.Datalogger.setClockManufacturer" title="Permalink to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>clockManufacturer</strong> string</p>
</dd>
</dl>
<p>Clock manufacturer (mostly unused)</p>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.Datalogger.clockManufacturer">
<code class="sig-name descname">clockManufacturer</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.Datalogger.clockManufacturer" title="Permalink to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Return type</dt>
<dd class="field-odd"><p>string</p>
</dd>
</dl>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.Datalogger.setClockType">
<code class="sig-name descname">setClockType</code><span class="sig-paren">(</span><em class="sig-param">clockType</em><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.Datalogger.setClockType" title="Permalink to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>clockType</strong> string</p>
</dd>
</dl>
<p>Clock type (mostly unused)</p>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.Datalogger.clockType">
<code class="sig-name descname">clockType</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.Datalogger.clockType" title="Permalink to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Return type</dt>
<dd class="field-odd"><p>string</p>
</dd>
</dl>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.Datalogger.setGain">
<code class="sig-name descname">setGain</code><span class="sig-paren">(</span><em class="sig-param">gain</em><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.Datalogger.setGain" title="Permalink to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>gain</strong> float</p>
</dd>
</dl>
<p>Sensitivity of digitizer, counts/V (48.05/58.04)</p>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.Datalogger.gain">
<code class="sig-name descname">gain</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.Datalogger.gain" title="Permalink to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Return type</dt>
<dd class="field-odd"><p>float</p>
</dd>
</dl>
<div class="admonition note">
<p class="admonition-title">Note</p>
<p>As this attribute is optional, this method throws a ValueError if
the value of the attribute is not set.</p>
</div>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.Datalogger.setMaxClockDrift">
<code class="sig-name descname">setMaxClockDrift</code><span class="sig-paren">(</span><em class="sig-param">maxClockDrift</em><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.Datalogger.setMaxClockDrift" title="Permalink to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>maxClockDrift</strong> float</p>
</dd>
</dl>
<p>Max clock drift, seconds/second (not identical to 52.19, which is
seconds/sample)</p>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.Datalogger.maxClockDrift">
<code class="sig-name descname">maxClockDrift</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.Datalogger.maxClockDrift" title="Permalink to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Return type</dt>
<dd class="field-odd"><p>float</p>
</dd>
</dl>
<div class="admonition note">
<p class="admonition-title">Note</p>
<p>As this attribute is optional, this method throws a ValueError if
the value of the attribute is not set.</p>
</div>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.Datalogger.setRemark">
<code class="sig-name descname">setRemark</code><span class="sig-paren">(</span><em class="sig-param">remark</em><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.Datalogger.setRemark" title="Permalink to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>remark</strong> <a class="reference internal" href="#api-python-datamodel-blob"><span class="std std-ref">Blob</span></a></p>
</dd>
</dl>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.Datalogger.remark">
<code class="sig-name descname">remark</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.Datalogger.remark" title="Permalink to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Return type</dt>
<dd class="field-odd"><p><a class="reference internal" href="#api-python-datamodel-blob"><span class="std std-ref">Blob</span></a></p>
</dd>
</dl>
<div class="admonition note">
<p class="admonition-title">Note</p>
<p>As this attribute is optional, this method throws a ValueError if
the value of the attribute is not set.</p>
</div>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.Datalogger.add">
<code class="sig-name descname">add</code><span class="sig-paren">(</span><em class="sig-param">dataloggerCalibration</em><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.Datalogger.add" title="Permalink to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>dataloggerCalibration</strong> Object of type <a class="reference internal" href="#api-python-datamodel-dataloggercalibration"><span class="std std-ref">DataloggerCalibration</span></a></p>
</dd>
<dt class="field-even">Return type</dt>
<dd class="field-even"><p>A Boolean value indicating success with True, False otherwise.</p>
</dd>
</dl>
<p>Adds a DataloggerCalibration object to Datalogger. The object is not
copied but managed by this instance. Any change to the passed object
will also change the child.</p>
</dd></dl>
<dl class="method">
<dt>
<code class="sig-name descname">add</code><span class="sig-paren">(</span><em class="sig-param">decimation</em><span class="sig-paren">)</span></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>decimation</strong> Object of type <a class="reference internal" href="#api-python-datamodel-decimation"><span class="std std-ref">Decimation</span></a></p>
</dd>
<dt class="field-even">Return type</dt>
<dd class="field-even"><p>A Boolean value indicating success with True, False otherwise.</p>
</dd>
</dl>
<p>Adds a Decimation object to Datalogger. The object is not
copied but managed by this instance. Any change to the passed object
will also change the child.</p>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.Datalogger.remove">
<code class="sig-name descname">remove</code><span class="sig-paren">(</span><em class="sig-param">dataloggerCalibration</em><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.Datalogger.remove" title="Permalink to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>dataloggerCalibration</strong> Object of type <a class="reference internal" href="#api-python-datamodel-dataloggercalibration"><span class="std std-ref">DataloggerCalibration</span></a></p>
</dd>
<dt class="field-even">Return type</dt>
<dd class="field-even"><p>A Boolean value indicating success with True, False otherwise.</p>
</dd>
</dl>
<p>Removes a previously added DataloggerCalibration object from Datalogger.</p>
</dd></dl>
<dl class="method">
<dt>
<code class="sig-name descname">remove</code><span class="sig-paren">(</span><em class="sig-param">decimation</em><span class="sig-paren">)</span></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>decimation</strong> Object of type <a class="reference internal" href="#api-python-datamodel-decimation"><span class="std std-ref">Decimation</span></a></p>
</dd>
<dt class="field-even">Return type</dt>
<dd class="field-even"><p>A Boolean value indicating success with True, False otherwise.</p>
</dd>
</dl>
<p>Removes a previously added Decimation object from Datalogger.</p>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.Datalogger.removeDataloggerCalibration">
<code class="sig-name descname">removeDataloggerCalibration</code><span class="sig-paren">(</span><em class="sig-param">idx</em><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.Datalogger.removeDataloggerCalibration" title="Permalink to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>idx</strong> An integer index of the object to be removed.</p>
</dd>
<dt class="field-even">Return type</dt>
<dd class="field-even"><p>A Boolean value indicating success with True, False otherwise.</p>
</dd>
</dl>
</dd></dl>
<dl class="method">
<dt>
<code class="sig-name descname">removeDataloggerCalibration(dataloggerCalibrationIndex);</code></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>dataloggerCalibrationIndex</strong> The index of the object to be removed of type DataloggerCalibrationIndex.</p>
</dd>
<dt class="field-even">Return type</dt>
<dd class="field-even"><p>A Boolean value indicating success with True, False otherwise.</p>
</dd>
</dl>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.Datalogger.removeDecimation">
<code class="sig-name descname">removeDecimation</code><span class="sig-paren">(</span><em class="sig-param">idx</em><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.Datalogger.removeDecimation" title="Permalink to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>idx</strong> An integer index of the object to be removed.</p>
</dd>
<dt class="field-even">Return type</dt>
<dd class="field-even"><p>A Boolean value indicating success with True, False otherwise.</p>
</dd>
</dl>
</dd></dl>
<dl class="method">
<dt>
<code class="sig-name descname">removeDecimation(decimationIndex);</code></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>decimationIndex</strong> The index of the object to be removed of type DecimationIndex.</p>
</dd>
<dt class="field-even">Return type</dt>
<dd class="field-even"><p>A Boolean value indicating success with True, False otherwise.</p>
</dd>
</dl>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.Datalogger.dataloggerCalibrationCount">
<code class="sig-name descname">dataloggerCalibrationCount</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.Datalogger.dataloggerCalibrationCount" title="Permalink to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Return type</dt>
<dd class="field-odd"><p>integer value indicating the number of child objects.</p>
</dd>
</dl>
<p>Returns the number of DataloggerCalibration child objects.</p>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.Datalogger.decimationCount">
<code class="sig-name descname">decimationCount</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.Datalogger.decimationCount" title="Permalink to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Return type</dt>
<dd class="field-odd"><p>integer value indicating the number of child objects.</p>
</dd>
</dl>
<p>Returns the number of Decimation child objects.</p>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.Datalogger.dataloggerCalibration">
<code class="sig-name descname">dataloggerCalibration</code><span class="sig-paren">(</span><em class="sig-param">idx</em><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.Datalogger.dataloggerCalibration" title="Permalink to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>idx</strong> An integer index of the object to be returned.</p>
</dd>
<dt class="field-even">Return type</dt>
<dd class="field-even"><p>Object of type <a class="reference internal" href="#api-python-datamodel-dataloggercalibration"><span class="std std-ref">DataloggerCalibration</span></a>.</p>
</dd>
</dl>
<p>Returns the DataloggerCalibration at index idx.</p>
</dd></dl>
<dl class="method">
<dt>
<code class="sig-name descname">dataloggerCalibration</code><span class="sig-paren">(</span><em class="sig-param">dataloggerCalibrationIndex</em><span class="sig-paren">)</span></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>dataloggerCalibrationIndex</strong> The index of the object to be removed of type DataloggerCalibrationIndex.</p>
</dd>
<dt class="field-even">Return type</dt>
<dd class="field-even"><p>Object of type <a class="reference internal" href="#api-python-datamodel-dataloggercalibration"><span class="std std-ref">DataloggerCalibration</span></a>.</p>
</dd>
</dl>
<p>Returns the DataloggerCalibration at given index. The indexes of all child objects
are compared by value which makes this function slower than the direct
integer index look-up.</p>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.Datalogger.decimation">
<code class="sig-name descname">decimation</code><span class="sig-paren">(</span><em class="sig-param">idx</em><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.Datalogger.decimation" title="Permalink to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>idx</strong> An integer index of the object to be returned.</p>
</dd>
<dt class="field-even">Return type</dt>
<dd class="field-even"><p>Object of type <a class="reference internal" href="#api-python-datamodel-decimation"><span class="std std-ref">Decimation</span></a>.</p>
</dd>
</dl>
<p>Returns the Decimation at index idx.</p>
</dd></dl>
<dl class="method">
<dt>
<code class="sig-name descname">decimation</code><span class="sig-paren">(</span><em class="sig-param">decimationIndex</em><span class="sig-paren">)</span></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>decimationIndex</strong> The index of the object to be removed of type DecimationIndex.</p>
</dd>
<dt class="field-even">Return type</dt>
<dd class="field-even"><p>Object of type <a class="reference internal" href="#api-python-datamodel-decimation"><span class="std std-ref">Decimation</span></a>.</p>
</dd>
</dl>
<p>Returns the Decimation at given index. The indexes of all child objects
are compared by value which makes this function slower than the direct
integer index look-up.</p>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.Datalogger.inventory">
<code class="sig-name descname">inventory</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.Datalogger.inventory" title="Permalink to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Return type</dt>
<dd class="field-odd"><p><a class="reference internal" href="#seiscomp.datamodel.Inventory" title="seiscomp.datamodel.Inventory">Inventory</a></p>
</dd>
</dl>
<p>Returns the parent Inventory if available. Returns None
if the parent is not a Inventory. This is a convenience wrapper
for parent().</p>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.Datalogger.assign">
<code class="sig-name descname">assign</code><span class="sig-paren">(</span><em class="sig-param">other</em><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.Datalogger.assign" title="Permalink to this definition"></a></dt>
<dd><p>This method implements the <a class="reference internal" href="#api-python-datamodel-object"><span class="std std-ref">Object</span></a> interface.</p>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.Datalogger.attachTo">
<code class="sig-name descname">attachTo</code><span class="sig-paren">(</span><em class="sig-param">parent</em><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.Datalogger.attachTo" title="Permalink to this definition"></a></dt>
<dd><p>This method implements the <a class="reference internal" href="#api-python-datamodel-object"><span class="std std-ref">Object</span></a> interface.</p>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.Datalogger.detachFrom">
<code class="sig-name descname">detachFrom</code><span class="sig-paren">(</span><em class="sig-param">parent</em><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.Datalogger.detachFrom" title="Permalink to this definition"></a></dt>
<dd><p>This method implements the <a class="reference internal" href="#api-python-datamodel-object"><span class="std std-ref">Object</span></a> interface.</p>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.Datalogger.detach">
<code class="sig-name descname">detach</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.Datalogger.detach" title="Permalink to this definition"></a></dt>
<dd><p>This method implements the <a class="reference internal" href="#api-python-datamodel-object"><span class="std std-ref">Object</span></a> interface.</p>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.Datalogger.clone">
<code class="sig-name descname">clone</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.Datalogger.clone" title="Permalink to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Return type</dt>
<dd class="field-odd"><p>A cloned Datalogger.</p>
</dd>
</dl>
<p>Returns a new instance that is a clone of the current instance. Child
objects are being ignored.</p>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.Datalogger.updateChild">
<code class="sig-name descname">updateChild</code><span class="sig-paren">(</span><em class="sig-param">ref</em><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.Datalogger.updateChild" title="Permalink to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>ref</strong> A child object derived from class Object.</p>
</dd>
<dt class="field-even">Return type</dt>
<dd class="field-even"><p>A Boolean flag indicating success with True, False otherwise</p>
</dd>
</dl>
<p>This method takes the passed reference object and searches for a child
with the same publicID (if derived from <a class="reference internal" href="#api-python-datamodel-publicobject"><span class="std std-ref">PublicObject</span></a>)
or the same index (if derived from <a class="reference internal" href="#api-python-datamodel-object"><span class="std std-ref">Object</span></a>).
The the child was found the reference objects attributes are copied to
the child object. Children of child are being ignored during this operation.
This method implements the <a class="reference internal" href="#api-python-datamodel-publicobject"><span class="std std-ref">PublicObject</span></a> interface.</p>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.Datalogger.accept">
<code class="sig-name descname">accept</code><span class="sig-paren">(</span><em class="sig-param">visitor</em><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.Datalogger.accept" title="Permalink to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>visitor</strong> A visitor.</p>
</dd>
</dl>
<p>This method implements the <a class="reference internal" href="#api-python-datamodel-publicobject"><span class="std std-ref">PublicObject</span></a> interface.</p>
</dd></dl>
</dd></dl>
</div>
<div class="section" id="dataloggercalibration">
<span id="api-python-datamodel-dataloggercalibration"></span><h3>DataloggerCalibration<a class="headerlink" href="#dataloggercalibration" title="Permalink to this headline"></a></h3>
<dl class="class">
<dt id="seiscomp.datamodel.DataloggerCalibration">
<em class="property">class </em><code class="sig-prename descclassname">seiscomp.datamodel.</code><code class="sig-name descname">DataloggerCalibration</code><a class="headerlink" href="#seiscomp.datamodel.DataloggerCalibration" title="Permalink to this definition"></a></dt>
<dd><p>Inherits <a class="reference internal" href="#api-python-datamodel-object"><span class="std std-ref">Object</span></a>.</p>
<p>This type describes a datalogger calibration</p>
<p><strong>Parents</strong>:</p>
<ul class="simple">
<li><p><code class="docutils literal notranslate"><span class="pre">datalogger</span></code> <a class="reference internal" href="#api-python-datamodel-datalogger"><span class="std std-ref">Datalogger</span></a></p></li>
</ul>
<p><strong>Attributes</strong>:</p>
<ul class="simple">
<li><p><code class="docutils literal notranslate"><span class="pre">serialNumber</span></code> string</p></li>
<li><p><code class="docutils literal notranslate"><span class="pre">channel</span></code> int</p></li>
<li><p><code class="docutils literal notranslate"><span class="pre">start</span></code> seiscomp.core.Time</p></li>
<li><p><code class="docutils literal notranslate"><span class="pre">end</span></code> seiscomp.core.Time (optional)</p></li>
<li><p><code class="docutils literal notranslate"><span class="pre">gain</span></code> float (optional)</p></li>
<li><p><code class="docutils literal notranslate"><span class="pre">gainFrequency</span></code> float (optional)</p></li>
<li><p><code class="docutils literal notranslate"><span class="pre">remark</span></code> <a class="reference internal" href="#api-python-datamodel-blob"><span class="std std-ref">Blob</span></a> (optional)</p></li>
</ul>
<p><strong>Methods</strong>:</p>
<dl class="method">
<dt id="seiscomp.datamodel.DataloggerCalibration.Cast">
<em class="property">static </em><code class="sig-name descname">Cast</code><span class="sig-paren">(</span><em class="sig-param">obj</em><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.DataloggerCalibration.Cast" title="Permalink to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>obj</strong> The object to be casted.</p>
</dd>
<dt class="field-even">Return type</dt>
<dd class="field-even"><p>An object of type DataloggerCalibration if the cast was successful,
None otherwise.</p>
</dd>
</dl>
<p>Cast an arbitrary object to DataloggerCalibration if the internal wrapped
representation is an DataloggerCalibration object. The cast is important if
instances of type <a class="reference internal" href="#api-python-datamodel-object"><span class="std std-ref">Object</span></a>
are passed to methods which need access to the real type.</p>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.DataloggerCalibration.equal">
<code class="sig-name descname">equal</code><span class="sig-paren">(</span><em class="sig-param">other</em><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.DataloggerCalibration.equal" title="Permalink to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>other</strong> Another object of type DataloggerCalibration to compare this
instance to</p>
</dd>
<dt class="field-even">Return type</dt>
<dd class="field-even"><p>A Boolean value indicating True if both objects are equal or
False otherwise.</p>
</dd>
</dl>
<p>Compares two objects without its child objects. Both objects are compared
by value.</p>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.DataloggerCalibration.index">
<code class="sig-name descname">index</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.DataloggerCalibration.index" title="Permalink to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Return type</dt>
<dd class="field-odd"><p><p>The objects index of type DataloggerCalibrationIndex.</p>
<p>Returns the objects index which is also used for the database as unique
constraint.</p>
</p>
</dd>
</dl>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.DataloggerCalibration.equalIndex">
<code class="sig-name descname">equalIndex</code><span class="sig-paren">(</span><em class="sig-param">lhs</em><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.DataloggerCalibration.equalIndex" title="Permalink to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>lhs</strong> <a class="reference internal" href="#api-python-datamodel-dataloggercalibration"><span class="std std-ref">DataloggerCalibration</span></a></p>
</dd>
<dt class="field-even">Return type</dt>
<dd class="field-even"><p>A Boolean value indicating True if both indexes are equal or
False otherwise.</p>
</dd>
</dl>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.DataloggerCalibration.setSerialNumber">
<code class="sig-name descname">setSerialNumber</code><span class="sig-paren">(</span><em class="sig-param">serialNumber</em><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.DataloggerCalibration.setSerialNumber" title="Permalink to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>serialNumber</strong> string</p>
</dd>
</dl>
<p>Referred from network/station/Stream/&#64;dataloggerSerialNumber</p>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.DataloggerCalibration.serialNumber">
<code class="sig-name descname">serialNumber</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.DataloggerCalibration.serialNumber" title="Permalink to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Return type</dt>
<dd class="field-odd"><p>string</p>
</dd>
</dl>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.DataloggerCalibration.setChannel">
<code class="sig-name descname">setChannel</code><span class="sig-paren">(</span><em class="sig-param">channel</em><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.DataloggerCalibration.setChannel" title="Permalink to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>channel</strong> int</p>
</dd>
</dl>
<p>Referred from network/station/Stream/&#64;dataloggerChannel</p>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.DataloggerCalibration.channel">
<code class="sig-name descname">channel</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.DataloggerCalibration.channel" title="Permalink to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Return type</dt>
<dd class="field-odd"><p>int</p>
</dd>
</dl>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.DataloggerCalibration.setStart">
<code class="sig-name descname">setStart</code><span class="sig-paren">(</span><em class="sig-param">start</em><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.DataloggerCalibration.setStart" title="Permalink to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>start</strong> seiscomp.core.Time</p>
</dd>
</dl>
<p>Start of validity</p>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.DataloggerCalibration.start">
<code class="sig-name descname">start</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.DataloggerCalibration.start" title="Permalink to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Return type</dt>
<dd class="field-odd"><p>seiscomp.core.Time</p>
</dd>
</dl>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.DataloggerCalibration.setEnd">
<code class="sig-name descname">setEnd</code><span class="sig-paren">(</span><em class="sig-param">end</em><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.DataloggerCalibration.setEnd" title="Permalink to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>end</strong> seiscomp.core.Time</p>
</dd>
</dl>
<p>End of validity</p>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.DataloggerCalibration.end">
<code class="sig-name descname">end</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.DataloggerCalibration.end" title="Permalink to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Return type</dt>
<dd class="field-odd"><p>seiscomp.core.Time</p>
</dd>
</dl>
<div class="admonition note">
<p class="admonition-title">Note</p>
<p>As this attribute is optional, this method throws a ValueError if
the value of the attribute is not set.</p>
</div>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.DataloggerCalibration.setGain">
<code class="sig-name descname">setGain</code><span class="sig-paren">(</span><em class="sig-param">gain</em><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.DataloggerCalibration.setGain" title="Permalink to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>gain</strong> float</p>
</dd>
</dl>
<p>Overrides nominal gain of calibrated datalogger (48.05/58.04)</p>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.DataloggerCalibration.gain">
<code class="sig-name descname">gain</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.DataloggerCalibration.gain" title="Permalink to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Return type</dt>
<dd class="field-odd"><p>float</p>
</dd>
</dl>
<div class="admonition note">
<p class="admonition-title">Note</p>
<p>As this attribute is optional, this method throws a ValueError if
the value of the attribute is not set.</p>
</div>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.DataloggerCalibration.setGainFrequency">
<code class="sig-name descname">setGainFrequency</code><span class="sig-paren">(</span><em class="sig-param">gainFrequency</em><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.DataloggerCalibration.setGainFrequency" title="Permalink to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>gainFrequency</strong> float</p>
</dd>
</dl>
<p>Gain frequency (48.06/58.05)</p>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.DataloggerCalibration.gainFrequency">
<code class="sig-name descname">gainFrequency</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.DataloggerCalibration.gainFrequency" title="Permalink to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Return type</dt>
<dd class="field-odd"><p>float</p>
</dd>
</dl>
<div class="admonition note">
<p class="admonition-title">Note</p>
<p>As this attribute is optional, this method throws a ValueError if
the value of the attribute is not set.</p>
</div>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.DataloggerCalibration.setRemark">
<code class="sig-name descname">setRemark</code><span class="sig-paren">(</span><em class="sig-param">remark</em><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.DataloggerCalibration.setRemark" title="Permalink to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>remark</strong> <a class="reference internal" href="#api-python-datamodel-blob"><span class="std std-ref">Blob</span></a></p>
</dd>
</dl>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.DataloggerCalibration.remark">
<code class="sig-name descname">remark</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.DataloggerCalibration.remark" title="Permalink to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Return type</dt>
<dd class="field-odd"><p><a class="reference internal" href="#api-python-datamodel-blob"><span class="std std-ref">Blob</span></a></p>
</dd>
</dl>
<div class="admonition note">
<p class="admonition-title">Note</p>
<p>As this attribute is optional, this method throws a ValueError if
the value of the attribute is not set.</p>
</div>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.DataloggerCalibration.datalogger">
<code class="sig-name descname">datalogger</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.DataloggerCalibration.datalogger" title="Permalink to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Return type</dt>
<dd class="field-odd"><p><a class="reference internal" href="#seiscomp.datamodel.Datalogger" title="seiscomp.datamodel.Datalogger">Datalogger</a></p>
</dd>
</dl>
<p>Returns the parent Datalogger if available. Returns None
if the parent is not a Datalogger. This is a convenience wrapper
for parent().</p>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.DataloggerCalibration.assign">
<code class="sig-name descname">assign</code><span class="sig-paren">(</span><em class="sig-param">other</em><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.DataloggerCalibration.assign" title="Permalink to this definition"></a></dt>
<dd><p>This method implements the <a class="reference internal" href="#api-python-datamodel-object"><span class="std std-ref">Object</span></a> interface.</p>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.DataloggerCalibration.attachTo">
<code class="sig-name descname">attachTo</code><span class="sig-paren">(</span><em class="sig-param">parent</em><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.DataloggerCalibration.attachTo" title="Permalink to this definition"></a></dt>
<dd><p>This method implements the <a class="reference internal" href="#api-python-datamodel-object"><span class="std std-ref">Object</span></a> interface.</p>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.DataloggerCalibration.detachFrom">
<code class="sig-name descname">detachFrom</code><span class="sig-paren">(</span><em class="sig-param">parent</em><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.DataloggerCalibration.detachFrom" title="Permalink to this definition"></a></dt>
<dd><p>This method implements the <a class="reference internal" href="#api-python-datamodel-object"><span class="std std-ref">Object</span></a> interface.</p>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.DataloggerCalibration.detach">
<code class="sig-name descname">detach</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.DataloggerCalibration.detach" title="Permalink to this definition"></a></dt>
<dd><p>This method implements the <a class="reference internal" href="#api-python-datamodel-object"><span class="std std-ref">Object</span></a> interface.</p>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.DataloggerCalibration.clone">
<code class="sig-name descname">clone</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.DataloggerCalibration.clone" title="Permalink to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Return type</dt>
<dd class="field-odd"><p>A cloned DataloggerCalibration.</p>
</dd>
</dl>
<p>Returns a new instance that is a clone of the current instance. Child
objects are being ignored.</p>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.DataloggerCalibration.accept">
<code class="sig-name descname">accept</code><span class="sig-paren">(</span><em class="sig-param">visitor</em><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.DataloggerCalibration.accept" title="Permalink to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>visitor</strong> A visitor.</p>
</dd>
</dl>
<p>This method implements the <a class="reference internal" href="#api-python-datamodel-publicobject"><span class="std std-ref">PublicObject</span></a> interface.</p>
</dd></dl>
</dd></dl>
</div>
<div class="section" id="decimation">
<span id="api-python-datamodel-decimation"></span><h3>Decimation<a class="headerlink" href="#decimation" title="Permalink to this headline"></a></h3>
<dl class="class">
<dt id="seiscomp.datamodel.Decimation">
<em class="property">class </em><code class="sig-prename descclassname">seiscomp.datamodel.</code><code class="sig-name descname">Decimation</code><a class="headerlink" href="#seiscomp.datamodel.Decimation" title="Permalink to this definition"></a></dt>
<dd><p>Inherits <a class="reference internal" href="#api-python-datamodel-object"><span class="std std-ref">Object</span></a>.</p>
<p>This type describes a decimation to a certain sample rate</p>
<p><strong>Parents</strong>:</p>
<ul class="simple">
<li><p><code class="docutils literal notranslate"><span class="pre">datalogger</span></code> <a class="reference internal" href="#api-python-datamodel-datalogger"><span class="std std-ref">Datalogger</span></a></p></li>
</ul>
<p><strong>Attributes</strong>:</p>
<ul class="simple">
<li><p><code class="docutils literal notranslate"><span class="pre">sampleRateNumerator</span></code> int</p></li>
<li><p><code class="docutils literal notranslate"><span class="pre">sampleRateDenominator</span></code> int</p></li>
<li><p><code class="docutils literal notranslate"><span class="pre">analogueFilterChain</span></code> <a class="reference internal" href="#api-python-datamodel-blob"><span class="std std-ref">Blob</span></a> (optional)</p></li>
<li><p><code class="docutils literal notranslate"><span class="pre">digitalFilterChain</span></code> <a class="reference internal" href="#api-python-datamodel-blob"><span class="std std-ref">Blob</span></a> (optional)</p></li>
</ul>
<p><strong>Methods</strong>:</p>
<dl class="method">
<dt id="seiscomp.datamodel.Decimation.Cast">
<em class="property">static </em><code class="sig-name descname">Cast</code><span class="sig-paren">(</span><em class="sig-param">obj</em><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.Decimation.Cast" title="Permalink to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>obj</strong> The object to be casted.</p>
</dd>
<dt class="field-even">Return type</dt>
<dd class="field-even"><p>An object of type Decimation if the cast was successful,
None otherwise.</p>
</dd>
</dl>
<p>Cast an arbitrary object to Decimation if the internal wrapped
representation is an Decimation object. The cast is important if
instances of type <a class="reference internal" href="#api-python-datamodel-object"><span class="std std-ref">Object</span></a>
are passed to methods which need access to the real type.</p>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.Decimation.equal">
<code class="sig-name descname">equal</code><span class="sig-paren">(</span><em class="sig-param">other</em><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.Decimation.equal" title="Permalink to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>other</strong> Another object of type Decimation to compare this
instance to</p>
</dd>
<dt class="field-even">Return type</dt>
<dd class="field-even"><p>A Boolean value indicating True if both objects are equal or
False otherwise.</p>
</dd>
</dl>
<p>Compares two objects without its child objects. Both objects are compared
by value.</p>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.Decimation.index">
<code class="sig-name descname">index</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.Decimation.index" title="Permalink to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Return type</dt>
<dd class="field-odd"><p><p>The objects index of type DecimationIndex.</p>
<p>Returns the objects index which is also used for the database as unique
constraint.</p>
</p>
</dd>
</dl>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.Decimation.equalIndex">
<code class="sig-name descname">equalIndex</code><span class="sig-paren">(</span><em class="sig-param">lhs</em><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.Decimation.equalIndex" title="Permalink to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>lhs</strong> <a class="reference internal" href="#api-python-datamodel-decimation"><span class="std std-ref">Decimation</span></a></p>
</dd>
<dt class="field-even">Return type</dt>
<dd class="field-even"><p>A Boolean value indicating True if both indexes are equal or
False otherwise.</p>
</dd>
</dl>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.Decimation.setSampleRateNumerator">
<code class="sig-name descname">setSampleRateNumerator</code><span class="sig-paren">(</span><em class="sig-param">sampleRateNumerator</em><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.Decimation.setSampleRateNumerator" title="Permalink to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>sampleRateNumerator</strong> int</p>
</dd>
</dl>
<p>Output sample rate (numerator); referred from
network/station/Stream/&#64;sampleRateNumerator</p>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.Decimation.sampleRateNumerator">
<code class="sig-name descname">sampleRateNumerator</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.Decimation.sampleRateNumerator" title="Permalink to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Return type</dt>
<dd class="field-odd"><p>int</p>
</dd>
</dl>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.Decimation.setSampleRateDenominator">
<code class="sig-name descname">setSampleRateDenominator</code><span class="sig-paren">(</span><em class="sig-param">sampleRateDenominator</em><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.Decimation.setSampleRateDenominator" title="Permalink to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>sampleRateDenominator</strong> int</p>
</dd>
</dl>
<p>Output sample rate (denominator); referred from
network/station/Stream/&#64;sampleRateDenominator</p>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.Decimation.sampleRateDenominator">
<code class="sig-name descname">sampleRateDenominator</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.Decimation.sampleRateDenominator" title="Permalink to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Return type</dt>
<dd class="field-odd"><p>int</p>
</dd>
</dl>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.Decimation.setAnalogueFilterChain">
<code class="sig-name descname">setAnalogueFilterChain</code><span class="sig-paren">(</span><em class="sig-param">analogueFilterChain</em><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.Decimation.setAnalogueFilterChain" title="Permalink to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>analogueFilterChain</strong> <a class="reference internal" href="#api-python-datamodel-blob"><span class="std std-ref">Blob</span></a></p>
</dd>
</dl>
<p>Specifies analogue filters between seismometer and digitizer. Each element
(separated by space) references responsePAZ/&#64;publicID</p>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.Decimation.analogueFilterChain">
<code class="sig-name descname">analogueFilterChain</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.Decimation.analogueFilterChain" title="Permalink to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Return type</dt>
<dd class="field-odd"><p><a class="reference internal" href="#api-python-datamodel-blob"><span class="std std-ref">Blob</span></a></p>
</dd>
</dl>
<div class="admonition note">
<p class="admonition-title">Note</p>
<p>As this attribute is optional, this method throws a ValueError if
the value of the attribute is not set.</p>
</div>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.Decimation.setDigitalFilterChain">
<code class="sig-name descname">setDigitalFilterChain</code><span class="sig-paren">(</span><em class="sig-param">digitalFilterChain</em><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.Decimation.setDigitalFilterChain" title="Permalink to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>digitalFilterChain</strong> <a class="reference internal" href="#api-python-datamodel-blob"><span class="std std-ref">Blob</span></a></p>
</dd>
</dl>
<p>Specifies digital filters (decimation, gain removal). Each element
(separated by space) references responsePAZ&#64;publicID or
responseFIR/&#64;publicID</p>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.Decimation.digitalFilterChain">
<code class="sig-name descname">digitalFilterChain</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.Decimation.digitalFilterChain" title="Permalink to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Return type</dt>
<dd class="field-odd"><p><a class="reference internal" href="#api-python-datamodel-blob"><span class="std std-ref">Blob</span></a></p>
</dd>
</dl>
<div class="admonition note">
<p class="admonition-title">Note</p>
<p>As this attribute is optional, this method throws a ValueError if
the value of the attribute is not set.</p>
</div>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.Decimation.datalogger">
<code class="sig-name descname">datalogger</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.Decimation.datalogger" title="Permalink to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Return type</dt>
<dd class="field-odd"><p><a class="reference internal" href="#seiscomp.datamodel.Datalogger" title="seiscomp.datamodel.Datalogger">Datalogger</a></p>
</dd>
</dl>
<p>Returns the parent Datalogger if available. Returns None
if the parent is not a Datalogger. This is a convenience wrapper
for parent().</p>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.Decimation.assign">
<code class="sig-name descname">assign</code><span class="sig-paren">(</span><em class="sig-param">other</em><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.Decimation.assign" title="Permalink to this definition"></a></dt>
<dd><p>This method implements the <a class="reference internal" href="#api-python-datamodel-object"><span class="std std-ref">Object</span></a> interface.</p>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.Decimation.attachTo">
<code class="sig-name descname">attachTo</code><span class="sig-paren">(</span><em class="sig-param">parent</em><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.Decimation.attachTo" title="Permalink to this definition"></a></dt>
<dd><p>This method implements the <a class="reference internal" href="#api-python-datamodel-object"><span class="std std-ref">Object</span></a> interface.</p>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.Decimation.detachFrom">
<code class="sig-name descname">detachFrom</code><span class="sig-paren">(</span><em class="sig-param">parent</em><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.Decimation.detachFrom" title="Permalink to this definition"></a></dt>
<dd><p>This method implements the <a class="reference internal" href="#api-python-datamodel-object"><span class="std std-ref">Object</span></a> interface.</p>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.Decimation.detach">
<code class="sig-name descname">detach</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.Decimation.detach" title="Permalink to this definition"></a></dt>
<dd><p>This method implements the <a class="reference internal" href="#api-python-datamodel-object"><span class="std std-ref">Object</span></a> interface.</p>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.Decimation.clone">
<code class="sig-name descname">clone</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.Decimation.clone" title="Permalink to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Return type</dt>
<dd class="field-odd"><p>A cloned Decimation.</p>
</dd>
</dl>
<p>Returns a new instance that is a clone of the current instance. Child
objects are being ignored.</p>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.Decimation.accept">
<code class="sig-name descname">accept</code><span class="sig-paren">(</span><em class="sig-param">visitor</em><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.Decimation.accept" title="Permalink to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>visitor</strong> A visitor.</p>
</dd>
</dl>
<p>This method implements the <a class="reference internal" href="#api-python-datamodel-publicobject"><span class="std std-ref">PublicObject</span></a> interface.</p>
</dd></dl>
</dd></dl>
</div>
<div class="section" id="event">
<span id="api-python-datamodel-event"></span><h3>Event<a class="headerlink" href="#event" title="Permalink to this headline"></a></h3>
<dl class="class">
<dt id="seiscomp.datamodel.Event">
<em class="property">class </em><code class="sig-prename descclassname">seiscomp.datamodel.</code><code class="sig-name descname">Event</code><a class="headerlink" href="#seiscomp.datamodel.Event" title="Permalink to this definition"></a></dt>
<dd><p>Inherits <a class="reference internal" href="#api-python-datamodel-publicobject"><span class="std std-ref">PublicObject</span></a>.</p>
<p>The class Event describes a seismic event which does not necessarily need
to be a tectonic earthquake. An event is usually associated with one or
more origins, which contain information about focal time and geographical
location of the event. Multiple origins can cover automatic and manual
locations, a set of location from different agencies, locations generated
with different location programs and earth models, etc. Furthermore, an event
is usually associated with one or more magnitudes, and with one or more focal
mechanism determinations.</p>
<p><strong>Parents</strong>:</p>
<ul class="simple">
<li><p><code class="docutils literal notranslate"><span class="pre">eventParameters</span></code> <a class="reference internal" href="#api-python-datamodel-eventparameters"><span class="std std-ref">EventParameters</span></a></p></li>
</ul>
<p><strong>Children</strong>:</p>
<ul class="simple">
<li><p><code class="docutils literal notranslate"><span class="pre">eventDescription</span></code> <a class="reference internal" href="#api-python-datamodel-eventdescription"><span class="std std-ref">EventDescription</span></a></p></li>
<li><p><code class="docutils literal notranslate"><span class="pre">comment</span></code> <a class="reference internal" href="#api-python-datamodel-comment"><span class="std std-ref">Comment</span></a></p></li>
<li><p><code class="docutils literal notranslate"><span class="pre">originReference</span></code> <a class="reference internal" href="#api-python-datamodel-originreference"><span class="std std-ref">OriginReference</span></a></p></li>
<li><p><code class="docutils literal notranslate"><span class="pre">focalMechanismReference</span></code> <a class="reference internal" href="#api-python-datamodel-focalmechanismreference"><span class="std std-ref">FocalMechanismReference</span></a></p></li>
</ul>
<p><strong>Attributes</strong>:</p>
<ul class="simple">
<li><p><code class="docutils literal notranslate"><span class="pre">publicID</span></code>: string</p></li>
<li><p><code class="docutils literal notranslate"><span class="pre">preferredOriginID</span></code> string</p></li>
<li><p><code class="docutils literal notranslate"><span class="pre">preferredMagnitudeID</span></code> string</p></li>
<li><p><code class="docutils literal notranslate"><span class="pre">preferredFocalMechanismID</span></code> string</p></li>
<li><p><code class="docutils literal notranslate"><span class="pre">type</span></code> <a class="reference internal" href="#api-python-datamodel-eventtype"><span class="std std-ref">EventType</span></a> (optional)</p></li>
<li><p><code class="docutils literal notranslate"><span class="pre">typeCertainty</span></code> <a class="reference internal" href="#api-python-datamodel-eventtypecertainty"><span class="std std-ref">EventTypeCertainty</span></a> (optional)</p></li>
<li><p><code class="docutils literal notranslate"><span class="pre">creationInfo</span></code> <a class="reference internal" href="#api-python-datamodel-creationinfo"><span class="std std-ref">CreationInfo</span></a> (optional)</p></li>
</ul>
<p><strong>Methods</strong>:</p>
<dl class="method">
<dt id="seiscomp.datamodel.Event.Cast">
<em class="property">static </em><code class="sig-name descname">Cast</code><span class="sig-paren">(</span><em class="sig-param">obj</em><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.Event.Cast" title="Permalink to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>obj</strong> The object to be casted.</p>
</dd>
<dt class="field-even">Return type</dt>
<dd class="field-even"><p>An object of type Event if the cast was successful,
None otherwise.</p>
</dd>
</dl>
<p>Cast an arbitrary object to Event if the internal wrapped
representation is an Event object. The cast is important if
instances of type <a class="reference internal" href="#api-python-datamodel-object"><span class="std std-ref">Object</span></a>
are passed to methods which need access to the real type.</p>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.Event.Create">
<em class="property">static </em><code class="sig-name descname">Create</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.Event.Create" title="Permalink to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Return type</dt>
<dd class="field-odd"><p>A new object of type Event.</p>
</dd>
</dl>
<p>Creates and registers (if enabled) a Event instance. The
publicID is auto-generated.</p>
</dd></dl>
<dl class="method">
<dt>
<em class="property">static </em><code class="sig-name descname">Create</code><span class="sig-paren">(</span><em class="sig-param">publicID</em><span class="sig-paren">)</span></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Return type</dt>
<dd class="field-odd"><p>A new object of type Event.</p>
</dd>
</dl>
<p>Creates and registers (if enabled) a Event instance with
passed publicID.</p>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.Event.equal">
<code class="sig-name descname">equal</code><span class="sig-paren">(</span><em class="sig-param">other</em><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.Event.equal" title="Permalink to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>other</strong> Another object of type Event to compare this
instance to</p>
</dd>
<dt class="field-even">Return type</dt>
<dd class="field-even"><p>A Boolean value indicating True if both objects are equal or
False otherwise.</p>
</dd>
</dl>
<p>Compares two objects without its child objects. Both objects are compared
by value.</p>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.Event.setPreferredOriginID">
<code class="sig-name descname">setPreferredOriginID</code><span class="sig-paren">(</span><em class="sig-param">preferredOriginID</em><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.Event.setPreferredOriginID" title="Permalink to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>preferredOriginID</strong> string</p>
</dd>
</dl>
<p>Refers to the publicID of the preferred Origin object.</p>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.Event.preferredOriginID">
<code class="sig-name descname">preferredOriginID</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.Event.preferredOriginID" title="Permalink to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Return type</dt>
<dd class="field-odd"><p>string</p>
</dd>
</dl>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.Event.setPreferredMagnitudeID">
<code class="sig-name descname">setPreferredMagnitudeID</code><span class="sig-paren">(</span><em class="sig-param">preferredMagnitudeID</em><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.Event.setPreferredMagnitudeID" title="Permalink to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>preferredMagnitudeID</strong> string</p>
</dd>
</dl>
<p>Refers to the publicID of the preferred Magnitude object.</p>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.Event.preferredMagnitudeID">
<code class="sig-name descname">preferredMagnitudeID</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.Event.preferredMagnitudeID" title="Permalink to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Return type</dt>
<dd class="field-odd"><p>string</p>
</dd>
</dl>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.Event.setPreferredFocalMechanismID">
<code class="sig-name descname">setPreferredFocalMechanismID</code><span class="sig-paren">(</span><em class="sig-param">preferredFocalMechanismID</em><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.Event.setPreferredFocalMechanismID" title="Permalink to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>preferredFocalMechanismID</strong> string</p>
</dd>
</dl>
<p>Refers to the publicID of the preferred FocalMechanism object.</p>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.Event.preferredFocalMechanismID">
<code class="sig-name descname">preferredFocalMechanismID</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.Event.preferredFocalMechanismID" title="Permalink to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Return type</dt>
<dd class="field-odd"><p>string</p>
</dd>
</dl>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.Event.setType">
<code class="sig-name descname">setType</code><span class="sig-paren">(</span><em class="sig-param">type</em><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.Event.setType" title="Permalink to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>type</strong> EventType</p>
</dd>
</dl>
<p>Describes the type of an event (Storchak et al. 2012).</p>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.Event.type">
<code class="sig-name descname">type</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.Event.type" title="Permalink to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Return type</dt>
<dd class="field-odd"><p>EventType</p>
</dd>
</dl>
<div class="admonition note">
<p class="admonition-title">Note</p>
<p>As this attribute is optional, this method throws a ValueError if
the value of the attribute is not set.</p>
</div>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.Event.setTypeCertainty">
<code class="sig-name descname">setTypeCertainty</code><span class="sig-paren">(</span><em class="sig-param">typeCertainty</em><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.Event.setTypeCertainty" title="Permalink to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>typeCertainty</strong> EventTypeCertainty</p>
</dd>
</dl>
<p>Denotes how certain the information on event type is (Storchak et al.
2012).</p>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.Event.typeCertainty">
<code class="sig-name descname">typeCertainty</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.Event.typeCertainty" title="Permalink to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Return type</dt>
<dd class="field-odd"><p>EventTypeCertainty</p>
</dd>
</dl>
<div class="admonition note">
<p class="admonition-title">Note</p>
<p>As this attribute is optional, this method throws a ValueError if
the value of the attribute is not set.</p>
</div>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.Event.setCreationInfo">
<code class="sig-name descname">setCreationInfo</code><span class="sig-paren">(</span><em class="sig-param">creationInfo</em><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.Event.setCreationInfo" title="Permalink to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>creationInfo</strong> <a class="reference internal" href="#api-python-datamodel-creationinfo"><span class="std std-ref">CreationInfo</span></a></p>
</dd>
</dl>
<p>CreationInfo for the Event object.</p>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.Event.creationInfo">
<code class="sig-name descname">creationInfo</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.Event.creationInfo" title="Permalink to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Return type</dt>
<dd class="field-odd"><p><a class="reference internal" href="#api-python-datamodel-creationinfo"><span class="std std-ref">CreationInfo</span></a></p>
</dd>
</dl>
<div class="admonition note">
<p class="admonition-title">Note</p>
<p>As this attribute is optional, this method throws a ValueError if
the value of the attribute is not set.</p>
</div>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.Event.add">
<code class="sig-name descname">add</code><span class="sig-paren">(</span><em class="sig-param">eventDescription</em><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.Event.add" title="Permalink to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>eventDescription</strong> Object of type <a class="reference internal" href="#api-python-datamodel-eventdescription"><span class="std std-ref">EventDescription</span></a></p>
</dd>
<dt class="field-even">Return type</dt>
<dd class="field-even"><p>A Boolean value indicating success with True, False otherwise.</p>
</dd>
</dl>
<p>Adds a EventDescription object to Event. The object is not
copied but managed by this instance. Any change to the passed object
will also change the child.</p>
</dd></dl>
<dl class="method">
<dt>
<code class="sig-name descname">add</code><span class="sig-paren">(</span><em class="sig-param">comment</em><span class="sig-paren">)</span></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>comment</strong> Object of type <a class="reference internal" href="#api-python-datamodel-comment"><span class="std std-ref">Comment</span></a></p>
</dd>
<dt class="field-even">Return type</dt>
<dd class="field-even"><p>A Boolean value indicating success with True, False otherwise.</p>
</dd>
</dl>
<p>Adds a Comment object to Event. The object is not
copied but managed by this instance. Any change to the passed object
will also change the child.</p>
</dd></dl>
<dl class="method">
<dt>
<code class="sig-name descname">add</code><span class="sig-paren">(</span><em class="sig-param">originReference</em><span class="sig-paren">)</span></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>originReference</strong> Object of type <a class="reference internal" href="#api-python-datamodel-originreference"><span class="std std-ref">OriginReference</span></a></p>
</dd>
<dt class="field-even">Return type</dt>
<dd class="field-even"><p>A Boolean value indicating success with True, False otherwise.</p>
</dd>
</dl>
<p>Adds a OriginReference object to Event. The object is not
copied but managed by this instance. Any change to the passed object
will also change the child.</p>
</dd></dl>
<dl class="method">
<dt>
<code class="sig-name descname">add</code><span class="sig-paren">(</span><em class="sig-param">focalMechanismReference</em><span class="sig-paren">)</span></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>focalMechanismReference</strong> Object of type <a class="reference internal" href="#api-python-datamodel-focalmechanismreference"><span class="std std-ref">FocalMechanismReference</span></a></p>
</dd>
<dt class="field-even">Return type</dt>
<dd class="field-even"><p>A Boolean value indicating success with True, False otherwise.</p>
</dd>
</dl>
<p>Adds a FocalMechanismReference object to Event. The object is not
copied but managed by this instance. Any change to the passed object
will also change the child.</p>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.Event.remove">
<code class="sig-name descname">remove</code><span class="sig-paren">(</span><em class="sig-param">eventDescription</em><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.Event.remove" title="Permalink to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>eventDescription</strong> Object of type <a class="reference internal" href="#api-python-datamodel-eventdescription"><span class="std std-ref">EventDescription</span></a></p>
</dd>
<dt class="field-even">Return type</dt>
<dd class="field-even"><p>A Boolean value indicating success with True, False otherwise.</p>
</dd>
</dl>
<p>Removes a previously added EventDescription object from Event.</p>
</dd></dl>
<dl class="method">
<dt>
<code class="sig-name descname">remove</code><span class="sig-paren">(</span><em class="sig-param">comment</em><span class="sig-paren">)</span></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>comment</strong> Object of type <a class="reference internal" href="#api-python-datamodel-comment"><span class="std std-ref">Comment</span></a></p>
</dd>
<dt class="field-even">Return type</dt>
<dd class="field-even"><p>A Boolean value indicating success with True, False otherwise.</p>
</dd>
</dl>
<p>Removes a previously added Comment object from Event.</p>
</dd></dl>
<dl class="method">
<dt>
<code class="sig-name descname">remove</code><span class="sig-paren">(</span><em class="sig-param">originReference</em><span class="sig-paren">)</span></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>originReference</strong> Object of type <a class="reference internal" href="#api-python-datamodel-originreference"><span class="std std-ref">OriginReference</span></a></p>
</dd>
<dt class="field-even">Return type</dt>
<dd class="field-even"><p>A Boolean value indicating success with True, False otherwise.</p>
</dd>
</dl>
<p>Removes a previously added OriginReference object from Event.</p>
</dd></dl>
<dl class="method">
<dt>
<code class="sig-name descname">remove</code><span class="sig-paren">(</span><em class="sig-param">focalMechanismReference</em><span class="sig-paren">)</span></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>focalMechanismReference</strong> Object of type <a class="reference internal" href="#api-python-datamodel-focalmechanismreference"><span class="std std-ref">FocalMechanismReference</span></a></p>
</dd>
<dt class="field-even">Return type</dt>
<dd class="field-even"><p>A Boolean value indicating success with True, False otherwise.</p>
</dd>
</dl>
<p>Removes a previously added FocalMechanismReference object from Event.</p>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.Event.removeEventDescription">
<code class="sig-name descname">removeEventDescription</code><span class="sig-paren">(</span><em class="sig-param">idx</em><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.Event.removeEventDescription" title="Permalink to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>idx</strong> An integer index of the object to be removed.</p>
</dd>
<dt class="field-even">Return type</dt>
<dd class="field-even"><p>A Boolean value indicating success with True, False otherwise.</p>
</dd>
</dl>
</dd></dl>
<dl class="method">
<dt>
<code class="sig-name descname">removeEventDescription(eventDescriptionIndex);</code></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>eventDescriptionIndex</strong> The index of the object to be removed of type EventDescriptionIndex.</p>
</dd>
<dt class="field-even">Return type</dt>
<dd class="field-even"><p>A Boolean value indicating success with True, False otherwise.</p>
</dd>
</dl>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.Event.removeComment">
<code class="sig-name descname">removeComment</code><span class="sig-paren">(</span><em class="sig-param">idx</em><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.Event.removeComment" title="Permalink to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>idx</strong> An integer index of the object to be removed.</p>
</dd>
<dt class="field-even">Return type</dt>
<dd class="field-even"><p>A Boolean value indicating success with True, False otherwise.</p>
</dd>
</dl>
</dd></dl>
<dl class="method">
<dt>
<code class="sig-name descname">removeComment(commentIndex);</code></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>commentIndex</strong> The index of the object to be removed of type CommentIndex.</p>
</dd>
<dt class="field-even">Return type</dt>
<dd class="field-even"><p>A Boolean value indicating success with True, False otherwise.</p>
</dd>
</dl>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.Event.removeOriginReference">
<code class="sig-name descname">removeOriginReference</code><span class="sig-paren">(</span><em class="sig-param">idx</em><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.Event.removeOriginReference" title="Permalink to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>idx</strong> An integer index of the object to be removed.</p>
</dd>
<dt class="field-even">Return type</dt>
<dd class="field-even"><p>A Boolean value indicating success with True, False otherwise.</p>
</dd>
</dl>
</dd></dl>
<dl class="method">
<dt>
<code class="sig-name descname">removeOriginReference(originReferenceIndex);</code></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>originReferenceIndex</strong> The index of the object to be removed of type OriginReferenceIndex.</p>
</dd>
<dt class="field-even">Return type</dt>
<dd class="field-even"><p>A Boolean value indicating success with True, False otherwise.</p>
</dd>
</dl>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.Event.removeFocalMechanismReference">
<code class="sig-name descname">removeFocalMechanismReference</code><span class="sig-paren">(</span><em class="sig-param">idx</em><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.Event.removeFocalMechanismReference" title="Permalink to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>idx</strong> An integer index of the object to be removed.</p>
</dd>
<dt class="field-even">Return type</dt>
<dd class="field-even"><p>A Boolean value indicating success with True, False otherwise.</p>
</dd>
</dl>
</dd></dl>
<dl class="method">
<dt>
<code class="sig-name descname">removeFocalMechanismReference(focalMechanismReferenceIndex);</code></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>focalMechanismReferenceIndex</strong> The index of the object to be removed of type FocalMechanismReferenceIndex.</p>
</dd>
<dt class="field-even">Return type</dt>
<dd class="field-even"><p>A Boolean value indicating success with True, False otherwise.</p>
</dd>
</dl>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.Event.eventDescriptionCount">
<code class="sig-name descname">eventDescriptionCount</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.Event.eventDescriptionCount" title="Permalink to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Return type</dt>
<dd class="field-odd"><p>integer value indicating the number of child objects.</p>
</dd>
</dl>
<p>Returns the number of EventDescription child objects.</p>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.Event.commentCount">
<code class="sig-name descname">commentCount</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.Event.commentCount" title="Permalink to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Return type</dt>
<dd class="field-odd"><p>integer value indicating the number of child objects.</p>
</dd>
</dl>
<p>Returns the number of Comment child objects.</p>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.Event.originReferenceCount">
<code class="sig-name descname">originReferenceCount</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.Event.originReferenceCount" title="Permalink to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Return type</dt>
<dd class="field-odd"><p>integer value indicating the number of child objects.</p>
</dd>
</dl>
<p>Returns the number of OriginReference child objects.</p>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.Event.focalMechanismReferenceCount">
<code class="sig-name descname">focalMechanismReferenceCount</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.Event.focalMechanismReferenceCount" title="Permalink to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Return type</dt>
<dd class="field-odd"><p>integer value indicating the number of child objects.</p>
</dd>
</dl>
<p>Returns the number of FocalMechanismReference child objects.</p>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.Event.eventDescription">
<code class="sig-name descname">eventDescription</code><span class="sig-paren">(</span><em class="sig-param">idx</em><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.Event.eventDescription" title="Permalink to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>idx</strong> An integer index of the object to be returned.</p>
</dd>
<dt class="field-even">Return type</dt>
<dd class="field-even"><p>Object of type <a class="reference internal" href="#api-python-datamodel-eventdescription"><span class="std std-ref">EventDescription</span></a>.</p>
</dd>
</dl>
<p>Returns the EventDescription at index idx.</p>
</dd></dl>
<dl class="method">
<dt>
<code class="sig-name descname">eventDescription</code><span class="sig-paren">(</span><em class="sig-param">eventDescriptionIndex</em><span class="sig-paren">)</span></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>eventDescriptionIndex</strong> The index of the object to be removed of type EventDescriptionIndex.</p>
</dd>
<dt class="field-even">Return type</dt>
<dd class="field-even"><p>Object of type <a class="reference internal" href="#api-python-datamodel-eventdescription"><span class="std std-ref">EventDescription</span></a>.</p>
</dd>
</dl>
<p>Returns the EventDescription at given index. The indexes of all child objects
are compared by value which makes this function slower than the direct
integer index look-up.</p>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.Event.comment">
<code class="sig-name descname">comment</code><span class="sig-paren">(</span><em class="sig-param">idx</em><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.Event.comment" title="Permalink to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>idx</strong> An integer index of the object to be returned.</p>
</dd>
<dt class="field-even">Return type</dt>
<dd class="field-even"><p>Object of type <a class="reference internal" href="#api-python-datamodel-comment"><span class="std std-ref">Comment</span></a>.</p>
</dd>
</dl>
<p>Returns the Comment at index idx.</p>
</dd></dl>
<dl class="method">
<dt>
<code class="sig-name descname">comment</code><span class="sig-paren">(</span><em class="sig-param">commentIndex</em><span class="sig-paren">)</span></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>commentIndex</strong> The index of the object to be removed of type CommentIndex.</p>
</dd>
<dt class="field-even">Return type</dt>
<dd class="field-even"><p>Object of type <a class="reference internal" href="#api-python-datamodel-comment"><span class="std std-ref">Comment</span></a>.</p>
</dd>
</dl>
<p>Returns the Comment at given index. The indexes of all child objects
are compared by value which makes this function slower than the direct
integer index look-up.</p>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.Event.originReference">
<code class="sig-name descname">originReference</code><span class="sig-paren">(</span><em class="sig-param">idx</em><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.Event.originReference" title="Permalink to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>idx</strong> An integer index of the object to be returned.</p>
</dd>
<dt class="field-even">Return type</dt>
<dd class="field-even"><p>Object of type <a class="reference internal" href="#api-python-datamodel-originreference"><span class="std std-ref">OriginReference</span></a>.</p>
</dd>
</dl>
<p>Returns the OriginReference at index idx.</p>
</dd></dl>
<dl class="method">
<dt>
<code class="sig-name descname">originReference</code><span class="sig-paren">(</span><em class="sig-param">originReferenceIndex</em><span class="sig-paren">)</span></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>originReferenceIndex</strong> The index of the object to be removed of type OriginReferenceIndex.</p>
</dd>
<dt class="field-even">Return type</dt>
<dd class="field-even"><p>Object of type <a class="reference internal" href="#api-python-datamodel-originreference"><span class="std std-ref">OriginReference</span></a>.</p>
</dd>
</dl>
<p>Returns the OriginReference at given index. The indexes of all child objects
are compared by value which makes this function slower than the direct
integer index look-up.</p>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.Event.focalMechanismReference">
<code class="sig-name descname">focalMechanismReference</code><span class="sig-paren">(</span><em class="sig-param">idx</em><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.Event.focalMechanismReference" title="Permalink to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>idx</strong> An integer index of the object to be returned.</p>
</dd>
<dt class="field-even">Return type</dt>
<dd class="field-even"><p>Object of type <a class="reference internal" href="#api-python-datamodel-focalmechanismreference"><span class="std std-ref">FocalMechanismReference</span></a>.</p>
</dd>
</dl>
<p>Returns the FocalMechanismReference at index idx.</p>
</dd></dl>
<dl class="method">
<dt>
<code class="sig-name descname">focalMechanismReference</code><span class="sig-paren">(</span><em class="sig-param">focalMechanismReferenceIndex</em><span class="sig-paren">)</span></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>focalMechanismReferenceIndex</strong> The index of the object to be removed of type FocalMechanismReferenceIndex.</p>
</dd>
<dt class="field-even">Return type</dt>
<dd class="field-even"><p>Object of type <a class="reference internal" href="#api-python-datamodel-focalmechanismreference"><span class="std std-ref">FocalMechanismReference</span></a>.</p>
</dd>
</dl>
<p>Returns the FocalMechanismReference at given index. The indexes of all child objects
are compared by value which makes this function slower than the direct
integer index look-up.</p>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.Event.eventParameters">
<code class="sig-name descname">eventParameters</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.Event.eventParameters" title="Permalink to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Return type</dt>
<dd class="field-odd"><p><a class="reference internal" href="#seiscomp.datamodel.EventParameters" title="seiscomp.datamodel.EventParameters">EventParameters</a></p>
</dd>
</dl>
<p>Returns the parent EventParameters if available. Returns None
if the parent is not a EventParameters. This is a convenience wrapper
for parent().</p>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.Event.assign">
<code class="sig-name descname">assign</code><span class="sig-paren">(</span><em class="sig-param">other</em><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.Event.assign" title="Permalink to this definition"></a></dt>
<dd><p>This method implements the <a class="reference internal" href="#api-python-datamodel-object"><span class="std std-ref">Object</span></a> interface.</p>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.Event.attachTo">
<code class="sig-name descname">attachTo</code><span class="sig-paren">(</span><em class="sig-param">parent</em><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.Event.attachTo" title="Permalink to this definition"></a></dt>
<dd><p>This method implements the <a class="reference internal" href="#api-python-datamodel-object"><span class="std std-ref">Object</span></a> interface.</p>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.Event.detachFrom">
<code class="sig-name descname">detachFrom</code><span class="sig-paren">(</span><em class="sig-param">parent</em><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.Event.detachFrom" title="Permalink to this definition"></a></dt>
<dd><p>This method implements the <a class="reference internal" href="#api-python-datamodel-object"><span class="std std-ref">Object</span></a> interface.</p>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.Event.detach">
<code class="sig-name descname">detach</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.Event.detach" title="Permalink to this definition"></a></dt>
<dd><p>This method implements the <a class="reference internal" href="#api-python-datamodel-object"><span class="std std-ref">Object</span></a> interface.</p>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.Event.clone">
<code class="sig-name descname">clone</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.Event.clone" title="Permalink to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Return type</dt>
<dd class="field-odd"><p>A cloned Event.</p>
</dd>
</dl>
<p>Returns a new instance that is a clone of the current instance. Child
objects are being ignored.</p>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.Event.updateChild">
<code class="sig-name descname">updateChild</code><span class="sig-paren">(</span><em class="sig-param">ref</em><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.Event.updateChild" title="Permalink to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>ref</strong> A child object derived from class Object.</p>
</dd>
<dt class="field-even">Return type</dt>
<dd class="field-even"><p>A Boolean flag indicating success with True, False otherwise</p>
</dd>
</dl>
<p>This method takes the passed reference object and searches for a child
with the same publicID (if derived from <a class="reference internal" href="#api-python-datamodel-publicobject"><span class="std std-ref">PublicObject</span></a>)
or the same index (if derived from <a class="reference internal" href="#api-python-datamodel-object"><span class="std std-ref">Object</span></a>).
The the child was found the reference objects attributes are copied to
the child object. Children of child are being ignored during this operation.
This method implements the <a class="reference internal" href="#api-python-datamodel-publicobject"><span class="std std-ref">PublicObject</span></a> interface.</p>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.Event.accept">
<code class="sig-name descname">accept</code><span class="sig-paren">(</span><em class="sig-param">visitor</em><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.Event.accept" title="Permalink to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>visitor</strong> A visitor.</p>
</dd>
</dl>
<p>This method implements the <a class="reference internal" href="#api-python-datamodel-publicobject"><span class="std std-ref">PublicObject</span></a> interface.</p>
</dd></dl>
</dd></dl>
</div>
<div class="section" id="eventdescription">
<span id="api-python-datamodel-eventdescription"></span><h3>EventDescription<a class="headerlink" href="#eventdescription" title="Permalink to this headline"></a></h3>
<dl class="class">
<dt id="seiscomp.datamodel.EventDescription">
<em class="property">class </em><code class="sig-prename descclassname">seiscomp.datamodel.</code><code class="sig-name descname">EventDescription</code><a class="headerlink" href="#seiscomp.datamodel.EventDescription" title="Permalink to this definition"></a></dt>
<dd><p>Inherits <a class="reference internal" href="#api-python-datamodel-object"><span class="std std-ref">Object</span></a>.</p>
<p>Free-form string with additional event description. This can be a
well-known name, like 1906 San Francisco Earthquake. A number of
categories can be given in type.</p>
<p><strong>Parents</strong>:</p>
<ul class="simple">
<li><p><code class="docutils literal notranslate"><span class="pre">event</span></code> <a class="reference internal" href="#api-python-datamodel-event"><span class="std std-ref">Event</span></a></p></li>
</ul>
<p><strong>Attributes</strong>:</p>
<ul class="simple">
<li><p><code class="docutils literal notranslate"><span class="pre">text</span></code> string</p></li>
<li><p><code class="docutils literal notranslate"><span class="pre">type</span></code> <a class="reference internal" href="#api-python-datamodel-eventdescriptiontype"><span class="std std-ref">EventDescriptionType</span></a></p></li>
</ul>
<p><strong>Methods</strong>:</p>
<dl class="method">
<dt id="seiscomp.datamodel.EventDescription.Cast">
<em class="property">static </em><code class="sig-name descname">Cast</code><span class="sig-paren">(</span><em class="sig-param">obj</em><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.EventDescription.Cast" title="Permalink to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>obj</strong> The object to be casted.</p>
</dd>
<dt class="field-even">Return type</dt>
<dd class="field-even"><p>An object of type EventDescription if the cast was successful,
None otherwise.</p>
</dd>
</dl>
<p>Cast an arbitrary object to EventDescription if the internal wrapped
representation is an EventDescription object. The cast is important if
instances of type <a class="reference internal" href="#api-python-datamodel-object"><span class="std std-ref">Object</span></a>
are passed to methods which need access to the real type.</p>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.EventDescription.equal">
<code class="sig-name descname">equal</code><span class="sig-paren">(</span><em class="sig-param">other</em><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.EventDescription.equal" title="Permalink to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>other</strong> Another object of type EventDescription to compare this
instance to</p>
</dd>
<dt class="field-even">Return type</dt>
<dd class="field-even"><p>A Boolean value indicating True if both objects are equal or
False otherwise.</p>
</dd>
</dl>
<p>Compares two objects without its child objects. Both objects are compared
by value.</p>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.EventDescription.index">
<code class="sig-name descname">index</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.EventDescription.index" title="Permalink to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Return type</dt>
<dd class="field-odd"><p><p>The objects index of type EventDescriptionIndex.</p>
<p>Returns the objects index which is also used for the database as unique
constraint.</p>
</p>
</dd>
</dl>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.EventDescription.equalIndex">
<code class="sig-name descname">equalIndex</code><span class="sig-paren">(</span><em class="sig-param">lhs</em><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.EventDescription.equalIndex" title="Permalink to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>lhs</strong> <a class="reference internal" href="#api-python-datamodel-eventdescription"><span class="std std-ref">EventDescription</span></a></p>
</dd>
<dt class="field-even">Return type</dt>
<dd class="field-even"><p>A Boolean value indicating True if both indexes are equal or
False otherwise.</p>
</dd>
</dl>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.EventDescription.setText">
<code class="sig-name descname">setText</code><span class="sig-paren">(</span><em class="sig-param">text</em><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.EventDescription.setText" title="Permalink to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>text</strong> string</p>
</dd>
</dl>
<p>Free-form text with earthquake description.</p>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.EventDescription.text">
<code class="sig-name descname">text</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.EventDescription.text" title="Permalink to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Return type</dt>
<dd class="field-odd"><p>string</p>
</dd>
</dl>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.EventDescription.setType">
<code class="sig-name descname">setType</code><span class="sig-paren">(</span><em class="sig-param">type</em><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.EventDescription.setType" title="Permalink to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>type</strong> EventDescriptionType</p>
</dd>
</dl>
<p>Category of earthquake description.</p>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.EventDescription.type">
<code class="sig-name descname">type</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.EventDescription.type" title="Permalink to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Return type</dt>
<dd class="field-odd"><p>EventDescriptionType</p>
</dd>
</dl>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.EventDescription.event">
<code class="sig-name descname">event</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.EventDescription.event" title="Permalink to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Return type</dt>
<dd class="field-odd"><p><a class="reference internal" href="#seiscomp.datamodel.Event" title="seiscomp.datamodel.Event">Event</a></p>
</dd>
</dl>
<p>Returns the parent Event if available. Returns None
if the parent is not a Event. This is a convenience wrapper
for parent().</p>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.EventDescription.assign">
<code class="sig-name descname">assign</code><span class="sig-paren">(</span><em class="sig-param">other</em><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.EventDescription.assign" title="Permalink to this definition"></a></dt>
<dd><p>This method implements the <a class="reference internal" href="#api-python-datamodel-object"><span class="std std-ref">Object</span></a> interface.</p>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.EventDescription.attachTo">
<code class="sig-name descname">attachTo</code><span class="sig-paren">(</span><em class="sig-param">parent</em><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.EventDescription.attachTo" title="Permalink to this definition"></a></dt>
<dd><p>This method implements the <a class="reference internal" href="#api-python-datamodel-object"><span class="std std-ref">Object</span></a> interface.</p>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.EventDescription.detachFrom">
<code class="sig-name descname">detachFrom</code><span class="sig-paren">(</span><em class="sig-param">parent</em><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.EventDescription.detachFrom" title="Permalink to this definition"></a></dt>
<dd><p>This method implements the <a class="reference internal" href="#api-python-datamodel-object"><span class="std std-ref">Object</span></a> interface.</p>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.EventDescription.detach">
<code class="sig-name descname">detach</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.EventDescription.detach" title="Permalink to this definition"></a></dt>
<dd><p>This method implements the <a class="reference internal" href="#api-python-datamodel-object"><span class="std std-ref">Object</span></a> interface.</p>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.EventDescription.clone">
<code class="sig-name descname">clone</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.EventDescription.clone" title="Permalink to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Return type</dt>
<dd class="field-odd"><p>A cloned EventDescription.</p>
</dd>
</dl>
<p>Returns a new instance that is a clone of the current instance. Child
objects are being ignored.</p>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.EventDescription.accept">
<code class="sig-name descname">accept</code><span class="sig-paren">(</span><em class="sig-param">visitor</em><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.EventDescription.accept" title="Permalink to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>visitor</strong> A visitor.</p>
</dd>
</dl>
<p>This method implements the <a class="reference internal" href="#api-python-datamodel-publicobject"><span class="std std-ref">PublicObject</span></a> interface.</p>
</dd></dl>
</dd></dl>
</div>
<div class="section" id="api-python-datamodel-eventparameters">
<span id="id14"></span><h3>EventParameters<a class="headerlink" href="#api-python-datamodel-eventparameters" title="Permalink to this headline"></a></h3>
<dl class="class">
<dt id="seiscomp.datamodel.EventParameters">
<em class="property">class </em><code class="sig-prename descclassname">seiscomp.datamodel.</code><code class="sig-name descname">EventParameters</code><a class="headerlink" href="#seiscomp.datamodel.EventParameters" title="Permalink to this definition"></a></dt>
<dd><p>Inherits <a class="reference internal" href="#api-python-datamodel-publicobject"><span class="std std-ref">PublicObject</span></a>.</p>
<p>This type can hold objects of type Event, Origin, Magnitude, StationMagnitude,
FocalMechanism, Reading, Amplitude, and Pick.</p>
<p><strong>Children</strong>:</p>
<ul class="simple">
<li><p><code class="docutils literal notranslate"><span class="pre">pick</span></code> <a class="reference internal" href="#api-python-datamodel-pick"><span class="std std-ref">Pick</span></a></p></li>
<li><p><code class="docutils literal notranslate"><span class="pre">amplitude</span></code> <a class="reference internal" href="#api-python-datamodel-amplitude"><span class="std std-ref">Amplitude</span></a></p></li>
<li><p><code class="docutils literal notranslate"><span class="pre">reading</span></code> <a class="reference internal" href="#api-python-datamodel-reading"><span class="std std-ref">Reading</span></a></p></li>
<li><p><code class="docutils literal notranslate"><span class="pre">origin</span></code> <a class="reference internal" href="#api-python-datamodel-origin"><span class="std std-ref">Origin</span></a></p></li>
<li><p><code class="docutils literal notranslate"><span class="pre">focalMechanism</span></code> <a class="reference internal" href="#api-python-datamodel-focalmechanism"><span class="std std-ref">FocalMechanism</span></a></p></li>
<li><p><code class="docutils literal notranslate"><span class="pre">event</span></code> <a class="reference internal" href="#api-python-datamodel-event"><span class="std std-ref">Event</span></a></p></li>
</ul>
<p><strong>Attributes</strong>:</p>
<ul class="simple">
<li><p><code class="docutils literal notranslate"><span class="pre">publicID</span></code>: string</p></li>
</ul>
<p><strong>Methods</strong>:</p>
<dl class="method">
<dt id="seiscomp.datamodel.EventParameters.Cast">
<em class="property">static </em><code class="sig-name descname">Cast</code><span class="sig-paren">(</span><em class="sig-param">obj</em><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.EventParameters.Cast" title="Permalink to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>obj</strong> The object to be casted.</p>
</dd>
<dt class="field-even">Return type</dt>
<dd class="field-even"><p>An object of type EventParameters if the cast was successful,
None otherwise.</p>
</dd>
</dl>
<p>Cast an arbitrary object to EventParameters if the internal wrapped
representation is an EventParameters object. The cast is important if
instances of type <a class="reference internal" href="#api-python-datamodel-object"><span class="std std-ref">Object</span></a>
are passed to methods which need access to the real type.</p>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.EventParameters.equal">
<code class="sig-name descname">equal</code><span class="sig-paren">(</span><em class="sig-param">other</em><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.EventParameters.equal" title="Permalink to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>other</strong> Another object of type EventParameters to compare this
instance to</p>
</dd>
<dt class="field-even">Return type</dt>
<dd class="field-even"><p>A Boolean value indicating True if both objects are equal or
False otherwise.</p>
</dd>
</dl>
<p>Compares two objects without its child objects. Both objects are compared
by value.</p>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.EventParameters.add">
<code class="sig-name descname">add</code><span class="sig-paren">(</span><em class="sig-param">pick</em><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.EventParameters.add" title="Permalink to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>pick</strong> Object of type <a class="reference internal" href="#api-python-datamodel-pick"><span class="std std-ref">Pick</span></a></p>
</dd>
<dt class="field-even">Return type</dt>
<dd class="field-even"><p>A Boolean value indicating success with True, False otherwise.</p>
</dd>
</dl>
<p>Adds a Pick object to EventParameters. The object is not
copied but managed by this instance. Any change to the passed object
will also change the child.</p>
</dd></dl>
<dl class="method">
<dt>
<code class="sig-name descname">add</code><span class="sig-paren">(</span><em class="sig-param">amplitude</em><span class="sig-paren">)</span></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>amplitude</strong> Object of type <a class="reference internal" href="#api-python-datamodel-amplitude"><span class="std std-ref">Amplitude</span></a></p>
</dd>
<dt class="field-even">Return type</dt>
<dd class="field-even"><p>A Boolean value indicating success with True, False otherwise.</p>
</dd>
</dl>
<p>Adds a Amplitude object to EventParameters. The object is not
copied but managed by this instance. Any change to the passed object
will also change the child.</p>
</dd></dl>
<dl class="method">
<dt>
<code class="sig-name descname">add</code><span class="sig-paren">(</span><em class="sig-param">reading</em><span class="sig-paren">)</span></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>reading</strong> Object of type <a class="reference internal" href="#api-python-datamodel-reading"><span class="std std-ref">Reading</span></a></p>
</dd>
<dt class="field-even">Return type</dt>
<dd class="field-even"><p>A Boolean value indicating success with True, False otherwise.</p>
</dd>
</dl>
<p>Adds a Reading object to EventParameters. The object is not
copied but managed by this instance. Any change to the passed object
will also change the child.</p>
</dd></dl>
<dl class="method">
<dt>
<code class="sig-name descname">add</code><span class="sig-paren">(</span><em class="sig-param">origin</em><span class="sig-paren">)</span></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>origin</strong> Object of type <a class="reference internal" href="#api-python-datamodel-origin"><span class="std std-ref">Origin</span></a></p>
</dd>
<dt class="field-even">Return type</dt>
<dd class="field-even"><p>A Boolean value indicating success with True, False otherwise.</p>
</dd>
</dl>
<p>Adds a Origin object to EventParameters. The object is not
copied but managed by this instance. Any change to the passed object
will also change the child.</p>
</dd></dl>
<dl class="method">
<dt>
<code class="sig-name descname">add</code><span class="sig-paren">(</span><em class="sig-param">focalMechanism</em><span class="sig-paren">)</span></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>focalMechanism</strong> Object of type <a class="reference internal" href="#api-python-datamodel-focalmechanism"><span class="std std-ref">FocalMechanism</span></a></p>
</dd>
<dt class="field-even">Return type</dt>
<dd class="field-even"><p>A Boolean value indicating success with True, False otherwise.</p>
</dd>
</dl>
<p>Adds a FocalMechanism object to EventParameters. The object is not
copied but managed by this instance. Any change to the passed object
will also change the child.</p>
</dd></dl>
<dl class="method">
<dt>
<code class="sig-name descname">add</code><span class="sig-paren">(</span><em class="sig-param">event</em><span class="sig-paren">)</span></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>event</strong> Object of type <a class="reference internal" href="#api-python-datamodel-event"><span class="std std-ref">Event</span></a></p>
</dd>
<dt class="field-even">Return type</dt>
<dd class="field-even"><p>A Boolean value indicating success with True, False otherwise.</p>
</dd>
</dl>
<p>Adds a Event object to EventParameters. The object is not
copied but managed by this instance. Any change to the passed object
will also change the child.</p>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.EventParameters.remove">
<code class="sig-name descname">remove</code><span class="sig-paren">(</span><em class="sig-param">pick</em><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.EventParameters.remove" title="Permalink to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>pick</strong> Object of type <a class="reference internal" href="#api-python-datamodel-pick"><span class="std std-ref">Pick</span></a></p>
</dd>
<dt class="field-even">Return type</dt>
<dd class="field-even"><p>A Boolean value indicating success with True, False otherwise.</p>
</dd>
</dl>
<p>Removes a previously added Pick object from EventParameters.</p>
</dd></dl>
<dl class="method">
<dt>
<code class="sig-name descname">remove</code><span class="sig-paren">(</span><em class="sig-param">amplitude</em><span class="sig-paren">)</span></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>amplitude</strong> Object of type <a class="reference internal" href="#api-python-datamodel-amplitude"><span class="std std-ref">Amplitude</span></a></p>
</dd>
<dt class="field-even">Return type</dt>
<dd class="field-even"><p>A Boolean value indicating success with True, False otherwise.</p>
</dd>
</dl>
<p>Removes a previously added Amplitude object from EventParameters.</p>
</dd></dl>
<dl class="method">
<dt>
<code class="sig-name descname">remove</code><span class="sig-paren">(</span><em class="sig-param">reading</em><span class="sig-paren">)</span></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>reading</strong> Object of type <a class="reference internal" href="#api-python-datamodel-reading"><span class="std std-ref">Reading</span></a></p>
</dd>
<dt class="field-even">Return type</dt>
<dd class="field-even"><p>A Boolean value indicating success with True, False otherwise.</p>
</dd>
</dl>
<p>Removes a previously added Reading object from EventParameters.</p>
</dd></dl>
<dl class="method">
<dt>
<code class="sig-name descname">remove</code><span class="sig-paren">(</span><em class="sig-param">origin</em><span class="sig-paren">)</span></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>origin</strong> Object of type <a class="reference internal" href="#api-python-datamodel-origin"><span class="std std-ref">Origin</span></a></p>
</dd>
<dt class="field-even">Return type</dt>
<dd class="field-even"><p>A Boolean value indicating success with True, False otherwise.</p>
</dd>
</dl>
<p>Removes a previously added Origin object from EventParameters.</p>
</dd></dl>
<dl class="method">
<dt>
<code class="sig-name descname">remove</code><span class="sig-paren">(</span><em class="sig-param">focalMechanism</em><span class="sig-paren">)</span></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>focalMechanism</strong> Object of type <a class="reference internal" href="#api-python-datamodel-focalmechanism"><span class="std std-ref">FocalMechanism</span></a></p>
</dd>
<dt class="field-even">Return type</dt>
<dd class="field-even"><p>A Boolean value indicating success with True, False otherwise.</p>
</dd>
</dl>
<p>Removes a previously added FocalMechanism object from EventParameters.</p>
</dd></dl>
<dl class="method">
<dt>
<code class="sig-name descname">remove</code><span class="sig-paren">(</span><em class="sig-param">event</em><span class="sig-paren">)</span></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>event</strong> Object of type <a class="reference internal" href="#api-python-datamodel-event"><span class="std std-ref">Event</span></a></p>
</dd>
<dt class="field-even">Return type</dt>
<dd class="field-even"><p>A Boolean value indicating success with True, False otherwise.</p>
</dd>
</dl>
<p>Removes a previously added Event object from EventParameters.</p>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.EventParameters.removePick">
<code class="sig-name descname">removePick</code><span class="sig-paren">(</span><em class="sig-param">idx</em><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.EventParameters.removePick" title="Permalink to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>idx</strong> An integer index of the object to be removed.</p>
</dd>
<dt class="field-even">Return type</dt>
<dd class="field-even"><p>A Boolean value indicating success with True, False otherwise.</p>
</dd>
</dl>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.EventParameters.removeAmplitude">
<code class="sig-name descname">removeAmplitude</code><span class="sig-paren">(</span><em class="sig-param">idx</em><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.EventParameters.removeAmplitude" title="Permalink to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>idx</strong> An integer index of the object to be removed.</p>
</dd>
<dt class="field-even">Return type</dt>
<dd class="field-even"><p>A Boolean value indicating success with True, False otherwise.</p>
</dd>
</dl>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.EventParameters.removeReading">
<code class="sig-name descname">removeReading</code><span class="sig-paren">(</span><em class="sig-param">idx</em><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.EventParameters.removeReading" title="Permalink to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>idx</strong> An integer index of the object to be removed.</p>
</dd>
<dt class="field-even">Return type</dt>
<dd class="field-even"><p>A Boolean value indicating success with True, False otherwise.</p>
</dd>
</dl>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.EventParameters.removeOrigin">
<code class="sig-name descname">removeOrigin</code><span class="sig-paren">(</span><em class="sig-param">idx</em><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.EventParameters.removeOrigin" title="Permalink to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>idx</strong> An integer index of the object to be removed.</p>
</dd>
<dt class="field-even">Return type</dt>
<dd class="field-even"><p>A Boolean value indicating success with True, False otherwise.</p>
</dd>
</dl>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.EventParameters.removeFocalMechanism">
<code class="sig-name descname">removeFocalMechanism</code><span class="sig-paren">(</span><em class="sig-param">idx</em><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.EventParameters.removeFocalMechanism" title="Permalink to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>idx</strong> An integer index of the object to be removed.</p>
</dd>
<dt class="field-even">Return type</dt>
<dd class="field-even"><p>A Boolean value indicating success with True, False otherwise.</p>
</dd>
</dl>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.EventParameters.removeEvent">
<code class="sig-name descname">removeEvent</code><span class="sig-paren">(</span><em class="sig-param">idx</em><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.EventParameters.removeEvent" title="Permalink to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>idx</strong> An integer index of the object to be removed.</p>
</dd>
<dt class="field-even">Return type</dt>
<dd class="field-even"><p>A Boolean value indicating success with True, False otherwise.</p>
</dd>
</dl>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.EventParameters.pickCount">
<code class="sig-name descname">pickCount</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.EventParameters.pickCount" title="Permalink to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Return type</dt>
<dd class="field-odd"><p>integer value indicating the number of child objects.</p>
</dd>
</dl>
<p>Returns the number of Pick child objects.</p>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.EventParameters.amplitudeCount">
<code class="sig-name descname">amplitudeCount</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.EventParameters.amplitudeCount" title="Permalink to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Return type</dt>
<dd class="field-odd"><p>integer value indicating the number of child objects.</p>
</dd>
</dl>
<p>Returns the number of Amplitude child objects.</p>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.EventParameters.readingCount">
<code class="sig-name descname">readingCount</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.EventParameters.readingCount" title="Permalink to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Return type</dt>
<dd class="field-odd"><p>integer value indicating the number of child objects.</p>
</dd>
</dl>
<p>Returns the number of Reading child objects.</p>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.EventParameters.originCount">
<code class="sig-name descname">originCount</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.EventParameters.originCount" title="Permalink to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Return type</dt>
<dd class="field-odd"><p>integer value indicating the number of child objects.</p>
</dd>
</dl>
<p>Returns the number of Origin child objects.</p>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.EventParameters.focalMechanismCount">
<code class="sig-name descname">focalMechanismCount</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.EventParameters.focalMechanismCount" title="Permalink to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Return type</dt>
<dd class="field-odd"><p>integer value indicating the number of child objects.</p>
</dd>
</dl>
<p>Returns the number of FocalMechanism child objects.</p>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.EventParameters.eventCount">
<code class="sig-name descname">eventCount</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.EventParameters.eventCount" title="Permalink to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Return type</dt>
<dd class="field-odd"><p>integer value indicating the number of child objects.</p>
</dd>
</dl>
<p>Returns the number of Event child objects.</p>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.EventParameters.pick">
<code class="sig-name descname">pick</code><span class="sig-paren">(</span><em class="sig-param">idx</em><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.EventParameters.pick" title="Permalink to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>idx</strong> An integer index of the object to be returned.</p>
</dd>
<dt class="field-even">Return type</dt>
<dd class="field-even"><p>Object of type <a class="reference internal" href="#api-python-datamodel-pick"><span class="std std-ref">Pick</span></a>.</p>
</dd>
</dl>
<p>Returns the Pick at index idx.</p>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.EventParameters.amplitude">
<code class="sig-name descname">amplitude</code><span class="sig-paren">(</span><em class="sig-param">idx</em><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.EventParameters.amplitude" title="Permalink to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>idx</strong> An integer index of the object to be returned.</p>
</dd>
<dt class="field-even">Return type</dt>
<dd class="field-even"><p>Object of type <a class="reference internal" href="#api-python-datamodel-amplitude"><span class="std std-ref">Amplitude</span></a>.</p>
</dd>
</dl>
<p>Returns the Amplitude at index idx.</p>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.EventParameters.reading">
<code class="sig-name descname">reading</code><span class="sig-paren">(</span><em class="sig-param">idx</em><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.EventParameters.reading" title="Permalink to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>idx</strong> An integer index of the object to be returned.</p>
</dd>
<dt class="field-even">Return type</dt>
<dd class="field-even"><p>Object of type <a class="reference internal" href="#api-python-datamodel-reading"><span class="std std-ref">Reading</span></a>.</p>
</dd>
</dl>
<p>Returns the Reading at index idx.</p>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.EventParameters.origin">
<code class="sig-name descname">origin</code><span class="sig-paren">(</span><em class="sig-param">idx</em><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.EventParameters.origin" title="Permalink to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>idx</strong> An integer index of the object to be returned.</p>
</dd>
<dt class="field-even">Return type</dt>
<dd class="field-even"><p>Object of type <a class="reference internal" href="#api-python-datamodel-origin"><span class="std std-ref">Origin</span></a>.</p>
</dd>
</dl>
<p>Returns the Origin at index idx.</p>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.EventParameters.focalMechanism">
<code class="sig-name descname">focalMechanism</code><span class="sig-paren">(</span><em class="sig-param">idx</em><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.EventParameters.focalMechanism" title="Permalink to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>idx</strong> An integer index of the object to be returned.</p>
</dd>
<dt class="field-even">Return type</dt>
<dd class="field-even"><p>Object of type <a class="reference internal" href="#api-python-datamodel-focalmechanism"><span class="std std-ref">FocalMechanism</span></a>.</p>
</dd>
</dl>
<p>Returns the FocalMechanism at index idx.</p>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.EventParameters.event">
<code class="sig-name descname">event</code><span class="sig-paren">(</span><em class="sig-param">idx</em><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.EventParameters.event" title="Permalink to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>idx</strong> An integer index of the object to be returned.</p>
</dd>
<dt class="field-even">Return type</dt>
<dd class="field-even"><p>Object of type <a class="reference internal" href="#api-python-datamodel-event"><span class="std std-ref">Event</span></a>.</p>
</dd>
</dl>
<p>Returns the Event at index idx.</p>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.EventParameters.findPick">
<code class="sig-name descname">findPick</code><span class="sig-paren">(</span><em class="sig-param">publicID</em><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.EventParameters.findPick" title="Permalink to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>publicID</strong> The publicID of the object to find.</p>
</dd>
<dt class="field-even">Return type</dt>
<dd class="field-even"><p>Object of type <a class="reference internal" href="#api-python-datamodel-pick"><span class="std std-ref">Pick</span></a>.</p>
</dd>
</dl>
<p>Returns the child object with a certain publicID, None otherwise.</p>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.EventParameters.findAmplitude">
<code class="sig-name descname">findAmplitude</code><span class="sig-paren">(</span><em class="sig-param">publicID</em><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.EventParameters.findAmplitude" title="Permalink to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>publicID</strong> The publicID of the object to find.</p>
</dd>
<dt class="field-even">Return type</dt>
<dd class="field-even"><p>Object of type <a class="reference internal" href="#api-python-datamodel-amplitude"><span class="std std-ref">Amplitude</span></a>.</p>
</dd>
</dl>
<p>Returns the child object with a certain publicID, None otherwise.</p>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.EventParameters.findReading">
<code class="sig-name descname">findReading</code><span class="sig-paren">(</span><em class="sig-param">publicID</em><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.EventParameters.findReading" title="Permalink to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>publicID</strong> The publicID of the object to find.</p>
</dd>
<dt class="field-even">Return type</dt>
<dd class="field-even"><p>Object of type <a class="reference internal" href="#api-python-datamodel-reading"><span class="std std-ref">Reading</span></a>.</p>
</dd>
</dl>
<p>Returns the child object with a certain publicID, None otherwise.</p>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.EventParameters.findOrigin">
<code class="sig-name descname">findOrigin</code><span class="sig-paren">(</span><em class="sig-param">publicID</em><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.EventParameters.findOrigin" title="Permalink to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>publicID</strong> The publicID of the object to find.</p>
</dd>
<dt class="field-even">Return type</dt>
<dd class="field-even"><p>Object of type <a class="reference internal" href="#api-python-datamodel-origin"><span class="std std-ref">Origin</span></a>.</p>
</dd>
</dl>
<p>Returns the child object with a certain publicID, None otherwise.</p>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.EventParameters.findFocalMechanism">
<code class="sig-name descname">findFocalMechanism</code><span class="sig-paren">(</span><em class="sig-param">publicID</em><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.EventParameters.findFocalMechanism" title="Permalink to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>publicID</strong> The publicID of the object to find.</p>
</dd>
<dt class="field-even">Return type</dt>
<dd class="field-even"><p>Object of type <a class="reference internal" href="#api-python-datamodel-focalmechanism"><span class="std std-ref">FocalMechanism</span></a>.</p>
</dd>
</dl>
<p>Returns the child object with a certain publicID, None otherwise.</p>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.EventParameters.findEvent">
<code class="sig-name descname">findEvent</code><span class="sig-paren">(</span><em class="sig-param">publicID</em><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.EventParameters.findEvent" title="Permalink to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>publicID</strong> The publicID of the object to find.</p>
</dd>
<dt class="field-even">Return type</dt>
<dd class="field-even"><p>Object of type <a class="reference internal" href="#api-python-datamodel-event"><span class="std std-ref">Event</span></a>.</p>
</dd>
</dl>
<p>Returns the child object with a certain publicID, None otherwise.</p>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.EventParameters.assign">
<code class="sig-name descname">assign</code><span class="sig-paren">(</span><em class="sig-param">other</em><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.EventParameters.assign" title="Permalink to this definition"></a></dt>
<dd><p>This method implements the <a class="reference internal" href="#api-python-datamodel-object"><span class="std std-ref">Object</span></a> interface.</p>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.EventParameters.attachTo">
<code class="sig-name descname">attachTo</code><span class="sig-paren">(</span><em class="sig-param">parent</em><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.EventParameters.attachTo" title="Permalink to this definition"></a></dt>
<dd><p>This method implements the <a class="reference internal" href="#api-python-datamodel-object"><span class="std std-ref">Object</span></a> interface.</p>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.EventParameters.detachFrom">
<code class="sig-name descname">detachFrom</code><span class="sig-paren">(</span><em class="sig-param">parent</em><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.EventParameters.detachFrom" title="Permalink to this definition"></a></dt>
<dd><p>This method implements the <a class="reference internal" href="#api-python-datamodel-object"><span class="std std-ref">Object</span></a> interface.</p>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.EventParameters.detach">
<code class="sig-name descname">detach</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.EventParameters.detach" title="Permalink to this definition"></a></dt>
<dd><p>This method implements the <a class="reference internal" href="#api-python-datamodel-object"><span class="std std-ref">Object</span></a> interface.</p>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.EventParameters.clone">
<code class="sig-name descname">clone</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.EventParameters.clone" title="Permalink to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Return type</dt>
<dd class="field-odd"><p>A cloned EventParameters.</p>
</dd>
</dl>
<p>Returns a new instance that is a clone of the current instance. Child
objects are being ignored.</p>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.EventParameters.updateChild">
<code class="sig-name descname">updateChild</code><span class="sig-paren">(</span><em class="sig-param">ref</em><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.EventParameters.updateChild" title="Permalink to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>ref</strong> A child object derived from class Object.</p>
</dd>
<dt class="field-even">Return type</dt>
<dd class="field-even"><p>A Boolean flag indicating success with True, False otherwise</p>
</dd>
</dl>
<p>This method takes the passed reference object and searches for a child
with the same publicID (if derived from <a class="reference internal" href="#api-python-datamodel-publicobject"><span class="std std-ref">PublicObject</span></a>)
or the same index (if derived from <a class="reference internal" href="#api-python-datamodel-object"><span class="std std-ref">Object</span></a>).
The the child was found the reference objects attributes are copied to
the child object. Children of child are being ignored during this operation.
This method implements the <a class="reference internal" href="#api-python-datamodel-publicobject"><span class="std std-ref">PublicObject</span></a> interface.</p>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.EventParameters.accept">
<code class="sig-name descname">accept</code><span class="sig-paren">(</span><em class="sig-param">visitor</em><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.EventParameters.accept" title="Permalink to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>visitor</strong> A visitor.</p>
</dd>
</dl>
<p>This method implements the <a class="reference internal" href="#api-python-datamodel-publicobject"><span class="std std-ref">PublicObject</span></a> interface.</p>
</dd></dl>
</dd></dl>
</div>
<div class="section" id="focalmechanism">
<span id="api-python-datamodel-focalmechanism"></span><h3>FocalMechanism<a class="headerlink" href="#focalmechanism" title="Permalink to this headline"></a></h3>
<dl class="class">
<dt id="seiscomp.datamodel.FocalMechanism">
<em class="property">class </em><code class="sig-prename descclassname">seiscomp.datamodel.</code><code class="sig-name descname">FocalMechanism</code><a class="headerlink" href="#seiscomp.datamodel.FocalMechanism" title="Permalink to this definition"></a></dt>
<dd><p>Inherits <a class="reference internal" href="#api-python-datamodel-publicobject"><span class="std std-ref">PublicObject</span></a>.</p>
<p>This class describes the focal mechanism of an event. It includes different
descriptions like nodal planes, principal axes, and a moment tensor.
The moment tensor description is provided by objects of the class
MomentTensor which can be specified as child elements of FocalMechanism.</p>
<p><strong>Parents</strong>:</p>
<ul class="simple">
<li><p><code class="docutils literal notranslate"><span class="pre">eventParameters</span></code> <a class="reference internal" href="#api-python-datamodel-eventparameters"><span class="std std-ref">EventParameters</span></a></p></li>
</ul>
<p><strong>Children</strong>:</p>
<ul class="simple">
<li><p><code class="docutils literal notranslate"><span class="pre">comment</span></code> <a class="reference internal" href="#api-python-datamodel-comment"><span class="std std-ref">Comment</span></a></p></li>
<li><p><code class="docutils literal notranslate"><span class="pre">momentTensor</span></code> <a class="reference internal" href="#api-python-datamodel-momenttensor"><span class="std std-ref">MomentTensor</span></a></p></li>
</ul>
<p><strong>Attributes</strong>:</p>
<ul class="simple">
<li><p><code class="docutils literal notranslate"><span class="pre">publicID</span></code>: string</p></li>
<li><p><code class="docutils literal notranslate"><span class="pre">triggeringOriginID</span></code> string</p></li>
<li><p><code class="docutils literal notranslate"><span class="pre">nodalPlanes</span></code> <a class="reference internal" href="#api-python-datamodel-nodalplanes"><span class="std std-ref">NodalPlanes</span></a> (optional)</p></li>
<li><p><code class="docutils literal notranslate"><span class="pre">principalAxes</span></code> <a class="reference internal" href="#api-python-datamodel-principalaxes"><span class="std std-ref">PrincipalAxes</span></a> (optional)</p></li>
<li><p><code class="docutils literal notranslate"><span class="pre">azimuthalGap</span></code> float (optional)</p></li>
<li><p><code class="docutils literal notranslate"><span class="pre">stationPolarityCount</span></code> int (optional)</p></li>
<li><p><code class="docutils literal notranslate"><span class="pre">misfit</span></code> float (optional)</p></li>
<li><p><code class="docutils literal notranslate"><span class="pre">stationDistributionRatio</span></code> float (optional)</p></li>
<li><p><code class="docutils literal notranslate"><span class="pre">methodID</span></code> string</p></li>
<li><p><code class="docutils literal notranslate"><span class="pre">evaluationMode</span></code> <a class="reference internal" href="#api-python-datamodel-evaluationmode"><span class="std std-ref">EvaluationMode</span></a> (optional)</p></li>
<li><p><code class="docutils literal notranslate"><span class="pre">evaluationStatus</span></code> <a class="reference internal" href="#api-python-datamodel-evaluationstatus"><span class="std std-ref">EvaluationStatus</span></a> (optional)</p></li>
<li><p><code class="docutils literal notranslate"><span class="pre">creationInfo</span></code> <a class="reference internal" href="#api-python-datamodel-creationinfo"><span class="std std-ref">CreationInfo</span></a> (optional)</p></li>
</ul>
<p><strong>Referenced by</strong>:</p>
<ul class="simple">
<li><p><a class="reference internal" href="#seiscomp.datamodel.Event.preferredFocalMechanismID" title="seiscomp.datamodel.Event.preferredFocalMechanismID"><code class="xref py py-func docutils literal notranslate"><span class="pre">Event.preferredFocalMechanismID()</span></code></a></p></li>
<li><p><a class="reference internal" href="#seiscomp.datamodel.FocalMechanismReference.focalMechanismID" title="seiscomp.datamodel.FocalMechanismReference.focalMechanismID"><code class="xref py py-func docutils literal notranslate"><span class="pre">FocalMechanismReference.focalMechanismID()</span></code></a></p></li>
</ul>
<p><strong>Methods</strong>:</p>
<dl class="method">
<dt id="seiscomp.datamodel.FocalMechanism.Cast">
<em class="property">static </em><code class="sig-name descname">Cast</code><span class="sig-paren">(</span><em class="sig-param">obj</em><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.FocalMechanism.Cast" title="Permalink to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>obj</strong> The object to be casted.</p>
</dd>
<dt class="field-even">Return type</dt>
<dd class="field-even"><p>An object of type FocalMechanism if the cast was successful,
None otherwise.</p>
</dd>
</dl>
<p>Cast an arbitrary object to FocalMechanism if the internal wrapped
representation is an FocalMechanism object. The cast is important if
instances of type <a class="reference internal" href="#api-python-datamodel-object"><span class="std std-ref">Object</span></a>
are passed to methods which need access to the real type.</p>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.FocalMechanism.Create">
<em class="property">static </em><code class="sig-name descname">Create</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.FocalMechanism.Create" title="Permalink to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Return type</dt>
<dd class="field-odd"><p>A new object of type FocalMechanism.</p>
</dd>
</dl>
<p>Creates and registers (if enabled) a FocalMechanism instance. The
publicID is auto-generated.</p>
</dd></dl>
<dl class="method">
<dt>
<em class="property">static </em><code class="sig-name descname">Create</code><span class="sig-paren">(</span><em class="sig-param">publicID</em><span class="sig-paren">)</span></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Return type</dt>
<dd class="field-odd"><p>A new object of type FocalMechanism.</p>
</dd>
</dl>
<p>Creates and registers (if enabled) a FocalMechanism instance with
passed publicID.</p>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.FocalMechanism.equal">
<code class="sig-name descname">equal</code><span class="sig-paren">(</span><em class="sig-param">other</em><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.FocalMechanism.equal" title="Permalink to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>other</strong> Another object of type FocalMechanism to compare this
instance to</p>
</dd>
<dt class="field-even">Return type</dt>
<dd class="field-even"><p>A Boolean value indicating True if both objects are equal or
False otherwise.</p>
</dd>
</dl>
<p>Compares two objects without its child objects. Both objects are compared
by value.</p>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.FocalMechanism.setTriggeringOriginID">
<code class="sig-name descname">setTriggeringOriginID</code><span class="sig-paren">(</span><em class="sig-param">triggeringOriginID</em><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.FocalMechanism.setTriggeringOriginID" title="Permalink to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>triggeringOriginID</strong> string</p>
</dd>
</dl>
<p>Refers to the publicID of the triggering origin.</p>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.FocalMechanism.triggeringOriginID">
<code class="sig-name descname">triggeringOriginID</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.FocalMechanism.triggeringOriginID" title="Permalink to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Return type</dt>
<dd class="field-odd"><p>string</p>
</dd>
</dl>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.FocalMechanism.setNodalPlanes">
<code class="sig-name descname">setNodalPlanes</code><span class="sig-paren">(</span><em class="sig-param">nodalPlanes</em><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.FocalMechanism.setNodalPlanes" title="Permalink to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>nodalPlanes</strong> <a class="reference internal" href="#api-python-datamodel-nodalplanes"><span class="std std-ref">NodalPlanes</span></a></p>
</dd>
</dl>
<p>Nodal planes of the focal mechanism.</p>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.FocalMechanism.nodalPlanes">
<code class="sig-name descname">nodalPlanes</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.FocalMechanism.nodalPlanes" title="Permalink to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Return type</dt>
<dd class="field-odd"><p><a class="reference internal" href="#api-python-datamodel-nodalplanes"><span class="std std-ref">NodalPlanes</span></a></p>
</dd>
</dl>
<div class="admonition note">
<p class="admonition-title">Note</p>
<p>As this attribute is optional, this method throws a ValueError if
the value of the attribute is not set.</p>
</div>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.FocalMechanism.setPrincipalAxes">
<code class="sig-name descname">setPrincipalAxes</code><span class="sig-paren">(</span><em class="sig-param">principalAxes</em><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.FocalMechanism.setPrincipalAxes" title="Permalink to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>principalAxes</strong> <a class="reference internal" href="#api-python-datamodel-principalaxes"><span class="std std-ref">PrincipalAxes</span></a></p>
</dd>
</dl>
<p>Principal axes of the focal mechanism.</p>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.FocalMechanism.principalAxes">
<code class="sig-name descname">principalAxes</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.FocalMechanism.principalAxes" title="Permalink to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Return type</dt>
<dd class="field-odd"><p><a class="reference internal" href="#api-python-datamodel-principalaxes"><span class="std std-ref">PrincipalAxes</span></a></p>
</dd>
</dl>
<div class="admonition note">
<p class="admonition-title">Note</p>
<p>As this attribute is optional, this method throws a ValueError if
the value of the attribute is not set.</p>
</div>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.FocalMechanism.setAzimuthalGap">
<code class="sig-name descname">setAzimuthalGap</code><span class="sig-paren">(</span><em class="sig-param">azimuthalGap</em><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.FocalMechanism.setAzimuthalGap" title="Permalink to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>azimuthalGap</strong> float</p>
</dd>
</dl>
<p>Largest azimuthal gap in distribution of stations used for determination
of focal mechanism in degrees.</p>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.FocalMechanism.azimuthalGap">
<code class="sig-name descname">azimuthalGap</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.FocalMechanism.azimuthalGap" title="Permalink to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Return type</dt>
<dd class="field-odd"><p>float</p>
</dd>
</dl>
<div class="admonition note">
<p class="admonition-title">Note</p>
<p>As this attribute is optional, this method throws a ValueError if
the value of the attribute is not set.</p>
</div>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.FocalMechanism.setStationPolarityCount">
<code class="sig-name descname">setStationPolarityCount</code><span class="sig-paren">(</span><em class="sig-param">stationPolarityCount</em><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.FocalMechanism.setStationPolarityCount" title="Permalink to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>stationPolarityCount</strong> int</p>
</dd>
</dl>
<p>Number of station polarities used for determination of focal mechanism.</p>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.FocalMechanism.stationPolarityCount">
<code class="sig-name descname">stationPolarityCount</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.FocalMechanism.stationPolarityCount" title="Permalink to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Return type</dt>
<dd class="field-odd"><p>int</p>
</dd>
</dl>
<div class="admonition note">
<p class="admonition-title">Note</p>
<p>As this attribute is optional, this method throws a ValueError if
the value of the attribute is not set.</p>
</div>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.FocalMechanism.setMisfit">
<code class="sig-name descname">setMisfit</code><span class="sig-paren">(</span><em class="sig-param">misfit</em><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.FocalMechanism.setMisfit" title="Permalink to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>misfit</strong> float</p>
</dd>
</dl>
<p>Fraction of misfit polarities in a first-motion focal mechanism
determination.
Decimal fraction between 0 and 1.</p>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.FocalMechanism.misfit">
<code class="sig-name descname">misfit</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.FocalMechanism.misfit" title="Permalink to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Return type</dt>
<dd class="field-odd"><p>float</p>
</dd>
</dl>
<div class="admonition note">
<p class="admonition-title">Note</p>
<p>As this attribute is optional, this method throws a ValueError if
the value of the attribute is not set.</p>
</div>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.FocalMechanism.setStationDistributionRatio">
<code class="sig-name descname">setStationDistributionRatio</code><span class="sig-paren">(</span><em class="sig-param">stationDistributionRatio</em><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.FocalMechanism.setStationDistributionRatio" title="Permalink to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>stationDistributionRatio</strong> float</p>
</dd>
</dl>
<p>Station distribution ratio (STDR) parameter. Indicates how the stations
are distributed about the focal sphere (Reasenberg and Oppenheimer 1985).
Decimal fraction between 0 and 1.</p>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.FocalMechanism.stationDistributionRatio">
<code class="sig-name descname">stationDistributionRatio</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.FocalMechanism.stationDistributionRatio" title="Permalink to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Return type</dt>
<dd class="field-odd"><p>float</p>
</dd>
</dl>
<div class="admonition note">
<p class="admonition-title">Note</p>
<p>As this attribute is optional, this method throws a ValueError if
the value of the attribute is not set.</p>
</div>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.FocalMechanism.setMethodID">
<code class="sig-name descname">setMethodID</code><span class="sig-paren">(</span><em class="sig-param">methodID</em><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.FocalMechanism.setMethodID" title="Permalink to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>methodID</strong> string</p>
</dd>
</dl>
<p>Resource identifier of the method used for determination of the focal
mechanism.</p>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.FocalMechanism.methodID">
<code class="sig-name descname">methodID</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.FocalMechanism.methodID" title="Permalink to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Return type</dt>
<dd class="field-odd"><p>string</p>
</dd>
</dl>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.FocalMechanism.setEvaluationMode">
<code class="sig-name descname">setEvaluationMode</code><span class="sig-paren">(</span><em class="sig-param">evaluationMode</em><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.FocalMechanism.setEvaluationMode" title="Permalink to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>evaluationMode</strong> EvaluationMode</p>
</dd>
</dl>
<p>Evaluation mode of FocalMechanism.</p>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.FocalMechanism.evaluationMode">
<code class="sig-name descname">evaluationMode</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.FocalMechanism.evaluationMode" title="Permalink to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Return type</dt>
<dd class="field-odd"><p>EvaluationMode</p>
</dd>
</dl>
<div class="admonition note">
<p class="admonition-title">Note</p>
<p>As this attribute is optional, this method throws a ValueError if
the value of the attribute is not set.</p>
</div>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.FocalMechanism.setEvaluationStatus">
<code class="sig-name descname">setEvaluationStatus</code><span class="sig-paren">(</span><em class="sig-param">evaluationStatus</em><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.FocalMechanism.setEvaluationStatus" title="Permalink to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>evaluationStatus</strong> EvaluationStatus</p>
</dd>
</dl>
<p>Evaluation status of FocalMechanism.</p>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.FocalMechanism.evaluationStatus">
<code class="sig-name descname">evaluationStatus</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.FocalMechanism.evaluationStatus" title="Permalink to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Return type</dt>
<dd class="field-odd"><p>EvaluationStatus</p>
</dd>
</dl>
<div class="admonition note">
<p class="admonition-title">Note</p>
<p>As this attribute is optional, this method throws a ValueError if
the value of the attribute is not set.</p>
</div>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.FocalMechanism.setCreationInfo">
<code class="sig-name descname">setCreationInfo</code><span class="sig-paren">(</span><em class="sig-param">creationInfo</em><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.FocalMechanism.setCreationInfo" title="Permalink to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>creationInfo</strong> <a class="reference internal" href="#api-python-datamodel-creationinfo"><span class="std std-ref">CreationInfo</span></a></p>
</dd>
</dl>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.FocalMechanism.creationInfo">
<code class="sig-name descname">creationInfo</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.FocalMechanism.creationInfo" title="Permalink to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Return type</dt>
<dd class="field-odd"><p><a class="reference internal" href="#api-python-datamodel-creationinfo"><span class="std std-ref">CreationInfo</span></a></p>
</dd>
</dl>
<div class="admonition note">
<p class="admonition-title">Note</p>
<p>As this attribute is optional, this method throws a ValueError if
the value of the attribute is not set.</p>
</div>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.FocalMechanism.add">
<code class="sig-name descname">add</code><span class="sig-paren">(</span><em class="sig-param">comment</em><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.FocalMechanism.add" title="Permalink to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>comment</strong> Object of type <a class="reference internal" href="#api-python-datamodel-comment"><span class="std std-ref">Comment</span></a></p>
</dd>
<dt class="field-even">Return type</dt>
<dd class="field-even"><p>A Boolean value indicating success with True, False otherwise.</p>
</dd>
</dl>
<p>Adds a Comment object to FocalMechanism. The object is not
copied but managed by this instance. Any change to the passed object
will also change the child.</p>
</dd></dl>
<dl class="method">
<dt>
<code class="sig-name descname">add</code><span class="sig-paren">(</span><em class="sig-param">momentTensor</em><span class="sig-paren">)</span></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>momentTensor</strong> Object of type <a class="reference internal" href="#api-python-datamodel-momenttensor"><span class="std std-ref">MomentTensor</span></a></p>
</dd>
<dt class="field-even">Return type</dt>
<dd class="field-even"><p>A Boolean value indicating success with True, False otherwise.</p>
</dd>
</dl>
<p>Adds a MomentTensor object to FocalMechanism. The object is not
copied but managed by this instance. Any change to the passed object
will also change the child.</p>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.FocalMechanism.remove">
<code class="sig-name descname">remove</code><span class="sig-paren">(</span><em class="sig-param">comment</em><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.FocalMechanism.remove" title="Permalink to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>comment</strong> Object of type <a class="reference internal" href="#api-python-datamodel-comment"><span class="std std-ref">Comment</span></a></p>
</dd>
<dt class="field-even">Return type</dt>
<dd class="field-even"><p>A Boolean value indicating success with True, False otherwise.</p>
</dd>
</dl>
<p>Removes a previously added Comment object from FocalMechanism.</p>
</dd></dl>
<dl class="method">
<dt>
<code class="sig-name descname">remove</code><span class="sig-paren">(</span><em class="sig-param">momentTensor</em><span class="sig-paren">)</span></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>momentTensor</strong> Object of type <a class="reference internal" href="#api-python-datamodel-momenttensor"><span class="std std-ref">MomentTensor</span></a></p>
</dd>
<dt class="field-even">Return type</dt>
<dd class="field-even"><p>A Boolean value indicating success with True, False otherwise.</p>
</dd>
</dl>
<p>Removes a previously added MomentTensor object from FocalMechanism.</p>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.FocalMechanism.removeComment">
<code class="sig-name descname">removeComment</code><span class="sig-paren">(</span><em class="sig-param">idx</em><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.FocalMechanism.removeComment" title="Permalink to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>idx</strong> An integer index of the object to be removed.</p>
</dd>
<dt class="field-even">Return type</dt>
<dd class="field-even"><p>A Boolean value indicating success with True, False otherwise.</p>
</dd>
</dl>
</dd></dl>
<dl class="method">
<dt>
<code class="sig-name descname">removeComment(commentIndex);</code></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>commentIndex</strong> The index of the object to be removed of type CommentIndex.</p>
</dd>
<dt class="field-even">Return type</dt>
<dd class="field-even"><p>A Boolean value indicating success with True, False otherwise.</p>
</dd>
</dl>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.FocalMechanism.removeMomentTensor">
<code class="sig-name descname">removeMomentTensor</code><span class="sig-paren">(</span><em class="sig-param">idx</em><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.FocalMechanism.removeMomentTensor" title="Permalink to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>idx</strong> An integer index of the object to be removed.</p>
</dd>
<dt class="field-even">Return type</dt>
<dd class="field-even"><p>A Boolean value indicating success with True, False otherwise.</p>
</dd>
</dl>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.FocalMechanism.commentCount">
<code class="sig-name descname">commentCount</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.FocalMechanism.commentCount" title="Permalink to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Return type</dt>
<dd class="field-odd"><p>integer value indicating the number of child objects.</p>
</dd>
</dl>
<p>Returns the number of Comment child objects.</p>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.FocalMechanism.momentTensorCount">
<code class="sig-name descname">momentTensorCount</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.FocalMechanism.momentTensorCount" title="Permalink to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Return type</dt>
<dd class="field-odd"><p>integer value indicating the number of child objects.</p>
</dd>
</dl>
<p>Returns the number of MomentTensor child objects.</p>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.FocalMechanism.comment">
<code class="sig-name descname">comment</code><span class="sig-paren">(</span><em class="sig-param">idx</em><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.FocalMechanism.comment" title="Permalink to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>idx</strong> An integer index of the object to be returned.</p>
</dd>
<dt class="field-even">Return type</dt>
<dd class="field-even"><p>Object of type <a class="reference internal" href="#api-python-datamodel-comment"><span class="std std-ref">Comment</span></a>.</p>
</dd>
</dl>
<p>Returns the Comment at index idx.</p>
</dd></dl>
<dl class="method">
<dt>
<code class="sig-name descname">comment</code><span class="sig-paren">(</span><em class="sig-param">commentIndex</em><span class="sig-paren">)</span></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>commentIndex</strong> The index of the object to be removed of type CommentIndex.</p>
</dd>
<dt class="field-even">Return type</dt>
<dd class="field-even"><p>Object of type <a class="reference internal" href="#api-python-datamodel-comment"><span class="std std-ref">Comment</span></a>.</p>
</dd>
</dl>
<p>Returns the Comment at given index. The indexes of all child objects
are compared by value which makes this function slower than the direct
integer index look-up.</p>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.FocalMechanism.momentTensor">
<code class="sig-name descname">momentTensor</code><span class="sig-paren">(</span><em class="sig-param">idx</em><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.FocalMechanism.momentTensor" title="Permalink to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>idx</strong> An integer index of the object to be returned.</p>
</dd>
<dt class="field-even">Return type</dt>
<dd class="field-even"><p>Object of type <a class="reference internal" href="#api-python-datamodel-momenttensor"><span class="std std-ref">MomentTensor</span></a>.</p>
</dd>
</dl>
<p>Returns the MomentTensor at index idx.</p>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.FocalMechanism.findMomentTensor">
<code class="sig-name descname">findMomentTensor</code><span class="sig-paren">(</span><em class="sig-param">publicID</em><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.FocalMechanism.findMomentTensor" title="Permalink to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>publicID</strong> The publicID of the object to find.</p>
</dd>
<dt class="field-even">Return type</dt>
<dd class="field-even"><p>Object of type <a class="reference internal" href="#api-python-datamodel-momenttensor"><span class="std std-ref">MomentTensor</span></a>.</p>
</dd>
</dl>
<p>Returns the child object with a certain publicID, None otherwise.</p>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.FocalMechanism.eventParameters">
<code class="sig-name descname">eventParameters</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.FocalMechanism.eventParameters" title="Permalink to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Return type</dt>
<dd class="field-odd"><p><a class="reference internal" href="#seiscomp.datamodel.EventParameters" title="seiscomp.datamodel.EventParameters">EventParameters</a></p>
</dd>
</dl>
<p>Returns the parent EventParameters if available. Returns None
if the parent is not a EventParameters. This is a convenience wrapper
for parent().</p>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.FocalMechanism.assign">
<code class="sig-name descname">assign</code><span class="sig-paren">(</span><em class="sig-param">other</em><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.FocalMechanism.assign" title="Permalink to this definition"></a></dt>
<dd><p>This method implements the <a class="reference internal" href="#api-python-datamodel-object"><span class="std std-ref">Object</span></a> interface.</p>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.FocalMechanism.attachTo">
<code class="sig-name descname">attachTo</code><span class="sig-paren">(</span><em class="sig-param">parent</em><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.FocalMechanism.attachTo" title="Permalink to this definition"></a></dt>
<dd><p>This method implements the <a class="reference internal" href="#api-python-datamodel-object"><span class="std std-ref">Object</span></a> interface.</p>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.FocalMechanism.detachFrom">
<code class="sig-name descname">detachFrom</code><span class="sig-paren">(</span><em class="sig-param">parent</em><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.FocalMechanism.detachFrom" title="Permalink to this definition"></a></dt>
<dd><p>This method implements the <a class="reference internal" href="#api-python-datamodel-object"><span class="std std-ref">Object</span></a> interface.</p>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.FocalMechanism.detach">
<code class="sig-name descname">detach</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.FocalMechanism.detach" title="Permalink to this definition"></a></dt>
<dd><p>This method implements the <a class="reference internal" href="#api-python-datamodel-object"><span class="std std-ref">Object</span></a> interface.</p>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.FocalMechanism.clone">
<code class="sig-name descname">clone</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.FocalMechanism.clone" title="Permalink to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Return type</dt>
<dd class="field-odd"><p>A cloned FocalMechanism.</p>
</dd>
</dl>
<p>Returns a new instance that is a clone of the current instance. Child
objects are being ignored.</p>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.FocalMechanism.updateChild">
<code class="sig-name descname">updateChild</code><span class="sig-paren">(</span><em class="sig-param">ref</em><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.FocalMechanism.updateChild" title="Permalink to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>ref</strong> A child object derived from class Object.</p>
</dd>
<dt class="field-even">Return type</dt>
<dd class="field-even"><p>A Boolean flag indicating success with True, False otherwise</p>
</dd>
</dl>
<p>This method takes the passed reference object and searches for a child
with the same publicID (if derived from <a class="reference internal" href="#api-python-datamodel-publicobject"><span class="std std-ref">PublicObject</span></a>)
or the same index (if derived from <a class="reference internal" href="#api-python-datamodel-object"><span class="std std-ref">Object</span></a>).
The the child was found the reference objects attributes are copied to
the child object. Children of child are being ignored during this operation.
This method implements the <a class="reference internal" href="#api-python-datamodel-publicobject"><span class="std std-ref">PublicObject</span></a> interface.</p>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.FocalMechanism.accept">
<code class="sig-name descname">accept</code><span class="sig-paren">(</span><em class="sig-param">visitor</em><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.FocalMechanism.accept" title="Permalink to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>visitor</strong> A visitor.</p>
</dd>
</dl>
<p>This method implements the <a class="reference internal" href="#api-python-datamodel-publicobject"><span class="std std-ref">PublicObject</span></a> interface.</p>
</dd></dl>
</dd></dl>
</div>
<div class="section" id="focalmechanismreference">
<span id="api-python-datamodel-focalmechanismreference"></span><h3>FocalMechanismReference<a class="headerlink" href="#focalmechanismreference" title="Permalink to this headline"></a></h3>
<dl class="class">
<dt id="seiscomp.datamodel.FocalMechanismReference">
<em class="property">class </em><code class="sig-prename descclassname">seiscomp.datamodel.</code><code class="sig-name descname">FocalMechanismReference</code><a class="headerlink" href="#seiscomp.datamodel.FocalMechanismReference" title="Permalink to this definition"></a></dt>
<dd><p>Inherits <a class="reference internal" href="#api-python-datamodel-object"><span class="std std-ref">Object</span></a>.</p>
<p><strong>Parents</strong>:</p>
<ul class="simple">
<li><p><code class="docutils literal notranslate"><span class="pre">event</span></code> <a class="reference internal" href="#api-python-datamodel-event"><span class="std std-ref">Event</span></a></p></li>
</ul>
<p><strong>Attributes</strong>:</p>
<ul class="simple">
<li><p><code class="docutils literal notranslate"><span class="pre">focalMechanismID</span></code> string</p></li>
</ul>
<p><strong>Methods</strong>:</p>
<dl class="method">
<dt id="seiscomp.datamodel.FocalMechanismReference.Cast">
<em class="property">static </em><code class="sig-name descname">Cast</code><span class="sig-paren">(</span><em class="sig-param">obj</em><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.FocalMechanismReference.Cast" title="Permalink to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>obj</strong> The object to be casted.</p>
</dd>
<dt class="field-even">Return type</dt>
<dd class="field-even"><p>An object of type FocalMechanismReference if the cast was successful,
None otherwise.</p>
</dd>
</dl>
<p>Cast an arbitrary object to FocalMechanismReference if the internal wrapped
representation is an FocalMechanismReference object. The cast is important if
instances of type <a class="reference internal" href="#api-python-datamodel-object"><span class="std std-ref">Object</span></a>
are passed to methods which need access to the real type.</p>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.FocalMechanismReference.equal">
<code class="sig-name descname">equal</code><span class="sig-paren">(</span><em class="sig-param">other</em><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.FocalMechanismReference.equal" title="Permalink to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>other</strong> Another object of type FocalMechanismReference to compare this
instance to</p>
</dd>
<dt class="field-even">Return type</dt>
<dd class="field-even"><p>A Boolean value indicating True if both objects are equal or
False otherwise.</p>
</dd>
</dl>
<p>Compares two objects without its child objects. Both objects are compared
by value.</p>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.FocalMechanismReference.index">
<code class="sig-name descname">index</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.FocalMechanismReference.index" title="Permalink to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Return type</dt>
<dd class="field-odd"><p><p>The objects index of type FocalMechanismReferenceIndex.</p>
<p>Returns the objects index which is also used for the database as unique
constraint.</p>
</p>
</dd>
</dl>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.FocalMechanismReference.equalIndex">
<code class="sig-name descname">equalIndex</code><span class="sig-paren">(</span><em class="sig-param">lhs</em><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.FocalMechanismReference.equalIndex" title="Permalink to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>lhs</strong> <a class="reference internal" href="#api-python-datamodel-focalmechanismreference"><span class="std std-ref">FocalMechanismReference</span></a></p>
</dd>
<dt class="field-even">Return type</dt>
<dd class="field-even"><p>A Boolean value indicating True if both indexes are equal or
False otherwise.</p>
</dd>
</dl>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.FocalMechanismReference.setFocalMechanismID">
<code class="sig-name descname">setFocalMechanismID</code><span class="sig-paren">(</span><em class="sig-param">focalMechanismID</em><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.FocalMechanismReference.setFocalMechanismID" title="Permalink to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>focalMechanismID</strong> string</p>
</dd>
</dl>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.FocalMechanismReference.focalMechanismID">
<code class="sig-name descname">focalMechanismID</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.FocalMechanismReference.focalMechanismID" title="Permalink to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Return type</dt>
<dd class="field-odd"><p>string</p>
</dd>
</dl>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.FocalMechanismReference.event">
<code class="sig-name descname">event</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.FocalMechanismReference.event" title="Permalink to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Return type</dt>
<dd class="field-odd"><p><a class="reference internal" href="#seiscomp.datamodel.Event" title="seiscomp.datamodel.Event">Event</a></p>
</dd>
</dl>
<p>Returns the parent Event if available. Returns None
if the parent is not a Event. This is a convenience wrapper
for parent().</p>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.FocalMechanismReference.assign">
<code class="sig-name descname">assign</code><span class="sig-paren">(</span><em class="sig-param">other</em><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.FocalMechanismReference.assign" title="Permalink to this definition"></a></dt>
<dd><p>This method implements the <a class="reference internal" href="#api-python-datamodel-object"><span class="std std-ref">Object</span></a> interface.</p>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.FocalMechanismReference.attachTo">
<code class="sig-name descname">attachTo</code><span class="sig-paren">(</span><em class="sig-param">parent</em><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.FocalMechanismReference.attachTo" title="Permalink to this definition"></a></dt>
<dd><p>This method implements the <a class="reference internal" href="#api-python-datamodel-object"><span class="std std-ref">Object</span></a> interface.</p>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.FocalMechanismReference.detachFrom">
<code class="sig-name descname">detachFrom</code><span class="sig-paren">(</span><em class="sig-param">parent</em><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.FocalMechanismReference.detachFrom" title="Permalink to this definition"></a></dt>
<dd><p>This method implements the <a class="reference internal" href="#api-python-datamodel-object"><span class="std std-ref">Object</span></a> interface.</p>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.FocalMechanismReference.detach">
<code class="sig-name descname">detach</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.FocalMechanismReference.detach" title="Permalink to this definition"></a></dt>
<dd><p>This method implements the <a class="reference internal" href="#api-python-datamodel-object"><span class="std std-ref">Object</span></a> interface.</p>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.FocalMechanismReference.clone">
<code class="sig-name descname">clone</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.FocalMechanismReference.clone" title="Permalink to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Return type</dt>
<dd class="field-odd"><p>A cloned FocalMechanismReference.</p>
</dd>
</dl>
<p>Returns a new instance that is a clone of the current instance. Child
objects are being ignored.</p>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.FocalMechanismReference.accept">
<code class="sig-name descname">accept</code><span class="sig-paren">(</span><em class="sig-param">visitor</em><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.FocalMechanismReference.accept" title="Permalink to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>visitor</strong> A visitor.</p>
</dd>
</dl>
<p>This method implements the <a class="reference internal" href="#api-python-datamodel-publicobject"><span class="std std-ref">PublicObject</span></a> interface.</p>
</dd></dl>
</dd></dl>
</div>
<div class="section" id="integerquantity">
<span id="api-python-datamodel-integerquantity"></span><h3>IntegerQuantity<a class="headerlink" href="#integerquantity" title="Permalink to this headline"></a></h3>
<dl class="class">
<dt id="seiscomp.datamodel.IntegerQuantity">
<em class="property">class </em><code class="sig-prename descclassname">seiscomp.datamodel.</code><code class="sig-name descname">IntegerQuantity</code><a class="headerlink" href="#seiscomp.datamodel.IntegerQuantity" title="Permalink to this definition"></a></dt>
<dd><p>Inherits <a class="reference internal" href="#api-python-datamodel-object"><span class="std std-ref">Object</span></a>.</p>
<p>Physical quantities expressed as integers are represented by their
measured or computed values and optional values for symmetric or upper
and lower uncertainties. The interpretation of these uncertainties is
not defined in the standard. They can contain statistically well-defined
error measures, but the mechanism can also be used to simply describe a
possible value range. If the confidence level of the uncertainty is known,
it can be listed in the optional attribute confidenceLevel.
Note that uncertainty, upperUncertainty, and lowerUncertainty are given as
absolute values of the deviation
from the main value.</p>
<p><strong>Attributes</strong>:</p>
<ul class="simple">
<li><p><code class="docutils literal notranslate"><span class="pre">value</span></code> int</p></li>
<li><p><code class="docutils literal notranslate"><span class="pre">uncertainty</span></code> int (optional)</p></li>
<li><p><code class="docutils literal notranslate"><span class="pre">lowerUncertainty</span></code> int (optional)</p></li>
<li><p><code class="docutils literal notranslate"><span class="pre">upperUncertainty</span></code> int (optional)</p></li>
<li><p><code class="docutils literal notranslate"><span class="pre">confidenceLevel</span></code> float (optional)</p></li>
</ul>
<p><strong>Used by</strong>:</p>
<ul class="simple">
<li><p><a class="reference internal" href="#seiscomp.datamodel.CompositeTime.year" title="seiscomp.datamodel.CompositeTime.year"><code class="xref py py-func docutils literal notranslate"><span class="pre">CompositeTime.year()</span></code></a></p></li>
<li><p><a class="reference internal" href="#seiscomp.datamodel.CompositeTime.month" title="seiscomp.datamodel.CompositeTime.month"><code class="xref py py-func docutils literal notranslate"><span class="pre">CompositeTime.month()</span></code></a></p></li>
<li><p><a class="reference internal" href="#seiscomp.datamodel.CompositeTime.day" title="seiscomp.datamodel.CompositeTime.day"><code class="xref py py-func docutils literal notranslate"><span class="pre">CompositeTime.day()</span></code></a></p></li>
<li><p><a class="reference internal" href="#seiscomp.datamodel.CompositeTime.hour" title="seiscomp.datamodel.CompositeTime.hour"><code class="xref py py-func docutils literal notranslate"><span class="pre">CompositeTime.hour()</span></code></a></p></li>
<li><p><a class="reference internal" href="#seiscomp.datamodel.CompositeTime.minute" title="seiscomp.datamodel.CompositeTime.minute"><code class="xref py py-func docutils literal notranslate"><span class="pre">CompositeTime.minute()</span></code></a></p></li>
</ul>
<p><strong>Methods</strong>:</p>
<dl class="method">
<dt id="seiscomp.datamodel.IntegerQuantity.Cast">
<em class="property">static </em><code class="sig-name descname">Cast</code><span class="sig-paren">(</span><em class="sig-param">obj</em><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.IntegerQuantity.Cast" title="Permalink to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>obj</strong> The object to be casted.</p>
</dd>
<dt class="field-even">Return type</dt>
<dd class="field-even"><p>An object of type IntegerQuantity if the cast was successful,
None otherwise.</p>
</dd>
</dl>
<p>Cast an arbitrary object to IntegerQuantity if the internal wrapped
representation is an IntegerQuantity object. The cast is important if
instances of type <a class="reference internal" href="#api-python-datamodel-object"><span class="std std-ref">Object</span></a>
are passed to methods which need access to the real type.</p>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.IntegerQuantity.equal">
<code class="sig-name descname">equal</code><span class="sig-paren">(</span><em class="sig-param">other</em><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.IntegerQuantity.equal" title="Permalink to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>other</strong> Another object of type IntegerQuantity to compare this
instance to</p>
</dd>
<dt class="field-even">Return type</dt>
<dd class="field-even"><p>A Boolean value indicating True if both objects are equal or
False otherwise.</p>
</dd>
</dl>
<p>Compares two objects without its child objects. Both objects are compared
by value.</p>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.IntegerQuantity.setValue">
<code class="sig-name descname">setValue</code><span class="sig-paren">(</span><em class="sig-param">value</em><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.IntegerQuantity.setValue" title="Permalink to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>value</strong> int</p>
</dd>
</dl>
<p>Value of the quantity. The unit is implicitly defined and depends on the
context.</p>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.IntegerQuantity.value">
<code class="sig-name descname">value</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.IntegerQuantity.value" title="Permalink to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Return type</dt>
<dd class="field-odd"><p>int</p>
</dd>
</dl>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.IntegerQuantity.setUncertainty">
<code class="sig-name descname">setUncertainty</code><span class="sig-paren">(</span><em class="sig-param">uncertainty</em><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.IntegerQuantity.setUncertainty" title="Permalink to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>uncertainty</strong> int</p>
</dd>
</dl>
<p>Uncertainty as the absolute value of symmetric deviation from the main value.</p>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.IntegerQuantity.uncertainty">
<code class="sig-name descname">uncertainty</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.IntegerQuantity.uncertainty" title="Permalink to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Return type</dt>
<dd class="field-odd"><p>int</p>
</dd>
</dl>
<div class="admonition note">
<p class="admonition-title">Note</p>
<p>As this attribute is optional, this method throws a ValueError if
the value of the attribute is not set.</p>
</div>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.IntegerQuantity.setLowerUncertainty">
<code class="sig-name descname">setLowerUncertainty</code><span class="sig-paren">(</span><em class="sig-param">lowerUncertainty</em><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.IntegerQuantity.setLowerUncertainty" title="Permalink to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>lowerUncertainty</strong> int</p>
</dd>
</dl>
<p>Uncertainty as the absolute value of deviation from the main value towards
smaller values.</p>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.IntegerQuantity.lowerUncertainty">
<code class="sig-name descname">lowerUncertainty</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.IntegerQuantity.lowerUncertainty" title="Permalink to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Return type</dt>
<dd class="field-odd"><p>int</p>
</dd>
</dl>
<div class="admonition note">
<p class="admonition-title">Note</p>
<p>As this attribute is optional, this method throws a ValueError if
the value of the attribute is not set.</p>
</div>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.IntegerQuantity.setUpperUncertainty">
<code class="sig-name descname">setUpperUncertainty</code><span class="sig-paren">(</span><em class="sig-param">upperUncertainty</em><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.IntegerQuantity.setUpperUncertainty" title="Permalink to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>upperUncertainty</strong> int</p>
</dd>
</dl>
<p>Uncertainty as the absolute value of deviation from the main value towards
larger values.</p>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.IntegerQuantity.upperUncertainty">
<code class="sig-name descname">upperUncertainty</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.IntegerQuantity.upperUncertainty" title="Permalink to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Return type</dt>
<dd class="field-odd"><p>int</p>
</dd>
</dl>
<div class="admonition note">
<p class="admonition-title">Note</p>
<p>As this attribute is optional, this method throws a ValueError if
the value of the attribute is not set.</p>
</div>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.IntegerQuantity.setConfidenceLevel">
<code class="sig-name descname">setConfidenceLevel</code><span class="sig-paren">(</span><em class="sig-param">confidenceLevel</em><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.IntegerQuantity.setConfidenceLevel" title="Permalink to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>confidenceLevel</strong> float</p>
</dd>
</dl>
<p>Confidence level of the uncertainty, given in percent.</p>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.IntegerQuantity.confidenceLevel">
<code class="sig-name descname">confidenceLevel</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.IntegerQuantity.confidenceLevel" title="Permalink to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Return type</dt>
<dd class="field-odd"><p>float</p>
</dd>
</dl>
<div class="admonition note">
<p class="admonition-title">Note</p>
<p>As this attribute is optional, this method throws a ValueError if
the value of the attribute is not set.</p>
</div>
</dd></dl>
</dd></dl>
</div>
<div class="section" id="api-python-datamodel-inventory">
<span id="id15"></span><h3>Inventory<a class="headerlink" href="#api-python-datamodel-inventory" title="Permalink to this headline"></a></h3>
<dl class="class">
<dt id="seiscomp.datamodel.Inventory">
<em class="property">class </em><code class="sig-prename descclassname">seiscomp.datamodel.</code><code class="sig-name descname">Inventory</code><a class="headerlink" href="#seiscomp.datamodel.Inventory" title="Permalink to this definition"></a></dt>
<dd><p>Inherits <a class="reference internal" href="#api-python-datamodel-publicobject"><span class="std std-ref">PublicObject</span></a>.</p>
<p><strong>Children</strong>:</p>
<ul class="simple">
<li><p><code class="docutils literal notranslate"><span class="pre">stationGroup</span></code> <a class="reference internal" href="#api-python-datamodel-stationgroup"><span class="std std-ref">StationGroup</span></a></p></li>
<li><p><code class="docutils literal notranslate"><span class="pre">auxDevice</span></code> <a class="reference internal" href="#api-python-datamodel-auxdevice"><span class="std std-ref">AuxDevice</span></a></p></li>
<li><p><code class="docutils literal notranslate"><span class="pre">sensor</span></code> <a class="reference internal" href="#api-python-datamodel-sensor"><span class="std std-ref">Sensor</span></a></p></li>
<li><p><code class="docutils literal notranslate"><span class="pre">datalogger</span></code> <a class="reference internal" href="#api-python-datamodel-datalogger"><span class="std std-ref">Datalogger</span></a></p></li>
<li><p><code class="docutils literal notranslate"><span class="pre">responsePAZ</span></code> <a class="reference internal" href="#api-python-datamodel-responsepaz"><span class="std std-ref">ResponsePAZ</span></a></p></li>
<li><p><code class="docutils literal notranslate"><span class="pre">responseFIR</span></code> <a class="reference internal" href="#api-python-datamodel-responsefir"><span class="std std-ref">ResponseFIR</span></a></p></li>
<li><p><code class="docutils literal notranslate"><span class="pre">responseIIR</span></code> <a class="reference internal" href="#api-python-datamodel-responseiir"><span class="std std-ref">ResponseIIR</span></a></p></li>
<li><p><code class="docutils literal notranslate"><span class="pre">responsePolynomial</span></code> <a class="reference internal" href="#api-python-datamodel-responsepolynomial"><span class="std std-ref">ResponsePolynomial</span></a></p></li>
<li><p><code class="docutils literal notranslate"><span class="pre">responseFAP</span></code> <a class="reference internal" href="#api-python-datamodel-responsefap"><span class="std std-ref">ResponseFAP</span></a></p></li>
<li><p><code class="docutils literal notranslate"><span class="pre">network</span></code> <a class="reference internal" href="#api-python-datamodel-network"><span class="std std-ref">Network</span></a></p></li>
</ul>
<p><strong>Attributes</strong>:</p>
<ul class="simple">
<li><p><code class="docutils literal notranslate"><span class="pre">publicID</span></code>: string</p></li>
</ul>
<p><strong>Methods</strong>:</p>
<dl class="method">
<dt id="seiscomp.datamodel.Inventory.Cast">
<em class="property">static </em><code class="sig-name descname">Cast</code><span class="sig-paren">(</span><em class="sig-param">obj</em><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.Inventory.Cast" title="Permalink to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>obj</strong> The object to be casted.</p>
</dd>
<dt class="field-even">Return type</dt>
<dd class="field-even"><p>An object of type Inventory if the cast was successful,
None otherwise.</p>
</dd>
</dl>
<p>Cast an arbitrary object to Inventory if the internal wrapped
representation is an Inventory object. The cast is important if
instances of type <a class="reference internal" href="#api-python-datamodel-object"><span class="std std-ref">Object</span></a>
are passed to methods which need access to the real type.</p>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.Inventory.equal">
<code class="sig-name descname">equal</code><span class="sig-paren">(</span><em class="sig-param">other</em><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.Inventory.equal" title="Permalink to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>other</strong> Another object of type Inventory to compare this
instance to</p>
</dd>
<dt class="field-even">Return type</dt>
<dd class="field-even"><p>A Boolean value indicating True if both objects are equal or
False otherwise.</p>
</dd>
</dl>
<p>Compares two objects without its child objects. Both objects are compared
by value.</p>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.Inventory.add">
<code class="sig-name descname">add</code><span class="sig-paren">(</span><em class="sig-param">stationGroup</em><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.Inventory.add" title="Permalink to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>stationGroup</strong> Object of type <a class="reference internal" href="#api-python-datamodel-stationgroup"><span class="std std-ref">StationGroup</span></a></p>
</dd>
<dt class="field-even">Return type</dt>
<dd class="field-even"><p>A Boolean value indicating success with True, False otherwise.</p>
</dd>
</dl>
<p>Adds a StationGroup object to Inventory. The object is not
copied but managed by this instance. Any change to the passed object
will also change the child.</p>
</dd></dl>
<dl class="method">
<dt>
<code class="sig-name descname">add</code><span class="sig-paren">(</span><em class="sig-param">auxDevice</em><span class="sig-paren">)</span></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>auxDevice</strong> Object of type <a class="reference internal" href="#api-python-datamodel-auxdevice"><span class="std std-ref">AuxDevice</span></a></p>
</dd>
<dt class="field-even">Return type</dt>
<dd class="field-even"><p>A Boolean value indicating success with True, False otherwise.</p>
</dd>
</dl>
<p>Adds a AuxDevice object to Inventory. The object is not
copied but managed by this instance. Any change to the passed object
will also change the child.</p>
</dd></dl>
<dl class="method">
<dt>
<code class="sig-name descname">add</code><span class="sig-paren">(</span><em class="sig-param">sensor</em><span class="sig-paren">)</span></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>sensor</strong> Object of type <a class="reference internal" href="#api-python-datamodel-sensor"><span class="std std-ref">Sensor</span></a></p>
</dd>
<dt class="field-even">Return type</dt>
<dd class="field-even"><p>A Boolean value indicating success with True, False otherwise.</p>
</dd>
</dl>
<p>Adds a Sensor object to Inventory. The object is not
copied but managed by this instance. Any change to the passed object
will also change the child.</p>
</dd></dl>
<dl class="method">
<dt>
<code class="sig-name descname">add</code><span class="sig-paren">(</span><em class="sig-param">datalogger</em><span class="sig-paren">)</span></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>datalogger</strong> Object of type <a class="reference internal" href="#api-python-datamodel-datalogger"><span class="std std-ref">Datalogger</span></a></p>
</dd>
<dt class="field-even">Return type</dt>
<dd class="field-even"><p>A Boolean value indicating success with True, False otherwise.</p>
</dd>
</dl>
<p>Adds a Datalogger object to Inventory. The object is not
copied but managed by this instance. Any change to the passed object
will also change the child.</p>
</dd></dl>
<dl class="method">
<dt>
<code class="sig-name descname">add</code><span class="sig-paren">(</span><em class="sig-param">responsePAZ</em><span class="sig-paren">)</span></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>responsePAZ</strong> Object of type <a class="reference internal" href="#api-python-datamodel-responsepaz"><span class="std std-ref">ResponsePAZ</span></a></p>
</dd>
<dt class="field-even">Return type</dt>
<dd class="field-even"><p>A Boolean value indicating success with True, False otherwise.</p>
</dd>
</dl>
<p>Adds a ResponsePAZ object to Inventory. The object is not
copied but managed by this instance. Any change to the passed object
will also change the child.</p>
</dd></dl>
<dl class="method">
<dt>
<code class="sig-name descname">add</code><span class="sig-paren">(</span><em class="sig-param">responseFIR</em><span class="sig-paren">)</span></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>responseFIR</strong> Object of type <a class="reference internal" href="#api-python-datamodel-responsefir"><span class="std std-ref">ResponseFIR</span></a></p>
</dd>
<dt class="field-even">Return type</dt>
<dd class="field-even"><p>A Boolean value indicating success with True, False otherwise.</p>
</dd>
</dl>
<p>Adds a ResponseFIR object to Inventory. The object is not
copied but managed by this instance. Any change to the passed object
will also change the child.</p>
</dd></dl>
<dl class="method">
<dt>
<code class="sig-name descname">add</code><span class="sig-paren">(</span><em class="sig-param">responseIIR</em><span class="sig-paren">)</span></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>responseIIR</strong> Object of type <a class="reference internal" href="#api-python-datamodel-responseiir"><span class="std std-ref">ResponseIIR</span></a></p>
</dd>
<dt class="field-even">Return type</dt>
<dd class="field-even"><p>A Boolean value indicating success with True, False otherwise.</p>
</dd>
</dl>
<p>Adds a ResponseIIR object to Inventory. The object is not
copied but managed by this instance. Any change to the passed object
will also change the child.</p>
</dd></dl>
<dl class="method">
<dt>
<code class="sig-name descname">add</code><span class="sig-paren">(</span><em class="sig-param">responsePolynomial</em><span class="sig-paren">)</span></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>responsePolynomial</strong> Object of type <a class="reference internal" href="#api-python-datamodel-responsepolynomial"><span class="std std-ref">ResponsePolynomial</span></a></p>
</dd>
<dt class="field-even">Return type</dt>
<dd class="field-even"><p>A Boolean value indicating success with True, False otherwise.</p>
</dd>
</dl>
<p>Adds a ResponsePolynomial object to Inventory. The object is not
copied but managed by this instance. Any change to the passed object
will also change the child.</p>
</dd></dl>
<dl class="method">
<dt>
<code class="sig-name descname">add</code><span class="sig-paren">(</span><em class="sig-param">responseFAP</em><span class="sig-paren">)</span></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>responseFAP</strong> Object of type <a class="reference internal" href="#api-python-datamodel-responsefap"><span class="std std-ref">ResponseFAP</span></a></p>
</dd>
<dt class="field-even">Return type</dt>
<dd class="field-even"><p>A Boolean value indicating success with True, False otherwise.</p>
</dd>
</dl>
<p>Adds a ResponseFAP object to Inventory. The object is not
copied but managed by this instance. Any change to the passed object
will also change the child.</p>
</dd></dl>
<dl class="method">
<dt>
<code class="sig-name descname">add</code><span class="sig-paren">(</span><em class="sig-param">network</em><span class="sig-paren">)</span></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>network</strong> Object of type <a class="reference internal" href="#api-python-datamodel-network"><span class="std std-ref">Network</span></a></p>
</dd>
<dt class="field-even">Return type</dt>
<dd class="field-even"><p>A Boolean value indicating success with True, False otherwise.</p>
</dd>
</dl>
<p>Adds a Network object to Inventory. The object is not
copied but managed by this instance. Any change to the passed object
will also change the child.</p>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.Inventory.remove">
<code class="sig-name descname">remove</code><span class="sig-paren">(</span><em class="sig-param">stationGroup</em><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.Inventory.remove" title="Permalink to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>stationGroup</strong> Object of type <a class="reference internal" href="#api-python-datamodel-stationgroup"><span class="std std-ref">StationGroup</span></a></p>
</dd>
<dt class="field-even">Return type</dt>
<dd class="field-even"><p>A Boolean value indicating success with True, False otherwise.</p>
</dd>
</dl>
<p>Removes a previously added StationGroup object from Inventory.</p>
</dd></dl>
<dl class="method">
<dt>
<code class="sig-name descname">remove</code><span class="sig-paren">(</span><em class="sig-param">auxDevice</em><span class="sig-paren">)</span></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>auxDevice</strong> Object of type <a class="reference internal" href="#api-python-datamodel-auxdevice"><span class="std std-ref">AuxDevice</span></a></p>
</dd>
<dt class="field-even">Return type</dt>
<dd class="field-even"><p>A Boolean value indicating success with True, False otherwise.</p>
</dd>
</dl>
<p>Removes a previously added AuxDevice object from Inventory.</p>
</dd></dl>
<dl class="method">
<dt>
<code class="sig-name descname">remove</code><span class="sig-paren">(</span><em class="sig-param">sensor</em><span class="sig-paren">)</span></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>sensor</strong> Object of type <a class="reference internal" href="#api-python-datamodel-sensor"><span class="std std-ref">Sensor</span></a></p>
</dd>
<dt class="field-even">Return type</dt>
<dd class="field-even"><p>A Boolean value indicating success with True, False otherwise.</p>
</dd>
</dl>
<p>Removes a previously added Sensor object from Inventory.</p>
</dd></dl>
<dl class="method">
<dt>
<code class="sig-name descname">remove</code><span class="sig-paren">(</span><em class="sig-param">datalogger</em><span class="sig-paren">)</span></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>datalogger</strong> Object of type <a class="reference internal" href="#api-python-datamodel-datalogger"><span class="std std-ref">Datalogger</span></a></p>
</dd>
<dt class="field-even">Return type</dt>
<dd class="field-even"><p>A Boolean value indicating success with True, False otherwise.</p>
</dd>
</dl>
<p>Removes a previously added Datalogger object from Inventory.</p>
</dd></dl>
<dl class="method">
<dt>
<code class="sig-name descname">remove</code><span class="sig-paren">(</span><em class="sig-param">responsePAZ</em><span class="sig-paren">)</span></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>responsePAZ</strong> Object of type <a class="reference internal" href="#api-python-datamodel-responsepaz"><span class="std std-ref">ResponsePAZ</span></a></p>
</dd>
<dt class="field-even">Return type</dt>
<dd class="field-even"><p>A Boolean value indicating success with True, False otherwise.</p>
</dd>
</dl>
<p>Removes a previously added ResponsePAZ object from Inventory.</p>
</dd></dl>
<dl class="method">
<dt>
<code class="sig-name descname">remove</code><span class="sig-paren">(</span><em class="sig-param">responseFIR</em><span class="sig-paren">)</span></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>responseFIR</strong> Object of type <a class="reference internal" href="#api-python-datamodel-responsefir"><span class="std std-ref">ResponseFIR</span></a></p>
</dd>
<dt class="field-even">Return type</dt>
<dd class="field-even"><p>A Boolean value indicating success with True, False otherwise.</p>
</dd>
</dl>
<p>Removes a previously added ResponseFIR object from Inventory.</p>
</dd></dl>
<dl class="method">
<dt>
<code class="sig-name descname">remove</code><span class="sig-paren">(</span><em class="sig-param">responseIIR</em><span class="sig-paren">)</span></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>responseIIR</strong> Object of type <a class="reference internal" href="#api-python-datamodel-responseiir"><span class="std std-ref">ResponseIIR</span></a></p>
</dd>
<dt class="field-even">Return type</dt>
<dd class="field-even"><p>A Boolean value indicating success with True, False otherwise.</p>
</dd>
</dl>
<p>Removes a previously added ResponseIIR object from Inventory.</p>
</dd></dl>
<dl class="method">
<dt>
<code class="sig-name descname">remove</code><span class="sig-paren">(</span><em class="sig-param">responsePolynomial</em><span class="sig-paren">)</span></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>responsePolynomial</strong> Object of type <a class="reference internal" href="#api-python-datamodel-responsepolynomial"><span class="std std-ref">ResponsePolynomial</span></a></p>
</dd>
<dt class="field-even">Return type</dt>
<dd class="field-even"><p>A Boolean value indicating success with True, False otherwise.</p>
</dd>
</dl>
<p>Removes a previously added ResponsePolynomial object from Inventory.</p>
</dd></dl>
<dl class="method">
<dt>
<code class="sig-name descname">remove</code><span class="sig-paren">(</span><em class="sig-param">responseFAP</em><span class="sig-paren">)</span></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>responseFAP</strong> Object of type <a class="reference internal" href="#api-python-datamodel-responsefap"><span class="std std-ref">ResponseFAP</span></a></p>
</dd>
<dt class="field-even">Return type</dt>
<dd class="field-even"><p>A Boolean value indicating success with True, False otherwise.</p>
</dd>
</dl>
<p>Removes a previously added ResponseFAP object from Inventory.</p>
</dd></dl>
<dl class="method">
<dt>
<code class="sig-name descname">remove</code><span class="sig-paren">(</span><em class="sig-param">network</em><span class="sig-paren">)</span></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>network</strong> Object of type <a class="reference internal" href="#api-python-datamodel-network"><span class="std std-ref">Network</span></a></p>
</dd>
<dt class="field-even">Return type</dt>
<dd class="field-even"><p>A Boolean value indicating success with True, False otherwise.</p>
</dd>
</dl>
<p>Removes a previously added Network object from Inventory.</p>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.Inventory.removeStationGroup">
<code class="sig-name descname">removeStationGroup</code><span class="sig-paren">(</span><em class="sig-param">idx</em><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.Inventory.removeStationGroup" title="Permalink to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>idx</strong> An integer index of the object to be removed.</p>
</dd>
<dt class="field-even">Return type</dt>
<dd class="field-even"><p>A Boolean value indicating success with True, False otherwise.</p>
</dd>
</dl>
</dd></dl>
<dl class="method">
<dt>
<code class="sig-name descname">removeStationGroup(stationGroupIndex);</code></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>stationGroupIndex</strong> The index of the object to be removed of type StationGroupIndex.</p>
</dd>
<dt class="field-even">Return type</dt>
<dd class="field-even"><p>A Boolean value indicating success with True, False otherwise.</p>
</dd>
</dl>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.Inventory.removeAuxDevice">
<code class="sig-name descname">removeAuxDevice</code><span class="sig-paren">(</span><em class="sig-param">idx</em><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.Inventory.removeAuxDevice" title="Permalink to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>idx</strong> An integer index of the object to be removed.</p>
</dd>
<dt class="field-even">Return type</dt>
<dd class="field-even"><p>A Boolean value indicating success with True, False otherwise.</p>
</dd>
</dl>
</dd></dl>
<dl class="method">
<dt>
<code class="sig-name descname">removeAuxDevice(auxDeviceIndex);</code></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>auxDeviceIndex</strong> The index of the object to be removed of type AuxDeviceIndex.</p>
</dd>
<dt class="field-even">Return type</dt>
<dd class="field-even"><p>A Boolean value indicating success with True, False otherwise.</p>
</dd>
</dl>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.Inventory.removeSensor">
<code class="sig-name descname">removeSensor</code><span class="sig-paren">(</span><em class="sig-param">idx</em><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.Inventory.removeSensor" title="Permalink to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>idx</strong> An integer index of the object to be removed.</p>
</dd>
<dt class="field-even">Return type</dt>
<dd class="field-even"><p>A Boolean value indicating success with True, False otherwise.</p>
</dd>
</dl>
</dd></dl>
<dl class="method">
<dt>
<code class="sig-name descname">removeSensor(sensorIndex);</code></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>sensorIndex</strong> The index of the object to be removed of type SensorIndex.</p>
</dd>
<dt class="field-even">Return type</dt>
<dd class="field-even"><p>A Boolean value indicating success with True, False otherwise.</p>
</dd>
</dl>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.Inventory.removeDatalogger">
<code class="sig-name descname">removeDatalogger</code><span class="sig-paren">(</span><em class="sig-param">idx</em><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.Inventory.removeDatalogger" title="Permalink to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>idx</strong> An integer index of the object to be removed.</p>
</dd>
<dt class="field-even">Return type</dt>
<dd class="field-even"><p>A Boolean value indicating success with True, False otherwise.</p>
</dd>
</dl>
</dd></dl>
<dl class="method">
<dt>
<code class="sig-name descname">removeDatalogger(dataloggerIndex);</code></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>dataloggerIndex</strong> The index of the object to be removed of type DataloggerIndex.</p>
</dd>
<dt class="field-even">Return type</dt>
<dd class="field-even"><p>A Boolean value indicating success with True, False otherwise.</p>
</dd>
</dl>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.Inventory.removeResponsePAZ">
<code class="sig-name descname">removeResponsePAZ</code><span class="sig-paren">(</span><em class="sig-param">idx</em><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.Inventory.removeResponsePAZ" title="Permalink to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>idx</strong> An integer index of the object to be removed.</p>
</dd>
<dt class="field-even">Return type</dt>
<dd class="field-even"><p>A Boolean value indicating success with True, False otherwise.</p>
</dd>
</dl>
</dd></dl>
<dl class="method">
<dt>
<code class="sig-name descname">removeResponsePAZ(responsePAZIndex);</code></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>responsePAZIndex</strong> The index of the object to be removed of type ResponsePAZIndex.</p>
</dd>
<dt class="field-even">Return type</dt>
<dd class="field-even"><p>A Boolean value indicating success with True, False otherwise.</p>
</dd>
</dl>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.Inventory.removeResponseFIR">
<code class="sig-name descname">removeResponseFIR</code><span class="sig-paren">(</span><em class="sig-param">idx</em><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.Inventory.removeResponseFIR" title="Permalink to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>idx</strong> An integer index of the object to be removed.</p>
</dd>
<dt class="field-even">Return type</dt>
<dd class="field-even"><p>A Boolean value indicating success with True, False otherwise.</p>
</dd>
</dl>
</dd></dl>
<dl class="method">
<dt>
<code class="sig-name descname">removeResponseFIR(responseFIRIndex);</code></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>responseFIRIndex</strong> The index of the object to be removed of type ResponseFIRIndex.</p>
</dd>
<dt class="field-even">Return type</dt>
<dd class="field-even"><p>A Boolean value indicating success with True, False otherwise.</p>
</dd>
</dl>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.Inventory.removeResponseIIR">
<code class="sig-name descname">removeResponseIIR</code><span class="sig-paren">(</span><em class="sig-param">idx</em><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.Inventory.removeResponseIIR" title="Permalink to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>idx</strong> An integer index of the object to be removed.</p>
</dd>
<dt class="field-even">Return type</dt>
<dd class="field-even"><p>A Boolean value indicating success with True, False otherwise.</p>
</dd>
</dl>
</dd></dl>
<dl class="method">
<dt>
<code class="sig-name descname">removeResponseIIR(responseIIRIndex);</code></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>responseIIRIndex</strong> The index of the object to be removed of type ResponseIIRIndex.</p>
</dd>
<dt class="field-even">Return type</dt>
<dd class="field-even"><p>A Boolean value indicating success with True, False otherwise.</p>
</dd>
</dl>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.Inventory.removeResponsePolynomial">
<code class="sig-name descname">removeResponsePolynomial</code><span class="sig-paren">(</span><em class="sig-param">idx</em><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.Inventory.removeResponsePolynomial" title="Permalink to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>idx</strong> An integer index of the object to be removed.</p>
</dd>
<dt class="field-even">Return type</dt>
<dd class="field-even"><p>A Boolean value indicating success with True, False otherwise.</p>
</dd>
</dl>
</dd></dl>
<dl class="method">
<dt>
<code class="sig-name descname">removeResponsePolynomial(responsePolynomialIndex);</code></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>responsePolynomialIndex</strong> The index of the object to be removed of type ResponsePolynomialIndex.</p>
</dd>
<dt class="field-even">Return type</dt>
<dd class="field-even"><p>A Boolean value indicating success with True, False otherwise.</p>
</dd>
</dl>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.Inventory.removeResponseFAP">
<code class="sig-name descname">removeResponseFAP</code><span class="sig-paren">(</span><em class="sig-param">idx</em><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.Inventory.removeResponseFAP" title="Permalink to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>idx</strong> An integer index of the object to be removed.</p>
</dd>
<dt class="field-even">Return type</dt>
<dd class="field-even"><p>A Boolean value indicating success with True, False otherwise.</p>
</dd>
</dl>
</dd></dl>
<dl class="method">
<dt>
<code class="sig-name descname">removeResponseFAP(responseFAPIndex);</code></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>responseFAPIndex</strong> The index of the object to be removed of type ResponseFAPIndex.</p>
</dd>
<dt class="field-even">Return type</dt>
<dd class="field-even"><p>A Boolean value indicating success with True, False otherwise.</p>
</dd>
</dl>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.Inventory.removeNetwork">
<code class="sig-name descname">removeNetwork</code><span class="sig-paren">(</span><em class="sig-param">idx</em><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.Inventory.removeNetwork" title="Permalink to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>idx</strong> An integer index of the object to be removed.</p>
</dd>
<dt class="field-even">Return type</dt>
<dd class="field-even"><p>A Boolean value indicating success with True, False otherwise.</p>
</dd>
</dl>
</dd></dl>
<dl class="method">
<dt>
<code class="sig-name descname">removeNetwork(networkIndex);</code></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>networkIndex</strong> The index of the object to be removed of type NetworkIndex.</p>
</dd>
<dt class="field-even">Return type</dt>
<dd class="field-even"><p>A Boolean value indicating success with True, False otherwise.</p>
</dd>
</dl>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.Inventory.stationGroupCount">
<code class="sig-name descname">stationGroupCount</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.Inventory.stationGroupCount" title="Permalink to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Return type</dt>
<dd class="field-odd"><p>integer value indicating the number of child objects.</p>
</dd>
</dl>
<p>Returns the number of StationGroup child objects.</p>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.Inventory.auxDeviceCount">
<code class="sig-name descname">auxDeviceCount</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.Inventory.auxDeviceCount" title="Permalink to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Return type</dt>
<dd class="field-odd"><p>integer value indicating the number of child objects.</p>
</dd>
</dl>
<p>Returns the number of AuxDevice child objects.</p>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.Inventory.sensorCount">
<code class="sig-name descname">sensorCount</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.Inventory.sensorCount" title="Permalink to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Return type</dt>
<dd class="field-odd"><p>integer value indicating the number of child objects.</p>
</dd>
</dl>
<p>Returns the number of Sensor child objects.</p>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.Inventory.dataloggerCount">
<code class="sig-name descname">dataloggerCount</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.Inventory.dataloggerCount" title="Permalink to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Return type</dt>
<dd class="field-odd"><p>integer value indicating the number of child objects.</p>
</dd>
</dl>
<p>Returns the number of Datalogger child objects.</p>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.Inventory.responsePAZCount">
<code class="sig-name descname">responsePAZCount</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.Inventory.responsePAZCount" title="Permalink to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Return type</dt>
<dd class="field-odd"><p>integer value indicating the number of child objects.</p>
</dd>
</dl>
<p>Returns the number of ResponsePAZ child objects.</p>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.Inventory.responseFIRCount">
<code class="sig-name descname">responseFIRCount</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.Inventory.responseFIRCount" title="Permalink to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Return type</dt>
<dd class="field-odd"><p>integer value indicating the number of child objects.</p>
</dd>
</dl>
<p>Returns the number of ResponseFIR child objects.</p>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.Inventory.responseIIRCount">
<code class="sig-name descname">responseIIRCount</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.Inventory.responseIIRCount" title="Permalink to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Return type</dt>
<dd class="field-odd"><p>integer value indicating the number of child objects.</p>
</dd>
</dl>
<p>Returns the number of ResponseIIR child objects.</p>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.Inventory.responsePolynomialCount">
<code class="sig-name descname">responsePolynomialCount</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.Inventory.responsePolynomialCount" title="Permalink to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Return type</dt>
<dd class="field-odd"><p>integer value indicating the number of child objects.</p>
</dd>
</dl>
<p>Returns the number of ResponsePolynomial child objects.</p>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.Inventory.responseFAPCount">
<code class="sig-name descname">responseFAPCount</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.Inventory.responseFAPCount" title="Permalink to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Return type</dt>
<dd class="field-odd"><p>integer value indicating the number of child objects.</p>
</dd>
</dl>
<p>Returns the number of ResponseFAP child objects.</p>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.Inventory.networkCount">
<code class="sig-name descname">networkCount</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.Inventory.networkCount" title="Permalink to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Return type</dt>
<dd class="field-odd"><p>integer value indicating the number of child objects.</p>
</dd>
</dl>
<p>Returns the number of Network child objects.</p>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.Inventory.stationGroup">
<code class="sig-name descname">stationGroup</code><span class="sig-paren">(</span><em class="sig-param">idx</em><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.Inventory.stationGroup" title="Permalink to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>idx</strong> An integer index of the object to be returned.</p>
</dd>
<dt class="field-even">Return type</dt>
<dd class="field-even"><p>Object of type <a class="reference internal" href="#api-python-datamodel-stationgroup"><span class="std std-ref">StationGroup</span></a>.</p>
</dd>
</dl>
<p>Returns the StationGroup at index idx.</p>
</dd></dl>
<dl class="method">
<dt>
<code class="sig-name descname">stationGroup</code><span class="sig-paren">(</span><em class="sig-param">stationGroupIndex</em><span class="sig-paren">)</span></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>stationGroupIndex</strong> The index of the object to be removed of type StationGroupIndex.</p>
</dd>
<dt class="field-even">Return type</dt>
<dd class="field-even"><p>Object of type <a class="reference internal" href="#api-python-datamodel-stationgroup"><span class="std std-ref">StationGroup</span></a>.</p>
</dd>
</dl>
<p>Returns the StationGroup at given index. The indexes of all child objects
are compared by value which makes this function slower than the direct
integer index look-up.</p>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.Inventory.auxDevice">
<code class="sig-name descname">auxDevice</code><span class="sig-paren">(</span><em class="sig-param">idx</em><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.Inventory.auxDevice" title="Permalink to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>idx</strong> An integer index of the object to be returned.</p>
</dd>
<dt class="field-even">Return type</dt>
<dd class="field-even"><p>Object of type <a class="reference internal" href="#api-python-datamodel-auxdevice"><span class="std std-ref">AuxDevice</span></a>.</p>
</dd>
</dl>
<p>Returns the AuxDevice at index idx.</p>
</dd></dl>
<dl class="method">
<dt>
<code class="sig-name descname">auxDevice</code><span class="sig-paren">(</span><em class="sig-param">auxDeviceIndex</em><span class="sig-paren">)</span></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>auxDeviceIndex</strong> The index of the object to be removed of type AuxDeviceIndex.</p>
</dd>
<dt class="field-even">Return type</dt>
<dd class="field-even"><p>Object of type <a class="reference internal" href="#api-python-datamodel-auxdevice"><span class="std std-ref">AuxDevice</span></a>.</p>
</dd>
</dl>
<p>Returns the AuxDevice at given index. The indexes of all child objects
are compared by value which makes this function slower than the direct
integer index look-up.</p>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.Inventory.sensor">
<code class="sig-name descname">sensor</code><span class="sig-paren">(</span><em class="sig-param">idx</em><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.Inventory.sensor" title="Permalink to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>idx</strong> An integer index of the object to be returned.</p>
</dd>
<dt class="field-even">Return type</dt>
<dd class="field-even"><p>Object of type <a class="reference internal" href="#api-python-datamodel-sensor"><span class="std std-ref">Sensor</span></a>.</p>
</dd>
</dl>
<p>Returns the Sensor at index idx.</p>
</dd></dl>
<dl class="method">
<dt>
<code class="sig-name descname">sensor</code><span class="sig-paren">(</span><em class="sig-param">sensorIndex</em><span class="sig-paren">)</span></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>sensorIndex</strong> The index of the object to be removed of type SensorIndex.</p>
</dd>
<dt class="field-even">Return type</dt>
<dd class="field-even"><p>Object of type <a class="reference internal" href="#api-python-datamodel-sensor"><span class="std std-ref">Sensor</span></a>.</p>
</dd>
</dl>
<p>Returns the Sensor at given index. The indexes of all child objects
are compared by value which makes this function slower than the direct
integer index look-up.</p>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.Inventory.datalogger">
<code class="sig-name descname">datalogger</code><span class="sig-paren">(</span><em class="sig-param">idx</em><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.Inventory.datalogger" title="Permalink to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>idx</strong> An integer index of the object to be returned.</p>
</dd>
<dt class="field-even">Return type</dt>
<dd class="field-even"><p>Object of type <a class="reference internal" href="#api-python-datamodel-datalogger"><span class="std std-ref">Datalogger</span></a>.</p>
</dd>
</dl>
<p>Returns the Datalogger at index idx.</p>
</dd></dl>
<dl class="method">
<dt>
<code class="sig-name descname">datalogger</code><span class="sig-paren">(</span><em class="sig-param">dataloggerIndex</em><span class="sig-paren">)</span></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>dataloggerIndex</strong> The index of the object to be removed of type DataloggerIndex.</p>
</dd>
<dt class="field-even">Return type</dt>
<dd class="field-even"><p>Object of type <a class="reference internal" href="#api-python-datamodel-datalogger"><span class="std std-ref">Datalogger</span></a>.</p>
</dd>
</dl>
<p>Returns the Datalogger at given index. The indexes of all child objects
are compared by value which makes this function slower than the direct
integer index look-up.</p>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.Inventory.responsePAZ">
<code class="sig-name descname">responsePAZ</code><span class="sig-paren">(</span><em class="sig-param">idx</em><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.Inventory.responsePAZ" title="Permalink to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>idx</strong> An integer index of the object to be returned.</p>
</dd>
<dt class="field-even">Return type</dt>
<dd class="field-even"><p>Object of type <a class="reference internal" href="#api-python-datamodel-responsepaz"><span class="std std-ref">ResponsePAZ</span></a>.</p>
</dd>
</dl>
<p>Returns the ResponsePAZ at index idx.</p>
</dd></dl>
<dl class="method">
<dt>
<code class="sig-name descname">responsePAZ</code><span class="sig-paren">(</span><em class="sig-param">responsePAZIndex</em><span class="sig-paren">)</span></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>responsePAZIndex</strong> The index of the object to be removed of type ResponsePAZIndex.</p>
</dd>
<dt class="field-even">Return type</dt>
<dd class="field-even"><p>Object of type <a class="reference internal" href="#api-python-datamodel-responsepaz"><span class="std std-ref">ResponsePAZ</span></a>.</p>
</dd>
</dl>
<p>Returns the ResponsePAZ at given index. The indexes of all child objects
are compared by value which makes this function slower than the direct
integer index look-up.</p>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.Inventory.responseFIR">
<code class="sig-name descname">responseFIR</code><span class="sig-paren">(</span><em class="sig-param">idx</em><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.Inventory.responseFIR" title="Permalink to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>idx</strong> An integer index of the object to be returned.</p>
</dd>
<dt class="field-even">Return type</dt>
<dd class="field-even"><p>Object of type <a class="reference internal" href="#api-python-datamodel-responsefir"><span class="std std-ref">ResponseFIR</span></a>.</p>
</dd>
</dl>
<p>Returns the ResponseFIR at index idx.</p>
</dd></dl>
<dl class="method">
<dt>
<code class="sig-name descname">responseFIR</code><span class="sig-paren">(</span><em class="sig-param">responseFIRIndex</em><span class="sig-paren">)</span></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>responseFIRIndex</strong> The index of the object to be removed of type ResponseFIRIndex.</p>
</dd>
<dt class="field-even">Return type</dt>
<dd class="field-even"><p>Object of type <a class="reference internal" href="#api-python-datamodel-responsefir"><span class="std std-ref">ResponseFIR</span></a>.</p>
</dd>
</dl>
<p>Returns the ResponseFIR at given index. The indexes of all child objects
are compared by value which makes this function slower than the direct
integer index look-up.</p>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.Inventory.responseIIR">
<code class="sig-name descname">responseIIR</code><span class="sig-paren">(</span><em class="sig-param">idx</em><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.Inventory.responseIIR" title="Permalink to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>idx</strong> An integer index of the object to be returned.</p>
</dd>
<dt class="field-even">Return type</dt>
<dd class="field-even"><p>Object of type <a class="reference internal" href="#api-python-datamodel-responseiir"><span class="std std-ref">ResponseIIR</span></a>.</p>
</dd>
</dl>
<p>Returns the ResponseIIR at index idx.</p>
</dd></dl>
<dl class="method">
<dt>
<code class="sig-name descname">responseIIR</code><span class="sig-paren">(</span><em class="sig-param">responseIIRIndex</em><span class="sig-paren">)</span></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>responseIIRIndex</strong> The index of the object to be removed of type ResponseIIRIndex.</p>
</dd>
<dt class="field-even">Return type</dt>
<dd class="field-even"><p>Object of type <a class="reference internal" href="#api-python-datamodel-responseiir"><span class="std std-ref">ResponseIIR</span></a>.</p>
</dd>
</dl>
<p>Returns the ResponseIIR at given index. The indexes of all child objects
are compared by value which makes this function slower than the direct
integer index look-up.</p>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.Inventory.responsePolynomial">
<code class="sig-name descname">responsePolynomial</code><span class="sig-paren">(</span><em class="sig-param">idx</em><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.Inventory.responsePolynomial" title="Permalink to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>idx</strong> An integer index of the object to be returned.</p>
</dd>
<dt class="field-even">Return type</dt>
<dd class="field-even"><p>Object of type <a class="reference internal" href="#api-python-datamodel-responsepolynomial"><span class="std std-ref">ResponsePolynomial</span></a>.</p>
</dd>
</dl>
<p>Returns the ResponsePolynomial at index idx.</p>
</dd></dl>
<dl class="method">
<dt>
<code class="sig-name descname">responsePolynomial</code><span class="sig-paren">(</span><em class="sig-param">responsePolynomialIndex</em><span class="sig-paren">)</span></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>responsePolynomialIndex</strong> The index of the object to be removed of type ResponsePolynomialIndex.</p>
</dd>
<dt class="field-even">Return type</dt>
<dd class="field-even"><p>Object of type <a class="reference internal" href="#api-python-datamodel-responsepolynomial"><span class="std std-ref">ResponsePolynomial</span></a>.</p>
</dd>
</dl>
<p>Returns the ResponsePolynomial at given index. The indexes of all child objects
are compared by value which makes this function slower than the direct
integer index look-up.</p>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.Inventory.responseFAP">
<code class="sig-name descname">responseFAP</code><span class="sig-paren">(</span><em class="sig-param">idx</em><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.Inventory.responseFAP" title="Permalink to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>idx</strong> An integer index of the object to be returned.</p>
</dd>
<dt class="field-even">Return type</dt>
<dd class="field-even"><p>Object of type <a class="reference internal" href="#api-python-datamodel-responsefap"><span class="std std-ref">ResponseFAP</span></a>.</p>
</dd>
</dl>
<p>Returns the ResponseFAP at index idx.</p>
</dd></dl>
<dl class="method">
<dt>
<code class="sig-name descname">responseFAP</code><span class="sig-paren">(</span><em class="sig-param">responseFAPIndex</em><span class="sig-paren">)</span></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>responseFAPIndex</strong> The index of the object to be removed of type ResponseFAPIndex.</p>
</dd>
<dt class="field-even">Return type</dt>
<dd class="field-even"><p>Object of type <a class="reference internal" href="#api-python-datamodel-responsefap"><span class="std std-ref">ResponseFAP</span></a>.</p>
</dd>
</dl>
<p>Returns the ResponseFAP at given index. The indexes of all child objects
are compared by value which makes this function slower than the direct
integer index look-up.</p>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.Inventory.network">
<code class="sig-name descname">network</code><span class="sig-paren">(</span><em class="sig-param">idx</em><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.Inventory.network" title="Permalink to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>idx</strong> An integer index of the object to be returned.</p>
</dd>
<dt class="field-even">Return type</dt>
<dd class="field-even"><p>Object of type <a class="reference internal" href="#api-python-datamodel-network"><span class="std std-ref">Network</span></a>.</p>
</dd>
</dl>
<p>Returns the Network at index idx.</p>
</dd></dl>
<dl class="method">
<dt>
<code class="sig-name descname">network</code><span class="sig-paren">(</span><em class="sig-param">networkIndex</em><span class="sig-paren">)</span></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>networkIndex</strong> The index of the object to be removed of type NetworkIndex.</p>
</dd>
<dt class="field-even">Return type</dt>
<dd class="field-even"><p>Object of type <a class="reference internal" href="#api-python-datamodel-network"><span class="std std-ref">Network</span></a>.</p>
</dd>
</dl>
<p>Returns the Network at given index. The indexes of all child objects
are compared by value which makes this function slower than the direct
integer index look-up.</p>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.Inventory.findStationGroup">
<code class="sig-name descname">findStationGroup</code><span class="sig-paren">(</span><em class="sig-param">publicID</em><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.Inventory.findStationGroup" title="Permalink to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>publicID</strong> The publicID of the object to find.</p>
</dd>
<dt class="field-even">Return type</dt>
<dd class="field-even"><p>Object of type <a class="reference internal" href="#api-python-datamodel-stationgroup"><span class="std std-ref">StationGroup</span></a>.</p>
</dd>
</dl>
<p>Returns the child object with a certain publicID, None otherwise.</p>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.Inventory.findAuxDevice">
<code class="sig-name descname">findAuxDevice</code><span class="sig-paren">(</span><em class="sig-param">publicID</em><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.Inventory.findAuxDevice" title="Permalink to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>publicID</strong> The publicID of the object to find.</p>
</dd>
<dt class="field-even">Return type</dt>
<dd class="field-even"><p>Object of type <a class="reference internal" href="#api-python-datamodel-auxdevice"><span class="std std-ref">AuxDevice</span></a>.</p>
</dd>
</dl>
<p>Returns the child object with a certain publicID, None otherwise.</p>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.Inventory.findSensor">
<code class="sig-name descname">findSensor</code><span class="sig-paren">(</span><em class="sig-param">publicID</em><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.Inventory.findSensor" title="Permalink to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>publicID</strong> The publicID of the object to find.</p>
</dd>
<dt class="field-even">Return type</dt>
<dd class="field-even"><p>Object of type <a class="reference internal" href="#api-python-datamodel-sensor"><span class="std std-ref">Sensor</span></a>.</p>
</dd>
</dl>
<p>Returns the child object with a certain publicID, None otherwise.</p>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.Inventory.findDatalogger">
<code class="sig-name descname">findDatalogger</code><span class="sig-paren">(</span><em class="sig-param">publicID</em><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.Inventory.findDatalogger" title="Permalink to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>publicID</strong> The publicID of the object to find.</p>
</dd>
<dt class="field-even">Return type</dt>
<dd class="field-even"><p>Object of type <a class="reference internal" href="#api-python-datamodel-datalogger"><span class="std std-ref">Datalogger</span></a>.</p>
</dd>
</dl>
<p>Returns the child object with a certain publicID, None otherwise.</p>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.Inventory.findResponsePAZ">
<code class="sig-name descname">findResponsePAZ</code><span class="sig-paren">(</span><em class="sig-param">publicID</em><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.Inventory.findResponsePAZ" title="Permalink to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>publicID</strong> The publicID of the object to find.</p>
</dd>
<dt class="field-even">Return type</dt>
<dd class="field-even"><p>Object of type <a class="reference internal" href="#api-python-datamodel-responsepaz"><span class="std std-ref">ResponsePAZ</span></a>.</p>
</dd>
</dl>
<p>Returns the child object with a certain publicID, None otherwise.</p>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.Inventory.findResponseFIR">
<code class="sig-name descname">findResponseFIR</code><span class="sig-paren">(</span><em class="sig-param">publicID</em><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.Inventory.findResponseFIR" title="Permalink to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>publicID</strong> The publicID of the object to find.</p>
</dd>
<dt class="field-even">Return type</dt>
<dd class="field-even"><p>Object of type <a class="reference internal" href="#api-python-datamodel-responsefir"><span class="std std-ref">ResponseFIR</span></a>.</p>
</dd>
</dl>
<p>Returns the child object with a certain publicID, None otherwise.</p>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.Inventory.findResponseIIR">
<code class="sig-name descname">findResponseIIR</code><span class="sig-paren">(</span><em class="sig-param">publicID</em><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.Inventory.findResponseIIR" title="Permalink to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>publicID</strong> The publicID of the object to find.</p>
</dd>
<dt class="field-even">Return type</dt>
<dd class="field-even"><p>Object of type <a class="reference internal" href="#api-python-datamodel-responseiir"><span class="std std-ref">ResponseIIR</span></a>.</p>
</dd>
</dl>
<p>Returns the child object with a certain publicID, None otherwise.</p>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.Inventory.findResponsePolynomial">
<code class="sig-name descname">findResponsePolynomial</code><span class="sig-paren">(</span><em class="sig-param">publicID</em><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.Inventory.findResponsePolynomial" title="Permalink to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>publicID</strong> The publicID of the object to find.</p>
</dd>
<dt class="field-even">Return type</dt>
<dd class="field-even"><p>Object of type <a class="reference internal" href="#api-python-datamodel-responsepolynomial"><span class="std std-ref">ResponsePolynomial</span></a>.</p>
</dd>
</dl>
<p>Returns the child object with a certain publicID, None otherwise.</p>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.Inventory.findResponseFAP">
<code class="sig-name descname">findResponseFAP</code><span class="sig-paren">(</span><em class="sig-param">publicID</em><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.Inventory.findResponseFAP" title="Permalink to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>publicID</strong> The publicID of the object to find.</p>
</dd>
<dt class="field-even">Return type</dt>
<dd class="field-even"><p>Object of type <a class="reference internal" href="#api-python-datamodel-responsefap"><span class="std std-ref">ResponseFAP</span></a>.</p>
</dd>
</dl>
<p>Returns the child object with a certain publicID, None otherwise.</p>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.Inventory.findNetwork">
<code class="sig-name descname">findNetwork</code><span class="sig-paren">(</span><em class="sig-param">publicID</em><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.Inventory.findNetwork" title="Permalink to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>publicID</strong> The publicID of the object to find.</p>
</dd>
<dt class="field-even">Return type</dt>
<dd class="field-even"><p>Object of type <a class="reference internal" href="#api-python-datamodel-network"><span class="std std-ref">Network</span></a>.</p>
</dd>
</dl>
<p>Returns the child object with a certain publicID, None otherwise.</p>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.Inventory.assign">
<code class="sig-name descname">assign</code><span class="sig-paren">(</span><em class="sig-param">other</em><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.Inventory.assign" title="Permalink to this definition"></a></dt>
<dd><p>This method implements the <a class="reference internal" href="#api-python-datamodel-object"><span class="std std-ref">Object</span></a> interface.</p>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.Inventory.attachTo">
<code class="sig-name descname">attachTo</code><span class="sig-paren">(</span><em class="sig-param">parent</em><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.Inventory.attachTo" title="Permalink to this definition"></a></dt>
<dd><p>This method implements the <a class="reference internal" href="#api-python-datamodel-object"><span class="std std-ref">Object</span></a> interface.</p>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.Inventory.detachFrom">
<code class="sig-name descname">detachFrom</code><span class="sig-paren">(</span><em class="sig-param">parent</em><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.Inventory.detachFrom" title="Permalink to this definition"></a></dt>
<dd><p>This method implements the <a class="reference internal" href="#api-python-datamodel-object"><span class="std std-ref">Object</span></a> interface.</p>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.Inventory.detach">
<code class="sig-name descname">detach</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.Inventory.detach" title="Permalink to this definition"></a></dt>
<dd><p>This method implements the <a class="reference internal" href="#api-python-datamodel-object"><span class="std std-ref">Object</span></a> interface.</p>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.Inventory.clone">
<code class="sig-name descname">clone</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.Inventory.clone" title="Permalink to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Return type</dt>
<dd class="field-odd"><p>A cloned Inventory.</p>
</dd>
</dl>
<p>Returns a new instance that is a clone of the current instance. Child
objects are being ignored.</p>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.Inventory.updateChild">
<code class="sig-name descname">updateChild</code><span class="sig-paren">(</span><em class="sig-param">ref</em><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.Inventory.updateChild" title="Permalink to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>ref</strong> A child object derived from class Object.</p>
</dd>
<dt class="field-even">Return type</dt>
<dd class="field-even"><p>A Boolean flag indicating success with True, False otherwise</p>
</dd>
</dl>
<p>This method takes the passed reference object and searches for a child
with the same publicID (if derived from <a class="reference internal" href="#api-python-datamodel-publicobject"><span class="std std-ref">PublicObject</span></a>)
or the same index (if derived from <a class="reference internal" href="#api-python-datamodel-object"><span class="std std-ref">Object</span></a>).
The the child was found the reference objects attributes are copied to
the child object. Children of child are being ignored during this operation.
This method implements the <a class="reference internal" href="#api-python-datamodel-publicobject"><span class="std std-ref">PublicObject</span></a> interface.</p>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.Inventory.accept">
<code class="sig-name descname">accept</code><span class="sig-paren">(</span><em class="sig-param">visitor</em><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.Inventory.accept" title="Permalink to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>visitor</strong> A visitor.</p>
</dd>
</dl>
<p>This method implements the <a class="reference internal" href="#api-python-datamodel-publicobject"><span class="std std-ref">PublicObject</span></a> interface.</p>
</dd></dl>
</dd></dl>
</div>
<div class="section" id="journalentry">
<span id="api-python-datamodel-journalentry"></span><h3>JournalEntry<a class="headerlink" href="#journalentry" title="Permalink to this headline"></a></h3>
<dl class="class">
<dt id="seiscomp.datamodel.JournalEntry">
<em class="property">class </em><code class="sig-prename descclassname">seiscomp.datamodel.</code><code class="sig-name descname">JournalEntry</code><a class="headerlink" href="#seiscomp.datamodel.JournalEntry" title="Permalink to this definition"></a></dt>
<dd><p>Inherits <a class="reference internal" href="#api-python-datamodel-object"><span class="std std-ref">Object</span></a>.</p>
<p><strong>Parents</strong>:</p>
<ul class="simple">
<li><p><code class="docutils literal notranslate"><span class="pre">journaling</span></code> <a class="reference internal" href="#api-python-datamodel-journaling"><span class="std std-ref">Journaling</span></a></p></li>
</ul>
<p><strong>Attributes</strong>:</p>
<ul class="simple">
<li><p><code class="docutils literal notranslate"><span class="pre">created</span></code> seiscomp.core.Time (optional)</p></li>
<li><p><code class="docutils literal notranslate"><span class="pre">objectID</span></code> string</p></li>
<li><p><code class="docutils literal notranslate"><span class="pre">sender</span></code> string</p></li>
<li><p><code class="docutils literal notranslate"><span class="pre">action</span></code> string</p></li>
<li><p><code class="docutils literal notranslate"><span class="pre">parameters</span></code> string</p></li>
</ul>
<p><strong>Methods</strong>:</p>
<dl class="method">
<dt id="seiscomp.datamodel.JournalEntry.Cast">
<em class="property">static </em><code class="sig-name descname">Cast</code><span class="sig-paren">(</span><em class="sig-param">obj</em><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.JournalEntry.Cast" title="Permalink to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>obj</strong> The object to be casted.</p>
</dd>
<dt class="field-even">Return type</dt>
<dd class="field-even"><p>An object of type JournalEntry if the cast was successful,
None otherwise.</p>
</dd>
</dl>
<p>Cast an arbitrary object to JournalEntry if the internal wrapped
representation is an JournalEntry object. The cast is important if
instances of type <a class="reference internal" href="#api-python-datamodel-object"><span class="std std-ref">Object</span></a>
are passed to methods which need access to the real type.</p>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.JournalEntry.equal">
<code class="sig-name descname">equal</code><span class="sig-paren">(</span><em class="sig-param">other</em><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.JournalEntry.equal" title="Permalink to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>other</strong> Another object of type JournalEntry to compare this
instance to</p>
</dd>
<dt class="field-even">Return type</dt>
<dd class="field-even"><p>A Boolean value indicating True if both objects are equal or
False otherwise.</p>
</dd>
</dl>
<p>Compares two objects without its child objects. Both objects are compared
by value.</p>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.JournalEntry.setCreated">
<code class="sig-name descname">setCreated</code><span class="sig-paren">(</span><em class="sig-param">created</em><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.JournalEntry.setCreated" title="Permalink to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>created</strong> seiscomp.core.Time</p>
</dd>
</dl>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.JournalEntry.created">
<code class="sig-name descname">created</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.JournalEntry.created" title="Permalink to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Return type</dt>
<dd class="field-odd"><p>seiscomp.core.Time</p>
</dd>
</dl>
<div class="admonition note">
<p class="admonition-title">Note</p>
<p>As this attribute is optional, this method throws a ValueError if
the value of the attribute is not set.</p>
</div>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.JournalEntry.setObjectID">
<code class="sig-name descname">setObjectID</code><span class="sig-paren">(</span><em class="sig-param">objectID</em><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.JournalEntry.setObjectID" title="Permalink to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>objectID</strong> string</p>
</dd>
</dl>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.JournalEntry.objectID">
<code class="sig-name descname">objectID</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.JournalEntry.objectID" title="Permalink to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Return type</dt>
<dd class="field-odd"><p>string</p>
</dd>
</dl>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.JournalEntry.setSender">
<code class="sig-name descname">setSender</code><span class="sig-paren">(</span><em class="sig-param">sender</em><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.JournalEntry.setSender" title="Permalink to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>sender</strong> string</p>
</dd>
</dl>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.JournalEntry.sender">
<code class="sig-name descname">sender</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.JournalEntry.sender" title="Permalink to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Return type</dt>
<dd class="field-odd"><p>string</p>
</dd>
</dl>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.JournalEntry.setAction">
<code class="sig-name descname">setAction</code><span class="sig-paren">(</span><em class="sig-param">action</em><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.JournalEntry.setAction" title="Permalink to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>action</strong> string</p>
</dd>
</dl>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.JournalEntry.action">
<code class="sig-name descname">action</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.JournalEntry.action" title="Permalink to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Return type</dt>
<dd class="field-odd"><p>string</p>
</dd>
</dl>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.JournalEntry.setParameters">
<code class="sig-name descname">setParameters</code><span class="sig-paren">(</span><em class="sig-param">parameters</em><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.JournalEntry.setParameters" title="Permalink to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>parameters</strong> string</p>
</dd>
</dl>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.JournalEntry.parameters">
<code class="sig-name descname">parameters</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.JournalEntry.parameters" title="Permalink to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Return type</dt>
<dd class="field-odd"><p>string</p>
</dd>
</dl>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.JournalEntry.journaling">
<code class="sig-name descname">journaling</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.JournalEntry.journaling" title="Permalink to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Return type</dt>
<dd class="field-odd"><p><a class="reference internal" href="#seiscomp.datamodel.Journaling" title="seiscomp.datamodel.Journaling">Journaling</a></p>
</dd>
</dl>
<p>Returns the parent Journaling if available. Returns None
if the parent is not a Journaling. This is a convenience wrapper
for parent().</p>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.JournalEntry.assign">
<code class="sig-name descname">assign</code><span class="sig-paren">(</span><em class="sig-param">other</em><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.JournalEntry.assign" title="Permalink to this definition"></a></dt>
<dd><p>This method implements the <a class="reference internal" href="#api-python-datamodel-object"><span class="std std-ref">Object</span></a> interface.</p>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.JournalEntry.attachTo">
<code class="sig-name descname">attachTo</code><span class="sig-paren">(</span><em class="sig-param">parent</em><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.JournalEntry.attachTo" title="Permalink to this definition"></a></dt>
<dd><p>This method implements the <a class="reference internal" href="#api-python-datamodel-object"><span class="std std-ref">Object</span></a> interface.</p>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.JournalEntry.detachFrom">
<code class="sig-name descname">detachFrom</code><span class="sig-paren">(</span><em class="sig-param">parent</em><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.JournalEntry.detachFrom" title="Permalink to this definition"></a></dt>
<dd><p>This method implements the <a class="reference internal" href="#api-python-datamodel-object"><span class="std std-ref">Object</span></a> interface.</p>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.JournalEntry.detach">
<code class="sig-name descname">detach</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.JournalEntry.detach" title="Permalink to this definition"></a></dt>
<dd><p>This method implements the <a class="reference internal" href="#api-python-datamodel-object"><span class="std std-ref">Object</span></a> interface.</p>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.JournalEntry.clone">
<code class="sig-name descname">clone</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.JournalEntry.clone" title="Permalink to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Return type</dt>
<dd class="field-odd"><p>A cloned JournalEntry.</p>
</dd>
</dl>
<p>Returns a new instance that is a clone of the current instance. Child
objects are being ignored.</p>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.JournalEntry.accept">
<code class="sig-name descname">accept</code><span class="sig-paren">(</span><em class="sig-param">visitor</em><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.JournalEntry.accept" title="Permalink to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>visitor</strong> A visitor.</p>
</dd>
</dl>
<p>This method implements the <a class="reference internal" href="#api-python-datamodel-publicobject"><span class="std std-ref">PublicObject</span></a> interface.</p>
</dd></dl>
</dd></dl>
</div>
<div class="section" id="api-python-datamodel-journaling">
<span id="id16"></span><h3>Journaling<a class="headerlink" href="#api-python-datamodel-journaling" title="Permalink to this headline"></a></h3>
<dl class="class">
<dt id="seiscomp.datamodel.Journaling">
<em class="property">class </em><code class="sig-prename descclassname">seiscomp.datamodel.</code><code class="sig-name descname">Journaling</code><a class="headerlink" href="#seiscomp.datamodel.Journaling" title="Permalink to this definition"></a></dt>
<dd><p>Inherits <a class="reference internal" href="#api-python-datamodel-publicobject"><span class="std std-ref">PublicObject</span></a>.</p>
<p><strong>Children</strong>:</p>
<ul class="simple">
<li><p><code class="docutils literal notranslate"><span class="pre">journalEntry</span></code> <a class="reference internal" href="#api-python-datamodel-journalentry"><span class="std std-ref">JournalEntry</span></a></p></li>
</ul>
<p><strong>Attributes</strong>:</p>
<ul class="simple">
<li><p><code class="docutils literal notranslate"><span class="pre">publicID</span></code>: string</p></li>
</ul>
<p><strong>Methods</strong>:</p>
<dl class="method">
<dt id="seiscomp.datamodel.Journaling.Cast">
<em class="property">static </em><code class="sig-name descname">Cast</code><span class="sig-paren">(</span><em class="sig-param">obj</em><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.Journaling.Cast" title="Permalink to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>obj</strong> The object to be casted.</p>
</dd>
<dt class="field-even">Return type</dt>
<dd class="field-even"><p>An object of type Journaling if the cast was successful,
None otherwise.</p>
</dd>
</dl>
<p>Cast an arbitrary object to Journaling if the internal wrapped
representation is an Journaling object. The cast is important if
instances of type <a class="reference internal" href="#api-python-datamodel-object"><span class="std std-ref">Object</span></a>
are passed to methods which need access to the real type.</p>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.Journaling.equal">
<code class="sig-name descname">equal</code><span class="sig-paren">(</span><em class="sig-param">other</em><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.Journaling.equal" title="Permalink to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>other</strong> Another object of type Journaling to compare this
instance to</p>
</dd>
<dt class="field-even">Return type</dt>
<dd class="field-even"><p>A Boolean value indicating True if both objects are equal or
False otherwise.</p>
</dd>
</dl>
<p>Compares two objects without its child objects. Both objects are compared
by value.</p>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.Journaling.add">
<code class="sig-name descname">add</code><span class="sig-paren">(</span><em class="sig-param">journalEntry</em><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.Journaling.add" title="Permalink to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>journalEntry</strong> Object of type <a class="reference internal" href="#api-python-datamodel-journalentry"><span class="std std-ref">JournalEntry</span></a></p>
</dd>
<dt class="field-even">Return type</dt>
<dd class="field-even"><p>A Boolean value indicating success with True, False otherwise.</p>
</dd>
</dl>
<p>Adds a JournalEntry object to Journaling. The object is not
copied but managed by this instance. Any change to the passed object
will also change the child.</p>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.Journaling.remove">
<code class="sig-name descname">remove</code><span class="sig-paren">(</span><em class="sig-param">journalEntry</em><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.Journaling.remove" title="Permalink to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>journalEntry</strong> Object of type <a class="reference internal" href="#api-python-datamodel-journalentry"><span class="std std-ref">JournalEntry</span></a></p>
</dd>
<dt class="field-even">Return type</dt>
<dd class="field-even"><p>A Boolean value indicating success with True, False otherwise.</p>
</dd>
</dl>
<p>Removes a previously added JournalEntry object from Journaling.</p>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.Journaling.removeJournalEntry">
<code class="sig-name descname">removeJournalEntry</code><span class="sig-paren">(</span><em class="sig-param">idx</em><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.Journaling.removeJournalEntry" title="Permalink to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>idx</strong> An integer index of the object to be removed.</p>
</dd>
<dt class="field-even">Return type</dt>
<dd class="field-even"><p>A Boolean value indicating success with True, False otherwise.</p>
</dd>
</dl>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.Journaling.journalEntryCount">
<code class="sig-name descname">journalEntryCount</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.Journaling.journalEntryCount" title="Permalink to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Return type</dt>
<dd class="field-odd"><p>integer value indicating the number of child objects.</p>
</dd>
</dl>
<p>Returns the number of JournalEntry child objects.</p>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.Journaling.journalEntry">
<code class="sig-name descname">journalEntry</code><span class="sig-paren">(</span><em class="sig-param">idx</em><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.Journaling.journalEntry" title="Permalink to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>idx</strong> An integer index of the object to be returned.</p>
</dd>
<dt class="field-even">Return type</dt>
<dd class="field-even"><p>Object of type <a class="reference internal" href="#api-python-datamodel-journalentry"><span class="std std-ref">JournalEntry</span></a>.</p>
</dd>
</dl>
<p>Returns the JournalEntry at index idx.</p>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.Journaling.findJournalEntry">
<code class="sig-name descname">findJournalEntry</code><span class="sig-paren">(</span><em class="sig-param">journalEntry</em><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.Journaling.findJournalEntry" title="Permalink to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>journalEntry</strong> Reference object of type <a class="reference internal" href="#api-python-datamodel-journalentry"><span class="std std-ref">JournalEntry</span></a>.</p>
</dd>
<dt class="field-even">Return type</dt>
<dd class="field-even"><p>Object of type <a class="reference internal" href="#api-python-datamodel-journalentry"><span class="std std-ref">JournalEntry</span></a>.</p>
</dd>
</dl>
<p>Returns the child object with equals the passed object, None otherwise.</p>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.Journaling.assign">
<code class="sig-name descname">assign</code><span class="sig-paren">(</span><em class="sig-param">other</em><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.Journaling.assign" title="Permalink to this definition"></a></dt>
<dd><p>This method implements the <a class="reference internal" href="#api-python-datamodel-object"><span class="std std-ref">Object</span></a> interface.</p>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.Journaling.attachTo">
<code class="sig-name descname">attachTo</code><span class="sig-paren">(</span><em class="sig-param">parent</em><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.Journaling.attachTo" title="Permalink to this definition"></a></dt>
<dd><p>This method implements the <a class="reference internal" href="#api-python-datamodel-object"><span class="std std-ref">Object</span></a> interface.</p>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.Journaling.detachFrom">
<code class="sig-name descname">detachFrom</code><span class="sig-paren">(</span><em class="sig-param">parent</em><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.Journaling.detachFrom" title="Permalink to this definition"></a></dt>
<dd><p>This method implements the <a class="reference internal" href="#api-python-datamodel-object"><span class="std std-ref">Object</span></a> interface.</p>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.Journaling.detach">
<code class="sig-name descname">detach</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.Journaling.detach" title="Permalink to this definition"></a></dt>
<dd><p>This method implements the <a class="reference internal" href="#api-python-datamodel-object"><span class="std std-ref">Object</span></a> interface.</p>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.Journaling.clone">
<code class="sig-name descname">clone</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.Journaling.clone" title="Permalink to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Return type</dt>
<dd class="field-odd"><p>A cloned Journaling.</p>
</dd>
</dl>
<p>Returns a new instance that is a clone of the current instance. Child
objects are being ignored.</p>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.Journaling.updateChild">
<code class="sig-name descname">updateChild</code><span class="sig-paren">(</span><em class="sig-param">ref</em><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.Journaling.updateChild" title="Permalink to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>ref</strong> A child object derived from class Object.</p>
</dd>
<dt class="field-even">Return type</dt>
<dd class="field-even"><p>A Boolean flag indicating success with True, False otherwise</p>
</dd>
</dl>
<p>This method takes the passed reference object and searches for a child
with the same publicID (if derived from <a class="reference internal" href="#api-python-datamodel-publicobject"><span class="std std-ref">PublicObject</span></a>)
or the same index (if derived from <a class="reference internal" href="#api-python-datamodel-object"><span class="std std-ref">Object</span></a>).
The the child was found the reference objects attributes are copied to
the child object. Children of child are being ignored during this operation.
This method implements the <a class="reference internal" href="#api-python-datamodel-publicobject"><span class="std std-ref">PublicObject</span></a> interface.</p>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.Journaling.accept">
<code class="sig-name descname">accept</code><span class="sig-paren">(</span><em class="sig-param">visitor</em><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.Journaling.accept" title="Permalink to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>visitor</strong> A visitor.</p>
</dd>
</dl>
<p>This method implements the <a class="reference internal" href="#api-python-datamodel-publicobject"><span class="std std-ref">PublicObject</span></a> interface.</p>
</dd></dl>
</dd></dl>
</div>
<div class="section" id="magnitude">
<span id="api-python-datamodel-magnitude"></span><h3>Magnitude<a class="headerlink" href="#magnitude" title="Permalink to this headline"></a></h3>
<dl class="class">
<dt id="seiscomp.datamodel.Magnitude">
<em class="property">class </em><code class="sig-prename descclassname">seiscomp.datamodel.</code><code class="sig-name descname">Magnitude</code><a class="headerlink" href="#seiscomp.datamodel.Magnitude" title="Permalink to this definition"></a></dt>
<dd><p>Inherits <a class="reference internal" href="#api-python-datamodel-publicobject"><span class="std std-ref">PublicObject</span></a>.</p>
<p>Describes a magnitude which can, but does not need to be associated with
an origin. Association with an origin is expressed with the optional
attribute originID. It is either a combination of different magnitude
estimations, or it represents the reported magnitude for the given event.</p>
<p><strong>Parents</strong>:</p>
<ul class="simple">
<li><p><code class="docutils literal notranslate"><span class="pre">origin</span></code> <a class="reference internal" href="#api-python-datamodel-origin"><span class="std std-ref">Origin</span></a></p></li>
</ul>
<p><strong>Children</strong>:</p>
<ul class="simple">
<li><p><code class="docutils literal notranslate"><span class="pre">comment</span></code> <a class="reference internal" href="#api-python-datamodel-comment"><span class="std std-ref">Comment</span></a></p></li>
<li><p><code class="docutils literal notranslate"><span class="pre">stationMagnitudeContribution</span></code> <a class="reference internal" href="#api-python-datamodel-stationmagnitudecontribution"><span class="std std-ref">StationMagnitudeContribution</span></a></p></li>
</ul>
<p><strong>Attributes</strong>:</p>
<ul class="simple">
<li><p><code class="docutils literal notranslate"><span class="pre">publicID</span></code>: string</p></li>
<li><p><code class="docutils literal notranslate"><span class="pre">magnitude</span></code> <a class="reference internal" href="#api-python-datamodel-realquantity"><span class="std std-ref">RealQuantity</span></a></p></li>
<li><p><code class="docutils literal notranslate"><span class="pre">type</span></code> string</p></li>
<li><p><code class="docutils literal notranslate"><span class="pre">originID</span></code> string</p></li>
<li><p><code class="docutils literal notranslate"><span class="pre">methodID</span></code> string</p></li>
<li><p><code class="docutils literal notranslate"><span class="pre">stationCount</span></code> int (optional)</p></li>
<li><p><code class="docutils literal notranslate"><span class="pre">azimuthalGap</span></code> float (optional)</p></li>
<li><p><code class="docutils literal notranslate"><span class="pre">evaluationStatus</span></code> <a class="reference internal" href="#api-python-datamodel-evaluationstatus"><span class="std std-ref">EvaluationStatus</span></a> (optional)</p></li>
<li><p><code class="docutils literal notranslate"><span class="pre">creationInfo</span></code> <a class="reference internal" href="#api-python-datamodel-creationinfo"><span class="std std-ref">CreationInfo</span></a> (optional)</p></li>
</ul>
<p><strong>Referenced by</strong>:</p>
<ul class="simple">
<li><p><a class="reference internal" href="#seiscomp.datamodel.Event.preferredMagnitudeID" title="seiscomp.datamodel.Event.preferredMagnitudeID"><code class="xref py py-func docutils literal notranslate"><span class="pre">Event.preferredMagnitudeID()</span></code></a></p></li>
<li><p><a class="reference internal" href="#seiscomp.datamodel.MomentTensor.momentMagnitudeID" title="seiscomp.datamodel.MomentTensor.momentMagnitudeID"><code class="xref py py-func docutils literal notranslate"><span class="pre">MomentTensor.momentMagnitudeID()</span></code></a></p></li>
<li><p><a class="reference internal" href="#seiscomp.datamodel.StationMagnitudeContribution.stationMagnitudeID" title="seiscomp.datamodel.StationMagnitudeContribution.stationMagnitudeID"><code class="xref py py-func docutils literal notranslate"><span class="pre">StationMagnitudeContribution.stationMagnitudeID()</span></code></a></p></li>
</ul>
<p><strong>Methods</strong>:</p>
<dl class="method">
<dt id="seiscomp.datamodel.Magnitude.Cast">
<em class="property">static </em><code class="sig-name descname">Cast</code><span class="sig-paren">(</span><em class="sig-param">obj</em><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.Magnitude.Cast" title="Permalink to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>obj</strong> The object to be casted.</p>
</dd>
<dt class="field-even">Return type</dt>
<dd class="field-even"><p>An object of type Magnitude if the cast was successful,
None otherwise.</p>
</dd>
</dl>
<p>Cast an arbitrary object to Magnitude if the internal wrapped
representation is an Magnitude object. The cast is important if
instances of type <a class="reference internal" href="#api-python-datamodel-object"><span class="std std-ref">Object</span></a>
are passed to methods which need access to the real type.</p>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.Magnitude.Create">
<em class="property">static </em><code class="sig-name descname">Create</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.Magnitude.Create" title="Permalink to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Return type</dt>
<dd class="field-odd"><p>A new object of type Magnitude.</p>
</dd>
</dl>
<p>Creates and registers (if enabled) a Magnitude instance. The
publicID is auto-generated.</p>
</dd></dl>
<dl class="method">
<dt>
<em class="property">static </em><code class="sig-name descname">Create</code><span class="sig-paren">(</span><em class="sig-param">publicID</em><span class="sig-paren">)</span></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Return type</dt>
<dd class="field-odd"><p>A new object of type Magnitude.</p>
</dd>
</dl>
<p>Creates and registers (if enabled) a Magnitude instance with
passed publicID.</p>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.Magnitude.equal">
<code class="sig-name descname">equal</code><span class="sig-paren">(</span><em class="sig-param">other</em><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.Magnitude.equal" title="Permalink to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>other</strong> Another object of type Magnitude to compare this
instance to</p>
</dd>
<dt class="field-even">Return type</dt>
<dd class="field-even"><p>A Boolean value indicating True if both objects are equal or
False otherwise.</p>
</dd>
</dl>
<p>Compares two objects without its child objects. Both objects are compared
by value.</p>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.Magnitude.setMagnitude">
<code class="sig-name descname">setMagnitude</code><span class="sig-paren">(</span><em class="sig-param">magnitude</em><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.Magnitude.setMagnitude" title="Permalink to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>magnitude</strong> <a class="reference internal" href="#api-python-datamodel-realquantity"><span class="std std-ref">RealQuantity</span></a></p>
</dd>
</dl>
<p>Resulting magnitude value from combining values of type StationMagnitude.
If no estimations are available, this value can represent the reported
magnitude.</p>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.Magnitude.magnitude">
<code class="sig-name descname">magnitude</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.Magnitude.magnitude" title="Permalink to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Return type</dt>
<dd class="field-odd"><p><a class="reference internal" href="#api-python-datamodel-realquantity"><span class="std std-ref">RealQuantity</span></a></p>
</dd>
</dl>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.Magnitude.setType">
<code class="sig-name descname">setType</code><span class="sig-paren">(</span><em class="sig-param">type</em><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.Magnitude.setType" title="Permalink to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>type</strong> string</p>
</dd>
</dl>
<p>Describes the type of magnitude. This is a free-text field because
it is impossible to cover all existing magnitude type designations
with an enumeration. Possible values are unspecified magnitude (M),
local magnitude (ML), body wave magnitude (Mb),
surface wave magnitude (MS), moment magnitude (Mw),
duration magnitude (Md), coda magnitude (Mc), MH, Mwp, M50, M100, etc.</p>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.Magnitude.type">
<code class="sig-name descname">type</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.Magnitude.type" title="Permalink to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Return type</dt>
<dd class="field-odd"><p>string</p>
</dd>
</dl>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.Magnitude.setOriginID">
<code class="sig-name descname">setOriginID</code><span class="sig-paren">(</span><em class="sig-param">originID</em><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.Magnitude.setOriginID" title="Permalink to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>originID</strong> string</p>
</dd>
</dl>
<p>Reference to an origins publicID if the magnitude has an associated Origin.</p>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.Magnitude.originID">
<code class="sig-name descname">originID</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.Magnitude.originID" title="Permalink to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Return type</dt>
<dd class="field-odd"><p>string</p>
</dd>
</dl>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.Magnitude.setMethodID">
<code class="sig-name descname">setMethodID</code><span class="sig-paren">(</span><em class="sig-param">methodID</em><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.Magnitude.setMethodID" title="Permalink to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>methodID</strong> string</p>
</dd>
</dl>
<p>Identifies the method of magnitude estimation. Users should avoid to
give contradictory information in methodID and type.</p>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.Magnitude.methodID">
<code class="sig-name descname">methodID</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.Magnitude.methodID" title="Permalink to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Return type</dt>
<dd class="field-odd"><p>string</p>
</dd>
</dl>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.Magnitude.setStationCount">
<code class="sig-name descname">setStationCount</code><span class="sig-paren">(</span><em class="sig-param">stationCount</em><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.Magnitude.setStationCount" title="Permalink to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>stationCount</strong> int</p>
</dd>
</dl>
<p>Number of used stations for this magnitude computation.</p>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.Magnitude.stationCount">
<code class="sig-name descname">stationCount</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.Magnitude.stationCount" title="Permalink to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Return type</dt>
<dd class="field-odd"><p>int</p>
</dd>
</dl>
<div class="admonition note">
<p class="admonition-title">Note</p>
<p>As this attribute is optional, this method throws a ValueError if
the value of the attribute is not set.</p>
</div>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.Magnitude.setAzimuthalGap">
<code class="sig-name descname">setAzimuthalGap</code><span class="sig-paren">(</span><em class="sig-param">azimuthalGap</em><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.Magnitude.setAzimuthalGap" title="Permalink to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>azimuthalGap</strong> float</p>
</dd>
</dl>
<p>Azimuthal gap for this magnitude computation in degrees.</p>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.Magnitude.azimuthalGap">
<code class="sig-name descname">azimuthalGap</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.Magnitude.azimuthalGap" title="Permalink to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Return type</dt>
<dd class="field-odd"><p>float</p>
</dd>
</dl>
<div class="admonition note">
<p class="admonition-title">Note</p>
<p>As this attribute is optional, this method throws a ValueError if
the value of the attribute is not set.</p>
</div>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.Magnitude.setEvaluationStatus">
<code class="sig-name descname">setEvaluationStatus</code><span class="sig-paren">(</span><em class="sig-param">evaluationStatus</em><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.Magnitude.setEvaluationStatus" title="Permalink to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>evaluationStatus</strong> EvaluationStatus</p>
</dd>
</dl>
<p>Evaluation status of Magnitude.</p>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.Magnitude.evaluationStatus">
<code class="sig-name descname">evaluationStatus</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.Magnitude.evaluationStatus" title="Permalink to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Return type</dt>
<dd class="field-odd"><p>EvaluationStatus</p>
</dd>
</dl>
<div class="admonition note">
<p class="admonition-title">Note</p>
<p>As this attribute is optional, this method throws a ValueError if
the value of the attribute is not set.</p>
</div>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.Magnitude.setCreationInfo">
<code class="sig-name descname">setCreationInfo</code><span class="sig-paren">(</span><em class="sig-param">creationInfo</em><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.Magnitude.setCreationInfo" title="Permalink to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>creationInfo</strong> <a class="reference internal" href="#api-python-datamodel-creationinfo"><span class="std std-ref">CreationInfo</span></a></p>
</dd>
</dl>
<p>CreationInfo for the Magnitude object.</p>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.Magnitude.creationInfo">
<code class="sig-name descname">creationInfo</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.Magnitude.creationInfo" title="Permalink to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Return type</dt>
<dd class="field-odd"><p><a class="reference internal" href="#api-python-datamodel-creationinfo"><span class="std std-ref">CreationInfo</span></a></p>
</dd>
</dl>
<div class="admonition note">
<p class="admonition-title">Note</p>
<p>As this attribute is optional, this method throws a ValueError if
the value of the attribute is not set.</p>
</div>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.Magnitude.add">
<code class="sig-name descname">add</code><span class="sig-paren">(</span><em class="sig-param">comment</em><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.Magnitude.add" title="Permalink to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>comment</strong> Object of type <a class="reference internal" href="#api-python-datamodel-comment"><span class="std std-ref">Comment</span></a></p>
</dd>
<dt class="field-even">Return type</dt>
<dd class="field-even"><p>A Boolean value indicating success with True, False otherwise.</p>
</dd>
</dl>
<p>Adds a Comment object to Magnitude. The object is not
copied but managed by this instance. Any change to the passed object
will also change the child.</p>
</dd></dl>
<dl class="method">
<dt>
<code class="sig-name descname">add</code><span class="sig-paren">(</span><em class="sig-param">stationMagnitudeContribution</em><span class="sig-paren">)</span></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>stationMagnitudeContribution</strong> Object of type <a class="reference internal" href="#api-python-datamodel-stationmagnitudecontribution"><span class="std std-ref">StationMagnitudeContribution</span></a></p>
</dd>
<dt class="field-even">Return type</dt>
<dd class="field-even"><p>A Boolean value indicating success with True, False otherwise.</p>
</dd>
</dl>
<p>Adds a StationMagnitudeContribution object to Magnitude. The object is not
copied but managed by this instance. Any change to the passed object
will also change the child.</p>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.Magnitude.remove">
<code class="sig-name descname">remove</code><span class="sig-paren">(</span><em class="sig-param">comment</em><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.Magnitude.remove" title="Permalink to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>comment</strong> Object of type <a class="reference internal" href="#api-python-datamodel-comment"><span class="std std-ref">Comment</span></a></p>
</dd>
<dt class="field-even">Return type</dt>
<dd class="field-even"><p>A Boolean value indicating success with True, False otherwise.</p>
</dd>
</dl>
<p>Removes a previously added Comment object from Magnitude.</p>
</dd></dl>
<dl class="method">
<dt>
<code class="sig-name descname">remove</code><span class="sig-paren">(</span><em class="sig-param">stationMagnitudeContribution</em><span class="sig-paren">)</span></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>stationMagnitudeContribution</strong> Object of type <a class="reference internal" href="#api-python-datamodel-stationmagnitudecontribution"><span class="std std-ref">StationMagnitudeContribution</span></a></p>
</dd>
<dt class="field-even">Return type</dt>
<dd class="field-even"><p>A Boolean value indicating success with True, False otherwise.</p>
</dd>
</dl>
<p>Removes a previously added StationMagnitudeContribution object from Magnitude.</p>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.Magnitude.removeComment">
<code class="sig-name descname">removeComment</code><span class="sig-paren">(</span><em class="sig-param">idx</em><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.Magnitude.removeComment" title="Permalink to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>idx</strong> An integer index of the object to be removed.</p>
</dd>
<dt class="field-even">Return type</dt>
<dd class="field-even"><p>A Boolean value indicating success with True, False otherwise.</p>
</dd>
</dl>
</dd></dl>
<dl class="method">
<dt>
<code class="sig-name descname">removeComment(commentIndex);</code></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>commentIndex</strong> The index of the object to be removed of type CommentIndex.</p>
</dd>
<dt class="field-even">Return type</dt>
<dd class="field-even"><p>A Boolean value indicating success with True, False otherwise.</p>
</dd>
</dl>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.Magnitude.removeStationMagnitudeContribution">
<code class="sig-name descname">removeStationMagnitudeContribution</code><span class="sig-paren">(</span><em class="sig-param">idx</em><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.Magnitude.removeStationMagnitudeContribution" title="Permalink to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>idx</strong> An integer index of the object to be removed.</p>
</dd>
<dt class="field-even">Return type</dt>
<dd class="field-even"><p>A Boolean value indicating success with True, False otherwise.</p>
</dd>
</dl>
</dd></dl>
<dl class="method">
<dt>
<code class="sig-name descname">removeStationMagnitudeContribution(stationMagnitudeContributionIndex);</code></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>stationMagnitudeContributionIndex</strong> The index of the object to be removed of type StationMagnitudeContributionIndex.</p>
</dd>
<dt class="field-even">Return type</dt>
<dd class="field-even"><p>A Boolean value indicating success with True, False otherwise.</p>
</dd>
</dl>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.Magnitude.commentCount">
<code class="sig-name descname">commentCount</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.Magnitude.commentCount" title="Permalink to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Return type</dt>
<dd class="field-odd"><p>integer value indicating the number of child objects.</p>
</dd>
</dl>
<p>Returns the number of Comment child objects.</p>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.Magnitude.stationMagnitudeContributionCount">
<code class="sig-name descname">stationMagnitudeContributionCount</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.Magnitude.stationMagnitudeContributionCount" title="Permalink to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Return type</dt>
<dd class="field-odd"><p>integer value indicating the number of child objects.</p>
</dd>
</dl>
<p>Returns the number of StationMagnitudeContribution child objects.</p>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.Magnitude.comment">
<code class="sig-name descname">comment</code><span class="sig-paren">(</span><em class="sig-param">idx</em><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.Magnitude.comment" title="Permalink to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>idx</strong> An integer index of the object to be returned.</p>
</dd>
<dt class="field-even">Return type</dt>
<dd class="field-even"><p>Object of type <a class="reference internal" href="#api-python-datamodel-comment"><span class="std std-ref">Comment</span></a>.</p>
</dd>
</dl>
<p>Returns the Comment at index idx.</p>
</dd></dl>
<dl class="method">
<dt>
<code class="sig-name descname">comment</code><span class="sig-paren">(</span><em class="sig-param">commentIndex</em><span class="sig-paren">)</span></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>commentIndex</strong> The index of the object to be removed of type CommentIndex.</p>
</dd>
<dt class="field-even">Return type</dt>
<dd class="field-even"><p>Object of type <a class="reference internal" href="#api-python-datamodel-comment"><span class="std std-ref">Comment</span></a>.</p>
</dd>
</dl>
<p>Returns the Comment at given index. The indexes of all child objects
are compared by value which makes this function slower than the direct
integer index look-up.</p>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.Magnitude.stationMagnitudeContribution">
<code class="sig-name descname">stationMagnitudeContribution</code><span class="sig-paren">(</span><em class="sig-param">idx</em><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.Magnitude.stationMagnitudeContribution" title="Permalink to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>idx</strong> An integer index of the object to be returned.</p>
</dd>
<dt class="field-even">Return type</dt>
<dd class="field-even"><p>Object of type <a class="reference internal" href="#api-python-datamodel-stationmagnitudecontribution"><span class="std std-ref">StationMagnitudeContribution</span></a>.</p>
</dd>
</dl>
<p>Returns the StationMagnitudeContribution at index idx.</p>
</dd></dl>
<dl class="method">
<dt>
<code class="sig-name descname">stationMagnitudeContribution</code><span class="sig-paren">(</span><em class="sig-param">stationMagnitudeContributionIndex</em><span class="sig-paren">)</span></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>stationMagnitudeContributionIndex</strong> The index of the object to be removed of type StationMagnitudeContributionIndex.</p>
</dd>
<dt class="field-even">Return type</dt>
<dd class="field-even"><p>Object of type <a class="reference internal" href="#api-python-datamodel-stationmagnitudecontribution"><span class="std std-ref">StationMagnitudeContribution</span></a>.</p>
</dd>
</dl>
<p>Returns the StationMagnitudeContribution at given index. The indexes of all child objects
are compared by value which makes this function slower than the direct
integer index look-up.</p>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.Magnitude.origin">
<code class="sig-name descname">origin</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.Magnitude.origin" title="Permalink to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Return type</dt>
<dd class="field-odd"><p><a class="reference internal" href="#seiscomp.datamodel.Origin" title="seiscomp.datamodel.Origin">Origin</a></p>
</dd>
</dl>
<p>Returns the parent Origin if available. Returns None
if the parent is not a Origin. This is a convenience wrapper
for parent().</p>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.Magnitude.assign">
<code class="sig-name descname">assign</code><span class="sig-paren">(</span><em class="sig-param">other</em><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.Magnitude.assign" title="Permalink to this definition"></a></dt>
<dd><p>This method implements the <a class="reference internal" href="#api-python-datamodel-object"><span class="std std-ref">Object</span></a> interface.</p>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.Magnitude.attachTo">
<code class="sig-name descname">attachTo</code><span class="sig-paren">(</span><em class="sig-param">parent</em><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.Magnitude.attachTo" title="Permalink to this definition"></a></dt>
<dd><p>This method implements the <a class="reference internal" href="#api-python-datamodel-object"><span class="std std-ref">Object</span></a> interface.</p>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.Magnitude.detachFrom">
<code class="sig-name descname">detachFrom</code><span class="sig-paren">(</span><em class="sig-param">parent</em><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.Magnitude.detachFrom" title="Permalink to this definition"></a></dt>
<dd><p>This method implements the <a class="reference internal" href="#api-python-datamodel-object"><span class="std std-ref">Object</span></a> interface.</p>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.Magnitude.detach">
<code class="sig-name descname">detach</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.Magnitude.detach" title="Permalink to this definition"></a></dt>
<dd><p>This method implements the <a class="reference internal" href="#api-python-datamodel-object"><span class="std std-ref">Object</span></a> interface.</p>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.Magnitude.clone">
<code class="sig-name descname">clone</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.Magnitude.clone" title="Permalink to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Return type</dt>
<dd class="field-odd"><p>A cloned Magnitude.</p>
</dd>
</dl>
<p>Returns a new instance that is a clone of the current instance. Child
objects are being ignored.</p>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.Magnitude.updateChild">
<code class="sig-name descname">updateChild</code><span class="sig-paren">(</span><em class="sig-param">ref</em><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.Magnitude.updateChild" title="Permalink to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>ref</strong> A child object derived from class Object.</p>
</dd>
<dt class="field-even">Return type</dt>
<dd class="field-even"><p>A Boolean flag indicating success with True, False otherwise</p>
</dd>
</dl>
<p>This method takes the passed reference object and searches for a child
with the same publicID (if derived from <a class="reference internal" href="#api-python-datamodel-publicobject"><span class="std std-ref">PublicObject</span></a>)
or the same index (if derived from <a class="reference internal" href="#api-python-datamodel-object"><span class="std std-ref">Object</span></a>).
The the child was found the reference objects attributes are copied to
the child object. Children of child are being ignored during this operation.
This method implements the <a class="reference internal" href="#api-python-datamodel-publicobject"><span class="std std-ref">PublicObject</span></a> interface.</p>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.Magnitude.accept">
<code class="sig-name descname">accept</code><span class="sig-paren">(</span><em class="sig-param">visitor</em><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.Magnitude.accept" title="Permalink to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>visitor</strong> A visitor.</p>
</dd>
</dl>
<p>This method implements the <a class="reference internal" href="#api-python-datamodel-publicobject"><span class="std std-ref">PublicObject</span></a> interface.</p>
</dd></dl>
</dd></dl>
</div>
<div class="section" id="momenttensor">
<span id="api-python-datamodel-momenttensor"></span><h3>MomentTensor<a class="headerlink" href="#momenttensor" title="Permalink to this headline"></a></h3>
<dl class="class">
<dt id="seiscomp.datamodel.MomentTensor">
<em class="property">class </em><code class="sig-prename descclassname">seiscomp.datamodel.</code><code class="sig-name descname">MomentTensor</code><a class="headerlink" href="#seiscomp.datamodel.MomentTensor" title="Permalink to this definition"></a></dt>
<dd><p>Inherits <a class="reference internal" href="#api-python-datamodel-publicobject"><span class="std std-ref">PublicObject</span></a>.</p>
<p>This class represents a moment tensor solution for an event. It is an
optional part of a FocalMechanism description.</p>
<p><strong>Parents</strong>:</p>
<ul class="simple">
<li><p><code class="docutils literal notranslate"><span class="pre">focalMechanism</span></code> <a class="reference internal" href="#api-python-datamodel-focalmechanism"><span class="std std-ref">FocalMechanism</span></a></p></li>
</ul>
<p><strong>Children</strong>:</p>
<ul class="simple">
<li><p><code class="docutils literal notranslate"><span class="pre">comment</span></code> <a class="reference internal" href="#api-python-datamodel-comment"><span class="std std-ref">Comment</span></a></p></li>
<li><p><code class="docutils literal notranslate"><span class="pre">dataUsed</span></code> <a class="reference internal" href="#api-python-datamodel-dataused"><span class="std std-ref">DataUsed</span></a></p></li>
<li><p><code class="docutils literal notranslate"><span class="pre">momentTensorPhaseSetting</span></code> <a class="reference internal" href="#api-python-datamodel-momenttensorphasesetting"><span class="std std-ref">MomentTensorPhaseSetting</span></a></p></li>
<li><p><code class="docutils literal notranslate"><span class="pre">momentTensorStationContribution</span></code> <a class="reference internal" href="#api-python-datamodel-momenttensorstationcontribution"><span class="std std-ref">MomentTensorStationContribution</span></a></p></li>
</ul>
<p><strong>Attributes</strong>:</p>
<ul class="simple">
<li><p><code class="docutils literal notranslate"><span class="pre">publicID</span></code>: string</p></li>
<li><p><code class="docutils literal notranslate"><span class="pre">derivedOriginID</span></code> string</p></li>
<li><p><code class="docutils literal notranslate"><span class="pre">momentMagnitudeID</span></code> string</p></li>
<li><p><code class="docutils literal notranslate"><span class="pre">scalarMoment</span></code> <a class="reference internal" href="#api-python-datamodel-realquantity"><span class="std std-ref">RealQuantity</span></a> (optional)</p></li>
<li><p><code class="docutils literal notranslate"><span class="pre">tensor</span></code> <a class="reference internal" href="#api-python-datamodel-tensor"><span class="std std-ref">Tensor</span></a> (optional)</p></li>
<li><p><code class="docutils literal notranslate"><span class="pre">variance</span></code> float (optional)</p></li>
<li><p><code class="docutils literal notranslate"><span class="pre">varianceReduction</span></code> float (optional)</p></li>
<li><p><code class="docutils literal notranslate"><span class="pre">doubleCouple</span></code> float (optional)</p></li>
<li><p><code class="docutils literal notranslate"><span class="pre">clvd</span></code> float (optional)</p></li>
<li><p><code class="docutils literal notranslate"><span class="pre">iso</span></code> float (optional)</p></li>
<li><p><code class="docutils literal notranslate"><span class="pre">greensFunctionID</span></code> string</p></li>
<li><p><code class="docutils literal notranslate"><span class="pre">filterID</span></code> string</p></li>
<li><p><code class="docutils literal notranslate"><span class="pre">sourceTimeFunction</span></code> <a class="reference internal" href="#api-python-datamodel-sourcetimefunction"><span class="std std-ref">SourceTimeFunction</span></a> (optional)</p></li>
<li><p><code class="docutils literal notranslate"><span class="pre">methodID</span></code> string</p></li>
<li><p><code class="docutils literal notranslate"><span class="pre">method</span></code> <a class="reference internal" href="#api-python-datamodel-momenttensormethod"><span class="std std-ref">MomentTensorMethod</span></a> (optional)</p></li>
<li><p><code class="docutils literal notranslate"><span class="pre">status</span></code> <a class="reference internal" href="#api-python-datamodel-momenttensorstatus"><span class="std std-ref">MomentTensorStatus</span></a> (optional)</p></li>
<li><p><code class="docutils literal notranslate"><span class="pre">cmtName</span></code> string</p></li>
<li><p><code class="docutils literal notranslate"><span class="pre">cmtVersion</span></code> string</p></li>
<li><p><code class="docutils literal notranslate"><span class="pre">creationInfo</span></code> <a class="reference internal" href="#api-python-datamodel-creationinfo"><span class="std std-ref">CreationInfo</span></a> (optional)</p></li>
</ul>
<p><strong>Methods</strong>:</p>
<dl class="method">
<dt id="seiscomp.datamodel.MomentTensor.Cast">
<em class="property">static </em><code class="sig-name descname">Cast</code><span class="sig-paren">(</span><em class="sig-param">obj</em><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.MomentTensor.Cast" title="Permalink to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>obj</strong> The object to be casted.</p>
</dd>
<dt class="field-even">Return type</dt>
<dd class="field-even"><p>An object of type MomentTensor if the cast was successful,
None otherwise.</p>
</dd>
</dl>
<p>Cast an arbitrary object to MomentTensor if the internal wrapped
representation is an MomentTensor object. The cast is important if
instances of type <a class="reference internal" href="#api-python-datamodel-object"><span class="std std-ref">Object</span></a>
are passed to methods which need access to the real type.</p>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.MomentTensor.Create">
<em class="property">static </em><code class="sig-name descname">Create</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.MomentTensor.Create" title="Permalink to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Return type</dt>
<dd class="field-odd"><p>A new object of type MomentTensor.</p>
</dd>
</dl>
<p>Creates and registers (if enabled) a MomentTensor instance. The
publicID is auto-generated.</p>
</dd></dl>
<dl class="method">
<dt>
<em class="property">static </em><code class="sig-name descname">Create</code><span class="sig-paren">(</span><em class="sig-param">publicID</em><span class="sig-paren">)</span></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Return type</dt>
<dd class="field-odd"><p>A new object of type MomentTensor.</p>
</dd>
</dl>
<p>Creates and registers (if enabled) a MomentTensor instance with
passed publicID.</p>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.MomentTensor.equal">
<code class="sig-name descname">equal</code><span class="sig-paren">(</span><em class="sig-param">other</em><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.MomentTensor.equal" title="Permalink to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>other</strong> Another object of type MomentTensor to compare this
instance to</p>
</dd>
<dt class="field-even">Return type</dt>
<dd class="field-even"><p>A Boolean value indicating True if both objects are equal or
False otherwise.</p>
</dd>
</dl>
<p>Compares two objects without its child objects. Both objects are compared
by value.</p>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.MomentTensor.setDerivedOriginID">
<code class="sig-name descname">setDerivedOriginID</code><span class="sig-paren">(</span><em class="sig-param">derivedOriginID</em><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.MomentTensor.setDerivedOriginID" title="Permalink to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>derivedOriginID</strong> string</p>
</dd>
</dl>
<p>Refers to the publicID of the Origin derived in the moment tensor inversion.</p>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.MomentTensor.derivedOriginID">
<code class="sig-name descname">derivedOriginID</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.MomentTensor.derivedOriginID" title="Permalink to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Return type</dt>
<dd class="field-odd"><p>string</p>
</dd>
</dl>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.MomentTensor.setMomentMagnitudeID">
<code class="sig-name descname">setMomentMagnitudeID</code><span class="sig-paren">(</span><em class="sig-param">momentMagnitudeID</em><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.MomentTensor.setMomentMagnitudeID" title="Permalink to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>momentMagnitudeID</strong> string</p>
</dd>
</dl>
<p>Refers to the publicID of the Magnitude object which represents the derived
moment
magnitude.</p>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.MomentTensor.momentMagnitudeID">
<code class="sig-name descname">momentMagnitudeID</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.MomentTensor.momentMagnitudeID" title="Permalink to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Return type</dt>
<dd class="field-odd"><p>string</p>
</dd>
</dl>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.MomentTensor.setScalarMoment">
<code class="sig-name descname">setScalarMoment</code><span class="sig-paren">(</span><em class="sig-param">scalarMoment</em><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.MomentTensor.setScalarMoment" title="Permalink to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>scalarMoment</strong> <a class="reference internal" href="#api-python-datamodel-realquantity"><span class="std std-ref">RealQuantity</span></a></p>
</dd>
</dl>
<p>Scalar moment as derived in moment tensor inversion in Nm.</p>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.MomentTensor.scalarMoment">
<code class="sig-name descname">scalarMoment</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.MomentTensor.scalarMoment" title="Permalink to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Return type</dt>
<dd class="field-odd"><p><a class="reference internal" href="#api-python-datamodel-realquantity"><span class="std std-ref">RealQuantity</span></a></p>
</dd>
</dl>
<div class="admonition note">
<p class="admonition-title">Note</p>
<p>As this attribute is optional, this method throws a ValueError if
the value of the attribute is not set.</p>
</div>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.MomentTensor.setTensor">
<code class="sig-name descname">setTensor</code><span class="sig-paren">(</span><em class="sig-param">tensor</em><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.MomentTensor.setTensor" title="Permalink to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>tensor</strong> <a class="reference internal" href="#api-python-datamodel-tensor"><span class="std std-ref">Tensor</span></a></p>
</dd>
</dl>
<p>Tensor object holding the moment tensor elements.</p>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.MomentTensor.tensor">
<code class="sig-name descname">tensor</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.MomentTensor.tensor" title="Permalink to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Return type</dt>
<dd class="field-odd"><p><a class="reference internal" href="#api-python-datamodel-tensor"><span class="std std-ref">Tensor</span></a></p>
</dd>
</dl>
<div class="admonition note">
<p class="admonition-title">Note</p>
<p>As this attribute is optional, this method throws a ValueError if
the value of the attribute is not set.</p>
</div>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.MomentTensor.setVariance">
<code class="sig-name descname">setVariance</code><span class="sig-paren">(</span><em class="sig-param">variance</em><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.MomentTensor.setVariance" title="Permalink to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>variance</strong> float</p>
</dd>
</dl>
<p>Variance of moment tensor inversion.</p>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.MomentTensor.variance">
<code class="sig-name descname">variance</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.MomentTensor.variance" title="Permalink to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Return type</dt>
<dd class="field-odd"><p>float</p>
</dd>
</dl>
<div class="admonition note">
<p class="admonition-title">Note</p>
<p>As this attribute is optional, this method throws a ValueError if
the value of the attribute is not set.</p>
</div>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.MomentTensor.setVarianceReduction">
<code class="sig-name descname">setVarianceReduction</code><span class="sig-paren">(</span><em class="sig-param">varianceReduction</em><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.MomentTensor.setVarianceReduction" title="Permalink to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>varianceReduction</strong> float</p>
</dd>
</dl>
<p>Variance reduction of moment tensor inversion, given in percent (Dreger
2003). This is a
goodness-of-fit measure.</p>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.MomentTensor.varianceReduction">
<code class="sig-name descname">varianceReduction</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.MomentTensor.varianceReduction" title="Permalink to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Return type</dt>
<dd class="field-odd"><p>float</p>
</dd>
</dl>
<div class="admonition note">
<p class="admonition-title">Note</p>
<p>As this attribute is optional, this method throws a ValueError if
the value of the attribute is not set.</p>
</div>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.MomentTensor.setDoubleCouple">
<code class="sig-name descname">setDoubleCouple</code><span class="sig-paren">(</span><em class="sig-param">doubleCouple</em><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.MomentTensor.setDoubleCouple" title="Permalink to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>doubleCouple</strong> float</p>
</dd>
</dl>
<p>Double couple parameter obtained from moment tensor inversion (decimal
fraction between 0
and 1).</p>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.MomentTensor.doubleCouple">
<code class="sig-name descname">doubleCouple</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.MomentTensor.doubleCouple" title="Permalink to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Return type</dt>
<dd class="field-odd"><p>float</p>
</dd>
</dl>
<div class="admonition note">
<p class="admonition-title">Note</p>
<p>As this attribute is optional, this method throws a ValueError if
the value of the attribute is not set.</p>
</div>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.MomentTensor.setClvd">
<code class="sig-name descname">setClvd</code><span class="sig-paren">(</span><em class="sig-param">clvd</em><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.MomentTensor.setClvd" title="Permalink to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>clvd</strong> float</p>
</dd>
</dl>
<p>CLVD (compensated linear vector dipole) parameter obtained from moment
tensor inversion (decimal
fraction between 0 and 1).</p>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.MomentTensor.clvd">
<code class="sig-name descname">clvd</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.MomentTensor.clvd" title="Permalink to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Return type</dt>
<dd class="field-odd"><p>float</p>
</dd>
</dl>
<div class="admonition note">
<p class="admonition-title">Note</p>
<p>As this attribute is optional, this method throws a ValueError if
the value of the attribute is not set.</p>
</div>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.MomentTensor.setIso">
<code class="sig-name descname">setIso</code><span class="sig-paren">(</span><em class="sig-param">iso</em><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.MomentTensor.setIso" title="Permalink to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>iso</strong> float</p>
</dd>
</dl>
<p>Isotropic part obtained from moment tensor inversion (decimal fraction
between 0 and 1).</p>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.MomentTensor.iso">
<code class="sig-name descname">iso</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.MomentTensor.iso" title="Permalink to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Return type</dt>
<dd class="field-odd"><p>float</p>
</dd>
</dl>
<div class="admonition note">
<p class="admonition-title">Note</p>
<p>As this attribute is optional, this method throws a ValueError if
the value of the attribute is not set.</p>
</div>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.MomentTensor.setGreensFunctionID">
<code class="sig-name descname">setGreensFunctionID</code><span class="sig-paren">(</span><em class="sig-param">greensFunctionID</em><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.MomentTensor.setGreensFunctionID" title="Permalink to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>greensFunctionID</strong> string</p>
</dd>
</dl>
<p>Resource identifier of the Greens function used in moment tensor inversion.</p>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.MomentTensor.greensFunctionID">
<code class="sig-name descname">greensFunctionID</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.MomentTensor.greensFunctionID" title="Permalink to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Return type</dt>
<dd class="field-odd"><p>string</p>
</dd>
</dl>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.MomentTensor.setFilterID">
<code class="sig-name descname">setFilterID</code><span class="sig-paren">(</span><em class="sig-param">filterID</em><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.MomentTensor.setFilterID" title="Permalink to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>filterID</strong> string</p>
</dd>
</dl>
<p>Resource identifier of the filter setup used in moment tensor inversion.</p>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.MomentTensor.filterID">
<code class="sig-name descname">filterID</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.MomentTensor.filterID" title="Permalink to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Return type</dt>
<dd class="field-odd"><p>string</p>
</dd>
</dl>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.MomentTensor.setSourceTimeFunction">
<code class="sig-name descname">setSourceTimeFunction</code><span class="sig-paren">(</span><em class="sig-param">sourceTimeFunction</em><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.MomentTensor.setSourceTimeFunction" title="Permalink to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>sourceTimeFunction</strong> <a class="reference internal" href="#api-python-datamodel-sourcetimefunction"><span class="std std-ref">SourceTimeFunction</span></a></p>
</dd>
</dl>
<p>Source time function used in moment-tensor inversion.</p>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.MomentTensor.sourceTimeFunction">
<code class="sig-name descname">sourceTimeFunction</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.MomentTensor.sourceTimeFunction" title="Permalink to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Return type</dt>
<dd class="field-odd"><p><a class="reference internal" href="#api-python-datamodel-sourcetimefunction"><span class="std std-ref">SourceTimeFunction</span></a></p>
</dd>
</dl>
<div class="admonition note">
<p class="admonition-title">Note</p>
<p>As this attribute is optional, this method throws a ValueError if
the value of the attribute is not set.</p>
</div>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.MomentTensor.setMethodID">
<code class="sig-name descname">setMethodID</code><span class="sig-paren">(</span><em class="sig-param">methodID</em><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.MomentTensor.setMethodID" title="Permalink to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>methodID</strong> string</p>
</dd>
</dl>
<p>Resource identifier of the method used for moment-tensor inversion.</p>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.MomentTensor.methodID">
<code class="sig-name descname">methodID</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.MomentTensor.methodID" title="Permalink to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Return type</dt>
<dd class="field-odd"><p>string</p>
</dd>
</dl>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.MomentTensor.setMethod">
<code class="sig-name descname">setMethod</code><span class="sig-paren">(</span><em class="sig-param">method</em><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.MomentTensor.setMethod" title="Permalink to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>method</strong> MomentTensorMethod</p>
</dd>
</dl>
<p>Moment tensor method used.</p>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.MomentTensor.method">
<code class="sig-name descname">method</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.MomentTensor.method" title="Permalink to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Return type</dt>
<dd class="field-odd"><p>MomentTensorMethod</p>
</dd>
</dl>
<div class="admonition note">
<p class="admonition-title">Note</p>
<p>As this attribute is optional, this method throws a ValueError if
the value of the attribute is not set.</p>
</div>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.MomentTensor.setStatus">
<code class="sig-name descname">setStatus</code><span class="sig-paren">(</span><em class="sig-param">status</em><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.MomentTensor.setStatus" title="Permalink to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>status</strong> MomentTensorStatus</p>
</dd>
</dl>
<p>Status of moment tensor.</p>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.MomentTensor.status">
<code class="sig-name descname">status</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.MomentTensor.status" title="Permalink to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Return type</dt>
<dd class="field-odd"><p>MomentTensorStatus</p>
</dd>
</dl>
<div class="admonition note">
<p class="admonition-title">Note</p>
<p>As this attribute is optional, this method throws a ValueError if
the value of the attribute is not set.</p>
</div>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.MomentTensor.setCmtName">
<code class="sig-name descname">setCmtName</code><span class="sig-paren">(</span><em class="sig-param">cmtName</em><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.MomentTensor.setCmtName" title="Permalink to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>cmtName</strong> string</p>
</dd>
</dl>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.MomentTensor.cmtName">
<code class="sig-name descname">cmtName</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.MomentTensor.cmtName" title="Permalink to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Return type</dt>
<dd class="field-odd"><p>string</p>
</dd>
</dl>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.MomentTensor.setCmtVersion">
<code class="sig-name descname">setCmtVersion</code><span class="sig-paren">(</span><em class="sig-param">cmtVersion</em><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.MomentTensor.setCmtVersion" title="Permalink to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>cmtVersion</strong> string</p>
</dd>
</dl>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.MomentTensor.cmtVersion">
<code class="sig-name descname">cmtVersion</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.MomentTensor.cmtVersion" title="Permalink to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Return type</dt>
<dd class="field-odd"><p>string</p>
</dd>
</dl>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.MomentTensor.setCreationInfo">
<code class="sig-name descname">setCreationInfo</code><span class="sig-paren">(</span><em class="sig-param">creationInfo</em><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.MomentTensor.setCreationInfo" title="Permalink to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>creationInfo</strong> <a class="reference internal" href="#api-python-datamodel-creationinfo"><span class="std std-ref">CreationInfo</span></a></p>
</dd>
</dl>
<p>CreationInfo for the MomentTensor object.</p>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.MomentTensor.creationInfo">
<code class="sig-name descname">creationInfo</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.MomentTensor.creationInfo" title="Permalink to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Return type</dt>
<dd class="field-odd"><p><a class="reference internal" href="#api-python-datamodel-creationinfo"><span class="std std-ref">CreationInfo</span></a></p>
</dd>
</dl>
<div class="admonition note">
<p class="admonition-title">Note</p>
<p>As this attribute is optional, this method throws a ValueError if
the value of the attribute is not set.</p>
</div>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.MomentTensor.add">
<code class="sig-name descname">add</code><span class="sig-paren">(</span><em class="sig-param">comment</em><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.MomentTensor.add" title="Permalink to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>comment</strong> Object of type <a class="reference internal" href="#api-python-datamodel-comment"><span class="std std-ref">Comment</span></a></p>
</dd>
<dt class="field-even">Return type</dt>
<dd class="field-even"><p>A Boolean value indicating success with True, False otherwise.</p>
</dd>
</dl>
<p>Adds a Comment object to MomentTensor. The object is not
copied but managed by this instance. Any change to the passed object
will also change the child.</p>
</dd></dl>
<dl class="method">
<dt>
<code class="sig-name descname">add</code><span class="sig-paren">(</span><em class="sig-param">dataUsed</em><span class="sig-paren">)</span></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>dataUsed</strong> Object of type <a class="reference internal" href="#api-python-datamodel-dataused"><span class="std std-ref">DataUsed</span></a></p>
</dd>
<dt class="field-even">Return type</dt>
<dd class="field-even"><p>A Boolean value indicating success with True, False otherwise.</p>
</dd>
</dl>
<p>Adds a DataUsed object to MomentTensor. The object is not
copied but managed by this instance. Any change to the passed object
will also change the child.</p>
</dd></dl>
<dl class="method">
<dt>
<code class="sig-name descname">add</code><span class="sig-paren">(</span><em class="sig-param">momentTensorPhaseSetting</em><span class="sig-paren">)</span></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>momentTensorPhaseSetting</strong> Object of type <a class="reference internal" href="#api-python-datamodel-momenttensorphasesetting"><span class="std std-ref">MomentTensorPhaseSetting</span></a></p>
</dd>
<dt class="field-even">Return type</dt>
<dd class="field-even"><p>A Boolean value indicating success with True, False otherwise.</p>
</dd>
</dl>
<p>Adds a MomentTensorPhaseSetting object to MomentTensor. The object is not
copied but managed by this instance. Any change to the passed object
will also change the child.</p>
</dd></dl>
<dl class="method">
<dt>
<code class="sig-name descname">add</code><span class="sig-paren">(</span><em class="sig-param">momentTensorStationContribution</em><span class="sig-paren">)</span></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>momentTensorStationContribution</strong> Object of type <a class="reference internal" href="#api-python-datamodel-momenttensorstationcontribution"><span class="std std-ref">MomentTensorStationContribution</span></a></p>
</dd>
<dt class="field-even">Return type</dt>
<dd class="field-even"><p>A Boolean value indicating success with True, False otherwise.</p>
</dd>
</dl>
<p>Adds a MomentTensorStationContribution object to MomentTensor. The object is not
copied but managed by this instance. Any change to the passed object
will also change the child.</p>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.MomentTensor.remove">
<code class="sig-name descname">remove</code><span class="sig-paren">(</span><em class="sig-param">comment</em><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.MomentTensor.remove" title="Permalink to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>comment</strong> Object of type <a class="reference internal" href="#api-python-datamodel-comment"><span class="std std-ref">Comment</span></a></p>
</dd>
<dt class="field-even">Return type</dt>
<dd class="field-even"><p>A Boolean value indicating success with True, False otherwise.</p>
</dd>
</dl>
<p>Removes a previously added Comment object from MomentTensor.</p>
</dd></dl>
<dl class="method">
<dt>
<code class="sig-name descname">remove</code><span class="sig-paren">(</span><em class="sig-param">dataUsed</em><span class="sig-paren">)</span></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>dataUsed</strong> Object of type <a class="reference internal" href="#api-python-datamodel-dataused"><span class="std std-ref">DataUsed</span></a></p>
</dd>
<dt class="field-even">Return type</dt>
<dd class="field-even"><p>A Boolean value indicating success with True, False otherwise.</p>
</dd>
</dl>
<p>Removes a previously added DataUsed object from MomentTensor.</p>
</dd></dl>
<dl class="method">
<dt>
<code class="sig-name descname">remove</code><span class="sig-paren">(</span><em class="sig-param">momentTensorPhaseSetting</em><span class="sig-paren">)</span></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>momentTensorPhaseSetting</strong> Object of type <a class="reference internal" href="#api-python-datamodel-momenttensorphasesetting"><span class="std std-ref">MomentTensorPhaseSetting</span></a></p>
</dd>
<dt class="field-even">Return type</dt>
<dd class="field-even"><p>A Boolean value indicating success with True, False otherwise.</p>
</dd>
</dl>
<p>Removes a previously added MomentTensorPhaseSetting object from MomentTensor.</p>
</dd></dl>
<dl class="method">
<dt>
<code class="sig-name descname">remove</code><span class="sig-paren">(</span><em class="sig-param">momentTensorStationContribution</em><span class="sig-paren">)</span></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>momentTensorStationContribution</strong> Object of type <a class="reference internal" href="#api-python-datamodel-momenttensorstationcontribution"><span class="std std-ref">MomentTensorStationContribution</span></a></p>
</dd>
<dt class="field-even">Return type</dt>
<dd class="field-even"><p>A Boolean value indicating success with True, False otherwise.</p>
</dd>
</dl>
<p>Removes a previously added MomentTensorStationContribution object from MomentTensor.</p>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.MomentTensor.removeComment">
<code class="sig-name descname">removeComment</code><span class="sig-paren">(</span><em class="sig-param">idx</em><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.MomentTensor.removeComment" title="Permalink to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>idx</strong> An integer index of the object to be removed.</p>
</dd>
<dt class="field-even">Return type</dt>
<dd class="field-even"><p>A Boolean value indicating success with True, False otherwise.</p>
</dd>
</dl>
</dd></dl>
<dl class="method">
<dt>
<code class="sig-name descname">removeComment(commentIndex);</code></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>commentIndex</strong> The index of the object to be removed of type CommentIndex.</p>
</dd>
<dt class="field-even">Return type</dt>
<dd class="field-even"><p>A Boolean value indicating success with True, False otherwise.</p>
</dd>
</dl>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.MomentTensor.removeDataUsed">
<code class="sig-name descname">removeDataUsed</code><span class="sig-paren">(</span><em class="sig-param">idx</em><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.MomentTensor.removeDataUsed" title="Permalink to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>idx</strong> An integer index of the object to be removed.</p>
</dd>
<dt class="field-even">Return type</dt>
<dd class="field-even"><p>A Boolean value indicating success with True, False otherwise.</p>
</dd>
</dl>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.MomentTensor.removeMomentTensorPhaseSetting">
<code class="sig-name descname">removeMomentTensorPhaseSetting</code><span class="sig-paren">(</span><em class="sig-param">idx</em><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.MomentTensor.removeMomentTensorPhaseSetting" title="Permalink to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>idx</strong> An integer index of the object to be removed.</p>
</dd>
<dt class="field-even">Return type</dt>
<dd class="field-even"><p>A Boolean value indicating success with True, False otherwise.</p>
</dd>
</dl>
</dd></dl>
<dl class="method">
<dt>
<code class="sig-name descname">removeMomentTensorPhaseSetting(momentTensorPhaseSettingIndex);</code></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>momentTensorPhaseSettingIndex</strong> The index of the object to be removed of type MomentTensorPhaseSettingIndex.</p>
</dd>
<dt class="field-even">Return type</dt>
<dd class="field-even"><p>A Boolean value indicating success with True, False otherwise.</p>
</dd>
</dl>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.MomentTensor.removeMomentTensorStationContribution">
<code class="sig-name descname">removeMomentTensorStationContribution</code><span class="sig-paren">(</span><em class="sig-param">idx</em><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.MomentTensor.removeMomentTensorStationContribution" title="Permalink to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>idx</strong> An integer index of the object to be removed.</p>
</dd>
<dt class="field-even">Return type</dt>
<dd class="field-even"><p>A Boolean value indicating success with True, False otherwise.</p>
</dd>
</dl>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.MomentTensor.commentCount">
<code class="sig-name descname">commentCount</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.MomentTensor.commentCount" title="Permalink to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Return type</dt>
<dd class="field-odd"><p>integer value indicating the number of child objects.</p>
</dd>
</dl>
<p>Returns the number of Comment child objects.</p>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.MomentTensor.dataUsedCount">
<code class="sig-name descname">dataUsedCount</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.MomentTensor.dataUsedCount" title="Permalink to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Return type</dt>
<dd class="field-odd"><p>integer value indicating the number of child objects.</p>
</dd>
</dl>
<p>Returns the number of DataUsed child objects.</p>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.MomentTensor.momentTensorPhaseSettingCount">
<code class="sig-name descname">momentTensorPhaseSettingCount</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.MomentTensor.momentTensorPhaseSettingCount" title="Permalink to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Return type</dt>
<dd class="field-odd"><p>integer value indicating the number of child objects.</p>
</dd>
</dl>
<p>Returns the number of MomentTensorPhaseSetting child objects.</p>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.MomentTensor.momentTensorStationContributionCount">
<code class="sig-name descname">momentTensorStationContributionCount</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.MomentTensor.momentTensorStationContributionCount" title="Permalink to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Return type</dt>
<dd class="field-odd"><p>integer value indicating the number of child objects.</p>
</dd>
</dl>
<p>Returns the number of MomentTensorStationContribution child objects.</p>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.MomentTensor.comment">
<code class="sig-name descname">comment</code><span class="sig-paren">(</span><em class="sig-param">idx</em><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.MomentTensor.comment" title="Permalink to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>idx</strong> An integer index of the object to be returned.</p>
</dd>
<dt class="field-even">Return type</dt>
<dd class="field-even"><p>Object of type <a class="reference internal" href="#api-python-datamodel-comment"><span class="std std-ref">Comment</span></a>.</p>
</dd>
</dl>
<p>Returns the Comment at index idx.</p>
</dd></dl>
<dl class="method">
<dt>
<code class="sig-name descname">comment</code><span class="sig-paren">(</span><em class="sig-param">commentIndex</em><span class="sig-paren">)</span></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>commentIndex</strong> The index of the object to be removed of type CommentIndex.</p>
</dd>
<dt class="field-even">Return type</dt>
<dd class="field-even"><p>Object of type <a class="reference internal" href="#api-python-datamodel-comment"><span class="std std-ref">Comment</span></a>.</p>
</dd>
</dl>
<p>Returns the Comment at given index. The indexes of all child objects
are compared by value which makes this function slower than the direct
integer index look-up.</p>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.MomentTensor.dataUsed">
<code class="sig-name descname">dataUsed</code><span class="sig-paren">(</span><em class="sig-param">idx</em><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.MomentTensor.dataUsed" title="Permalink to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>idx</strong> An integer index of the object to be returned.</p>
</dd>
<dt class="field-even">Return type</dt>
<dd class="field-even"><p>Object of type <a class="reference internal" href="#api-python-datamodel-dataused"><span class="std std-ref">DataUsed</span></a>.</p>
</dd>
</dl>
<p>Returns the DataUsed at index idx.</p>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.MomentTensor.momentTensorPhaseSetting">
<code class="sig-name descname">momentTensorPhaseSetting</code><span class="sig-paren">(</span><em class="sig-param">idx</em><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.MomentTensor.momentTensorPhaseSetting" title="Permalink to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>idx</strong> An integer index of the object to be returned.</p>
</dd>
<dt class="field-even">Return type</dt>
<dd class="field-even"><p>Object of type <a class="reference internal" href="#api-python-datamodel-momenttensorphasesetting"><span class="std std-ref">MomentTensorPhaseSetting</span></a>.</p>
</dd>
</dl>
<p>Returns the MomentTensorPhaseSetting at index idx.</p>
</dd></dl>
<dl class="method">
<dt>
<code class="sig-name descname">momentTensorPhaseSetting</code><span class="sig-paren">(</span><em class="sig-param">momentTensorPhaseSettingIndex</em><span class="sig-paren">)</span></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>momentTensorPhaseSettingIndex</strong> The index of the object to be removed of type MomentTensorPhaseSettingIndex.</p>
</dd>
<dt class="field-even">Return type</dt>
<dd class="field-even"><p>Object of type <a class="reference internal" href="#api-python-datamodel-momenttensorphasesetting"><span class="std std-ref">MomentTensorPhaseSetting</span></a>.</p>
</dd>
</dl>
<p>Returns the MomentTensorPhaseSetting at given index. The indexes of all child objects
are compared by value which makes this function slower than the direct
integer index look-up.</p>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.MomentTensor.momentTensorStationContribution">
<code class="sig-name descname">momentTensorStationContribution</code><span class="sig-paren">(</span><em class="sig-param">idx</em><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.MomentTensor.momentTensorStationContribution" title="Permalink to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>idx</strong> An integer index of the object to be returned.</p>
</dd>
<dt class="field-even">Return type</dt>
<dd class="field-even"><p>Object of type <a class="reference internal" href="#api-python-datamodel-momenttensorstationcontribution"><span class="std std-ref">MomentTensorStationContribution</span></a>.</p>
</dd>
</dl>
<p>Returns the MomentTensorStationContribution at index idx.</p>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.MomentTensor.findDataUsed">
<code class="sig-name descname">findDataUsed</code><span class="sig-paren">(</span><em class="sig-param">dataUsed</em><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.MomentTensor.findDataUsed" title="Permalink to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>dataUsed</strong> Reference object of type <a class="reference internal" href="#api-python-datamodel-dataused"><span class="std std-ref">DataUsed</span></a>.</p>
</dd>
<dt class="field-even">Return type</dt>
<dd class="field-even"><p>Object of type <a class="reference internal" href="#api-python-datamodel-dataused"><span class="std std-ref">DataUsed</span></a>.</p>
</dd>
</dl>
<p>Returns the child object with equals the passed object, None otherwise.</p>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.MomentTensor.findMomentTensorStationContribution">
<code class="sig-name descname">findMomentTensorStationContribution</code><span class="sig-paren">(</span><em class="sig-param">publicID</em><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.MomentTensor.findMomentTensorStationContribution" title="Permalink to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>publicID</strong> The publicID of the object to find.</p>
</dd>
<dt class="field-even">Return type</dt>
<dd class="field-even"><p>Object of type <a class="reference internal" href="#api-python-datamodel-momenttensorstationcontribution"><span class="std std-ref">MomentTensorStationContribution</span></a>.</p>
</dd>
</dl>
<p>Returns the child object with a certain publicID, None otherwise.</p>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.MomentTensor.focalMechanism">
<code class="sig-name descname">focalMechanism</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.MomentTensor.focalMechanism" title="Permalink to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Return type</dt>
<dd class="field-odd"><p><a class="reference internal" href="#seiscomp.datamodel.FocalMechanism" title="seiscomp.datamodel.FocalMechanism">FocalMechanism</a></p>
</dd>
</dl>
<p>Returns the parent FocalMechanism if available. Returns None
if the parent is not a FocalMechanism. This is a convenience wrapper
for parent().</p>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.MomentTensor.assign">
<code class="sig-name descname">assign</code><span class="sig-paren">(</span><em class="sig-param">other</em><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.MomentTensor.assign" title="Permalink to this definition"></a></dt>
<dd><p>This method implements the <a class="reference internal" href="#api-python-datamodel-object"><span class="std std-ref">Object</span></a> interface.</p>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.MomentTensor.attachTo">
<code class="sig-name descname">attachTo</code><span class="sig-paren">(</span><em class="sig-param">parent</em><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.MomentTensor.attachTo" title="Permalink to this definition"></a></dt>
<dd><p>This method implements the <a class="reference internal" href="#api-python-datamodel-object"><span class="std std-ref">Object</span></a> interface.</p>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.MomentTensor.detachFrom">
<code class="sig-name descname">detachFrom</code><span class="sig-paren">(</span><em class="sig-param">parent</em><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.MomentTensor.detachFrom" title="Permalink to this definition"></a></dt>
<dd><p>This method implements the <a class="reference internal" href="#api-python-datamodel-object"><span class="std std-ref">Object</span></a> interface.</p>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.MomentTensor.detach">
<code class="sig-name descname">detach</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.MomentTensor.detach" title="Permalink to this definition"></a></dt>
<dd><p>This method implements the <a class="reference internal" href="#api-python-datamodel-object"><span class="std std-ref">Object</span></a> interface.</p>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.MomentTensor.clone">
<code class="sig-name descname">clone</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.MomentTensor.clone" title="Permalink to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Return type</dt>
<dd class="field-odd"><p>A cloned MomentTensor.</p>
</dd>
</dl>
<p>Returns a new instance that is a clone of the current instance. Child
objects are being ignored.</p>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.MomentTensor.updateChild">
<code class="sig-name descname">updateChild</code><span class="sig-paren">(</span><em class="sig-param">ref</em><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.MomentTensor.updateChild" title="Permalink to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>ref</strong> A child object derived from class Object.</p>
</dd>
<dt class="field-even">Return type</dt>
<dd class="field-even"><p>A Boolean flag indicating success with True, False otherwise</p>
</dd>
</dl>
<p>This method takes the passed reference object and searches for a child
with the same publicID (if derived from <a class="reference internal" href="#api-python-datamodel-publicobject"><span class="std std-ref">PublicObject</span></a>)
or the same index (if derived from <a class="reference internal" href="#api-python-datamodel-object"><span class="std std-ref">Object</span></a>).
The the child was found the reference objects attributes are copied to
the child object. Children of child are being ignored during this operation.
This method implements the <a class="reference internal" href="#api-python-datamodel-publicobject"><span class="std std-ref">PublicObject</span></a> interface.</p>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.MomentTensor.accept">
<code class="sig-name descname">accept</code><span class="sig-paren">(</span><em class="sig-param">visitor</em><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.MomentTensor.accept" title="Permalink to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>visitor</strong> A visitor.</p>
</dd>
</dl>
<p>This method implements the <a class="reference internal" href="#api-python-datamodel-publicobject"><span class="std std-ref">PublicObject</span></a> interface.</p>
</dd></dl>
</dd></dl>
</div>
<div class="section" id="momenttensorcomponentcontribution">
<span id="api-python-datamodel-momenttensorcomponentcontribution"></span><h3>MomentTensorComponentContribution<a class="headerlink" href="#momenttensorcomponentcontribution" title="Permalink to this headline"></a></h3>
<dl class="class">
<dt id="seiscomp.datamodel.MomentTensorComponentContribution">
<em class="property">class </em><code class="sig-prename descclassname">seiscomp.datamodel.</code><code class="sig-name descname">MomentTensorComponentContribution</code><a class="headerlink" href="#seiscomp.datamodel.MomentTensorComponentContribution" title="Permalink to this definition"></a></dt>
<dd><p>Inherits <a class="reference internal" href="#api-python-datamodel-object"><span class="std std-ref">Object</span></a>.</p>
<p><strong>Parents</strong>:</p>
<ul class="simple">
<li><p><code class="docutils literal notranslate"><span class="pre">momentTensorStationContribution</span></code> <a class="reference internal" href="#api-python-datamodel-momenttensorstationcontribution"><span class="std std-ref">MomentTensorStationContribution</span></a></p></li>
</ul>
<p><strong>Attributes</strong>:</p>
<ul class="simple">
<li><p><code class="docutils literal notranslate"><span class="pre">phaseCode</span></code> string</p></li>
<li><p><code class="docutils literal notranslate"><span class="pre">component</span></code> int</p></li>
<li><p><code class="docutils literal notranslate"><span class="pre">active</span></code> boolean</p></li>
<li><p><code class="docutils literal notranslate"><span class="pre">weight</span></code> float</p></li>
<li><p><code class="docutils literal notranslate"><span class="pre">timeShift</span></code> float</p></li>
<li><p><code class="docutils literal notranslate"><span class="pre">dataTimeWindow</span></code> float</p></li>
<li><p><code class="docutils literal notranslate"><span class="pre">misfit</span></code> float (optional)</p></li>
<li><p><code class="docutils literal notranslate"><span class="pre">snr</span></code> float (optional)</p></li>
</ul>
<p><strong>Methods</strong>:</p>
<dl class="method">
<dt id="seiscomp.datamodel.MomentTensorComponentContribution.Cast">
<em class="property">static </em><code class="sig-name descname">Cast</code><span class="sig-paren">(</span><em class="sig-param">obj</em><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.MomentTensorComponentContribution.Cast" title="Permalink to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>obj</strong> The object to be casted.</p>
</dd>
<dt class="field-even">Return type</dt>
<dd class="field-even"><p>An object of type MomentTensorComponentContribution if the cast was successful,
None otherwise.</p>
</dd>
</dl>
<p>Cast an arbitrary object to MomentTensorComponentContribution if the internal wrapped
representation is an MomentTensorComponentContribution object. The cast is important if
instances of type <a class="reference internal" href="#api-python-datamodel-object"><span class="std std-ref">Object</span></a>
are passed to methods which need access to the real type.</p>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.MomentTensorComponentContribution.equal">
<code class="sig-name descname">equal</code><span class="sig-paren">(</span><em class="sig-param">other</em><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.MomentTensorComponentContribution.equal" title="Permalink to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>other</strong> Another object of type MomentTensorComponentContribution to compare this
instance to</p>
</dd>
<dt class="field-even">Return type</dt>
<dd class="field-even"><p>A Boolean value indicating True if both objects are equal or
False otherwise.</p>
</dd>
</dl>
<p>Compares two objects without its child objects. Both objects are compared
by value.</p>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.MomentTensorComponentContribution.index">
<code class="sig-name descname">index</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.MomentTensorComponentContribution.index" title="Permalink to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Return type</dt>
<dd class="field-odd"><p><p>The objects index of type MomentTensorComponentContributionIndex.</p>
<p>Returns the objects index which is also used for the database as unique
constraint.</p>
</p>
</dd>
</dl>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.MomentTensorComponentContribution.equalIndex">
<code class="sig-name descname">equalIndex</code><span class="sig-paren">(</span><em class="sig-param">lhs</em><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.MomentTensorComponentContribution.equalIndex" title="Permalink to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>lhs</strong> <a class="reference internal" href="#api-python-datamodel-momenttensorcomponentcontribution"><span class="std std-ref">MomentTensorComponentContribution</span></a></p>
</dd>
<dt class="field-even">Return type</dt>
<dd class="field-even"><p>A Boolean value indicating True if both indexes are equal or
False otherwise.</p>
</dd>
</dl>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.MomentTensorComponentContribution.setPhaseCode">
<code class="sig-name descname">setPhaseCode</code><span class="sig-paren">(</span><em class="sig-param">phaseCode</em><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.MomentTensorComponentContribution.setPhaseCode" title="Permalink to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>phaseCode</strong> string</p>
</dd>
</dl>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.MomentTensorComponentContribution.phaseCode">
<code class="sig-name descname">phaseCode</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.MomentTensorComponentContribution.phaseCode" title="Permalink to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Return type</dt>
<dd class="field-odd"><p>string</p>
</dd>
</dl>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.MomentTensorComponentContribution.setComponent">
<code class="sig-name descname">setComponent</code><span class="sig-paren">(</span><em class="sig-param">component</em><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.MomentTensorComponentContribution.setComponent" title="Permalink to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>component</strong> int</p>
</dd>
</dl>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.MomentTensorComponentContribution.component">
<code class="sig-name descname">component</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.MomentTensorComponentContribution.component" title="Permalink to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Return type</dt>
<dd class="field-odd"><p>int</p>
</dd>
</dl>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.MomentTensorComponentContribution.setActive">
<code class="sig-name descname">setActive</code><span class="sig-paren">(</span><em class="sig-param">active</em><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.MomentTensorComponentContribution.setActive" title="Permalink to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>active</strong> boolean</p>
</dd>
</dl>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.MomentTensorComponentContribution.active">
<code class="sig-name descname">active</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.MomentTensorComponentContribution.active" title="Permalink to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Return type</dt>
<dd class="field-odd"><p>boolean</p>
</dd>
</dl>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.MomentTensorComponentContribution.setWeight">
<code class="sig-name descname">setWeight</code><span class="sig-paren">(</span><em class="sig-param">weight</em><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.MomentTensorComponentContribution.setWeight" title="Permalink to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>weight</strong> float</p>
</dd>
</dl>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.MomentTensorComponentContribution.weight">
<code class="sig-name descname">weight</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.MomentTensorComponentContribution.weight" title="Permalink to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Return type</dt>
<dd class="field-odd"><p>float</p>
</dd>
</dl>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.MomentTensorComponentContribution.setTimeShift">
<code class="sig-name descname">setTimeShift</code><span class="sig-paren">(</span><em class="sig-param">timeShift</em><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.MomentTensorComponentContribution.setTimeShift" title="Permalink to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>timeShift</strong> float</p>
</dd>
</dl>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.MomentTensorComponentContribution.timeShift">
<code class="sig-name descname">timeShift</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.MomentTensorComponentContribution.timeShift" title="Permalink to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Return type</dt>
<dd class="field-odd"><p>float</p>
</dd>
</dl>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.MomentTensorComponentContribution.setDataTimeWindow">
<code class="sig-name descname">setDataTimeWindow</code><span class="sig-paren">(</span><em class="sig-param">dataTimeWindow</em><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.MomentTensorComponentContribution.setDataTimeWindow" title="Permalink to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>dataTimeWindow</strong> float</p>
</dd>
</dl>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.MomentTensorComponentContribution.dataTimeWindow">
<code class="sig-name descname">dataTimeWindow</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.MomentTensorComponentContribution.dataTimeWindow" title="Permalink to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Return type</dt>
<dd class="field-odd"><p>float</p>
</dd>
</dl>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.MomentTensorComponentContribution.setMisfit">
<code class="sig-name descname">setMisfit</code><span class="sig-paren">(</span><em class="sig-param">misfit</em><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.MomentTensorComponentContribution.setMisfit" title="Permalink to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>misfit</strong> float</p>
</dd>
</dl>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.MomentTensorComponentContribution.misfit">
<code class="sig-name descname">misfit</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.MomentTensorComponentContribution.misfit" title="Permalink to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Return type</dt>
<dd class="field-odd"><p>float</p>
</dd>
</dl>
<div class="admonition note">
<p class="admonition-title">Note</p>
<p>As this attribute is optional, this method throws a ValueError if
the value of the attribute is not set.</p>
</div>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.MomentTensorComponentContribution.setSnr">
<code class="sig-name descname">setSnr</code><span class="sig-paren">(</span><em class="sig-param">snr</em><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.MomentTensorComponentContribution.setSnr" title="Permalink to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>snr</strong> float</p>
</dd>
</dl>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.MomentTensorComponentContribution.snr">
<code class="sig-name descname">snr</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.MomentTensorComponentContribution.snr" title="Permalink to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Return type</dt>
<dd class="field-odd"><p>float</p>
</dd>
</dl>
<div class="admonition note">
<p class="admonition-title">Note</p>
<p>As this attribute is optional, this method throws a ValueError if
the value of the attribute is not set.</p>
</div>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.MomentTensorComponentContribution.momentTensorStationContribution">
<code class="sig-name descname">momentTensorStationContribution</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.MomentTensorComponentContribution.momentTensorStationContribution" title="Permalink to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Return type</dt>
<dd class="field-odd"><p><a class="reference internal" href="#seiscomp.datamodel.MomentTensorStationContribution" title="seiscomp.datamodel.MomentTensorStationContribution">MomentTensorStationContribution</a></p>
</dd>
</dl>
<p>Returns the parent MomentTensorStationContribution if available. Returns None
if the parent is not a MomentTensorStationContribution. This is a convenience wrapper
for parent().</p>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.MomentTensorComponentContribution.assign">
<code class="sig-name descname">assign</code><span class="sig-paren">(</span><em class="sig-param">other</em><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.MomentTensorComponentContribution.assign" title="Permalink to this definition"></a></dt>
<dd><p>This method implements the <a class="reference internal" href="#api-python-datamodel-object"><span class="std std-ref">Object</span></a> interface.</p>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.MomentTensorComponentContribution.attachTo">
<code class="sig-name descname">attachTo</code><span class="sig-paren">(</span><em class="sig-param">parent</em><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.MomentTensorComponentContribution.attachTo" title="Permalink to this definition"></a></dt>
<dd><p>This method implements the <a class="reference internal" href="#api-python-datamodel-object"><span class="std std-ref">Object</span></a> interface.</p>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.MomentTensorComponentContribution.detachFrom">
<code class="sig-name descname">detachFrom</code><span class="sig-paren">(</span><em class="sig-param">parent</em><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.MomentTensorComponentContribution.detachFrom" title="Permalink to this definition"></a></dt>
<dd><p>This method implements the <a class="reference internal" href="#api-python-datamodel-object"><span class="std std-ref">Object</span></a> interface.</p>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.MomentTensorComponentContribution.detach">
<code class="sig-name descname">detach</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.MomentTensorComponentContribution.detach" title="Permalink to this definition"></a></dt>
<dd><p>This method implements the <a class="reference internal" href="#api-python-datamodel-object"><span class="std std-ref">Object</span></a> interface.</p>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.MomentTensorComponentContribution.clone">
<code class="sig-name descname">clone</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.MomentTensorComponentContribution.clone" title="Permalink to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Return type</dt>
<dd class="field-odd"><p>A cloned MomentTensorComponentContribution.</p>
</dd>
</dl>
<p>Returns a new instance that is a clone of the current instance. Child
objects are being ignored.</p>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.MomentTensorComponentContribution.accept">
<code class="sig-name descname">accept</code><span class="sig-paren">(</span><em class="sig-param">visitor</em><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.MomentTensorComponentContribution.accept" title="Permalink to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>visitor</strong> A visitor.</p>
</dd>
</dl>
<p>This method implements the <a class="reference internal" href="#api-python-datamodel-publicobject"><span class="std std-ref">PublicObject</span></a> interface.</p>
</dd></dl>
</dd></dl>
</div>
<div class="section" id="momenttensorphasesetting">
<span id="api-python-datamodel-momenttensorphasesetting"></span><h3>MomentTensorPhaseSetting<a class="headerlink" href="#momenttensorphasesetting" title="Permalink to this headline"></a></h3>
<dl class="class">
<dt id="seiscomp.datamodel.MomentTensorPhaseSetting">
<em class="property">class </em><code class="sig-prename descclassname">seiscomp.datamodel.</code><code class="sig-name descname">MomentTensorPhaseSetting</code><a class="headerlink" href="#seiscomp.datamodel.MomentTensorPhaseSetting" title="Permalink to this definition"></a></dt>
<dd><p>Inherits <a class="reference internal" href="#api-python-datamodel-object"><span class="std std-ref">Object</span></a>.</p>
<p><strong>Parents</strong>:</p>
<ul class="simple">
<li><p><code class="docutils literal notranslate"><span class="pre">momentTensor</span></code> <a class="reference internal" href="#api-python-datamodel-momenttensor"><span class="std std-ref">MomentTensor</span></a></p></li>
</ul>
<p><strong>Attributes</strong>:</p>
<ul class="simple">
<li><p><code class="docutils literal notranslate"><span class="pre">code</span></code> string</p></li>
<li><p><code class="docutils literal notranslate"><span class="pre">lowerPeriod</span></code> float</p></li>
<li><p><code class="docutils literal notranslate"><span class="pre">upperPeriod</span></code> float</p></li>
<li><p><code class="docutils literal notranslate"><span class="pre">minimumSNR</span></code> float (optional)</p></li>
<li><p><code class="docutils literal notranslate"><span class="pre">maximumTimeShift</span></code> float (optional)</p></li>
</ul>
<p><strong>Methods</strong>:</p>
<dl class="method">
<dt id="seiscomp.datamodel.MomentTensorPhaseSetting.Cast">
<em class="property">static </em><code class="sig-name descname">Cast</code><span class="sig-paren">(</span><em class="sig-param">obj</em><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.MomentTensorPhaseSetting.Cast" title="Permalink to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>obj</strong> The object to be casted.</p>
</dd>
<dt class="field-even">Return type</dt>
<dd class="field-even"><p>An object of type MomentTensorPhaseSetting if the cast was successful,
None otherwise.</p>
</dd>
</dl>
<p>Cast an arbitrary object to MomentTensorPhaseSetting if the internal wrapped
representation is an MomentTensorPhaseSetting object. The cast is important if
instances of type <a class="reference internal" href="#api-python-datamodel-object"><span class="std std-ref">Object</span></a>
are passed to methods which need access to the real type.</p>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.MomentTensorPhaseSetting.equal">
<code class="sig-name descname">equal</code><span class="sig-paren">(</span><em class="sig-param">other</em><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.MomentTensorPhaseSetting.equal" title="Permalink to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>other</strong> Another object of type MomentTensorPhaseSetting to compare this
instance to</p>
</dd>
<dt class="field-even">Return type</dt>
<dd class="field-even"><p>A Boolean value indicating True if both objects are equal or
False otherwise.</p>
</dd>
</dl>
<p>Compares two objects without its child objects. Both objects are compared
by value.</p>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.MomentTensorPhaseSetting.index">
<code class="sig-name descname">index</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.MomentTensorPhaseSetting.index" title="Permalink to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Return type</dt>
<dd class="field-odd"><p><p>The objects index of type MomentTensorPhaseSettingIndex.</p>
<p>Returns the objects index which is also used for the database as unique
constraint.</p>
</p>
</dd>
</dl>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.MomentTensorPhaseSetting.equalIndex">
<code class="sig-name descname">equalIndex</code><span class="sig-paren">(</span><em class="sig-param">lhs</em><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.MomentTensorPhaseSetting.equalIndex" title="Permalink to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>lhs</strong> <a class="reference internal" href="#api-python-datamodel-momenttensorphasesetting"><span class="std std-ref">MomentTensorPhaseSetting</span></a></p>
</dd>
<dt class="field-even">Return type</dt>
<dd class="field-even"><p>A Boolean value indicating True if both indexes are equal or
False otherwise.</p>
</dd>
</dl>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.MomentTensorPhaseSetting.setCode">
<code class="sig-name descname">setCode</code><span class="sig-paren">(</span><em class="sig-param">code</em><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.MomentTensorPhaseSetting.setCode" title="Permalink to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>code</strong> string</p>
</dd>
</dl>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.MomentTensorPhaseSetting.code">
<code class="sig-name descname">code</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.MomentTensorPhaseSetting.code" title="Permalink to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Return type</dt>
<dd class="field-odd"><p>string</p>
</dd>
</dl>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.MomentTensorPhaseSetting.setLowerPeriod">
<code class="sig-name descname">setLowerPeriod</code><span class="sig-paren">(</span><em class="sig-param">lowerPeriod</em><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.MomentTensorPhaseSetting.setLowerPeriod" title="Permalink to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>lowerPeriod</strong> float</p>
</dd>
</dl>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.MomentTensorPhaseSetting.lowerPeriod">
<code class="sig-name descname">lowerPeriod</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.MomentTensorPhaseSetting.lowerPeriod" title="Permalink to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Return type</dt>
<dd class="field-odd"><p>float</p>
</dd>
</dl>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.MomentTensorPhaseSetting.setUpperPeriod">
<code class="sig-name descname">setUpperPeriod</code><span class="sig-paren">(</span><em class="sig-param">upperPeriod</em><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.MomentTensorPhaseSetting.setUpperPeriod" title="Permalink to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>upperPeriod</strong> float</p>
</dd>
</dl>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.MomentTensorPhaseSetting.upperPeriod">
<code class="sig-name descname">upperPeriod</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.MomentTensorPhaseSetting.upperPeriod" title="Permalink to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Return type</dt>
<dd class="field-odd"><p>float</p>
</dd>
</dl>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.MomentTensorPhaseSetting.setMinimumSNR">
<code class="sig-name descname">setMinimumSNR</code><span class="sig-paren">(</span><em class="sig-param">minimumSNR</em><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.MomentTensorPhaseSetting.setMinimumSNR" title="Permalink to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>minimumSNR</strong> float</p>
</dd>
</dl>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.MomentTensorPhaseSetting.minimumSNR">
<code class="sig-name descname">minimumSNR</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.MomentTensorPhaseSetting.minimumSNR" title="Permalink to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Return type</dt>
<dd class="field-odd"><p>float</p>
</dd>
</dl>
<div class="admonition note">
<p class="admonition-title">Note</p>
<p>As this attribute is optional, this method throws a ValueError if
the value of the attribute is not set.</p>
</div>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.MomentTensorPhaseSetting.setMaximumTimeShift">
<code class="sig-name descname">setMaximumTimeShift</code><span class="sig-paren">(</span><em class="sig-param">maximumTimeShift</em><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.MomentTensorPhaseSetting.setMaximumTimeShift" title="Permalink to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>maximumTimeShift</strong> float</p>
</dd>
</dl>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.MomentTensorPhaseSetting.maximumTimeShift">
<code class="sig-name descname">maximumTimeShift</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.MomentTensorPhaseSetting.maximumTimeShift" title="Permalink to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Return type</dt>
<dd class="field-odd"><p>float</p>
</dd>
</dl>
<div class="admonition note">
<p class="admonition-title">Note</p>
<p>As this attribute is optional, this method throws a ValueError if
the value of the attribute is not set.</p>
</div>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.MomentTensorPhaseSetting.momentTensor">
<code class="sig-name descname">momentTensor</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.MomentTensorPhaseSetting.momentTensor" title="Permalink to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Return type</dt>
<dd class="field-odd"><p><a class="reference internal" href="#seiscomp.datamodel.MomentTensor" title="seiscomp.datamodel.MomentTensor">MomentTensor</a></p>
</dd>
</dl>
<p>Returns the parent MomentTensor if available. Returns None
if the parent is not a MomentTensor. This is a convenience wrapper
for parent().</p>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.MomentTensorPhaseSetting.assign">
<code class="sig-name descname">assign</code><span class="sig-paren">(</span><em class="sig-param">other</em><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.MomentTensorPhaseSetting.assign" title="Permalink to this definition"></a></dt>
<dd><p>This method implements the <a class="reference internal" href="#api-python-datamodel-object"><span class="std std-ref">Object</span></a> interface.</p>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.MomentTensorPhaseSetting.attachTo">
<code class="sig-name descname">attachTo</code><span class="sig-paren">(</span><em class="sig-param">parent</em><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.MomentTensorPhaseSetting.attachTo" title="Permalink to this definition"></a></dt>
<dd><p>This method implements the <a class="reference internal" href="#api-python-datamodel-object"><span class="std std-ref">Object</span></a> interface.</p>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.MomentTensorPhaseSetting.detachFrom">
<code class="sig-name descname">detachFrom</code><span class="sig-paren">(</span><em class="sig-param">parent</em><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.MomentTensorPhaseSetting.detachFrom" title="Permalink to this definition"></a></dt>
<dd><p>This method implements the <a class="reference internal" href="#api-python-datamodel-object"><span class="std std-ref">Object</span></a> interface.</p>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.MomentTensorPhaseSetting.detach">
<code class="sig-name descname">detach</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.MomentTensorPhaseSetting.detach" title="Permalink to this definition"></a></dt>
<dd><p>This method implements the <a class="reference internal" href="#api-python-datamodel-object"><span class="std std-ref">Object</span></a> interface.</p>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.MomentTensorPhaseSetting.clone">
<code class="sig-name descname">clone</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.MomentTensorPhaseSetting.clone" title="Permalink to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Return type</dt>
<dd class="field-odd"><p>A cloned MomentTensorPhaseSetting.</p>
</dd>
</dl>
<p>Returns a new instance that is a clone of the current instance. Child
objects are being ignored.</p>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.MomentTensorPhaseSetting.accept">
<code class="sig-name descname">accept</code><span class="sig-paren">(</span><em class="sig-param">visitor</em><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.MomentTensorPhaseSetting.accept" title="Permalink to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>visitor</strong> A visitor.</p>
</dd>
</dl>
<p>This method implements the <a class="reference internal" href="#api-python-datamodel-publicobject"><span class="std std-ref">PublicObject</span></a> interface.</p>
</dd></dl>
</dd></dl>
</div>
<div class="section" id="momenttensorstationcontribution">
<span id="api-python-datamodel-momenttensorstationcontribution"></span><h3>MomentTensorStationContribution<a class="headerlink" href="#momenttensorstationcontribution" title="Permalink to this headline"></a></h3>
<dl class="class">
<dt id="seiscomp.datamodel.MomentTensorStationContribution">
<em class="property">class </em><code class="sig-prename descclassname">seiscomp.datamodel.</code><code class="sig-name descname">MomentTensorStationContribution</code><a class="headerlink" href="#seiscomp.datamodel.MomentTensorStationContribution" title="Permalink to this definition"></a></dt>
<dd><p>Inherits <a class="reference internal" href="#api-python-datamodel-publicobject"><span class="std std-ref">PublicObject</span></a>.</p>
<p><strong>Parents</strong>:</p>
<ul class="simple">
<li><p><code class="docutils literal notranslate"><span class="pre">momentTensor</span></code> <a class="reference internal" href="#api-python-datamodel-momenttensor"><span class="std std-ref">MomentTensor</span></a></p></li>
</ul>
<p><strong>Children</strong>:</p>
<ul class="simple">
<li><p><code class="docutils literal notranslate"><span class="pre">momentTensorComponentContribution</span></code> <a class="reference internal" href="#api-python-datamodel-momenttensorcomponentcontribution"><span class="std std-ref">MomentTensorComponentContribution</span></a></p></li>
</ul>
<p><strong>Attributes</strong>:</p>
<ul class="simple">
<li><p><code class="docutils literal notranslate"><span class="pre">publicID</span></code>: string</p></li>
<li><p><code class="docutils literal notranslate"><span class="pre">active</span></code> boolean</p></li>
<li><p><code class="docutils literal notranslate"><span class="pre">waveformID</span></code> <a class="reference internal" href="#api-python-datamodel-waveformstreamid"><span class="std std-ref">WaveformStreamID</span></a> (optional)</p></li>
<li><p><code class="docutils literal notranslate"><span class="pre">weight</span></code> float (optional)</p></li>
<li><p><code class="docutils literal notranslate"><span class="pre">timeShift</span></code> float (optional)</p></li>
</ul>
<p><strong>Methods</strong>:</p>
<dl class="method">
<dt id="seiscomp.datamodel.MomentTensorStationContribution.Cast">
<em class="property">static </em><code class="sig-name descname">Cast</code><span class="sig-paren">(</span><em class="sig-param">obj</em><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.MomentTensorStationContribution.Cast" title="Permalink to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>obj</strong> The object to be casted.</p>
</dd>
<dt class="field-even">Return type</dt>
<dd class="field-even"><p>An object of type MomentTensorStationContribution if the cast was successful,
None otherwise.</p>
</dd>
</dl>
<p>Cast an arbitrary object to MomentTensorStationContribution if the internal wrapped
representation is an MomentTensorStationContribution object. The cast is important if
instances of type <a class="reference internal" href="#api-python-datamodel-object"><span class="std std-ref">Object</span></a>
are passed to methods which need access to the real type.</p>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.MomentTensorStationContribution.Create">
<em class="property">static </em><code class="sig-name descname">Create</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.MomentTensorStationContribution.Create" title="Permalink to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Return type</dt>
<dd class="field-odd"><p>A new object of type MomentTensorStationContribution.</p>
</dd>
</dl>
<p>Creates and registers (if enabled) a MomentTensorStationContribution instance. The
publicID is auto-generated.</p>
</dd></dl>
<dl class="method">
<dt>
<em class="property">static </em><code class="sig-name descname">Create</code><span class="sig-paren">(</span><em class="sig-param">publicID</em><span class="sig-paren">)</span></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Return type</dt>
<dd class="field-odd"><p>A new object of type MomentTensorStationContribution.</p>
</dd>
</dl>
<p>Creates and registers (if enabled) a MomentTensorStationContribution instance with
passed publicID.</p>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.MomentTensorStationContribution.equal">
<code class="sig-name descname">equal</code><span class="sig-paren">(</span><em class="sig-param">other</em><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.MomentTensorStationContribution.equal" title="Permalink to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>other</strong> Another object of type MomentTensorStationContribution to compare this
instance to</p>
</dd>
<dt class="field-even">Return type</dt>
<dd class="field-even"><p>A Boolean value indicating True if both objects are equal or
False otherwise.</p>
</dd>
</dl>
<p>Compares two objects without its child objects. Both objects are compared
by value.</p>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.MomentTensorStationContribution.setActive">
<code class="sig-name descname">setActive</code><span class="sig-paren">(</span><em class="sig-param">active</em><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.MomentTensorStationContribution.setActive" title="Permalink to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>active</strong> boolean</p>
</dd>
</dl>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.MomentTensorStationContribution.active">
<code class="sig-name descname">active</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.MomentTensorStationContribution.active" title="Permalink to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Return type</dt>
<dd class="field-odd"><p>boolean</p>
</dd>
</dl>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.MomentTensorStationContribution.setWaveformID">
<code class="sig-name descname">setWaveformID</code><span class="sig-paren">(</span><em class="sig-param">waveformID</em><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.MomentTensorStationContribution.setWaveformID" title="Permalink to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>waveformID</strong> <a class="reference internal" href="#api-python-datamodel-waveformstreamid"><span class="std std-ref">WaveformStreamID</span></a></p>
</dd>
</dl>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.MomentTensorStationContribution.waveformID">
<code class="sig-name descname">waveformID</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.MomentTensorStationContribution.waveformID" title="Permalink to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Return type</dt>
<dd class="field-odd"><p><a class="reference internal" href="#api-python-datamodel-waveformstreamid"><span class="std std-ref">WaveformStreamID</span></a></p>
</dd>
</dl>
<div class="admonition note">
<p class="admonition-title">Note</p>
<p>As this attribute is optional, this method throws a ValueError if
the value of the attribute is not set.</p>
</div>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.MomentTensorStationContribution.setWeight">
<code class="sig-name descname">setWeight</code><span class="sig-paren">(</span><em class="sig-param">weight</em><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.MomentTensorStationContribution.setWeight" title="Permalink to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>weight</strong> float</p>
</dd>
</dl>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.MomentTensorStationContribution.weight">
<code class="sig-name descname">weight</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.MomentTensorStationContribution.weight" title="Permalink to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Return type</dt>
<dd class="field-odd"><p>float</p>
</dd>
</dl>
<div class="admonition note">
<p class="admonition-title">Note</p>
<p>As this attribute is optional, this method throws a ValueError if
the value of the attribute is not set.</p>
</div>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.MomentTensorStationContribution.setTimeShift">
<code class="sig-name descname">setTimeShift</code><span class="sig-paren">(</span><em class="sig-param">timeShift</em><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.MomentTensorStationContribution.setTimeShift" title="Permalink to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>timeShift</strong> float</p>
</dd>
</dl>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.MomentTensorStationContribution.timeShift">
<code class="sig-name descname">timeShift</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.MomentTensorStationContribution.timeShift" title="Permalink to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Return type</dt>
<dd class="field-odd"><p>float</p>
</dd>
</dl>
<div class="admonition note">
<p class="admonition-title">Note</p>
<p>As this attribute is optional, this method throws a ValueError if
the value of the attribute is not set.</p>
</div>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.MomentTensorStationContribution.add">
<code class="sig-name descname">add</code><span class="sig-paren">(</span><em class="sig-param">momentTensorComponentContribution</em><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.MomentTensorStationContribution.add" title="Permalink to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>momentTensorComponentContribution</strong> Object of type <a class="reference internal" href="#api-python-datamodel-momenttensorcomponentcontribution"><span class="std std-ref">MomentTensorComponentContribution</span></a></p>
</dd>
<dt class="field-even">Return type</dt>
<dd class="field-even"><p>A Boolean value indicating success with True, False otherwise.</p>
</dd>
</dl>
<p>Adds a MomentTensorComponentContribution object to MomentTensorStationContribution. The object is not
copied but managed by this instance. Any change to the passed object
will also change the child.</p>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.MomentTensorStationContribution.remove">
<code class="sig-name descname">remove</code><span class="sig-paren">(</span><em class="sig-param">momentTensorComponentContribution</em><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.MomentTensorStationContribution.remove" title="Permalink to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>momentTensorComponentContribution</strong> Object of type <a class="reference internal" href="#api-python-datamodel-momenttensorcomponentcontribution"><span class="std std-ref">MomentTensorComponentContribution</span></a></p>
</dd>
<dt class="field-even">Return type</dt>
<dd class="field-even"><p>A Boolean value indicating success with True, False otherwise.</p>
</dd>
</dl>
<p>Removes a previously added MomentTensorComponentContribution object from MomentTensorStationContribution.</p>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.MomentTensorStationContribution.removeMomentTensorComponentContribution">
<code class="sig-name descname">removeMomentTensorComponentContribution</code><span class="sig-paren">(</span><em class="sig-param">idx</em><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.MomentTensorStationContribution.removeMomentTensorComponentContribution" title="Permalink to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>idx</strong> An integer index of the object to be removed.</p>
</dd>
<dt class="field-even">Return type</dt>
<dd class="field-even"><p>A Boolean value indicating success with True, False otherwise.</p>
</dd>
</dl>
</dd></dl>
<dl class="method">
<dt>
<code class="sig-name descname">removeMomentTensorComponentContribution(momentTensorComponentContributionIndex);</code></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>momentTensorComponentContributionIndex</strong> The index of the object to be removed of type MomentTensorComponentContributionIndex.</p>
</dd>
<dt class="field-even">Return type</dt>
<dd class="field-even"><p>A Boolean value indicating success with True, False otherwise.</p>
</dd>
</dl>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.MomentTensorStationContribution.momentTensorComponentContributionCount">
<code class="sig-name descname">momentTensorComponentContributionCount</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.MomentTensorStationContribution.momentTensorComponentContributionCount" title="Permalink to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Return type</dt>
<dd class="field-odd"><p>integer value indicating the number of child objects.</p>
</dd>
</dl>
<p>Returns the number of MomentTensorComponentContribution child objects.</p>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.MomentTensorStationContribution.momentTensorComponentContribution">
<code class="sig-name descname">momentTensorComponentContribution</code><span class="sig-paren">(</span><em class="sig-param">idx</em><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.MomentTensorStationContribution.momentTensorComponentContribution" title="Permalink to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>idx</strong> An integer index of the object to be returned.</p>
</dd>
<dt class="field-even">Return type</dt>
<dd class="field-even"><p>Object of type <a class="reference internal" href="#api-python-datamodel-momenttensorcomponentcontribution"><span class="std std-ref">MomentTensorComponentContribution</span></a>.</p>
</dd>
</dl>
<p>Returns the MomentTensorComponentContribution at index idx.</p>
</dd></dl>
<dl class="method">
<dt>
<code class="sig-name descname">momentTensorComponentContribution</code><span class="sig-paren">(</span><em class="sig-param">momentTensorComponentContributionIndex</em><span class="sig-paren">)</span></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>momentTensorComponentContributionIndex</strong> The index of the object to be removed of type MomentTensorComponentContributionIndex.</p>
</dd>
<dt class="field-even">Return type</dt>
<dd class="field-even"><p>Object of type <a class="reference internal" href="#api-python-datamodel-momenttensorcomponentcontribution"><span class="std std-ref">MomentTensorComponentContribution</span></a>.</p>
</dd>
</dl>
<p>Returns the MomentTensorComponentContribution at given index. The indexes of all child objects
are compared by value which makes this function slower than the direct
integer index look-up.</p>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.MomentTensorStationContribution.momentTensor">
<code class="sig-name descname">momentTensor</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.MomentTensorStationContribution.momentTensor" title="Permalink to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Return type</dt>
<dd class="field-odd"><p><a class="reference internal" href="#seiscomp.datamodel.MomentTensor" title="seiscomp.datamodel.MomentTensor">MomentTensor</a></p>
</dd>
</dl>
<p>Returns the parent MomentTensor if available. Returns None
if the parent is not a MomentTensor. This is a convenience wrapper
for parent().</p>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.MomentTensorStationContribution.assign">
<code class="sig-name descname">assign</code><span class="sig-paren">(</span><em class="sig-param">other</em><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.MomentTensorStationContribution.assign" title="Permalink to this definition"></a></dt>
<dd><p>This method implements the <a class="reference internal" href="#api-python-datamodel-object"><span class="std std-ref">Object</span></a> interface.</p>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.MomentTensorStationContribution.attachTo">
<code class="sig-name descname">attachTo</code><span class="sig-paren">(</span><em class="sig-param">parent</em><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.MomentTensorStationContribution.attachTo" title="Permalink to this definition"></a></dt>
<dd><p>This method implements the <a class="reference internal" href="#api-python-datamodel-object"><span class="std std-ref">Object</span></a> interface.</p>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.MomentTensorStationContribution.detachFrom">
<code class="sig-name descname">detachFrom</code><span class="sig-paren">(</span><em class="sig-param">parent</em><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.MomentTensorStationContribution.detachFrom" title="Permalink to this definition"></a></dt>
<dd><p>This method implements the <a class="reference internal" href="#api-python-datamodel-object"><span class="std std-ref">Object</span></a> interface.</p>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.MomentTensorStationContribution.detach">
<code class="sig-name descname">detach</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.MomentTensorStationContribution.detach" title="Permalink to this definition"></a></dt>
<dd><p>This method implements the <a class="reference internal" href="#api-python-datamodel-object"><span class="std std-ref">Object</span></a> interface.</p>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.MomentTensorStationContribution.clone">
<code class="sig-name descname">clone</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.MomentTensorStationContribution.clone" title="Permalink to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Return type</dt>
<dd class="field-odd"><p>A cloned MomentTensorStationContribution.</p>
</dd>
</dl>
<p>Returns a new instance that is a clone of the current instance. Child
objects are being ignored.</p>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.MomentTensorStationContribution.updateChild">
<code class="sig-name descname">updateChild</code><span class="sig-paren">(</span><em class="sig-param">ref</em><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.MomentTensorStationContribution.updateChild" title="Permalink to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>ref</strong> A child object derived from class Object.</p>
</dd>
<dt class="field-even">Return type</dt>
<dd class="field-even"><p>A Boolean flag indicating success with True, False otherwise</p>
</dd>
</dl>
<p>This method takes the passed reference object and searches for a child
with the same publicID (if derived from <a class="reference internal" href="#api-python-datamodel-publicobject"><span class="std std-ref">PublicObject</span></a>)
or the same index (if derived from <a class="reference internal" href="#api-python-datamodel-object"><span class="std std-ref">Object</span></a>).
The the child was found the reference objects attributes are copied to
the child object. Children of child are being ignored during this operation.
This method implements the <a class="reference internal" href="#api-python-datamodel-publicobject"><span class="std std-ref">PublicObject</span></a> interface.</p>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.MomentTensorStationContribution.accept">
<code class="sig-name descname">accept</code><span class="sig-paren">(</span><em class="sig-param">visitor</em><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.MomentTensorStationContribution.accept" title="Permalink to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>visitor</strong> A visitor.</p>
</dd>
</dl>
<p>This method implements the <a class="reference internal" href="#api-python-datamodel-publicobject"><span class="std std-ref">PublicObject</span></a> interface.</p>
</dd></dl>
</dd></dl>
</div>
<div class="section" id="network">
<span id="api-python-datamodel-network"></span><h3>Network<a class="headerlink" href="#network" title="Permalink to this headline"></a></h3>
<dl class="class">
<dt id="seiscomp.datamodel.Network">
<em class="property">class </em><code class="sig-prename descclassname">seiscomp.datamodel.</code><code class="sig-name descname">Network</code><a class="headerlink" href="#seiscomp.datamodel.Network" title="Permalink to this definition"></a></dt>
<dd><p>Inherits <a class="reference internal" href="#api-python-datamodel-publicobject"><span class="std std-ref">PublicObject</span></a>.</p>
<p>This type describes a network of seismic stations</p>
<p><strong>Parents</strong>:</p>
<ul class="simple">
<li><p><code class="docutils literal notranslate"><span class="pre">inventory</span></code> <a class="reference internal" href="#api-python-datamodel-inventory"><span class="std std-ref">Inventory</span></a></p></li>
</ul>
<p><strong>Children</strong>:</p>
<ul class="simple">
<li><p><code class="docutils literal notranslate"><span class="pre">comment</span></code> <a class="reference internal" href="#api-python-datamodel-comment"><span class="std std-ref">Comment</span></a></p></li>
<li><p><code class="docutils literal notranslate"><span class="pre">station</span></code> <a class="reference internal" href="#api-python-datamodel-station"><span class="std std-ref">Station</span></a></p></li>
</ul>
<p><strong>Attributes</strong>:</p>
<ul class="simple">
<li><p><code class="docutils literal notranslate"><span class="pre">publicID</span></code>: string</p></li>
<li><p><code class="docutils literal notranslate"><span class="pre">code</span></code> string</p></li>
<li><p><code class="docutils literal notranslate"><span class="pre">start</span></code> seiscomp.core.Time</p></li>
<li><p><code class="docutils literal notranslate"><span class="pre">end</span></code> seiscomp.core.Time (optional)</p></li>
<li><p><code class="docutils literal notranslate"><span class="pre">description</span></code> string</p></li>
<li><p><code class="docutils literal notranslate"><span class="pre">institutions</span></code> string</p></li>
<li><p><code class="docutils literal notranslate"><span class="pre">region</span></code> string</p></li>
<li><p><code class="docutils literal notranslate"><span class="pre">type</span></code> string</p></li>
<li><p><code class="docutils literal notranslate"><span class="pre">netClass</span></code> string</p></li>
<li><p><code class="docutils literal notranslate"><span class="pre">archive</span></code> string</p></li>
<li><p><code class="docutils literal notranslate"><span class="pre">restricted</span></code> boolean (optional)</p></li>
<li><p><code class="docutils literal notranslate"><span class="pre">shared</span></code> boolean (optional)</p></li>
<li><p><code class="docutils literal notranslate"><span class="pre">remark</span></code> <a class="reference internal" href="#api-python-datamodel-blob"><span class="std std-ref">Blob</span></a> (optional)</p></li>
</ul>
<p><strong>Methods</strong>:</p>
<dl class="method">
<dt id="seiscomp.datamodel.Network.Cast">
<em class="property">static </em><code class="sig-name descname">Cast</code><span class="sig-paren">(</span><em class="sig-param">obj</em><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.Network.Cast" title="Permalink to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>obj</strong> The object to be casted.</p>
</dd>
<dt class="field-even">Return type</dt>
<dd class="field-even"><p>An object of type Network if the cast was successful,
None otherwise.</p>
</dd>
</dl>
<p>Cast an arbitrary object to Network if the internal wrapped
representation is an Network object. The cast is important if
instances of type <a class="reference internal" href="#api-python-datamodel-object"><span class="std std-ref">Object</span></a>
are passed to methods which need access to the real type.</p>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.Network.Create">
<em class="property">static </em><code class="sig-name descname">Create</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.Network.Create" title="Permalink to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Return type</dt>
<dd class="field-odd"><p>A new object of type Network.</p>
</dd>
</dl>
<p>Creates and registers (if enabled) a Network instance. The
publicID is auto-generated.</p>
</dd></dl>
<dl class="method">
<dt>
<em class="property">static </em><code class="sig-name descname">Create</code><span class="sig-paren">(</span><em class="sig-param">publicID</em><span class="sig-paren">)</span></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Return type</dt>
<dd class="field-odd"><p>A new object of type Network.</p>
</dd>
</dl>
<p>Creates and registers (if enabled) a Network instance with
passed publicID.</p>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.Network.equal">
<code class="sig-name descname">equal</code><span class="sig-paren">(</span><em class="sig-param">other</em><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.Network.equal" title="Permalink to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>other</strong> Another object of type Network to compare this
instance to</p>
</dd>
<dt class="field-even">Return type</dt>
<dd class="field-even"><p>A Boolean value indicating True if both objects are equal or
False otherwise.</p>
</dd>
</dl>
<p>Compares two objects without its child objects. Both objects are compared
by value.</p>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.Network.index">
<code class="sig-name descname">index</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.Network.index" title="Permalink to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Return type</dt>
<dd class="field-odd"><p><p>The objects index of type NetworkIndex.</p>
<p>Returns the objects index which is also used for the database as unique
constraint.</p>
</p>
</dd>
</dl>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.Network.equalIndex">
<code class="sig-name descname">equalIndex</code><span class="sig-paren">(</span><em class="sig-param">lhs</em><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.Network.equalIndex" title="Permalink to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>lhs</strong> <a class="reference internal" href="#api-python-datamodel-network"><span class="std std-ref">Network</span></a></p>
</dd>
<dt class="field-even">Return type</dt>
<dd class="field-even"><p>A Boolean value indicating True if both indexes are equal or
False otherwise.</p>
</dd>
</dl>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.Network.setCode">
<code class="sig-name descname">setCode</code><span class="sig-paren">(</span><em class="sig-param">code</em><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.Network.setCode" title="Permalink to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>code</strong> string</p>
</dd>
</dl>
<p>Network code (50.16)</p>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.Network.code">
<code class="sig-name descname">code</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.Network.code" title="Permalink to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Return type</dt>
<dd class="field-odd"><p>string</p>
</dd>
</dl>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.Network.setStart">
<code class="sig-name descname">setStart</code><span class="sig-paren">(</span><em class="sig-param">start</em><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.Network.setStart" title="Permalink to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>start</strong> seiscomp.core.Time</p>
</dd>
</dl>
<p>Start of network epoch in ISO datetime format. Needed primarily to
identifytemorary networks that re-use network codes</p>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.Network.start">
<code class="sig-name descname">start</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.Network.start" title="Permalink to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Return type</dt>
<dd class="field-odd"><p>seiscomp.core.Time</p>
</dd>
</dl>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.Network.setEnd">
<code class="sig-name descname">setEnd</code><span class="sig-paren">(</span><em class="sig-param">end</em><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.Network.setEnd" title="Permalink to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>end</strong> seiscomp.core.Time</p>
</dd>
</dl>
<p>End of station epoch. Empty string if the station is open</p>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.Network.end">
<code class="sig-name descname">end</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.Network.end" title="Permalink to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Return type</dt>
<dd class="field-odd"><p>seiscomp.core.Time</p>
</dd>
</dl>
<div class="admonition note">
<p class="admonition-title">Note</p>
<p>As this attribute is optional, this method throws a ValueError if
the value of the attribute is not set.</p>
</div>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.Network.setDescription">
<code class="sig-name descname">setDescription</code><span class="sig-paren">(</span><em class="sig-param">description</em><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.Network.setDescription" title="Permalink to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>description</strong> string</p>
</dd>
</dl>
<p>Network description (50.10)</p>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.Network.description">
<code class="sig-name descname">description</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.Network.description" title="Permalink to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Return type</dt>
<dd class="field-odd"><p>string</p>
</dd>
</dl>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.Network.setInstitutions">
<code class="sig-name descname">setInstitutions</code><span class="sig-paren">(</span><em class="sig-param">institutions</em><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.Network.setInstitutions" title="Permalink to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>institutions</strong> string</p>
</dd>
</dl>
<p>Institution(s) operating the network</p>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.Network.institutions">
<code class="sig-name descname">institutions</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.Network.institutions" title="Permalink to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Return type</dt>
<dd class="field-odd"><p>string</p>
</dd>
</dl>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.Network.setRegion">
<code class="sig-name descname">setRegion</code><span class="sig-paren">(</span><em class="sig-param">region</em><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.Network.setRegion" title="Permalink to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>region</strong> string</p>
</dd>
</dl>
<p>Region of the network (eg., euromed, global)</p>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.Network.region">
<code class="sig-name descname">region</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.Network.region" title="Permalink to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Return type</dt>
<dd class="field-odd"><p>string</p>
</dd>
</dl>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.Network.setType">
<code class="sig-name descname">setType</code><span class="sig-paren">(</span><em class="sig-param">type</em><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.Network.setType" title="Permalink to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>type</strong> string</p>
</dd>
</dl>
<p>Type of the network (eg., VBB, SP)</p>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.Network.type">
<code class="sig-name descname">type</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.Network.type" title="Permalink to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Return type</dt>
<dd class="field-odd"><p>string</p>
</dd>
</dl>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.Network.setNetClass">
<code class="sig-name descname">setNetClass</code><span class="sig-paren">(</span><em class="sig-param">netClass</em><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.Network.setNetClass" title="Permalink to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>netClass</strong> string</p>
</dd>
</dl>
<p>;p; for permanent, ;t; for temporary</p>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.Network.netClass">
<code class="sig-name descname">netClass</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.Network.netClass" title="Permalink to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Return type</dt>
<dd class="field-odd"><p>string</p>
</dd>
</dl>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.Network.setArchive">
<code class="sig-name descname">setArchive</code><span class="sig-paren">(</span><em class="sig-param">archive</em><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.Network.setArchive" title="Permalink to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>archive</strong> string</p>
</dd>
</dl>
<p>Archive/Datacenter ID (metadata authority)</p>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.Network.archive">
<code class="sig-name descname">archive</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.Network.archive" title="Permalink to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Return type</dt>
<dd class="field-odd"><p>string</p>
</dd>
</dl>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.Network.setRestricted">
<code class="sig-name descname">setRestricted</code><span class="sig-paren">(</span><em class="sig-param">restricted</em><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.Network.setRestricted" title="Permalink to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>restricted</strong> boolean</p>
</dd>
</dl>
<p>Whether the network is “restricted”</p>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.Network.restricted">
<code class="sig-name descname">restricted</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.Network.restricted" title="Permalink to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Return type</dt>
<dd class="field-odd"><p>boolean</p>
</dd>
</dl>
<div class="admonition note">
<p class="admonition-title">Note</p>
<p>As this attribute is optional, this method throws a ValueError if
the value of the attribute is not set.</p>
</div>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.Network.setShared">
<code class="sig-name descname">setShared</code><span class="sig-paren">(</span><em class="sig-param">shared</em><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.Network.setShared" title="Permalink to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>shared</strong> boolean</p>
</dd>
</dl>
<p>Whether the metadata is synchronized with other datacenters</p>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.Network.shared">
<code class="sig-name descname">shared</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.Network.shared" title="Permalink to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Return type</dt>
<dd class="field-odd"><p>boolean</p>
</dd>
</dl>
<div class="admonition note">
<p class="admonition-title">Note</p>
<p>As this attribute is optional, this method throws a ValueError if
the value of the attribute is not set.</p>
</div>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.Network.setRemark">
<code class="sig-name descname">setRemark</code><span class="sig-paren">(</span><em class="sig-param">remark</em><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.Network.setRemark" title="Permalink to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>remark</strong> <a class="reference internal" href="#api-python-datamodel-blob"><span class="std std-ref">Blob</span></a></p>
</dd>
</dl>
<p>Any notes</p>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.Network.remark">
<code class="sig-name descname">remark</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.Network.remark" title="Permalink to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Return type</dt>
<dd class="field-odd"><p><a class="reference internal" href="#api-python-datamodel-blob"><span class="std std-ref">Blob</span></a></p>
</dd>
</dl>
<div class="admonition note">
<p class="admonition-title">Note</p>
<p>As this attribute is optional, this method throws a ValueError if
the value of the attribute is not set.</p>
</div>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.Network.add">
<code class="sig-name descname">add</code><span class="sig-paren">(</span><em class="sig-param">comment</em><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.Network.add" title="Permalink to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>comment</strong> Object of type <a class="reference internal" href="#api-python-datamodel-comment"><span class="std std-ref">Comment</span></a></p>
</dd>
<dt class="field-even">Return type</dt>
<dd class="field-even"><p>A Boolean value indicating success with True, False otherwise.</p>
</dd>
</dl>
<p>Adds a Comment object to Network. The object is not
copied but managed by this instance. Any change to the passed object
will also change the child.</p>
</dd></dl>
<dl class="method">
<dt>
<code class="sig-name descname">add</code><span class="sig-paren">(</span><em class="sig-param">station</em><span class="sig-paren">)</span></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>station</strong> Object of type <a class="reference internal" href="#api-python-datamodel-station"><span class="std std-ref">Station</span></a></p>
</dd>
<dt class="field-even">Return type</dt>
<dd class="field-even"><p>A Boolean value indicating success with True, False otherwise.</p>
</dd>
</dl>
<p>Adds a Station object to Network. The object is not
copied but managed by this instance. Any change to the passed object
will also change the child.</p>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.Network.remove">
<code class="sig-name descname">remove</code><span class="sig-paren">(</span><em class="sig-param">comment</em><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.Network.remove" title="Permalink to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>comment</strong> Object of type <a class="reference internal" href="#api-python-datamodel-comment"><span class="std std-ref">Comment</span></a></p>
</dd>
<dt class="field-even">Return type</dt>
<dd class="field-even"><p>A Boolean value indicating success with True, False otherwise.</p>
</dd>
</dl>
<p>Removes a previously added Comment object from Network.</p>
</dd></dl>
<dl class="method">
<dt>
<code class="sig-name descname">remove</code><span class="sig-paren">(</span><em class="sig-param">station</em><span class="sig-paren">)</span></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>station</strong> Object of type <a class="reference internal" href="#api-python-datamodel-station"><span class="std std-ref">Station</span></a></p>
</dd>
<dt class="field-even">Return type</dt>
<dd class="field-even"><p>A Boolean value indicating success with True, False otherwise.</p>
</dd>
</dl>
<p>Removes a previously added Station object from Network.</p>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.Network.removeComment">
<code class="sig-name descname">removeComment</code><span class="sig-paren">(</span><em class="sig-param">idx</em><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.Network.removeComment" title="Permalink to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>idx</strong> An integer index of the object to be removed.</p>
</dd>
<dt class="field-even">Return type</dt>
<dd class="field-even"><p>A Boolean value indicating success with True, False otherwise.</p>
</dd>
</dl>
</dd></dl>
<dl class="method">
<dt>
<code class="sig-name descname">removeComment(commentIndex);</code></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>commentIndex</strong> The index of the object to be removed of type CommentIndex.</p>
</dd>
<dt class="field-even">Return type</dt>
<dd class="field-even"><p>A Boolean value indicating success with True, False otherwise.</p>
</dd>
</dl>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.Network.removeStation">
<code class="sig-name descname">removeStation</code><span class="sig-paren">(</span><em class="sig-param">idx</em><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.Network.removeStation" title="Permalink to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>idx</strong> An integer index of the object to be removed.</p>
</dd>
<dt class="field-even">Return type</dt>
<dd class="field-even"><p>A Boolean value indicating success with True, False otherwise.</p>
</dd>
</dl>
</dd></dl>
<dl class="method">
<dt>
<code class="sig-name descname">removeStation(stationIndex);</code></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>stationIndex</strong> The index of the object to be removed of type StationIndex.</p>
</dd>
<dt class="field-even">Return type</dt>
<dd class="field-even"><p>A Boolean value indicating success with True, False otherwise.</p>
</dd>
</dl>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.Network.commentCount">
<code class="sig-name descname">commentCount</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.Network.commentCount" title="Permalink to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Return type</dt>
<dd class="field-odd"><p>integer value indicating the number of child objects.</p>
</dd>
</dl>
<p>Returns the number of Comment child objects.</p>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.Network.stationCount">
<code class="sig-name descname">stationCount</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.Network.stationCount" title="Permalink to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Return type</dt>
<dd class="field-odd"><p>integer value indicating the number of child objects.</p>
</dd>
</dl>
<p>Returns the number of Station child objects.</p>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.Network.comment">
<code class="sig-name descname">comment</code><span class="sig-paren">(</span><em class="sig-param">idx</em><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.Network.comment" title="Permalink to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>idx</strong> An integer index of the object to be returned.</p>
</dd>
<dt class="field-even">Return type</dt>
<dd class="field-even"><p>Object of type <a class="reference internal" href="#api-python-datamodel-comment"><span class="std std-ref">Comment</span></a>.</p>
</dd>
</dl>
<p>Returns the Comment at index idx.</p>
</dd></dl>
<dl class="method">
<dt>
<code class="sig-name descname">comment</code><span class="sig-paren">(</span><em class="sig-param">commentIndex</em><span class="sig-paren">)</span></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>commentIndex</strong> The index of the object to be removed of type CommentIndex.</p>
</dd>
<dt class="field-even">Return type</dt>
<dd class="field-even"><p>Object of type <a class="reference internal" href="#api-python-datamodel-comment"><span class="std std-ref">Comment</span></a>.</p>
</dd>
</dl>
<p>Returns the Comment at given index. The indexes of all child objects
are compared by value which makes this function slower than the direct
integer index look-up.</p>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.Network.station">
<code class="sig-name descname">station</code><span class="sig-paren">(</span><em class="sig-param">idx</em><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.Network.station" title="Permalink to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>idx</strong> An integer index of the object to be returned.</p>
</dd>
<dt class="field-even">Return type</dt>
<dd class="field-even"><p>Object of type <a class="reference internal" href="#api-python-datamodel-station"><span class="std std-ref">Station</span></a>.</p>
</dd>
</dl>
<p>Returns the Station at index idx.</p>
</dd></dl>
<dl class="method">
<dt>
<code class="sig-name descname">station</code><span class="sig-paren">(</span><em class="sig-param">stationIndex</em><span class="sig-paren">)</span></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>stationIndex</strong> The index of the object to be removed of type StationIndex.</p>
</dd>
<dt class="field-even">Return type</dt>
<dd class="field-even"><p>Object of type <a class="reference internal" href="#api-python-datamodel-station"><span class="std std-ref">Station</span></a>.</p>
</dd>
</dl>
<p>Returns the Station at given index. The indexes of all child objects
are compared by value which makes this function slower than the direct
integer index look-up.</p>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.Network.findStation">
<code class="sig-name descname">findStation</code><span class="sig-paren">(</span><em class="sig-param">publicID</em><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.Network.findStation" title="Permalink to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>publicID</strong> The publicID of the object to find.</p>
</dd>
<dt class="field-even">Return type</dt>
<dd class="field-even"><p>Object of type <a class="reference internal" href="#api-python-datamodel-station"><span class="std std-ref">Station</span></a>.</p>
</dd>
</dl>
<p>Returns the child object with a certain publicID, None otherwise.</p>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.Network.inventory">
<code class="sig-name descname">inventory</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.Network.inventory" title="Permalink to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Return type</dt>
<dd class="field-odd"><p><a class="reference internal" href="#seiscomp.datamodel.Inventory" title="seiscomp.datamodel.Inventory">Inventory</a></p>
</dd>
</dl>
<p>Returns the parent Inventory if available. Returns None
if the parent is not a Inventory. This is a convenience wrapper
for parent().</p>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.Network.assign">
<code class="sig-name descname">assign</code><span class="sig-paren">(</span><em class="sig-param">other</em><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.Network.assign" title="Permalink to this definition"></a></dt>
<dd><p>This method implements the <a class="reference internal" href="#api-python-datamodel-object"><span class="std std-ref">Object</span></a> interface.</p>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.Network.attachTo">
<code class="sig-name descname">attachTo</code><span class="sig-paren">(</span><em class="sig-param">parent</em><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.Network.attachTo" title="Permalink to this definition"></a></dt>
<dd><p>This method implements the <a class="reference internal" href="#api-python-datamodel-object"><span class="std std-ref">Object</span></a> interface.</p>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.Network.detachFrom">
<code class="sig-name descname">detachFrom</code><span class="sig-paren">(</span><em class="sig-param">parent</em><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.Network.detachFrom" title="Permalink to this definition"></a></dt>
<dd><p>This method implements the <a class="reference internal" href="#api-python-datamodel-object"><span class="std std-ref">Object</span></a> interface.</p>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.Network.detach">
<code class="sig-name descname">detach</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.Network.detach" title="Permalink to this definition"></a></dt>
<dd><p>This method implements the <a class="reference internal" href="#api-python-datamodel-object"><span class="std std-ref">Object</span></a> interface.</p>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.Network.clone">
<code class="sig-name descname">clone</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.Network.clone" title="Permalink to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Return type</dt>
<dd class="field-odd"><p>A cloned Network.</p>
</dd>
</dl>
<p>Returns a new instance that is a clone of the current instance. Child
objects are being ignored.</p>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.Network.updateChild">
<code class="sig-name descname">updateChild</code><span class="sig-paren">(</span><em class="sig-param">ref</em><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.Network.updateChild" title="Permalink to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>ref</strong> A child object derived from class Object.</p>
</dd>
<dt class="field-even">Return type</dt>
<dd class="field-even"><p>A Boolean flag indicating success with True, False otherwise</p>
</dd>
</dl>
<p>This method takes the passed reference object and searches for a child
with the same publicID (if derived from <a class="reference internal" href="#api-python-datamodel-publicobject"><span class="std std-ref">PublicObject</span></a>)
or the same index (if derived from <a class="reference internal" href="#api-python-datamodel-object"><span class="std std-ref">Object</span></a>).
The the child was found the reference objects attributes are copied to
the child object. Children of child are being ignored during this operation.
This method implements the <a class="reference internal" href="#api-python-datamodel-publicobject"><span class="std std-ref">PublicObject</span></a> interface.</p>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.Network.accept">
<code class="sig-name descname">accept</code><span class="sig-paren">(</span><em class="sig-param">visitor</em><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.Network.accept" title="Permalink to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>visitor</strong> A visitor.</p>
</dd>
</dl>
<p>This method implements the <a class="reference internal" href="#api-python-datamodel-publicobject"><span class="std std-ref">PublicObject</span></a> interface.</p>
</dd></dl>
</dd></dl>
</div>
<div class="section" id="nodalplane">
<span id="api-python-datamodel-nodalplane"></span><h3>NodalPlane<a class="headerlink" href="#nodalplane" title="Permalink to this headline"></a></h3>
<dl class="class">
<dt id="seiscomp.datamodel.NodalPlane">
<em class="property">class </em><code class="sig-prename descclassname">seiscomp.datamodel.</code><code class="sig-name descname">NodalPlane</code><a class="headerlink" href="#seiscomp.datamodel.NodalPlane" title="Permalink to this definition"></a></dt>
<dd><p>Inherits <a class="reference internal" href="#api-python-datamodel-object"><span class="std std-ref">Object</span></a>.</p>
<p>This class describes a nodal plane using the attributes strike, dip, and
rake. For a definition of the angles see Aki and Richards (1980).</p>
<p><strong>Attributes</strong>:</p>
<ul class="simple">
<li><p><code class="docutils literal notranslate"><span class="pre">strike</span></code> <a class="reference internal" href="#api-python-datamodel-realquantity"><span class="std std-ref">RealQuantity</span></a></p></li>
<li><p><code class="docutils literal notranslate"><span class="pre">dip</span></code> <a class="reference internal" href="#api-python-datamodel-realquantity"><span class="std std-ref">RealQuantity</span></a></p></li>
<li><p><code class="docutils literal notranslate"><span class="pre">rake</span></code> <a class="reference internal" href="#api-python-datamodel-realquantity"><span class="std std-ref">RealQuantity</span></a></p></li>
</ul>
<p><strong>Used by</strong>:</p>
<ul class="simple">
<li><p><a class="reference internal" href="#seiscomp.datamodel.NodalPlanes.nodalPlane1" title="seiscomp.datamodel.NodalPlanes.nodalPlane1"><code class="xref py py-func docutils literal notranslate"><span class="pre">NodalPlanes.nodalPlane1()</span></code></a></p></li>
<li><p><a class="reference internal" href="#seiscomp.datamodel.NodalPlanes.nodalPlane2" title="seiscomp.datamodel.NodalPlanes.nodalPlane2"><code class="xref py py-func docutils literal notranslate"><span class="pre">NodalPlanes.nodalPlane2()</span></code></a></p></li>
</ul>
<p><strong>Methods</strong>:</p>
<dl class="method">
<dt id="seiscomp.datamodel.NodalPlane.Cast">
<em class="property">static </em><code class="sig-name descname">Cast</code><span class="sig-paren">(</span><em class="sig-param">obj</em><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.NodalPlane.Cast" title="Permalink to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>obj</strong> The object to be casted.</p>
</dd>
<dt class="field-even">Return type</dt>
<dd class="field-even"><p>An object of type NodalPlane if the cast was successful,
None otherwise.</p>
</dd>
</dl>
<p>Cast an arbitrary object to NodalPlane if the internal wrapped
representation is an NodalPlane object. The cast is important if
instances of type <a class="reference internal" href="#api-python-datamodel-object"><span class="std std-ref">Object</span></a>
are passed to methods which need access to the real type.</p>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.NodalPlane.equal">
<code class="sig-name descname">equal</code><span class="sig-paren">(</span><em class="sig-param">other</em><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.NodalPlane.equal" title="Permalink to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>other</strong> Another object of type NodalPlane to compare this
instance to</p>
</dd>
<dt class="field-even">Return type</dt>
<dd class="field-even"><p>A Boolean value indicating True if both objects are equal or
False otherwise.</p>
</dd>
</dl>
<p>Compares two objects without its child objects. Both objects are compared
by value.</p>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.NodalPlane.setStrike">
<code class="sig-name descname">setStrike</code><span class="sig-paren">(</span><em class="sig-param">strike</em><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.NodalPlane.setStrike" title="Permalink to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>strike</strong> <a class="reference internal" href="#api-python-datamodel-realquantity"><span class="std std-ref">RealQuantity</span></a></p>
</dd>
</dl>
<p>Strike angle of nodal plane in degrees.</p>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.NodalPlane.strike">
<code class="sig-name descname">strike</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.NodalPlane.strike" title="Permalink to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Return type</dt>
<dd class="field-odd"><p><a class="reference internal" href="#api-python-datamodel-realquantity"><span class="std std-ref">RealQuantity</span></a></p>
</dd>
</dl>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.NodalPlane.setDip">
<code class="sig-name descname">setDip</code><span class="sig-paren">(</span><em class="sig-param">dip</em><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.NodalPlane.setDip" title="Permalink to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>dip</strong> <a class="reference internal" href="#api-python-datamodel-realquantity"><span class="std std-ref">RealQuantity</span></a></p>
</dd>
</dl>
<p>Dip angle of nodal plane in degrees.</p>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.NodalPlane.dip">
<code class="sig-name descname">dip</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.NodalPlane.dip" title="Permalink to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Return type</dt>
<dd class="field-odd"><p><a class="reference internal" href="#api-python-datamodel-realquantity"><span class="std std-ref">RealQuantity</span></a></p>
</dd>
</dl>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.NodalPlane.setRake">
<code class="sig-name descname">setRake</code><span class="sig-paren">(</span><em class="sig-param">rake</em><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.NodalPlane.setRake" title="Permalink to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>rake</strong> <a class="reference internal" href="#api-python-datamodel-realquantity"><span class="std std-ref">RealQuantity</span></a></p>
</dd>
</dl>
<p>Rake angle of nodal plane in degrees.</p>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.NodalPlane.rake">
<code class="sig-name descname">rake</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.NodalPlane.rake" title="Permalink to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Return type</dt>
<dd class="field-odd"><p><a class="reference internal" href="#api-python-datamodel-realquantity"><span class="std std-ref">RealQuantity</span></a></p>
</dd>
</dl>
</dd></dl>
</dd></dl>
</div>
<div class="section" id="nodalplanes">
<span id="api-python-datamodel-nodalplanes"></span><h3>NodalPlanes<a class="headerlink" href="#nodalplanes" title="Permalink to this headline"></a></h3>
<dl class="class">
<dt id="seiscomp.datamodel.NodalPlanes">
<em class="property">class </em><code class="sig-prename descclassname">seiscomp.datamodel.</code><code class="sig-name descname">NodalPlanes</code><a class="headerlink" href="#seiscomp.datamodel.NodalPlanes" title="Permalink to this definition"></a></dt>
<dd><p>Inherits <a class="reference internal" href="#api-python-datamodel-object"><span class="std std-ref">Object</span></a>.</p>
<p>This class describes the nodal planes of a double-couple moment-tensor
solution. The attribute preferredPlane
can be used to define which plane is the preferred one.</p>
<p><strong>Attributes</strong>:</p>
<ul class="simple">
<li><p><code class="docutils literal notranslate"><span class="pre">nodalPlane1</span></code> <a class="reference internal" href="#api-python-datamodel-nodalplane"><span class="std std-ref">NodalPlane</span></a> (optional)</p></li>
<li><p><code class="docutils literal notranslate"><span class="pre">nodalPlane2</span></code> <a class="reference internal" href="#api-python-datamodel-nodalplane"><span class="std std-ref">NodalPlane</span></a> (optional)</p></li>
<li><p><code class="docutils literal notranslate"><span class="pre">preferredPlane</span></code> int (optional)</p></li>
</ul>
<p><strong>Used by</strong>:</p>
<ul class="simple">
<li><p><a class="reference internal" href="#seiscomp.datamodel.FocalMechanism.nodalPlanes" title="seiscomp.datamodel.FocalMechanism.nodalPlanes"><code class="xref py py-func docutils literal notranslate"><span class="pre">FocalMechanism.nodalPlanes()</span></code></a></p></li>
</ul>
<p><strong>Methods</strong>:</p>
<dl class="method">
<dt id="seiscomp.datamodel.NodalPlanes.Cast">
<em class="property">static </em><code class="sig-name descname">Cast</code><span class="sig-paren">(</span><em class="sig-param">obj</em><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.NodalPlanes.Cast" title="Permalink to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>obj</strong> The object to be casted.</p>
</dd>
<dt class="field-even">Return type</dt>
<dd class="field-even"><p>An object of type NodalPlanes if the cast was successful,
None otherwise.</p>
</dd>
</dl>
<p>Cast an arbitrary object to NodalPlanes if the internal wrapped
representation is an NodalPlanes object. The cast is important if
instances of type <a class="reference internal" href="#api-python-datamodel-object"><span class="std std-ref">Object</span></a>
are passed to methods which need access to the real type.</p>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.NodalPlanes.equal">
<code class="sig-name descname">equal</code><span class="sig-paren">(</span><em class="sig-param">other</em><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.NodalPlanes.equal" title="Permalink to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>other</strong> Another object of type NodalPlanes to compare this
instance to</p>
</dd>
<dt class="field-even">Return type</dt>
<dd class="field-even"><p>A Boolean value indicating True if both objects are equal or
False otherwise.</p>
</dd>
</dl>
<p>Compares two objects without its child objects. Both objects are compared
by value.</p>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.NodalPlanes.setNodalPlane1">
<code class="sig-name descname">setNodalPlane1</code><span class="sig-paren">(</span><em class="sig-param">nodalPlane1</em><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.NodalPlanes.setNodalPlane1" title="Permalink to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>nodalPlane1</strong> <a class="reference internal" href="#api-python-datamodel-nodalplane"><span class="std std-ref">NodalPlane</span></a></p>
</dd>
</dl>
<p>First nodal plane of double-couple moment tensor solution.</p>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.NodalPlanes.nodalPlane1">
<code class="sig-name descname">nodalPlane1</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.NodalPlanes.nodalPlane1" title="Permalink to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Return type</dt>
<dd class="field-odd"><p><a class="reference internal" href="#api-python-datamodel-nodalplane"><span class="std std-ref">NodalPlane</span></a></p>
</dd>
</dl>
<div class="admonition note">
<p class="admonition-title">Note</p>
<p>As this attribute is optional, this method throws a ValueError if
the value of the attribute is not set.</p>
</div>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.NodalPlanes.setNodalPlane2">
<code class="sig-name descname">setNodalPlane2</code><span class="sig-paren">(</span><em class="sig-param">nodalPlane2</em><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.NodalPlanes.setNodalPlane2" title="Permalink to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>nodalPlane2</strong> <a class="reference internal" href="#api-python-datamodel-nodalplane"><span class="std std-ref">NodalPlane</span></a></p>
</dd>
</dl>
<p>Second nodal plane of double-couple moment tensor solution.</p>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.NodalPlanes.nodalPlane2">
<code class="sig-name descname">nodalPlane2</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.NodalPlanes.nodalPlane2" title="Permalink to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Return type</dt>
<dd class="field-odd"><p><a class="reference internal" href="#api-python-datamodel-nodalplane"><span class="std std-ref">NodalPlane</span></a></p>
</dd>
</dl>
<div class="admonition note">
<p class="admonition-title">Note</p>
<p>As this attribute is optional, this method throws a ValueError if
the value of the attribute is not set.</p>
</div>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.NodalPlanes.setPreferredPlane">
<code class="sig-name descname">setPreferredPlane</code><span class="sig-paren">(</span><em class="sig-param">preferredPlane</em><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.NodalPlanes.setPreferredPlane" title="Permalink to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>preferredPlane</strong> int</p>
</dd>
</dl>
<p>Indicator for preferred nodal plane of moment tensor solution. It can take
integer values 1 or 2.</p>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.NodalPlanes.preferredPlane">
<code class="sig-name descname">preferredPlane</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.NodalPlanes.preferredPlane" title="Permalink to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Return type</dt>
<dd class="field-odd"><p>int</p>
</dd>
</dl>
<div class="admonition note">
<p class="admonition-title">Note</p>
<p>As this attribute is optional, this method throws a ValueError if
the value of the attribute is not set.</p>
</div>
</dd></dl>
</dd></dl>
</div>
<div class="section" id="origin">
<span id="api-python-datamodel-origin"></span><h3>Origin<a class="headerlink" href="#origin" title="Permalink to this headline"></a></h3>
<dl class="class">
<dt id="seiscomp.datamodel.Origin">
<em class="property">class </em><code class="sig-prename descclassname">seiscomp.datamodel.</code><code class="sig-name descname">Origin</code><a class="headerlink" href="#seiscomp.datamodel.Origin" title="Permalink to this definition"></a></dt>
<dd><p>Inherits <a class="reference internal" href="#api-python-datamodel-publicobject"><span class="std std-ref">PublicObject</span></a>.</p>
<p>This class represents the focal time and geographical location of an
earthquake hypocenter, as well as additional meta-information. Origin
can have objects of type OriginUncertainty and Arrival as child elements.</p>
<p><strong>Parents</strong>:</p>
<ul class="simple">
<li><p><code class="docutils literal notranslate"><span class="pre">eventParameters</span></code> <a class="reference internal" href="#api-python-datamodel-eventparameters"><span class="std std-ref">EventParameters</span></a></p></li>
</ul>
<p><strong>Children</strong>:</p>
<ul class="simple">
<li><p><code class="docutils literal notranslate"><span class="pre">comment</span></code> <a class="reference internal" href="#api-python-datamodel-comment"><span class="std std-ref">Comment</span></a></p></li>
<li><p><code class="docutils literal notranslate"><span class="pre">compositeTime</span></code> <a class="reference internal" href="#api-python-datamodel-compositetime"><span class="std std-ref">CompositeTime</span></a></p></li>
<li><p><code class="docutils literal notranslate"><span class="pre">arrival</span></code> <a class="reference internal" href="#api-python-datamodel-arrival"><span class="std std-ref">Arrival</span></a></p></li>
<li><p><code class="docutils literal notranslate"><span class="pre">stationMagnitude</span></code> <a class="reference internal" href="#api-python-datamodel-stationmagnitude"><span class="std std-ref">StationMagnitude</span></a></p></li>
<li><p><code class="docutils literal notranslate"><span class="pre">magnitude</span></code> <a class="reference internal" href="#api-python-datamodel-magnitude"><span class="std std-ref">Magnitude</span></a></p></li>
</ul>
<p><strong>Attributes</strong>:</p>
<ul class="simple">
<li><p><code class="docutils literal notranslate"><span class="pre">publicID</span></code>: string</p></li>
<li><p><code class="docutils literal notranslate"><span class="pre">time</span></code> <a class="reference internal" href="#api-python-datamodel-timequantity"><span class="std std-ref">TimeQuantity</span></a></p></li>
<li><p><code class="docutils literal notranslate"><span class="pre">latitude</span></code> <a class="reference internal" href="#api-python-datamodel-realquantity"><span class="std std-ref">RealQuantity</span></a></p></li>
<li><p><code class="docutils literal notranslate"><span class="pre">longitude</span></code> <a class="reference internal" href="#api-python-datamodel-realquantity"><span class="std std-ref">RealQuantity</span></a></p></li>
<li><p><code class="docutils literal notranslate"><span class="pre">depth</span></code> <a class="reference internal" href="#api-python-datamodel-realquantity"><span class="std std-ref">RealQuantity</span></a> (optional)</p></li>
<li><p><code class="docutils literal notranslate"><span class="pre">depthType</span></code> <a class="reference internal" href="#api-python-datamodel-origindepthtype"><span class="std std-ref">OriginDepthType</span></a> (optional)</p></li>
<li><p><code class="docutils literal notranslate"><span class="pre">timeFixed</span></code> boolean (optional)</p></li>
<li><p><code class="docutils literal notranslate"><span class="pre">epicenterFixed</span></code> boolean (optional)</p></li>
<li><p><code class="docutils literal notranslate"><span class="pre">referenceSystemID</span></code> string</p></li>
<li><p><code class="docutils literal notranslate"><span class="pre">methodID</span></code> string</p></li>
<li><p><code class="docutils literal notranslate"><span class="pre">earthModelID</span></code> string</p></li>
<li><p><code class="docutils literal notranslate"><span class="pre">quality</span></code> <a class="reference internal" href="#api-python-datamodel-originquality"><span class="std std-ref">OriginQuality</span></a> (optional)</p></li>
<li><p><code class="docutils literal notranslate"><span class="pre">uncertainty</span></code> <a class="reference internal" href="#api-python-datamodel-originuncertainty"><span class="std std-ref">OriginUncertainty</span></a> (optional)</p></li>
<li><p><code class="docutils literal notranslate"><span class="pre">type</span></code> <a class="reference internal" href="#api-python-datamodel-origintype"><span class="std std-ref">OriginType</span></a> (optional)</p></li>
<li><p><code class="docutils literal notranslate"><span class="pre">evaluationMode</span></code> <a class="reference internal" href="#api-python-datamodel-evaluationmode"><span class="std std-ref">EvaluationMode</span></a> (optional)</p></li>
<li><p><code class="docutils literal notranslate"><span class="pre">evaluationStatus</span></code> <a class="reference internal" href="#api-python-datamodel-evaluationstatus"><span class="std std-ref">EvaluationStatus</span></a> (optional)</p></li>
<li><p><code class="docutils literal notranslate"><span class="pre">creationInfo</span></code> <a class="reference internal" href="#api-python-datamodel-creationinfo"><span class="std std-ref">CreationInfo</span></a> (optional)</p></li>
</ul>
<p><strong>Referenced by</strong>:</p>
<ul class="simple">
<li><p><a class="reference internal" href="#seiscomp.datamodel.Event.preferredOriginID" title="seiscomp.datamodel.Event.preferredOriginID"><code class="xref py py-func docutils literal notranslate"><span class="pre">Event.preferredOriginID()</span></code></a></p></li>
<li><p><a class="reference internal" href="#seiscomp.datamodel.FocalMechanism.triggeringOriginID" title="seiscomp.datamodel.FocalMechanism.triggeringOriginID"><code class="xref py py-func docutils literal notranslate"><span class="pre">FocalMechanism.triggeringOriginID()</span></code></a></p></li>
<li><p><a class="reference internal" href="#seiscomp.datamodel.Magnitude.originID" title="seiscomp.datamodel.Magnitude.originID"><code class="xref py py-func docutils literal notranslate"><span class="pre">Magnitude.originID()</span></code></a></p></li>
<li><p><a class="reference internal" href="#seiscomp.datamodel.MomentTensor.derivedOriginID" title="seiscomp.datamodel.MomentTensor.derivedOriginID"><code class="xref py py-func docutils literal notranslate"><span class="pre">MomentTensor.derivedOriginID()</span></code></a></p></li>
<li><p><a class="reference internal" href="#seiscomp.datamodel.OriginReference.originID" title="seiscomp.datamodel.OriginReference.originID"><code class="xref py py-func docutils literal notranslate"><span class="pre">OriginReference.originID()</span></code></a></p></li>
<li><p><a class="reference internal" href="#seiscomp.datamodel.StationMagnitude.originID" title="seiscomp.datamodel.StationMagnitude.originID"><code class="xref py py-func docutils literal notranslate"><span class="pre">StationMagnitude.originID()</span></code></a></p></li>
</ul>
<p><strong>Methods</strong>:</p>
<dl class="method">
<dt id="seiscomp.datamodel.Origin.Cast">
<em class="property">static </em><code class="sig-name descname">Cast</code><span class="sig-paren">(</span><em class="sig-param">obj</em><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.Origin.Cast" title="Permalink to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>obj</strong> The object to be casted.</p>
</dd>
<dt class="field-even">Return type</dt>
<dd class="field-even"><p>An object of type Origin if the cast was successful,
None otherwise.</p>
</dd>
</dl>
<p>Cast an arbitrary object to Origin if the internal wrapped
representation is an Origin object. The cast is important if
instances of type <a class="reference internal" href="#api-python-datamodel-object"><span class="std std-ref">Object</span></a>
are passed to methods which need access to the real type.</p>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.Origin.Create">
<em class="property">static </em><code class="sig-name descname">Create</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.Origin.Create" title="Permalink to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Return type</dt>
<dd class="field-odd"><p>A new object of type Origin.</p>
</dd>
</dl>
<p>Creates and registers (if enabled) a Origin instance. The
publicID is auto-generated.</p>
</dd></dl>
<dl class="method">
<dt>
<em class="property">static </em><code class="sig-name descname">Create</code><span class="sig-paren">(</span><em class="sig-param">publicID</em><span class="sig-paren">)</span></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Return type</dt>
<dd class="field-odd"><p>A new object of type Origin.</p>
</dd>
</dl>
<p>Creates and registers (if enabled) a Origin instance with
passed publicID.</p>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.Origin.equal">
<code class="sig-name descname">equal</code><span class="sig-paren">(</span><em class="sig-param">other</em><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.Origin.equal" title="Permalink to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>other</strong> Another object of type Origin to compare this
instance to</p>
</dd>
<dt class="field-even">Return type</dt>
<dd class="field-even"><p>A Boolean value indicating True if both objects are equal or
False otherwise.</p>
</dd>
</dl>
<p>Compares two objects without its child objects. Both objects are compared
by value.</p>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.Origin.setTime">
<code class="sig-name descname">setTime</code><span class="sig-paren">(</span><em class="sig-param">time</em><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.Origin.setTime" title="Permalink to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>time</strong> <a class="reference internal" href="#api-python-datamodel-timequantity"><span class="std std-ref">TimeQuantity</span></a></p>
</dd>
</dl>
<p>Focal time as TimeQuantity.</p>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.Origin.time">
<code class="sig-name descname">time</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.Origin.time" title="Permalink to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Return type</dt>
<dd class="field-odd"><p><a class="reference internal" href="#api-python-datamodel-timequantity"><span class="std std-ref">TimeQuantity</span></a></p>
</dd>
</dl>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.Origin.setLatitude">
<code class="sig-name descname">setLatitude</code><span class="sig-paren">(</span><em class="sig-param">latitude</em><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.Origin.setLatitude" title="Permalink to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>latitude</strong> <a class="reference internal" href="#api-python-datamodel-realquantity"><span class="std std-ref">RealQuantity</span></a></p>
</dd>
</dl>
<p>Hypocenter latitude with respect to the World Geodetic System 1984
(WGS84) reference system (National Imagery and Mapping Agency 2000)
in degrees. Uncertainties are given in kilometers.</p>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.Origin.latitude">
<code class="sig-name descname">latitude</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.Origin.latitude" title="Permalink to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Return type</dt>
<dd class="field-odd"><p><a class="reference internal" href="#api-python-datamodel-realquantity"><span class="std std-ref">RealQuantity</span></a></p>
</dd>
</dl>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.Origin.setLongitude">
<code class="sig-name descname">setLongitude</code><span class="sig-paren">(</span><em class="sig-param">longitude</em><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.Origin.setLongitude" title="Permalink to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>longitude</strong> <a class="reference internal" href="#api-python-datamodel-realquantity"><span class="std std-ref">RealQuantity</span></a></p>
</dd>
</dl>
<p>Hypocenter longitude with respect to the World Geodetic System 1984
(WGS84) reference system (National Imagery and Mapping Agency 2000)
in degrees. Uncertainties are given in kilometers.</p>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.Origin.longitude">
<code class="sig-name descname">longitude</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.Origin.longitude" title="Permalink to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Return type</dt>
<dd class="field-odd"><p><a class="reference internal" href="#api-python-datamodel-realquantity"><span class="std std-ref">RealQuantity</span></a></p>
</dd>
</dl>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.Origin.setDepth">
<code class="sig-name descname">setDepth</code><span class="sig-paren">(</span><em class="sig-param">depth</em><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.Origin.setDepth" title="Permalink to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>depth</strong> <a class="reference internal" href="#api-python-datamodel-realquantity"><span class="std std-ref">RealQuantity</span></a></p>
</dd>
</dl>
<p>Depth of hypocenter with respect to the nominal sea level given by the
WGS84 geoid (Earth Gravitational Model, EGM96, Lemoine et al. 1998).
Positive values indicate hypocenters below sea level. For shallow
hypocenters, the depth value can be negative. The depth is defined
in km.</p>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.Origin.depth">
<code class="sig-name descname">depth</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.Origin.depth" title="Permalink to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Return type</dt>
<dd class="field-odd"><p><a class="reference internal" href="#api-python-datamodel-realquantity"><span class="std std-ref">RealQuantity</span></a></p>
</dd>
</dl>
<div class="admonition note">
<p class="admonition-title">Note</p>
<p>As this attribute is optional, this method throws a ValueError if
the value of the attribute is not set.</p>
</div>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.Origin.setDepthType">
<code class="sig-name descname">setDepthType</code><span class="sig-paren">(</span><em class="sig-param">depthType</em><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.Origin.setDepthType" title="Permalink to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>depthType</strong> OriginDepthType</p>
</dd>
</dl>
<p>Type of depth determination.</p>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.Origin.depthType">
<code class="sig-name descname">depthType</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.Origin.depthType" title="Permalink to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Return type</dt>
<dd class="field-odd"><p>OriginDepthType</p>
</dd>
</dl>
<div class="admonition note">
<p class="admonition-title">Note</p>
<p>As this attribute is optional, this method throws a ValueError if
the value of the attribute is not set.</p>
</div>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.Origin.setTimeFixed">
<code class="sig-name descname">setTimeFixed</code><span class="sig-paren">(</span><em class="sig-param">timeFixed</em><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.Origin.setTimeFixed" title="Permalink to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>timeFixed</strong> boolean</p>
</dd>
</dl>
<p>Boolean flag. True if focal time was kept fixed for computation of the
Origin.</p>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.Origin.timeFixed">
<code class="sig-name descname">timeFixed</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.Origin.timeFixed" title="Permalink to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Return type</dt>
<dd class="field-odd"><p>boolean</p>
</dd>
</dl>
<div class="admonition note">
<p class="admonition-title">Note</p>
<p>As this attribute is optional, this method throws a ValueError if
the value of the attribute is not set.</p>
</div>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.Origin.setEpicenterFixed">
<code class="sig-name descname">setEpicenterFixed</code><span class="sig-paren">(</span><em class="sig-param">epicenterFixed</em><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.Origin.setEpicenterFixed" title="Permalink to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>epicenterFixed</strong> boolean</p>
</dd>
</dl>
<p>Boolean flag. True if epicenter was kept fixed for computation of Origin.</p>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.Origin.epicenterFixed">
<code class="sig-name descname">epicenterFixed</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.Origin.epicenterFixed" title="Permalink to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Return type</dt>
<dd class="field-odd"><p>boolean</p>
</dd>
</dl>
<div class="admonition note">
<p class="admonition-title">Note</p>
<p>As this attribute is optional, this method throws a ValueError if
the value of the attribute is not set.</p>
</div>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.Origin.setReferenceSystemID">
<code class="sig-name descname">setReferenceSystemID</code><span class="sig-paren">(</span><em class="sig-param">referenceSystemID</em><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.Origin.setReferenceSystemID" title="Permalink to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>referenceSystemID</strong> string</p>
</dd>
</dl>
<p>Identifies the reference system used for hypocenter determination. This is
only necessary if
a modified version of the standard (with local extensions) is used that
provides a non-standard coordinate
system.</p>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.Origin.referenceSystemID">
<code class="sig-name descname">referenceSystemID</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.Origin.referenceSystemID" title="Permalink to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Return type</dt>
<dd class="field-odd"><p>string</p>
</dd>
</dl>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.Origin.setMethodID">
<code class="sig-name descname">setMethodID</code><span class="sig-paren">(</span><em class="sig-param">methodID</em><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.Origin.setMethodID" title="Permalink to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>methodID</strong> string</p>
</dd>
</dl>
<p>Identifies the method used for locating the event.</p>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.Origin.methodID">
<code class="sig-name descname">methodID</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.Origin.methodID" title="Permalink to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Return type</dt>
<dd class="field-odd"><p>string</p>
</dd>
</dl>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.Origin.setEarthModelID">
<code class="sig-name descname">setEarthModelID</code><span class="sig-paren">(</span><em class="sig-param">earthModelID</em><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.Origin.setEarthModelID" title="Permalink to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>earthModelID</strong> string</p>
</dd>
</dl>
<p>Identifies the earth model used in methodID.</p>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.Origin.earthModelID">
<code class="sig-name descname">earthModelID</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.Origin.earthModelID" title="Permalink to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Return type</dt>
<dd class="field-odd"><p>string</p>
</dd>
</dl>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.Origin.setQuality">
<code class="sig-name descname">setQuality</code><span class="sig-paren">(</span><em class="sig-param">quality</em><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.Origin.setQuality" title="Permalink to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>quality</strong> <a class="reference internal" href="#api-python-datamodel-originquality"><span class="std std-ref">OriginQuality</span></a></p>
</dd>
</dl>
<p>Additional parameters describing the quality of an Origin determination.</p>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.Origin.quality">
<code class="sig-name descname">quality</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.Origin.quality" title="Permalink to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Return type</dt>
<dd class="field-odd"><p><a class="reference internal" href="#api-python-datamodel-originquality"><span class="std std-ref">OriginQuality</span></a></p>
</dd>
</dl>
<div class="admonition note">
<p class="admonition-title">Note</p>
<p>As this attribute is optional, this method throws a ValueError if
the value of the attribute is not set.</p>
</div>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.Origin.setUncertainty">
<code class="sig-name descname">setUncertainty</code><span class="sig-paren">(</span><em class="sig-param">uncertainty</em><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.Origin.setUncertainty" title="Permalink to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>uncertainty</strong> <a class="reference internal" href="#api-python-datamodel-originuncertainty"><span class="std std-ref">OriginUncertainty</span></a></p>
</dd>
</dl>
<p>Additional parameters describing the uncertainty of an Origin determination.</p>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.Origin.uncertainty">
<code class="sig-name descname">uncertainty</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.Origin.uncertainty" title="Permalink to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Return type</dt>
<dd class="field-odd"><p><a class="reference internal" href="#api-python-datamodel-originuncertainty"><span class="std std-ref">OriginUncertainty</span></a></p>
</dd>
</dl>
<div class="admonition note">
<p class="admonition-title">Note</p>
<p>As this attribute is optional, this method throws a ValueError if
the value of the attribute is not set.</p>
</div>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.Origin.setType">
<code class="sig-name descname">setType</code><span class="sig-paren">(</span><em class="sig-param">type</em><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.Origin.setType" title="Permalink to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>type</strong> OriginType</p>
</dd>
</dl>
<p>Describes the Origin type.</p>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.Origin.type">
<code class="sig-name descname">type</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.Origin.type" title="Permalink to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Return type</dt>
<dd class="field-odd"><p>OriginType</p>
</dd>
</dl>
<div class="admonition note">
<p class="admonition-title">Note</p>
<p>As this attribute is optional, this method throws a ValueError if
the value of the attribute is not set.</p>
</div>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.Origin.setEvaluationMode">
<code class="sig-name descname">setEvaluationMode</code><span class="sig-paren">(</span><em class="sig-param">evaluationMode</em><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.Origin.setEvaluationMode" title="Permalink to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>evaluationMode</strong> EvaluationMode</p>
</dd>
</dl>
<p>Evaluation mode of Origin.</p>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.Origin.evaluationMode">
<code class="sig-name descname">evaluationMode</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.Origin.evaluationMode" title="Permalink to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Return type</dt>
<dd class="field-odd"><p>EvaluationMode</p>
</dd>
</dl>
<div class="admonition note">
<p class="admonition-title">Note</p>
<p>As this attribute is optional, this method throws a ValueError if
the value of the attribute is not set.</p>
</div>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.Origin.setEvaluationStatus">
<code class="sig-name descname">setEvaluationStatus</code><span class="sig-paren">(</span><em class="sig-param">evaluationStatus</em><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.Origin.setEvaluationStatus" title="Permalink to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>evaluationStatus</strong> EvaluationStatus</p>
</dd>
</dl>
<p>Evaluation status of Origin.</p>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.Origin.evaluationStatus">
<code class="sig-name descname">evaluationStatus</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.Origin.evaluationStatus" title="Permalink to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Return type</dt>
<dd class="field-odd"><p>EvaluationStatus</p>
</dd>
</dl>
<div class="admonition note">
<p class="admonition-title">Note</p>
<p>As this attribute is optional, this method throws a ValueError if
the value of the attribute is not set.</p>
</div>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.Origin.setCreationInfo">
<code class="sig-name descname">setCreationInfo</code><span class="sig-paren">(</span><em class="sig-param">creationInfo</em><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.Origin.setCreationInfo" title="Permalink to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>creationInfo</strong> <a class="reference internal" href="#api-python-datamodel-creationinfo"><span class="std std-ref">CreationInfo</span></a></p>
</dd>
</dl>
<p>CreationInfo for the Origin object.</p>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.Origin.creationInfo">
<code class="sig-name descname">creationInfo</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.Origin.creationInfo" title="Permalink to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Return type</dt>
<dd class="field-odd"><p><a class="reference internal" href="#api-python-datamodel-creationinfo"><span class="std std-ref">CreationInfo</span></a></p>
</dd>
</dl>
<div class="admonition note">
<p class="admonition-title">Note</p>
<p>As this attribute is optional, this method throws a ValueError if
the value of the attribute is not set.</p>
</div>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.Origin.add">
<code class="sig-name descname">add</code><span class="sig-paren">(</span><em class="sig-param">comment</em><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.Origin.add" title="Permalink to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>comment</strong> Object of type <a class="reference internal" href="#api-python-datamodel-comment"><span class="std std-ref">Comment</span></a></p>
</dd>
<dt class="field-even">Return type</dt>
<dd class="field-even"><p>A Boolean value indicating success with True, False otherwise.</p>
</dd>
</dl>
<p>Adds a Comment object to Origin. The object is not
copied but managed by this instance. Any change to the passed object
will also change the child.</p>
</dd></dl>
<dl class="method">
<dt>
<code class="sig-name descname">add</code><span class="sig-paren">(</span><em class="sig-param">compositeTime</em><span class="sig-paren">)</span></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>compositeTime</strong> Object of type <a class="reference internal" href="#api-python-datamodel-compositetime"><span class="std std-ref">CompositeTime</span></a></p>
</dd>
<dt class="field-even">Return type</dt>
<dd class="field-even"><p>A Boolean value indicating success with True, False otherwise.</p>
</dd>
</dl>
<p>Adds a CompositeTime object to Origin. The object is not
copied but managed by this instance. Any change to the passed object
will also change the child.</p>
</dd></dl>
<dl class="method">
<dt>
<code class="sig-name descname">add</code><span class="sig-paren">(</span><em class="sig-param">arrival</em><span class="sig-paren">)</span></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>arrival</strong> Object of type <a class="reference internal" href="#api-python-datamodel-arrival"><span class="std std-ref">Arrival</span></a></p>
</dd>
<dt class="field-even">Return type</dt>
<dd class="field-even"><p>A Boolean value indicating success with True, False otherwise.</p>
</dd>
</dl>
<p>Adds a Arrival object to Origin. The object is not
copied but managed by this instance. Any change to the passed object
will also change the child.</p>
</dd></dl>
<dl class="method">
<dt>
<code class="sig-name descname">add</code><span class="sig-paren">(</span><em class="sig-param">stationMagnitude</em><span class="sig-paren">)</span></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>stationMagnitude</strong> Object of type <a class="reference internal" href="#api-python-datamodel-stationmagnitude"><span class="std std-ref">StationMagnitude</span></a></p>
</dd>
<dt class="field-even">Return type</dt>
<dd class="field-even"><p>A Boolean value indicating success with True, False otherwise.</p>
</dd>
</dl>
<p>Adds a StationMagnitude object to Origin. The object is not
copied but managed by this instance. Any change to the passed object
will also change the child.</p>
</dd></dl>
<dl class="method">
<dt>
<code class="sig-name descname">add</code><span class="sig-paren">(</span><em class="sig-param">magnitude</em><span class="sig-paren">)</span></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>magnitude</strong> Object of type <a class="reference internal" href="#api-python-datamodel-magnitude"><span class="std std-ref">Magnitude</span></a></p>
</dd>
<dt class="field-even">Return type</dt>
<dd class="field-even"><p>A Boolean value indicating success with True, False otherwise.</p>
</dd>
</dl>
<p>Adds a Magnitude object to Origin. The object is not
copied but managed by this instance. Any change to the passed object
will also change the child.</p>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.Origin.remove">
<code class="sig-name descname">remove</code><span class="sig-paren">(</span><em class="sig-param">comment</em><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.Origin.remove" title="Permalink to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>comment</strong> Object of type <a class="reference internal" href="#api-python-datamodel-comment"><span class="std std-ref">Comment</span></a></p>
</dd>
<dt class="field-even">Return type</dt>
<dd class="field-even"><p>A Boolean value indicating success with True, False otherwise.</p>
</dd>
</dl>
<p>Removes a previously added Comment object from Origin.</p>
</dd></dl>
<dl class="method">
<dt>
<code class="sig-name descname">remove</code><span class="sig-paren">(</span><em class="sig-param">compositeTime</em><span class="sig-paren">)</span></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>compositeTime</strong> Object of type <a class="reference internal" href="#api-python-datamodel-compositetime"><span class="std std-ref">CompositeTime</span></a></p>
</dd>
<dt class="field-even">Return type</dt>
<dd class="field-even"><p>A Boolean value indicating success with True, False otherwise.</p>
</dd>
</dl>
<p>Removes a previously added CompositeTime object from Origin.</p>
</dd></dl>
<dl class="method">
<dt>
<code class="sig-name descname">remove</code><span class="sig-paren">(</span><em class="sig-param">arrival</em><span class="sig-paren">)</span></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>arrival</strong> Object of type <a class="reference internal" href="#api-python-datamodel-arrival"><span class="std std-ref">Arrival</span></a></p>
</dd>
<dt class="field-even">Return type</dt>
<dd class="field-even"><p>A Boolean value indicating success with True, False otherwise.</p>
</dd>
</dl>
<p>Removes a previously added Arrival object from Origin.</p>
</dd></dl>
<dl class="method">
<dt>
<code class="sig-name descname">remove</code><span class="sig-paren">(</span><em class="sig-param">stationMagnitude</em><span class="sig-paren">)</span></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>stationMagnitude</strong> Object of type <a class="reference internal" href="#api-python-datamodel-stationmagnitude"><span class="std std-ref">StationMagnitude</span></a></p>
</dd>
<dt class="field-even">Return type</dt>
<dd class="field-even"><p>A Boolean value indicating success with True, False otherwise.</p>
</dd>
</dl>
<p>Removes a previously added StationMagnitude object from Origin.</p>
</dd></dl>
<dl class="method">
<dt>
<code class="sig-name descname">remove</code><span class="sig-paren">(</span><em class="sig-param">magnitude</em><span class="sig-paren">)</span></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>magnitude</strong> Object of type <a class="reference internal" href="#api-python-datamodel-magnitude"><span class="std std-ref">Magnitude</span></a></p>
</dd>
<dt class="field-even">Return type</dt>
<dd class="field-even"><p>A Boolean value indicating success with True, False otherwise.</p>
</dd>
</dl>
<p>Removes a previously added Magnitude object from Origin.</p>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.Origin.removeComment">
<code class="sig-name descname">removeComment</code><span class="sig-paren">(</span><em class="sig-param">idx</em><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.Origin.removeComment" title="Permalink to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>idx</strong> An integer index of the object to be removed.</p>
</dd>
<dt class="field-even">Return type</dt>
<dd class="field-even"><p>A Boolean value indicating success with True, False otherwise.</p>
</dd>
</dl>
</dd></dl>
<dl class="method">
<dt>
<code class="sig-name descname">removeComment(commentIndex);</code></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>commentIndex</strong> The index of the object to be removed of type CommentIndex.</p>
</dd>
<dt class="field-even">Return type</dt>
<dd class="field-even"><p>A Boolean value indicating success with True, False otherwise.</p>
</dd>
</dl>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.Origin.removeCompositeTime">
<code class="sig-name descname">removeCompositeTime</code><span class="sig-paren">(</span><em class="sig-param">idx</em><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.Origin.removeCompositeTime" title="Permalink to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>idx</strong> An integer index of the object to be removed.</p>
</dd>
<dt class="field-even">Return type</dt>
<dd class="field-even"><p>A Boolean value indicating success with True, False otherwise.</p>
</dd>
</dl>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.Origin.removeArrival">
<code class="sig-name descname">removeArrival</code><span class="sig-paren">(</span><em class="sig-param">idx</em><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.Origin.removeArrival" title="Permalink to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>idx</strong> An integer index of the object to be removed.</p>
</dd>
<dt class="field-even">Return type</dt>
<dd class="field-even"><p>A Boolean value indicating success with True, False otherwise.</p>
</dd>
</dl>
</dd></dl>
<dl class="method">
<dt>
<code class="sig-name descname">removeArrival(arrivalIndex);</code></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>arrivalIndex</strong> The index of the object to be removed of type ArrivalIndex.</p>
</dd>
<dt class="field-even">Return type</dt>
<dd class="field-even"><p>A Boolean value indicating success with True, False otherwise.</p>
</dd>
</dl>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.Origin.removeStationMagnitude">
<code class="sig-name descname">removeStationMagnitude</code><span class="sig-paren">(</span><em class="sig-param">idx</em><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.Origin.removeStationMagnitude" title="Permalink to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>idx</strong> An integer index of the object to be removed.</p>
</dd>
<dt class="field-even">Return type</dt>
<dd class="field-even"><p>A Boolean value indicating success with True, False otherwise.</p>
</dd>
</dl>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.Origin.removeMagnitude">
<code class="sig-name descname">removeMagnitude</code><span class="sig-paren">(</span><em class="sig-param">idx</em><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.Origin.removeMagnitude" title="Permalink to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>idx</strong> An integer index of the object to be removed.</p>
</dd>
<dt class="field-even">Return type</dt>
<dd class="field-even"><p>A Boolean value indicating success with True, False otherwise.</p>
</dd>
</dl>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.Origin.commentCount">
<code class="sig-name descname">commentCount</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.Origin.commentCount" title="Permalink to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Return type</dt>
<dd class="field-odd"><p>integer value indicating the number of child objects.</p>
</dd>
</dl>
<p>Returns the number of Comment child objects.</p>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.Origin.compositeTimeCount">
<code class="sig-name descname">compositeTimeCount</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.Origin.compositeTimeCount" title="Permalink to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Return type</dt>
<dd class="field-odd"><p>integer value indicating the number of child objects.</p>
</dd>
</dl>
<p>Returns the number of CompositeTime child objects.</p>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.Origin.arrivalCount">
<code class="sig-name descname">arrivalCount</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.Origin.arrivalCount" title="Permalink to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Return type</dt>
<dd class="field-odd"><p>integer value indicating the number of child objects.</p>
</dd>
</dl>
<p>Returns the number of Arrival child objects.</p>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.Origin.stationMagnitudeCount">
<code class="sig-name descname">stationMagnitudeCount</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.Origin.stationMagnitudeCount" title="Permalink to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Return type</dt>
<dd class="field-odd"><p>integer value indicating the number of child objects.</p>
</dd>
</dl>
<p>Returns the number of StationMagnitude child objects.</p>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.Origin.magnitudeCount">
<code class="sig-name descname">magnitudeCount</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.Origin.magnitudeCount" title="Permalink to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Return type</dt>
<dd class="field-odd"><p>integer value indicating the number of child objects.</p>
</dd>
</dl>
<p>Returns the number of Magnitude child objects.</p>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.Origin.comment">
<code class="sig-name descname">comment</code><span class="sig-paren">(</span><em class="sig-param">idx</em><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.Origin.comment" title="Permalink to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>idx</strong> An integer index of the object to be returned.</p>
</dd>
<dt class="field-even">Return type</dt>
<dd class="field-even"><p>Object of type <a class="reference internal" href="#api-python-datamodel-comment"><span class="std std-ref">Comment</span></a>.</p>
</dd>
</dl>
<p>Returns the Comment at index idx.</p>
</dd></dl>
<dl class="method">
<dt>
<code class="sig-name descname">comment</code><span class="sig-paren">(</span><em class="sig-param">commentIndex</em><span class="sig-paren">)</span></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>commentIndex</strong> The index of the object to be removed of type CommentIndex.</p>
</dd>
<dt class="field-even">Return type</dt>
<dd class="field-even"><p>Object of type <a class="reference internal" href="#api-python-datamodel-comment"><span class="std std-ref">Comment</span></a>.</p>
</dd>
</dl>
<p>Returns the Comment at given index. The indexes of all child objects
are compared by value which makes this function slower than the direct
integer index look-up.</p>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.Origin.compositeTime">
<code class="sig-name descname">compositeTime</code><span class="sig-paren">(</span><em class="sig-param">idx</em><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.Origin.compositeTime" title="Permalink to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>idx</strong> An integer index of the object to be returned.</p>
</dd>
<dt class="field-even">Return type</dt>
<dd class="field-even"><p>Object of type <a class="reference internal" href="#api-python-datamodel-compositetime"><span class="std std-ref">CompositeTime</span></a>.</p>
</dd>
</dl>
<p>Returns the CompositeTime at index idx.</p>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.Origin.arrival">
<code class="sig-name descname">arrival</code><span class="sig-paren">(</span><em class="sig-param">idx</em><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.Origin.arrival" title="Permalink to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>idx</strong> An integer index of the object to be returned.</p>
</dd>
<dt class="field-even">Return type</dt>
<dd class="field-even"><p>Object of type <a class="reference internal" href="#api-python-datamodel-arrival"><span class="std std-ref">Arrival</span></a>.</p>
</dd>
</dl>
<p>Returns the Arrival at index idx.</p>
</dd></dl>
<dl class="method">
<dt>
<code class="sig-name descname">arrival</code><span class="sig-paren">(</span><em class="sig-param">arrivalIndex</em><span class="sig-paren">)</span></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>arrivalIndex</strong> The index of the object to be removed of type ArrivalIndex.</p>
</dd>
<dt class="field-even">Return type</dt>
<dd class="field-even"><p>Object of type <a class="reference internal" href="#api-python-datamodel-arrival"><span class="std std-ref">Arrival</span></a>.</p>
</dd>
</dl>
<p>Returns the Arrival at given index. The indexes of all child objects
are compared by value which makes this function slower than the direct
integer index look-up.</p>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.Origin.stationMagnitude">
<code class="sig-name descname">stationMagnitude</code><span class="sig-paren">(</span><em class="sig-param">idx</em><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.Origin.stationMagnitude" title="Permalink to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>idx</strong> An integer index of the object to be returned.</p>
</dd>
<dt class="field-even">Return type</dt>
<dd class="field-even"><p>Object of type <a class="reference internal" href="#api-python-datamodel-stationmagnitude"><span class="std std-ref">StationMagnitude</span></a>.</p>
</dd>
</dl>
<p>Returns the StationMagnitude at index idx.</p>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.Origin.magnitude">
<code class="sig-name descname">magnitude</code><span class="sig-paren">(</span><em class="sig-param">idx</em><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.Origin.magnitude" title="Permalink to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>idx</strong> An integer index of the object to be returned.</p>
</dd>
<dt class="field-even">Return type</dt>
<dd class="field-even"><p>Object of type <a class="reference internal" href="#api-python-datamodel-magnitude"><span class="std std-ref">Magnitude</span></a>.</p>
</dd>
</dl>
<p>Returns the Magnitude at index idx.</p>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.Origin.findCompositeTime">
<code class="sig-name descname">findCompositeTime</code><span class="sig-paren">(</span><em class="sig-param">compositeTime</em><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.Origin.findCompositeTime" title="Permalink to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>compositeTime</strong> Reference object of type <a class="reference internal" href="#api-python-datamodel-compositetime"><span class="std std-ref">CompositeTime</span></a>.</p>
</dd>
<dt class="field-even">Return type</dt>
<dd class="field-even"><p>Object of type <a class="reference internal" href="#api-python-datamodel-compositetime"><span class="std std-ref">CompositeTime</span></a>.</p>
</dd>
</dl>
<p>Returns the child object with equals the passed object, None otherwise.</p>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.Origin.findStationMagnitude">
<code class="sig-name descname">findStationMagnitude</code><span class="sig-paren">(</span><em class="sig-param">publicID</em><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.Origin.findStationMagnitude" title="Permalink to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>publicID</strong> The publicID of the object to find.</p>
</dd>
<dt class="field-even">Return type</dt>
<dd class="field-even"><p>Object of type <a class="reference internal" href="#api-python-datamodel-stationmagnitude"><span class="std std-ref">StationMagnitude</span></a>.</p>
</dd>
</dl>
<p>Returns the child object with a certain publicID, None otherwise.</p>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.Origin.findMagnitude">
<code class="sig-name descname">findMagnitude</code><span class="sig-paren">(</span><em class="sig-param">publicID</em><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.Origin.findMagnitude" title="Permalink to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>publicID</strong> The publicID of the object to find.</p>
</dd>
<dt class="field-even">Return type</dt>
<dd class="field-even"><p>Object of type <a class="reference internal" href="#api-python-datamodel-magnitude"><span class="std std-ref">Magnitude</span></a>.</p>
</dd>
</dl>
<p>Returns the child object with a certain publicID, None otherwise.</p>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.Origin.eventParameters">
<code class="sig-name descname">eventParameters</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.Origin.eventParameters" title="Permalink to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Return type</dt>
<dd class="field-odd"><p><a class="reference internal" href="#seiscomp.datamodel.EventParameters" title="seiscomp.datamodel.EventParameters">EventParameters</a></p>
</dd>
</dl>
<p>Returns the parent EventParameters if available. Returns None
if the parent is not a EventParameters. This is a convenience wrapper
for parent().</p>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.Origin.assign">
<code class="sig-name descname">assign</code><span class="sig-paren">(</span><em class="sig-param">other</em><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.Origin.assign" title="Permalink to this definition"></a></dt>
<dd><p>This method implements the <a class="reference internal" href="#api-python-datamodel-object"><span class="std std-ref">Object</span></a> interface.</p>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.Origin.attachTo">
<code class="sig-name descname">attachTo</code><span class="sig-paren">(</span><em class="sig-param">parent</em><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.Origin.attachTo" title="Permalink to this definition"></a></dt>
<dd><p>This method implements the <a class="reference internal" href="#api-python-datamodel-object"><span class="std std-ref">Object</span></a> interface.</p>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.Origin.detachFrom">
<code class="sig-name descname">detachFrom</code><span class="sig-paren">(</span><em class="sig-param">parent</em><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.Origin.detachFrom" title="Permalink to this definition"></a></dt>
<dd><p>This method implements the <a class="reference internal" href="#api-python-datamodel-object"><span class="std std-ref">Object</span></a> interface.</p>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.Origin.detach">
<code class="sig-name descname">detach</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.Origin.detach" title="Permalink to this definition"></a></dt>
<dd><p>This method implements the <a class="reference internal" href="#api-python-datamodel-object"><span class="std std-ref">Object</span></a> interface.</p>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.Origin.clone">
<code class="sig-name descname">clone</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.Origin.clone" title="Permalink to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Return type</dt>
<dd class="field-odd"><p>A cloned Origin.</p>
</dd>
</dl>
<p>Returns a new instance that is a clone of the current instance. Child
objects are being ignored.</p>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.Origin.updateChild">
<code class="sig-name descname">updateChild</code><span class="sig-paren">(</span><em class="sig-param">ref</em><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.Origin.updateChild" title="Permalink to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>ref</strong> A child object derived from class Object.</p>
</dd>
<dt class="field-even">Return type</dt>
<dd class="field-even"><p>A Boolean flag indicating success with True, False otherwise</p>
</dd>
</dl>
<p>This method takes the passed reference object and searches for a child
with the same publicID (if derived from <a class="reference internal" href="#api-python-datamodel-publicobject"><span class="std std-ref">PublicObject</span></a>)
or the same index (if derived from <a class="reference internal" href="#api-python-datamodel-object"><span class="std std-ref">Object</span></a>).
The the child was found the reference objects attributes are copied to
the child object. Children of child are being ignored during this operation.
This method implements the <a class="reference internal" href="#api-python-datamodel-publicobject"><span class="std std-ref">PublicObject</span></a> interface.</p>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.Origin.accept">
<code class="sig-name descname">accept</code><span class="sig-paren">(</span><em class="sig-param">visitor</em><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.Origin.accept" title="Permalink to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>visitor</strong> A visitor.</p>
</dd>
</dl>
<p>This method implements the <a class="reference internal" href="#api-python-datamodel-publicobject"><span class="std std-ref">PublicObject</span></a> interface.</p>
</dd></dl>
</dd></dl>
</div>
<div class="section" id="originquality">
<span id="api-python-datamodel-originquality"></span><h3>OriginQuality<a class="headerlink" href="#originquality" title="Permalink to this headline"></a></h3>
<dl class="class">
<dt id="seiscomp.datamodel.OriginQuality">
<em class="property">class </em><code class="sig-prename descclassname">seiscomp.datamodel.</code><code class="sig-name descname">OriginQuality</code><a class="headerlink" href="#seiscomp.datamodel.OriginQuality" title="Permalink to this definition"></a></dt>
<dd><p>Inherits <a class="reference internal" href="#api-python-datamodel-object"><span class="std std-ref">Object</span></a>.</p>
<p>This type contains various attributes commonly used to describe the quality of
an origin, e. g., errors, azimuthal
coverage, etc. Origin objects have an optional attribute of the type
OriginQuality.</p>
<p><strong>Attributes</strong>:</p>
<ul class="simple">
<li><p><code class="docutils literal notranslate"><span class="pre">associatedPhaseCount</span></code> int (optional)</p></li>
<li><p><code class="docutils literal notranslate"><span class="pre">usedPhaseCount</span></code> int (optional)</p></li>
<li><p><code class="docutils literal notranslate"><span class="pre">associatedStationCount</span></code> int (optional)</p></li>
<li><p><code class="docutils literal notranslate"><span class="pre">usedStationCount</span></code> int (optional)</p></li>
<li><p><code class="docutils literal notranslate"><span class="pre">depthPhaseCount</span></code> int (optional)</p></li>
<li><p><code class="docutils literal notranslate"><span class="pre">standardError</span></code> float (optional)</p></li>
<li><p><code class="docutils literal notranslate"><span class="pre">azimuthalGap</span></code> float (optional)</p></li>
<li><p><code class="docutils literal notranslate"><span class="pre">secondaryAzimuthalGap</span></code> float (optional)</p></li>
<li><p><code class="docutils literal notranslate"><span class="pre">groundTruthLevel</span></code> string</p></li>
<li><p><code class="docutils literal notranslate"><span class="pre">maximumDistance</span></code> float (optional)</p></li>
<li><p><code class="docutils literal notranslate"><span class="pre">minimumDistance</span></code> float (optional)</p></li>
<li><p><code class="docutils literal notranslate"><span class="pre">medianDistance</span></code> float (optional)</p></li>
</ul>
<p><strong>Used by</strong>:</p>
<ul class="simple">
<li><p><a class="reference internal" href="#seiscomp.datamodel.Origin.quality" title="seiscomp.datamodel.Origin.quality"><code class="xref py py-func docutils literal notranslate"><span class="pre">Origin.quality()</span></code></a></p></li>
</ul>
<p><strong>Methods</strong>:</p>
<dl class="method">
<dt id="seiscomp.datamodel.OriginQuality.Cast">
<em class="property">static </em><code class="sig-name descname">Cast</code><span class="sig-paren">(</span><em class="sig-param">obj</em><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.OriginQuality.Cast" title="Permalink to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>obj</strong> The object to be casted.</p>
</dd>
<dt class="field-even">Return type</dt>
<dd class="field-even"><p>An object of type OriginQuality if the cast was successful,
None otherwise.</p>
</dd>
</dl>
<p>Cast an arbitrary object to OriginQuality if the internal wrapped
representation is an OriginQuality object. The cast is important if
instances of type <a class="reference internal" href="#api-python-datamodel-object"><span class="std std-ref">Object</span></a>
are passed to methods which need access to the real type.</p>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.OriginQuality.equal">
<code class="sig-name descname">equal</code><span class="sig-paren">(</span><em class="sig-param">other</em><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.OriginQuality.equal" title="Permalink to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>other</strong> Another object of type OriginQuality to compare this
instance to</p>
</dd>
<dt class="field-even">Return type</dt>
<dd class="field-even"><p>A Boolean value indicating True if both objects are equal or
False otherwise.</p>
</dd>
</dl>
<p>Compares two objects without its child objects. Both objects are compared
by value.</p>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.OriginQuality.setAssociatedPhaseCount">
<code class="sig-name descname">setAssociatedPhaseCount</code><span class="sig-paren">(</span><em class="sig-param">associatedPhaseCount</em><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.OriginQuality.setAssociatedPhaseCount" title="Permalink to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>associatedPhaseCount</strong> int</p>
</dd>
</dl>
<p>Number of associated phases, regardless of their use for origin computation.</p>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.OriginQuality.associatedPhaseCount">
<code class="sig-name descname">associatedPhaseCount</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.OriginQuality.associatedPhaseCount" title="Permalink to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Return type</dt>
<dd class="field-odd"><p>int</p>
</dd>
</dl>
<div class="admonition note">
<p class="admonition-title">Note</p>
<p>As this attribute is optional, this method throws a ValueError if
the value of the attribute is not set.</p>
</div>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.OriginQuality.setUsedPhaseCount">
<code class="sig-name descname">setUsedPhaseCount</code><span class="sig-paren">(</span><em class="sig-param">usedPhaseCount</em><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.OriginQuality.setUsedPhaseCount" title="Permalink to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>usedPhaseCount</strong> int</p>
</dd>
</dl>
<p>Number of defining phases, i. e., phase observations that were actually used
for computing
the origin. Note that there may be more than one defining phase per station.</p>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.OriginQuality.usedPhaseCount">
<code class="sig-name descname">usedPhaseCount</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.OriginQuality.usedPhaseCount" title="Permalink to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Return type</dt>
<dd class="field-odd"><p>int</p>
</dd>
</dl>
<div class="admonition note">
<p class="admonition-title">Note</p>
<p>As this attribute is optional, this method throws a ValueError if
the value of the attribute is not set.</p>
</div>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.OriginQuality.setAssociatedStationCount">
<code class="sig-name descname">setAssociatedStationCount</code><span class="sig-paren">(</span><em class="sig-param">associatedStationCount</em><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.OriginQuality.setAssociatedStationCount" title="Permalink to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>associatedStationCount</strong> int</p>
</dd>
</dl>
<p>Number of stations at which the event was observed.</p>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.OriginQuality.associatedStationCount">
<code class="sig-name descname">associatedStationCount</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.OriginQuality.associatedStationCount" title="Permalink to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Return type</dt>
<dd class="field-odd"><p>int</p>
</dd>
</dl>
<div class="admonition note">
<p class="admonition-title">Note</p>
<p>As this attribute is optional, this method throws a ValueError if
the value of the attribute is not set.</p>
</div>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.OriginQuality.setUsedStationCount">
<code class="sig-name descname">setUsedStationCount</code><span class="sig-paren">(</span><em class="sig-param">usedStationCount</em><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.OriginQuality.setUsedStationCount" title="Permalink to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>usedStationCount</strong> int</p>
</dd>
</dl>
<p>Number of stations from which data was used for origin computation.</p>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.OriginQuality.usedStationCount">
<code class="sig-name descname">usedStationCount</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.OriginQuality.usedStationCount" title="Permalink to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Return type</dt>
<dd class="field-odd"><p>int</p>
</dd>
</dl>
<div class="admonition note">
<p class="admonition-title">Note</p>
<p>As this attribute is optional, this method throws a ValueError if
the value of the attribute is not set.</p>
</div>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.OriginQuality.setDepthPhaseCount">
<code class="sig-name descname">setDepthPhaseCount</code><span class="sig-paren">(</span><em class="sig-param">depthPhaseCount</em><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.OriginQuality.setDepthPhaseCount" title="Permalink to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>depthPhaseCount</strong> int</p>
</dd>
</dl>
<p>Number of depth phases (typically pP, sometimes sP) used in depth
computation.</p>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.OriginQuality.depthPhaseCount">
<code class="sig-name descname">depthPhaseCount</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.OriginQuality.depthPhaseCount" title="Permalink to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Return type</dt>
<dd class="field-odd"><p>int</p>
</dd>
</dl>
<div class="admonition note">
<p class="admonition-title">Note</p>
<p>As this attribute is optional, this method throws a ValueError if
the value of the attribute is not set.</p>
</div>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.OriginQuality.setStandardError">
<code class="sig-name descname">setStandardError</code><span class="sig-paren">(</span><em class="sig-param">standardError</em><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.OriginQuality.setStandardError" title="Permalink to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>standardError</strong> float</p>
</dd>
</dl>
<p>RMS of the travel time residuals of the arrivals used for the origin
computation
in seconds.</p>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.OriginQuality.standardError">
<code class="sig-name descname">standardError</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.OriginQuality.standardError" title="Permalink to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Return type</dt>
<dd class="field-odd"><p>float</p>
</dd>
</dl>
<div class="admonition note">
<p class="admonition-title">Note</p>
<p>As this attribute is optional, this method throws a ValueError if
the value of the attribute is not set.</p>
</div>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.OriginQuality.setAzimuthalGap">
<code class="sig-name descname">setAzimuthalGap</code><span class="sig-paren">(</span><em class="sig-param">azimuthalGap</em><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.OriginQuality.setAzimuthalGap" title="Permalink to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>azimuthalGap</strong> float</p>
</dd>
</dl>
<p>Largest azimuthal gap in station distribution as seen from epicenter
in degrees.</p>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.OriginQuality.azimuthalGap">
<code class="sig-name descname">azimuthalGap</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.OriginQuality.azimuthalGap" title="Permalink to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Return type</dt>
<dd class="field-odd"><p>float</p>
</dd>
</dl>
<div class="admonition note">
<p class="admonition-title">Note</p>
<p>As this attribute is optional, this method throws a ValueError if
the value of the attribute is not set.</p>
</div>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.OriginQuality.setSecondaryAzimuthalGap">
<code class="sig-name descname">setSecondaryAzimuthalGap</code><span class="sig-paren">(</span><em class="sig-param">secondaryAzimuthalGap</em><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.OriginQuality.setSecondaryAzimuthalGap" title="Permalink to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>secondaryAzimuthalGap</strong> float</p>
</dd>
</dl>
<p>Secondary azimuthal gap in station distribution, i. e., the largest
azimuthal gap a station closes in degrees.</p>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.OriginQuality.secondaryAzimuthalGap">
<code class="sig-name descname">secondaryAzimuthalGap</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.OriginQuality.secondaryAzimuthalGap" title="Permalink to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Return type</dt>
<dd class="field-odd"><p>float</p>
</dd>
</dl>
<div class="admonition note">
<p class="admonition-title">Note</p>
<p>As this attribute is optional, this method throws a ValueError if
the value of the attribute is not set.</p>
</div>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.OriginQuality.setGroundTruthLevel">
<code class="sig-name descname">setGroundTruthLevel</code><span class="sig-paren">(</span><em class="sig-param">groundTruthLevel</em><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.OriginQuality.setGroundTruthLevel" title="Permalink to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>groundTruthLevel</strong> string</p>
</dd>
</dl>
<p>String describing ground-truth level, e. g. GT0, GT5, etc. It has a maximum
length of 16
characters.</p>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.OriginQuality.groundTruthLevel">
<code class="sig-name descname">groundTruthLevel</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.OriginQuality.groundTruthLevel" title="Permalink to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Return type</dt>
<dd class="field-odd"><p>string</p>
</dd>
</dl>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.OriginQuality.setMaximumDistance">
<code class="sig-name descname">setMaximumDistance</code><span class="sig-paren">(</span><em class="sig-param">maximumDistance</em><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.OriginQuality.setMaximumDistance" title="Permalink to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>maximumDistance</strong> float</p>
</dd>
</dl>
<p>Epicentral distance of station farthest from the epicenter in degrees.</p>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.OriginQuality.maximumDistance">
<code class="sig-name descname">maximumDistance</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.OriginQuality.maximumDistance" title="Permalink to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Return type</dt>
<dd class="field-odd"><p>float</p>
</dd>
</dl>
<div class="admonition note">
<p class="admonition-title">Note</p>
<p>As this attribute is optional, this method throws a ValueError if
the value of the attribute is not set.</p>
</div>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.OriginQuality.setMinimumDistance">
<code class="sig-name descname">setMinimumDistance</code><span class="sig-paren">(</span><em class="sig-param">minimumDistance</em><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.OriginQuality.setMinimumDistance" title="Permalink to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>minimumDistance</strong> float</p>
</dd>
</dl>
<p>Epicentral distance of station closest to the epicenter in degrees.</p>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.OriginQuality.minimumDistance">
<code class="sig-name descname">minimumDistance</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.OriginQuality.minimumDistance" title="Permalink to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Return type</dt>
<dd class="field-odd"><p>float</p>
</dd>
</dl>
<div class="admonition note">
<p class="admonition-title">Note</p>
<p>As this attribute is optional, this method throws a ValueError if
the value of the attribute is not set.</p>
</div>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.OriginQuality.setMedianDistance">
<code class="sig-name descname">setMedianDistance</code><span class="sig-paren">(</span><em class="sig-param">medianDistance</em><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.OriginQuality.setMedianDistance" title="Permalink to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>medianDistance</strong> float</p>
</dd>
</dl>
<p>Median epicentral distance of used stations in degrees.</p>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.OriginQuality.medianDistance">
<code class="sig-name descname">medianDistance</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.OriginQuality.medianDistance" title="Permalink to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Return type</dt>
<dd class="field-odd"><p>float</p>
</dd>
</dl>
<div class="admonition note">
<p class="admonition-title">Note</p>
<p>As this attribute is optional, this method throws a ValueError if
the value of the attribute is not set.</p>
</div>
</dd></dl>
</dd></dl>
</div>
<div class="section" id="originreference">
<span id="api-python-datamodel-originreference"></span><h3>OriginReference<a class="headerlink" href="#originreference" title="Permalink to this headline"></a></h3>
<dl class="class">
<dt id="seiscomp.datamodel.OriginReference">
<em class="property">class </em><code class="sig-prename descclassname">seiscomp.datamodel.</code><code class="sig-name descname">OriginReference</code><a class="headerlink" href="#seiscomp.datamodel.OriginReference" title="Permalink to this definition"></a></dt>
<dd><p>Inherits <a class="reference internal" href="#api-python-datamodel-object"><span class="std std-ref">Object</span></a>.</p>
<p><strong>Parents</strong>:</p>
<ul class="simple">
<li><p><code class="docutils literal notranslate"><span class="pre">event</span></code> <a class="reference internal" href="#api-python-datamodel-event"><span class="std std-ref">Event</span></a></p></li>
</ul>
<p><strong>Attributes</strong>:</p>
<ul class="simple">
<li><p><code class="docutils literal notranslate"><span class="pre">originID</span></code> string</p></li>
</ul>
<p><strong>Methods</strong>:</p>
<dl class="method">
<dt id="seiscomp.datamodel.OriginReference.Cast">
<em class="property">static </em><code class="sig-name descname">Cast</code><span class="sig-paren">(</span><em class="sig-param">obj</em><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.OriginReference.Cast" title="Permalink to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>obj</strong> The object to be casted.</p>
</dd>
<dt class="field-even">Return type</dt>
<dd class="field-even"><p>An object of type OriginReference if the cast was successful,
None otherwise.</p>
</dd>
</dl>
<p>Cast an arbitrary object to OriginReference if the internal wrapped
representation is an OriginReference object. The cast is important if
instances of type <a class="reference internal" href="#api-python-datamodel-object"><span class="std std-ref">Object</span></a>
are passed to methods which need access to the real type.</p>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.OriginReference.equal">
<code class="sig-name descname">equal</code><span class="sig-paren">(</span><em class="sig-param">other</em><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.OriginReference.equal" title="Permalink to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>other</strong> Another object of type OriginReference to compare this
instance to</p>
</dd>
<dt class="field-even">Return type</dt>
<dd class="field-even"><p>A Boolean value indicating True if both objects are equal or
False otherwise.</p>
</dd>
</dl>
<p>Compares two objects without its child objects. Both objects are compared
by value.</p>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.OriginReference.index">
<code class="sig-name descname">index</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.OriginReference.index" title="Permalink to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Return type</dt>
<dd class="field-odd"><p><p>The objects index of type OriginReferenceIndex.</p>
<p>Returns the objects index which is also used for the database as unique
constraint.</p>
</p>
</dd>
</dl>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.OriginReference.equalIndex">
<code class="sig-name descname">equalIndex</code><span class="sig-paren">(</span><em class="sig-param">lhs</em><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.OriginReference.equalIndex" title="Permalink to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>lhs</strong> <a class="reference internal" href="#api-python-datamodel-originreference"><span class="std std-ref">OriginReference</span></a></p>
</dd>
<dt class="field-even">Return type</dt>
<dd class="field-even"><p>A Boolean value indicating True if both indexes are equal or
False otherwise.</p>
</dd>
</dl>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.OriginReference.setOriginID">
<code class="sig-name descname">setOriginID</code><span class="sig-paren">(</span><em class="sig-param">originID</em><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.OriginReference.setOriginID" title="Permalink to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>originID</strong> string</p>
</dd>
</dl>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.OriginReference.originID">
<code class="sig-name descname">originID</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.OriginReference.originID" title="Permalink to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Return type</dt>
<dd class="field-odd"><p>string</p>
</dd>
</dl>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.OriginReference.event">
<code class="sig-name descname">event</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.OriginReference.event" title="Permalink to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Return type</dt>
<dd class="field-odd"><p><a class="reference internal" href="#seiscomp.datamodel.Event" title="seiscomp.datamodel.Event">Event</a></p>
</dd>
</dl>
<p>Returns the parent Event if available. Returns None
if the parent is not a Event. This is a convenience wrapper
for parent().</p>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.OriginReference.assign">
<code class="sig-name descname">assign</code><span class="sig-paren">(</span><em class="sig-param">other</em><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.OriginReference.assign" title="Permalink to this definition"></a></dt>
<dd><p>This method implements the <a class="reference internal" href="#api-python-datamodel-object"><span class="std std-ref">Object</span></a> interface.</p>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.OriginReference.attachTo">
<code class="sig-name descname">attachTo</code><span class="sig-paren">(</span><em class="sig-param">parent</em><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.OriginReference.attachTo" title="Permalink to this definition"></a></dt>
<dd><p>This method implements the <a class="reference internal" href="#api-python-datamodel-object"><span class="std std-ref">Object</span></a> interface.</p>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.OriginReference.detachFrom">
<code class="sig-name descname">detachFrom</code><span class="sig-paren">(</span><em class="sig-param">parent</em><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.OriginReference.detachFrom" title="Permalink to this definition"></a></dt>
<dd><p>This method implements the <a class="reference internal" href="#api-python-datamodel-object"><span class="std std-ref">Object</span></a> interface.</p>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.OriginReference.detach">
<code class="sig-name descname">detach</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.OriginReference.detach" title="Permalink to this definition"></a></dt>
<dd><p>This method implements the <a class="reference internal" href="#api-python-datamodel-object"><span class="std std-ref">Object</span></a> interface.</p>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.OriginReference.clone">
<code class="sig-name descname">clone</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.OriginReference.clone" title="Permalink to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Return type</dt>
<dd class="field-odd"><p>A cloned OriginReference.</p>
</dd>
</dl>
<p>Returns a new instance that is a clone of the current instance. Child
objects are being ignored.</p>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.OriginReference.accept">
<code class="sig-name descname">accept</code><span class="sig-paren">(</span><em class="sig-param">visitor</em><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.OriginReference.accept" title="Permalink to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>visitor</strong> A visitor.</p>
</dd>
</dl>
<p>This method implements the <a class="reference internal" href="#api-python-datamodel-publicobject"><span class="std std-ref">PublicObject</span></a> interface.</p>
</dd></dl>
</dd></dl>
</div>
<div class="section" id="originuncertainty">
<span id="api-python-datamodel-originuncertainty"></span><h3>OriginUncertainty<a class="headerlink" href="#originuncertainty" title="Permalink to this headline"></a></h3>
<dl class="class">
<dt id="seiscomp.datamodel.OriginUncertainty">
<em class="property">class </em><code class="sig-prename descclassname">seiscomp.datamodel.</code><code class="sig-name descname">OriginUncertainty</code><a class="headerlink" href="#seiscomp.datamodel.OriginUncertainty" title="Permalink to this definition"></a></dt>
<dd><p>Inherits <a class="reference internal" href="#api-python-datamodel-object"><span class="std std-ref">Object</span></a>.</p>
<p>This class describes the location uncertainties of an origin. The uncertainty
can be described either as a simple circular horizontal uncertainty, an
uncertainty ellipse according to IMS1.0, or a confidence ellipsoid. If
multiple uncertainty models are given, the preferred variant can be
specified in the attribute preferredDescription.</p>
<p><strong>Attributes</strong>:</p>
<ul class="simple">
<li><p><code class="docutils literal notranslate"><span class="pre">horizontalUncertainty</span></code> float (optional)</p></li>
<li><p><code class="docutils literal notranslate"><span class="pre">minHorizontalUncertainty</span></code> float (optional)</p></li>
<li><p><code class="docutils literal notranslate"><span class="pre">maxHorizontalUncertainty</span></code> float (optional)</p></li>
<li><p><code class="docutils literal notranslate"><span class="pre">azimuthMaxHorizontalUncertainty</span></code> float (optional)</p></li>
<li><p><code class="docutils literal notranslate"><span class="pre">confidenceEllipsoid</span></code> <a class="reference internal" href="#api-python-datamodel-confidenceellipsoid"><span class="std std-ref">ConfidenceEllipsoid</span></a> (optional)</p></li>
<li><p><code class="docutils literal notranslate"><span class="pre">preferredDescription</span></code> <a class="reference internal" href="#api-python-datamodel-originuncertaintydescription"><span class="std std-ref">OriginUncertaintyDescription</span></a> (optional)</p></li>
<li><p><code class="docutils literal notranslate"><span class="pre">confidenceLevel</span></code> float (optional)</p></li>
</ul>
<p><strong>Used by</strong>:</p>
<ul class="simple">
<li><p><a class="reference internal" href="#seiscomp.datamodel.Origin.uncertainty" title="seiscomp.datamodel.Origin.uncertainty"><code class="xref py py-func docutils literal notranslate"><span class="pre">Origin.uncertainty()</span></code></a></p></li>
</ul>
<p><strong>Methods</strong>:</p>
<dl class="method">
<dt id="seiscomp.datamodel.OriginUncertainty.Cast">
<em class="property">static </em><code class="sig-name descname">Cast</code><span class="sig-paren">(</span><em class="sig-param">obj</em><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.OriginUncertainty.Cast" title="Permalink to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>obj</strong> The object to be casted.</p>
</dd>
<dt class="field-even">Return type</dt>
<dd class="field-even"><p>An object of type OriginUncertainty if the cast was successful,
None otherwise.</p>
</dd>
</dl>
<p>Cast an arbitrary object to OriginUncertainty if the internal wrapped
representation is an OriginUncertainty object. The cast is important if
instances of type <a class="reference internal" href="#api-python-datamodel-object"><span class="std std-ref">Object</span></a>
are passed to methods which need access to the real type.</p>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.OriginUncertainty.equal">
<code class="sig-name descname">equal</code><span class="sig-paren">(</span><em class="sig-param">other</em><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.OriginUncertainty.equal" title="Permalink to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>other</strong> Another object of type OriginUncertainty to compare this
instance to</p>
</dd>
<dt class="field-even">Return type</dt>
<dd class="field-even"><p>A Boolean value indicating True if both objects are equal or
False otherwise.</p>
</dd>
</dl>
<p>Compares two objects without its child objects. Both objects are compared
by value.</p>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.OriginUncertainty.setHorizontalUncertainty">
<code class="sig-name descname">setHorizontalUncertainty</code><span class="sig-paren">(</span><em class="sig-param">horizontalUncertainty</em><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.OriginUncertainty.setHorizontalUncertainty" title="Permalink to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>horizontalUncertainty</strong> float</p>
</dd>
</dl>
<p>Circular confidence region, given by single value of horizontal uncertainty
in km.</p>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.OriginUncertainty.horizontalUncertainty">
<code class="sig-name descname">horizontalUncertainty</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.OriginUncertainty.horizontalUncertainty" title="Permalink to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Return type</dt>
<dd class="field-odd"><p>float</p>
</dd>
</dl>
<div class="admonition note">
<p class="admonition-title">Note</p>
<p>As this attribute is optional, this method throws a ValueError if
the value of the attribute is not set.</p>
</div>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.OriginUncertainty.setMinHorizontalUncertainty">
<code class="sig-name descname">setMinHorizontalUncertainty</code><span class="sig-paren">(</span><em class="sig-param">minHorizontalUncertainty</em><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.OriginUncertainty.setMinHorizontalUncertainty" title="Permalink to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>minHorizontalUncertainty</strong> float</p>
</dd>
</dl>
<p>Semi-minor axis of confidence ellipse in km.</p>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.OriginUncertainty.minHorizontalUncertainty">
<code class="sig-name descname">minHorizontalUncertainty</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.OriginUncertainty.minHorizontalUncertainty" title="Permalink to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Return type</dt>
<dd class="field-odd"><p>float</p>
</dd>
</dl>
<div class="admonition note">
<p class="admonition-title">Note</p>
<p>As this attribute is optional, this method throws a ValueError if
the value of the attribute is not set.</p>
</div>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.OriginUncertainty.setMaxHorizontalUncertainty">
<code class="sig-name descname">setMaxHorizontalUncertainty</code><span class="sig-paren">(</span><em class="sig-param">maxHorizontalUncertainty</em><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.OriginUncertainty.setMaxHorizontalUncertainty" title="Permalink to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>maxHorizontalUncertainty</strong> float</p>
</dd>
</dl>
<p>Semi-major axis of confidence ellipse in km.</p>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.OriginUncertainty.maxHorizontalUncertainty">
<code class="sig-name descname">maxHorizontalUncertainty</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.OriginUncertainty.maxHorizontalUncertainty" title="Permalink to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Return type</dt>
<dd class="field-odd"><p>float</p>
</dd>
</dl>
<div class="admonition note">
<p class="admonition-title">Note</p>
<p>As this attribute is optional, this method throws a ValueError if
the value of the attribute is not set.</p>
</div>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.OriginUncertainty.setAzimuthMaxHorizontalUncertainty">
<code class="sig-name descname">setAzimuthMaxHorizontalUncertainty</code><span class="sig-paren">(</span><em class="sig-param">azimuthMaxHorizontalUncertainty</em><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.OriginUncertainty.setAzimuthMaxHorizontalUncertainty" title="Permalink to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>azimuthMaxHorizontalUncertainty</strong> float</p>
</dd>
</dl>
<p>Azimuth of major axis of confidence ellipse. Measured clockwise from
South-North direction at epicenter in degrees.</p>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.OriginUncertainty.azimuthMaxHorizontalUncertainty">
<code class="sig-name descname">azimuthMaxHorizontalUncertainty</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.OriginUncertainty.azimuthMaxHorizontalUncertainty" title="Permalink to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Return type</dt>
<dd class="field-odd"><p>float</p>
</dd>
</dl>
<div class="admonition note">
<p class="admonition-title">Note</p>
<p>As this attribute is optional, this method throws a ValueError if
the value of the attribute is not set.</p>
</div>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.OriginUncertainty.setConfidenceEllipsoid">
<code class="sig-name descname">setConfidenceEllipsoid</code><span class="sig-paren">(</span><em class="sig-param">confidenceEllipsoid</em><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.OriginUncertainty.setConfidenceEllipsoid" title="Permalink to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>confidenceEllipsoid</strong> <a class="reference internal" href="#api-python-datamodel-confidenceellipsoid"><span class="std std-ref">ConfidenceEllipsoid</span></a></p>
</dd>
</dl>
<p>Confidence ellipsoid.</p>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.OriginUncertainty.confidenceEllipsoid">
<code class="sig-name descname">confidenceEllipsoid</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.OriginUncertainty.confidenceEllipsoid" title="Permalink to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Return type</dt>
<dd class="field-odd"><p><a class="reference internal" href="#api-python-datamodel-confidenceellipsoid"><span class="std std-ref">ConfidenceEllipsoid</span></a></p>
</dd>
</dl>
<div class="admonition note">
<p class="admonition-title">Note</p>
<p>As this attribute is optional, this method throws a ValueError if
the value of the attribute is not set.</p>
</div>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.OriginUncertainty.setPreferredDescription">
<code class="sig-name descname">setPreferredDescription</code><span class="sig-paren">(</span><em class="sig-param">preferredDescription</em><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.OriginUncertainty.setPreferredDescription" title="Permalink to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>preferredDescription</strong> OriginUncertaintyDescription</p>
</dd>
</dl>
<p>Preferred uncertainty description.</p>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.OriginUncertainty.preferredDescription">
<code class="sig-name descname">preferredDescription</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.OriginUncertainty.preferredDescription" title="Permalink to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Return type</dt>
<dd class="field-odd"><p>OriginUncertaintyDescription</p>
</dd>
</dl>
<div class="admonition note">
<p class="admonition-title">Note</p>
<p>As this attribute is optional, this method throws a ValueError if
the value of the attribute is not set.</p>
</div>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.OriginUncertainty.setConfidenceLevel">
<code class="sig-name descname">setConfidenceLevel</code><span class="sig-paren">(</span><em class="sig-param">confidenceLevel</em><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.OriginUncertainty.setConfidenceLevel" title="Permalink to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>confidenceLevel</strong> float</p>
</dd>
</dl>
<p>Confidence level of the uncertainty, given in percent.</p>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.OriginUncertainty.confidenceLevel">
<code class="sig-name descname">confidenceLevel</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.OriginUncertainty.confidenceLevel" title="Permalink to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Return type</dt>
<dd class="field-odd"><p>float</p>
</dd>
</dl>
<div class="admonition note">
<p class="admonition-title">Note</p>
<p>As this attribute is optional, this method throws a ValueError if
the value of the attribute is not set.</p>
</div>
</dd></dl>
</dd></dl>
</div>
<div class="section" id="outage">
<span id="api-python-datamodel-outage"></span><h3>Outage<a class="headerlink" href="#outage" title="Permalink to this headline"></a></h3>
<dl class="class">
<dt id="seiscomp.datamodel.Outage">
<em class="property">class </em><code class="sig-prename descclassname">seiscomp.datamodel.</code><code class="sig-name descname">Outage</code><a class="headerlink" href="#seiscomp.datamodel.Outage" title="Permalink to this definition"></a></dt>
<dd><p>Inherits <a class="reference internal" href="#api-python-datamodel-object"><span class="std std-ref">Object</span></a>.</p>
<p><strong>Parents</strong>:</p>
<ul class="simple">
<li><p><code class="docutils literal notranslate"><span class="pre">qualityControl</span></code> <a class="reference internal" href="#api-python-datamodel-qualitycontrol"><span class="std std-ref">QualityControl</span></a></p></li>
</ul>
<p><strong>Attributes</strong>:</p>
<ul class="simple">
<li><p><code class="docutils literal notranslate"><span class="pre">waveformID</span></code> <a class="reference internal" href="#api-python-datamodel-waveformstreamid"><span class="std std-ref">WaveformStreamID</span></a></p></li>
<li><p><code class="docutils literal notranslate"><span class="pre">creatorID</span></code> string</p></li>
<li><p><code class="docutils literal notranslate"><span class="pre">created</span></code> seiscomp.core.Time</p></li>
<li><p><code class="docutils literal notranslate"><span class="pre">start</span></code> seiscomp.core.Time</p></li>
<li><p><code class="docutils literal notranslate"><span class="pre">end</span></code> seiscomp.core.Time (optional)</p></li>
</ul>
<p><strong>Methods</strong>:</p>
<dl class="method">
<dt id="seiscomp.datamodel.Outage.Cast">
<em class="property">static </em><code class="sig-name descname">Cast</code><span class="sig-paren">(</span><em class="sig-param">obj</em><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.Outage.Cast" title="Permalink to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>obj</strong> The object to be casted.</p>
</dd>
<dt class="field-even">Return type</dt>
<dd class="field-even"><p>An object of type Outage if the cast was successful,
None otherwise.</p>
</dd>
</dl>
<p>Cast an arbitrary object to Outage if the internal wrapped
representation is an Outage object. The cast is important if
instances of type <a class="reference internal" href="#api-python-datamodel-object"><span class="std std-ref">Object</span></a>
are passed to methods which need access to the real type.</p>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.Outage.equal">
<code class="sig-name descname">equal</code><span class="sig-paren">(</span><em class="sig-param">other</em><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.Outage.equal" title="Permalink to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>other</strong> Another object of type Outage to compare this
instance to</p>
</dd>
<dt class="field-even">Return type</dt>
<dd class="field-even"><p>A Boolean value indicating True if both objects are equal or
False otherwise.</p>
</dd>
</dl>
<p>Compares two objects without its child objects. Both objects are compared
by value.</p>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.Outage.index">
<code class="sig-name descname">index</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.Outage.index" title="Permalink to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Return type</dt>
<dd class="field-odd"><p><p>The objects index of type OutageIndex.</p>
<p>Returns the objects index which is also used for the database as unique
constraint.</p>
</p>
</dd>
</dl>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.Outage.equalIndex">
<code class="sig-name descname">equalIndex</code><span class="sig-paren">(</span><em class="sig-param">lhs</em><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.Outage.equalIndex" title="Permalink to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>lhs</strong> <a class="reference internal" href="#api-python-datamodel-outage"><span class="std std-ref">Outage</span></a></p>
</dd>
<dt class="field-even">Return type</dt>
<dd class="field-even"><p>A Boolean value indicating True if both indexes are equal or
False otherwise.</p>
</dd>
</dl>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.Outage.setWaveformID">
<code class="sig-name descname">setWaveformID</code><span class="sig-paren">(</span><em class="sig-param">waveformID</em><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.Outage.setWaveformID" title="Permalink to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>waveformID</strong> <a class="reference internal" href="#api-python-datamodel-waveformstreamid"><span class="std std-ref">WaveformStreamID</span></a></p>
</dd>
</dl>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.Outage.waveformID">
<code class="sig-name descname">waveformID</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.Outage.waveformID" title="Permalink to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Return type</dt>
<dd class="field-odd"><p><a class="reference internal" href="#api-python-datamodel-waveformstreamid"><span class="std std-ref">WaveformStreamID</span></a></p>
</dd>
</dl>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.Outage.setCreatorID">
<code class="sig-name descname">setCreatorID</code><span class="sig-paren">(</span><em class="sig-param">creatorID</em><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.Outage.setCreatorID" title="Permalink to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>creatorID</strong> string</p>
</dd>
</dl>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.Outage.creatorID">
<code class="sig-name descname">creatorID</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.Outage.creatorID" title="Permalink to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Return type</dt>
<dd class="field-odd"><p>string</p>
</dd>
</dl>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.Outage.setCreated">
<code class="sig-name descname">setCreated</code><span class="sig-paren">(</span><em class="sig-param">created</em><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.Outage.setCreated" title="Permalink to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>created</strong> seiscomp.core.Time</p>
</dd>
</dl>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.Outage.created">
<code class="sig-name descname">created</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.Outage.created" title="Permalink to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Return type</dt>
<dd class="field-odd"><p>seiscomp.core.Time</p>
</dd>
</dl>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.Outage.setStart">
<code class="sig-name descname">setStart</code><span class="sig-paren">(</span><em class="sig-param">start</em><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.Outage.setStart" title="Permalink to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>start</strong> seiscomp.core.Time</p>
</dd>
</dl>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.Outage.start">
<code class="sig-name descname">start</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.Outage.start" title="Permalink to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Return type</dt>
<dd class="field-odd"><p>seiscomp.core.Time</p>
</dd>
</dl>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.Outage.setEnd">
<code class="sig-name descname">setEnd</code><span class="sig-paren">(</span><em class="sig-param">end</em><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.Outage.setEnd" title="Permalink to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>end</strong> seiscomp.core.Time</p>
</dd>
</dl>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.Outage.end">
<code class="sig-name descname">end</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.Outage.end" title="Permalink to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Return type</dt>
<dd class="field-odd"><p>seiscomp.core.Time</p>
</dd>
</dl>
<div class="admonition note">
<p class="admonition-title">Note</p>
<p>As this attribute is optional, this method throws a ValueError if
the value of the attribute is not set.</p>
</div>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.Outage.qualityControl">
<code class="sig-name descname">qualityControl</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.Outage.qualityControl" title="Permalink to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Return type</dt>
<dd class="field-odd"><p><a class="reference internal" href="#seiscomp.datamodel.QualityControl" title="seiscomp.datamodel.QualityControl">QualityControl</a></p>
</dd>
</dl>
<p>Returns the parent QualityControl if available. Returns None
if the parent is not a QualityControl. This is a convenience wrapper
for parent().</p>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.Outage.assign">
<code class="sig-name descname">assign</code><span class="sig-paren">(</span><em class="sig-param">other</em><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.Outage.assign" title="Permalink to this definition"></a></dt>
<dd><p>This method implements the <a class="reference internal" href="#api-python-datamodel-object"><span class="std std-ref">Object</span></a> interface.</p>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.Outage.attachTo">
<code class="sig-name descname">attachTo</code><span class="sig-paren">(</span><em class="sig-param">parent</em><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.Outage.attachTo" title="Permalink to this definition"></a></dt>
<dd><p>This method implements the <a class="reference internal" href="#api-python-datamodel-object"><span class="std std-ref">Object</span></a> interface.</p>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.Outage.detachFrom">
<code class="sig-name descname">detachFrom</code><span class="sig-paren">(</span><em class="sig-param">parent</em><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.Outage.detachFrom" title="Permalink to this definition"></a></dt>
<dd><p>This method implements the <a class="reference internal" href="#api-python-datamodel-object"><span class="std std-ref">Object</span></a> interface.</p>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.Outage.detach">
<code class="sig-name descname">detach</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.Outage.detach" title="Permalink to this definition"></a></dt>
<dd><p>This method implements the <a class="reference internal" href="#api-python-datamodel-object"><span class="std std-ref">Object</span></a> interface.</p>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.Outage.clone">
<code class="sig-name descname">clone</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.Outage.clone" title="Permalink to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Return type</dt>
<dd class="field-odd"><p>A cloned Outage.</p>
</dd>
</dl>
<p>Returns a new instance that is a clone of the current instance. Child
objects are being ignored.</p>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.Outage.accept">
<code class="sig-name descname">accept</code><span class="sig-paren">(</span><em class="sig-param">visitor</em><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.Outage.accept" title="Permalink to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>visitor</strong> A visitor.</p>
</dd>
</dl>
<p>This method implements the <a class="reference internal" href="#api-python-datamodel-publicobject"><span class="std std-ref">PublicObject</span></a> interface.</p>
</dd></dl>
</dd></dl>
</div>
<div class="section" id="parameter">
<span id="api-python-datamodel-parameter"></span><h3>Parameter<a class="headerlink" href="#parameter" title="Permalink to this headline"></a></h3>
<dl class="class">
<dt id="seiscomp.datamodel.Parameter">
<em class="property">class </em><code class="sig-prename descclassname">seiscomp.datamodel.</code><code class="sig-name descname">Parameter</code><a class="headerlink" href="#seiscomp.datamodel.Parameter" title="Permalink to this definition"></a></dt>
<dd><p>Inherits <a class="reference internal" href="#api-python-datamodel-publicobject"><span class="std std-ref">PublicObject</span></a>.</p>
<p><strong>Parents</strong>:</p>
<ul class="simple">
<li><p><code class="docutils literal notranslate"><span class="pre">parameterSet</span></code> <a class="reference internal" href="#api-python-datamodel-parameterset"><span class="std std-ref">ParameterSet</span></a></p></li>
</ul>
<p><strong>Children</strong>:</p>
<ul class="simple">
<li><p><code class="docutils literal notranslate"><span class="pre">comment</span></code> <a class="reference internal" href="#api-python-datamodel-comment"><span class="std std-ref">Comment</span></a></p></li>
</ul>
<p><strong>Attributes</strong>:</p>
<ul class="simple">
<li><p><code class="docutils literal notranslate"><span class="pre">publicID</span></code>: string</p></li>
<li><p><code class="docutils literal notranslate"><span class="pre">name</span></code> string</p></li>
<li><p><code class="docutils literal notranslate"><span class="pre">value</span></code> string</p></li>
</ul>
<p><strong>Methods</strong>:</p>
<dl class="method">
<dt id="seiscomp.datamodel.Parameter.Cast">
<em class="property">static </em><code class="sig-name descname">Cast</code><span class="sig-paren">(</span><em class="sig-param">obj</em><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.Parameter.Cast" title="Permalink to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>obj</strong> The object to be casted.</p>
</dd>
<dt class="field-even">Return type</dt>
<dd class="field-even"><p>An object of type Parameter if the cast was successful,
None otherwise.</p>
</dd>
</dl>
<p>Cast an arbitrary object to Parameter if the internal wrapped
representation is an Parameter object. The cast is important if
instances of type <a class="reference internal" href="#api-python-datamodel-object"><span class="std std-ref">Object</span></a>
are passed to methods which need access to the real type.</p>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.Parameter.Create">
<em class="property">static </em><code class="sig-name descname">Create</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.Parameter.Create" title="Permalink to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Return type</dt>
<dd class="field-odd"><p>A new object of type Parameter.</p>
</dd>
</dl>
<p>Creates and registers (if enabled) a Parameter instance. The
publicID is auto-generated.</p>
</dd></dl>
<dl class="method">
<dt>
<em class="property">static </em><code class="sig-name descname">Create</code><span class="sig-paren">(</span><em class="sig-param">publicID</em><span class="sig-paren">)</span></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Return type</dt>
<dd class="field-odd"><p>A new object of type Parameter.</p>
</dd>
</dl>
<p>Creates and registers (if enabled) a Parameter instance with
passed publicID.</p>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.Parameter.equal">
<code class="sig-name descname">equal</code><span class="sig-paren">(</span><em class="sig-param">other</em><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.Parameter.equal" title="Permalink to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>other</strong> Another object of type Parameter to compare this
instance to</p>
</dd>
<dt class="field-even">Return type</dt>
<dd class="field-even"><p>A Boolean value indicating True if both objects are equal or
False otherwise.</p>
</dd>
</dl>
<p>Compares two objects without its child objects. Both objects are compared
by value.</p>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.Parameter.setName">
<code class="sig-name descname">setName</code><span class="sig-paren">(</span><em class="sig-param">name</em><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.Parameter.setName" title="Permalink to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>name</strong> string</p>
</dd>
</dl>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.Parameter.name">
<code class="sig-name descname">name</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.Parameter.name" title="Permalink to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Return type</dt>
<dd class="field-odd"><p>string</p>
</dd>
</dl>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.Parameter.setValue">
<code class="sig-name descname">setValue</code><span class="sig-paren">(</span><em class="sig-param">value</em><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.Parameter.setValue" title="Permalink to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>value</strong> string</p>
</dd>
</dl>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.Parameter.value">
<code class="sig-name descname">value</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.Parameter.value" title="Permalink to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Return type</dt>
<dd class="field-odd"><p>string</p>
</dd>
</dl>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.Parameter.add">
<code class="sig-name descname">add</code><span class="sig-paren">(</span><em class="sig-param">comment</em><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.Parameter.add" title="Permalink to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>comment</strong> Object of type <a class="reference internal" href="#api-python-datamodel-comment"><span class="std std-ref">Comment</span></a></p>
</dd>
<dt class="field-even">Return type</dt>
<dd class="field-even"><p>A Boolean value indicating success with True, False otherwise.</p>
</dd>
</dl>
<p>Adds a Comment object to Parameter. The object is not
copied but managed by this instance. Any change to the passed object
will also change the child.</p>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.Parameter.remove">
<code class="sig-name descname">remove</code><span class="sig-paren">(</span><em class="sig-param">comment</em><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.Parameter.remove" title="Permalink to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>comment</strong> Object of type <a class="reference internal" href="#api-python-datamodel-comment"><span class="std std-ref">Comment</span></a></p>
</dd>
<dt class="field-even">Return type</dt>
<dd class="field-even"><p>A Boolean value indicating success with True, False otherwise.</p>
</dd>
</dl>
<p>Removes a previously added Comment object from Parameter.</p>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.Parameter.removeComment">
<code class="sig-name descname">removeComment</code><span class="sig-paren">(</span><em class="sig-param">idx</em><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.Parameter.removeComment" title="Permalink to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>idx</strong> An integer index of the object to be removed.</p>
</dd>
<dt class="field-even">Return type</dt>
<dd class="field-even"><p>A Boolean value indicating success with True, False otherwise.</p>
</dd>
</dl>
</dd></dl>
<dl class="method">
<dt>
<code class="sig-name descname">removeComment(commentIndex);</code></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>commentIndex</strong> The index of the object to be removed of type CommentIndex.</p>
</dd>
<dt class="field-even">Return type</dt>
<dd class="field-even"><p>A Boolean value indicating success with True, False otherwise.</p>
</dd>
</dl>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.Parameter.commentCount">
<code class="sig-name descname">commentCount</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.Parameter.commentCount" title="Permalink to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Return type</dt>
<dd class="field-odd"><p>integer value indicating the number of child objects.</p>
</dd>
</dl>
<p>Returns the number of Comment child objects.</p>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.Parameter.comment">
<code class="sig-name descname">comment</code><span class="sig-paren">(</span><em class="sig-param">idx</em><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.Parameter.comment" title="Permalink to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>idx</strong> An integer index of the object to be returned.</p>
</dd>
<dt class="field-even">Return type</dt>
<dd class="field-even"><p>Object of type <a class="reference internal" href="#api-python-datamodel-comment"><span class="std std-ref">Comment</span></a>.</p>
</dd>
</dl>
<p>Returns the Comment at index idx.</p>
</dd></dl>
<dl class="method">
<dt>
<code class="sig-name descname">comment</code><span class="sig-paren">(</span><em class="sig-param">commentIndex</em><span class="sig-paren">)</span></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>commentIndex</strong> The index of the object to be removed of type CommentIndex.</p>
</dd>
<dt class="field-even">Return type</dt>
<dd class="field-even"><p>Object of type <a class="reference internal" href="#api-python-datamodel-comment"><span class="std std-ref">Comment</span></a>.</p>
</dd>
</dl>
<p>Returns the Comment at given index. The indexes of all child objects
are compared by value which makes this function slower than the direct
integer index look-up.</p>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.Parameter.parameterSet">
<code class="sig-name descname">parameterSet</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.Parameter.parameterSet" title="Permalink to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Return type</dt>
<dd class="field-odd"><p><a class="reference internal" href="#seiscomp.datamodel.ParameterSet" title="seiscomp.datamodel.ParameterSet">ParameterSet</a></p>
</dd>
</dl>
<p>Returns the parent ParameterSet if available. Returns None
if the parent is not a ParameterSet. This is a convenience wrapper
for parent().</p>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.Parameter.assign">
<code class="sig-name descname">assign</code><span class="sig-paren">(</span><em class="sig-param">other</em><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.Parameter.assign" title="Permalink to this definition"></a></dt>
<dd><p>This method implements the <a class="reference internal" href="#api-python-datamodel-object"><span class="std std-ref">Object</span></a> interface.</p>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.Parameter.attachTo">
<code class="sig-name descname">attachTo</code><span class="sig-paren">(</span><em class="sig-param">parent</em><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.Parameter.attachTo" title="Permalink to this definition"></a></dt>
<dd><p>This method implements the <a class="reference internal" href="#api-python-datamodel-object"><span class="std std-ref">Object</span></a> interface.</p>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.Parameter.detachFrom">
<code class="sig-name descname">detachFrom</code><span class="sig-paren">(</span><em class="sig-param">parent</em><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.Parameter.detachFrom" title="Permalink to this definition"></a></dt>
<dd><p>This method implements the <a class="reference internal" href="#api-python-datamodel-object"><span class="std std-ref">Object</span></a> interface.</p>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.Parameter.detach">
<code class="sig-name descname">detach</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.Parameter.detach" title="Permalink to this definition"></a></dt>
<dd><p>This method implements the <a class="reference internal" href="#api-python-datamodel-object"><span class="std std-ref">Object</span></a> interface.</p>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.Parameter.clone">
<code class="sig-name descname">clone</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.Parameter.clone" title="Permalink to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Return type</dt>
<dd class="field-odd"><p>A cloned Parameter.</p>
</dd>
</dl>
<p>Returns a new instance that is a clone of the current instance. Child
objects are being ignored.</p>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.Parameter.updateChild">
<code class="sig-name descname">updateChild</code><span class="sig-paren">(</span><em class="sig-param">ref</em><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.Parameter.updateChild" title="Permalink to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>ref</strong> A child object derived from class Object.</p>
</dd>
<dt class="field-even">Return type</dt>
<dd class="field-even"><p>A Boolean flag indicating success with True, False otherwise</p>
</dd>
</dl>
<p>This method takes the passed reference object and searches for a child
with the same publicID (if derived from <a class="reference internal" href="#api-python-datamodel-publicobject"><span class="std std-ref">PublicObject</span></a>)
or the same index (if derived from <a class="reference internal" href="#api-python-datamodel-object"><span class="std std-ref">Object</span></a>).
The the child was found the reference objects attributes are copied to
the child object. Children of child are being ignored during this operation.
This method implements the <a class="reference internal" href="#api-python-datamodel-publicobject"><span class="std std-ref">PublicObject</span></a> interface.</p>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.Parameter.accept">
<code class="sig-name descname">accept</code><span class="sig-paren">(</span><em class="sig-param">visitor</em><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.Parameter.accept" title="Permalink to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>visitor</strong> A visitor.</p>
</dd>
</dl>
<p>This method implements the <a class="reference internal" href="#api-python-datamodel-publicobject"><span class="std std-ref">PublicObject</span></a> interface.</p>
</dd></dl>
</dd></dl>
</div>
<div class="section" id="parameterset">
<span id="api-python-datamodel-parameterset"></span><h3>ParameterSet<a class="headerlink" href="#parameterset" title="Permalink to this headline"></a></h3>
<dl class="class">
<dt id="seiscomp.datamodel.ParameterSet">
<em class="property">class </em><code class="sig-prename descclassname">seiscomp.datamodel.</code><code class="sig-name descname">ParameterSet</code><a class="headerlink" href="#seiscomp.datamodel.ParameterSet" title="Permalink to this definition"></a></dt>
<dd><p>Inherits <a class="reference internal" href="#api-python-datamodel-publicobject"><span class="std std-ref">PublicObject</span></a>.</p>
<p><strong>Parents</strong>:</p>
<ul class="simple">
<li><p><code class="docutils literal notranslate"><span class="pre">config</span></code> <a class="reference internal" href="#api-python-datamodel-config"><span class="std std-ref">Config</span></a></p></li>
</ul>
<p><strong>Children</strong>:</p>
<ul class="simple">
<li><p><code class="docutils literal notranslate"><span class="pre">parameter</span></code> <a class="reference internal" href="#api-python-datamodel-parameter"><span class="std std-ref">Parameter</span></a></p></li>
<li><p><code class="docutils literal notranslate"><span class="pre">comment</span></code> <a class="reference internal" href="#api-python-datamodel-comment"><span class="std std-ref">Comment</span></a></p></li>
</ul>
<p><strong>Attributes</strong>:</p>
<ul class="simple">
<li><p><code class="docutils literal notranslate"><span class="pre">publicID</span></code>: string</p></li>
<li><p><code class="docutils literal notranslate"><span class="pre">baseID</span></code> string</p></li>
<li><p><code class="docutils literal notranslate"><span class="pre">moduleID</span></code> string</p></li>
<li><p><code class="docutils literal notranslate"><span class="pre">created</span></code> seiscomp.core.Time (optional)</p></li>
</ul>
<p><strong>Referenced by</strong>:</p>
<ul class="simple">
<li><p><a class="reference internal" href="#seiscomp.datamodel.ConfigModule.parameterSetID" title="seiscomp.datamodel.ConfigModule.parameterSetID"><code class="xref py py-func docutils literal notranslate"><span class="pre">ConfigModule.parameterSetID()</span></code></a></p></li>
<li><p><a class="reference internal" href="#seiscomp.datamodel.ParameterSet.baseID" title="seiscomp.datamodel.ParameterSet.baseID"><code class="xref py py-func docutils literal notranslate"><span class="pre">ParameterSet.baseID()</span></code></a></p></li>
<li><p><a class="reference internal" href="#seiscomp.datamodel.Setup.parameterSetID" title="seiscomp.datamodel.Setup.parameterSetID"><code class="xref py py-func docutils literal notranslate"><span class="pre">Setup.parameterSetID()</span></code></a></p></li>
</ul>
<p><strong>Methods</strong>:</p>
<dl class="method">
<dt id="seiscomp.datamodel.ParameterSet.Cast">
<em class="property">static </em><code class="sig-name descname">Cast</code><span class="sig-paren">(</span><em class="sig-param">obj</em><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.ParameterSet.Cast" title="Permalink to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>obj</strong> The object to be casted.</p>
</dd>
<dt class="field-even">Return type</dt>
<dd class="field-even"><p>An object of type ParameterSet if the cast was successful,
None otherwise.</p>
</dd>
</dl>
<p>Cast an arbitrary object to ParameterSet if the internal wrapped
representation is an ParameterSet object. The cast is important if
instances of type <a class="reference internal" href="#api-python-datamodel-object"><span class="std std-ref">Object</span></a>
are passed to methods which need access to the real type.</p>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.ParameterSet.Create">
<em class="property">static </em><code class="sig-name descname">Create</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.ParameterSet.Create" title="Permalink to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Return type</dt>
<dd class="field-odd"><p>A new object of type ParameterSet.</p>
</dd>
</dl>
<p>Creates and registers (if enabled) a ParameterSet instance. The
publicID is auto-generated.</p>
</dd></dl>
<dl class="method">
<dt>
<em class="property">static </em><code class="sig-name descname">Create</code><span class="sig-paren">(</span><em class="sig-param">publicID</em><span class="sig-paren">)</span></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Return type</dt>
<dd class="field-odd"><p>A new object of type ParameterSet.</p>
</dd>
</dl>
<p>Creates and registers (if enabled) a ParameterSet instance with
passed publicID.</p>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.ParameterSet.equal">
<code class="sig-name descname">equal</code><span class="sig-paren">(</span><em class="sig-param">other</em><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.ParameterSet.equal" title="Permalink to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>other</strong> Another object of type ParameterSet to compare this
instance to</p>
</dd>
<dt class="field-even">Return type</dt>
<dd class="field-even"><p>A Boolean value indicating True if both objects are equal or
False otherwise.</p>
</dd>
</dl>
<p>Compares two objects without its child objects. Both objects are compared
by value.</p>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.ParameterSet.setBaseID">
<code class="sig-name descname">setBaseID</code><span class="sig-paren">(</span><em class="sig-param">baseID</em><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.ParameterSet.setBaseID" title="Permalink to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>baseID</strong> string</p>
</dd>
</dl>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.ParameterSet.baseID">
<code class="sig-name descname">baseID</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.ParameterSet.baseID" title="Permalink to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Return type</dt>
<dd class="field-odd"><p>string</p>
</dd>
</dl>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.ParameterSet.setModuleID">
<code class="sig-name descname">setModuleID</code><span class="sig-paren">(</span><em class="sig-param">moduleID</em><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.ParameterSet.setModuleID" title="Permalink to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>moduleID</strong> string</p>
</dd>
</dl>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.ParameterSet.moduleID">
<code class="sig-name descname">moduleID</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.ParameterSet.moduleID" title="Permalink to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Return type</dt>
<dd class="field-odd"><p>string</p>
</dd>
</dl>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.ParameterSet.setCreated">
<code class="sig-name descname">setCreated</code><span class="sig-paren">(</span><em class="sig-param">created</em><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.ParameterSet.setCreated" title="Permalink to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>created</strong> seiscomp.core.Time</p>
</dd>
</dl>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.ParameterSet.created">
<code class="sig-name descname">created</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.ParameterSet.created" title="Permalink to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Return type</dt>
<dd class="field-odd"><p>seiscomp.core.Time</p>
</dd>
</dl>
<div class="admonition note">
<p class="admonition-title">Note</p>
<p>As this attribute is optional, this method throws a ValueError if
the value of the attribute is not set.</p>
</div>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.ParameterSet.add">
<code class="sig-name descname">add</code><span class="sig-paren">(</span><em class="sig-param">parameter</em><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.ParameterSet.add" title="Permalink to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>parameter</strong> Object of type <a class="reference internal" href="#api-python-datamodel-parameter"><span class="std std-ref">Parameter</span></a></p>
</dd>
<dt class="field-even">Return type</dt>
<dd class="field-even"><p>A Boolean value indicating success with True, False otherwise.</p>
</dd>
</dl>
<p>Adds a Parameter object to ParameterSet. The object is not
copied but managed by this instance. Any change to the passed object
will also change the child.</p>
</dd></dl>
<dl class="method">
<dt>
<code class="sig-name descname">add</code><span class="sig-paren">(</span><em class="sig-param">comment</em><span class="sig-paren">)</span></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>comment</strong> Object of type <a class="reference internal" href="#api-python-datamodel-comment"><span class="std std-ref">Comment</span></a></p>
</dd>
<dt class="field-even">Return type</dt>
<dd class="field-even"><p>A Boolean value indicating success with True, False otherwise.</p>
</dd>
</dl>
<p>Adds a Comment object to ParameterSet. The object is not
copied but managed by this instance. Any change to the passed object
will also change the child.</p>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.ParameterSet.remove">
<code class="sig-name descname">remove</code><span class="sig-paren">(</span><em class="sig-param">parameter</em><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.ParameterSet.remove" title="Permalink to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>parameter</strong> Object of type <a class="reference internal" href="#api-python-datamodel-parameter"><span class="std std-ref">Parameter</span></a></p>
</dd>
<dt class="field-even">Return type</dt>
<dd class="field-even"><p>A Boolean value indicating success with True, False otherwise.</p>
</dd>
</dl>
<p>Removes a previously added Parameter object from ParameterSet.</p>
</dd></dl>
<dl class="method">
<dt>
<code class="sig-name descname">remove</code><span class="sig-paren">(</span><em class="sig-param">comment</em><span class="sig-paren">)</span></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>comment</strong> Object of type <a class="reference internal" href="#api-python-datamodel-comment"><span class="std std-ref">Comment</span></a></p>
</dd>
<dt class="field-even">Return type</dt>
<dd class="field-even"><p>A Boolean value indicating success with True, False otherwise.</p>
</dd>
</dl>
<p>Removes a previously added Comment object from ParameterSet.</p>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.ParameterSet.removeParameter">
<code class="sig-name descname">removeParameter</code><span class="sig-paren">(</span><em class="sig-param">idx</em><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.ParameterSet.removeParameter" title="Permalink to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>idx</strong> An integer index of the object to be removed.</p>
</dd>
<dt class="field-even">Return type</dt>
<dd class="field-even"><p>A Boolean value indicating success with True, False otherwise.</p>
</dd>
</dl>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.ParameterSet.removeComment">
<code class="sig-name descname">removeComment</code><span class="sig-paren">(</span><em class="sig-param">idx</em><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.ParameterSet.removeComment" title="Permalink to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>idx</strong> An integer index of the object to be removed.</p>
</dd>
<dt class="field-even">Return type</dt>
<dd class="field-even"><p>A Boolean value indicating success with True, False otherwise.</p>
</dd>
</dl>
</dd></dl>
<dl class="method">
<dt>
<code class="sig-name descname">removeComment(commentIndex);</code></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>commentIndex</strong> The index of the object to be removed of type CommentIndex.</p>
</dd>
<dt class="field-even">Return type</dt>
<dd class="field-even"><p>A Boolean value indicating success with True, False otherwise.</p>
</dd>
</dl>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.ParameterSet.parameterCount">
<code class="sig-name descname">parameterCount</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.ParameterSet.parameterCount" title="Permalink to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Return type</dt>
<dd class="field-odd"><p>integer value indicating the number of child objects.</p>
</dd>
</dl>
<p>Returns the number of Parameter child objects.</p>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.ParameterSet.commentCount">
<code class="sig-name descname">commentCount</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.ParameterSet.commentCount" title="Permalink to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Return type</dt>
<dd class="field-odd"><p>integer value indicating the number of child objects.</p>
</dd>
</dl>
<p>Returns the number of Comment child objects.</p>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.ParameterSet.parameter">
<code class="sig-name descname">parameter</code><span class="sig-paren">(</span><em class="sig-param">idx</em><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.ParameterSet.parameter" title="Permalink to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>idx</strong> An integer index of the object to be returned.</p>
</dd>
<dt class="field-even">Return type</dt>
<dd class="field-even"><p>Object of type <a class="reference internal" href="#api-python-datamodel-parameter"><span class="std std-ref">Parameter</span></a>.</p>
</dd>
</dl>
<p>Returns the Parameter at index idx.</p>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.ParameterSet.comment">
<code class="sig-name descname">comment</code><span class="sig-paren">(</span><em class="sig-param">idx</em><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.ParameterSet.comment" title="Permalink to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>idx</strong> An integer index of the object to be returned.</p>
</dd>
<dt class="field-even">Return type</dt>
<dd class="field-even"><p>Object of type <a class="reference internal" href="#api-python-datamodel-comment"><span class="std std-ref">Comment</span></a>.</p>
</dd>
</dl>
<p>Returns the Comment at index idx.</p>
</dd></dl>
<dl class="method">
<dt>
<code class="sig-name descname">comment</code><span class="sig-paren">(</span><em class="sig-param">commentIndex</em><span class="sig-paren">)</span></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>commentIndex</strong> The index of the object to be removed of type CommentIndex.</p>
</dd>
<dt class="field-even">Return type</dt>
<dd class="field-even"><p>Object of type <a class="reference internal" href="#api-python-datamodel-comment"><span class="std std-ref">Comment</span></a>.</p>
</dd>
</dl>
<p>Returns the Comment at given index. The indexes of all child objects
are compared by value which makes this function slower than the direct
integer index look-up.</p>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.ParameterSet.findParameter">
<code class="sig-name descname">findParameter</code><span class="sig-paren">(</span><em class="sig-param">publicID</em><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.ParameterSet.findParameter" title="Permalink to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>publicID</strong> The publicID of the object to find.</p>
</dd>
<dt class="field-even">Return type</dt>
<dd class="field-even"><p>Object of type <a class="reference internal" href="#api-python-datamodel-parameter"><span class="std std-ref">Parameter</span></a>.</p>
</dd>
</dl>
<p>Returns the child object with a certain publicID, None otherwise.</p>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.ParameterSet.config">
<code class="sig-name descname">config</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.ParameterSet.config" title="Permalink to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Return type</dt>
<dd class="field-odd"><p><a class="reference internal" href="#seiscomp.datamodel.Config" title="seiscomp.datamodel.Config">Config</a></p>
</dd>
</dl>
<p>Returns the parent Config if available. Returns None
if the parent is not a Config. This is a convenience wrapper
for parent().</p>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.ParameterSet.assign">
<code class="sig-name descname">assign</code><span class="sig-paren">(</span><em class="sig-param">other</em><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.ParameterSet.assign" title="Permalink to this definition"></a></dt>
<dd><p>This method implements the <a class="reference internal" href="#api-python-datamodel-object"><span class="std std-ref">Object</span></a> interface.</p>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.ParameterSet.attachTo">
<code class="sig-name descname">attachTo</code><span class="sig-paren">(</span><em class="sig-param">parent</em><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.ParameterSet.attachTo" title="Permalink to this definition"></a></dt>
<dd><p>This method implements the <a class="reference internal" href="#api-python-datamodel-object"><span class="std std-ref">Object</span></a> interface.</p>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.ParameterSet.detachFrom">
<code class="sig-name descname">detachFrom</code><span class="sig-paren">(</span><em class="sig-param">parent</em><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.ParameterSet.detachFrom" title="Permalink to this definition"></a></dt>
<dd><p>This method implements the <a class="reference internal" href="#api-python-datamodel-object"><span class="std std-ref">Object</span></a> interface.</p>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.ParameterSet.detach">
<code class="sig-name descname">detach</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.ParameterSet.detach" title="Permalink to this definition"></a></dt>
<dd><p>This method implements the <a class="reference internal" href="#api-python-datamodel-object"><span class="std std-ref">Object</span></a> interface.</p>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.ParameterSet.clone">
<code class="sig-name descname">clone</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.ParameterSet.clone" title="Permalink to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Return type</dt>
<dd class="field-odd"><p>A cloned ParameterSet.</p>
</dd>
</dl>
<p>Returns a new instance that is a clone of the current instance. Child
objects are being ignored.</p>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.ParameterSet.updateChild">
<code class="sig-name descname">updateChild</code><span class="sig-paren">(</span><em class="sig-param">ref</em><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.ParameterSet.updateChild" title="Permalink to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>ref</strong> A child object derived from class Object.</p>
</dd>
<dt class="field-even">Return type</dt>
<dd class="field-even"><p>A Boolean flag indicating success with True, False otherwise</p>
</dd>
</dl>
<p>This method takes the passed reference object and searches for a child
with the same publicID (if derived from <a class="reference internal" href="#api-python-datamodel-publicobject"><span class="std std-ref">PublicObject</span></a>)
or the same index (if derived from <a class="reference internal" href="#api-python-datamodel-object"><span class="std std-ref">Object</span></a>).
The the child was found the reference objects attributes are copied to
the child object. Children of child are being ignored during this operation.
This method implements the <a class="reference internal" href="#api-python-datamodel-publicobject"><span class="std std-ref">PublicObject</span></a> interface.</p>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.ParameterSet.accept">
<code class="sig-name descname">accept</code><span class="sig-paren">(</span><em class="sig-param">visitor</em><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.ParameterSet.accept" title="Permalink to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>visitor</strong> A visitor.</p>
</dd>
</dl>
<p>This method implements the <a class="reference internal" href="#api-python-datamodel-publicobject"><span class="std std-ref">PublicObject</span></a> interface.</p>
</dd></dl>
</dd></dl>
</div>
<div class="section" id="phase">
<span id="api-python-datamodel-phase"></span><h3>Phase<a class="headerlink" href="#phase" title="Permalink to this headline"></a></h3>
<dl class="class">
<dt id="seiscomp.datamodel.Phase">
<em class="property">class </em><code class="sig-prename descclassname">seiscomp.datamodel.</code><code class="sig-name descname">Phase</code><a class="headerlink" href="#seiscomp.datamodel.Phase" title="Permalink to this definition"></a></dt>
<dd><p>Inherits <a class="reference internal" href="#api-python-datamodel-object"><span class="std std-ref">Object</span></a>.</p>
<p>Generic and extensible phase description that currently contains the phase code
only.</p>
<p><strong>Attributes</strong>:</p>
<ul class="simple">
<li><p><code class="docutils literal notranslate"><span class="pre">code</span></code> string</p></li>
</ul>
<p><strong>Used by</strong>:</p>
<ul class="simple">
<li><p><a class="reference internal" href="#seiscomp.datamodel.Arrival.phase" title="seiscomp.datamodel.Arrival.phase"><code class="xref py py-func docutils literal notranslate"><span class="pre">Arrival.phase()</span></code></a></p></li>
<li><p><a class="reference internal" href="#seiscomp.datamodel.Pick.phaseHint" title="seiscomp.datamodel.Pick.phaseHint"><code class="xref py py-func docutils literal notranslate"><span class="pre">Pick.phaseHint()</span></code></a></p></li>
</ul>
<p><strong>Methods</strong>:</p>
<dl class="method">
<dt id="seiscomp.datamodel.Phase.Cast">
<em class="property">static </em><code class="sig-name descname">Cast</code><span class="sig-paren">(</span><em class="sig-param">obj</em><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.Phase.Cast" title="Permalink to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>obj</strong> The object to be casted.</p>
</dd>
<dt class="field-even">Return type</dt>
<dd class="field-even"><p>An object of type Phase if the cast was successful,
None otherwise.</p>
</dd>
</dl>
<p>Cast an arbitrary object to Phase if the internal wrapped
representation is an Phase object. The cast is important if
instances of type <a class="reference internal" href="#api-python-datamodel-object"><span class="std std-ref">Object</span></a>
are passed to methods which need access to the real type.</p>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.Phase.equal">
<code class="sig-name descname">equal</code><span class="sig-paren">(</span><em class="sig-param">other</em><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.Phase.equal" title="Permalink to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>other</strong> Another object of type Phase to compare this
instance to</p>
</dd>
<dt class="field-even">Return type</dt>
<dd class="field-even"><p>A Boolean value indicating True if both objects are equal or
False otherwise.</p>
</dd>
</dl>
<p>Compares two objects without its child objects. Both objects are compared
by value.</p>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.Phase.setCode">
<code class="sig-name descname">setCode</code><span class="sig-paren">(</span><em class="sig-param">code</em><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.Phase.setCode" title="Permalink to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>code</strong> string</p>
</dd>
</dl>
<p>Phase code as given in the IASPEI Standard Seismic Phase List
(Storchak et al. 2003). String with a maximum length of 32 characters.</p>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.Phase.code">
<code class="sig-name descname">code</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.Phase.code" title="Permalink to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Return type</dt>
<dd class="field-odd"><p>string</p>
</dd>
</dl>
</dd></dl>
</dd></dl>
</div>
<div class="section" id="pick">
<span id="api-python-datamodel-pick"></span><h3>Pick<a class="headerlink" href="#pick" title="Permalink to this headline"></a></h3>
<dl class="class">
<dt id="seiscomp.datamodel.Pick">
<em class="property">class </em><code class="sig-prename descclassname">seiscomp.datamodel.</code><code class="sig-name descname">Pick</code><a class="headerlink" href="#seiscomp.datamodel.Pick" title="Permalink to this definition"></a></dt>
<dd><p>Inherits <a class="reference internal" href="#api-python-datamodel-publicobject"><span class="std std-ref">PublicObject</span></a>.</p>
<p>A pick is the observation of an amplitude anomaly in a seismogram at a
specific point in time. It is not necessarily related to a seismic event.</p>
<p><strong>Parents</strong>:</p>
<ul class="simple">
<li><p><code class="docutils literal notranslate"><span class="pre">eventParameters</span></code> <a class="reference internal" href="#api-python-datamodel-eventparameters"><span class="std std-ref">EventParameters</span></a></p></li>
</ul>
<p><strong>Children</strong>:</p>
<ul class="simple">
<li><p><code class="docutils literal notranslate"><span class="pre">comment</span></code> <a class="reference internal" href="#api-python-datamodel-comment"><span class="std std-ref">Comment</span></a></p></li>
</ul>
<p><strong>Attributes</strong>:</p>
<ul class="simple">
<li><p><code class="docutils literal notranslate"><span class="pre">publicID</span></code>: string</p></li>
<li><p><code class="docutils literal notranslate"><span class="pre">time</span></code> <a class="reference internal" href="#api-python-datamodel-timequantity"><span class="std std-ref">TimeQuantity</span></a></p></li>
<li><p><code class="docutils literal notranslate"><span class="pre">waveformID</span></code> <a class="reference internal" href="#api-python-datamodel-waveformstreamid"><span class="std std-ref">WaveformStreamID</span></a></p></li>
<li><p><code class="docutils literal notranslate"><span class="pre">filterID</span></code> string</p></li>
<li><p><code class="docutils literal notranslate"><span class="pre">methodID</span></code> string</p></li>
<li><p><code class="docutils literal notranslate"><span class="pre">horizontalSlowness</span></code> <a class="reference internal" href="#api-python-datamodel-realquantity"><span class="std std-ref">RealQuantity</span></a> (optional)</p></li>
<li><p><code class="docutils literal notranslate"><span class="pre">backazimuth</span></code> <a class="reference internal" href="#api-python-datamodel-realquantity"><span class="std std-ref">RealQuantity</span></a> (optional)</p></li>
<li><p><code class="docutils literal notranslate"><span class="pre">slownessMethodID</span></code> string</p></li>
<li><p><code class="docutils literal notranslate"><span class="pre">onset</span></code> <a class="reference internal" href="#api-python-datamodel-pickonset"><span class="std std-ref">PickOnset</span></a> (optional)</p></li>
<li><p><code class="docutils literal notranslate"><span class="pre">phaseHint</span></code> <a class="reference internal" href="#api-python-datamodel-phase"><span class="std std-ref">Phase</span></a> (optional)</p></li>
<li><p><code class="docutils literal notranslate"><span class="pre">polarity</span></code> <a class="reference internal" href="#api-python-datamodel-pickpolarity"><span class="std std-ref">PickPolarity</span></a> (optional)</p></li>
<li><p><code class="docutils literal notranslate"><span class="pre">evaluationMode</span></code> <a class="reference internal" href="#api-python-datamodel-evaluationmode"><span class="std std-ref">EvaluationMode</span></a> (optional)</p></li>
<li><p><code class="docutils literal notranslate"><span class="pre">evaluationStatus</span></code> <a class="reference internal" href="#api-python-datamodel-evaluationstatus"><span class="std std-ref">EvaluationStatus</span></a> (optional)</p></li>
<li><p><code class="docutils literal notranslate"><span class="pre">creationInfo</span></code> <a class="reference internal" href="#api-python-datamodel-creationinfo"><span class="std std-ref">CreationInfo</span></a> (optional)</p></li>
</ul>
<p><strong>Referenced by</strong>:</p>
<ul class="simple">
<li><p><a class="reference internal" href="#seiscomp.datamodel.Amplitude.pickID" title="seiscomp.datamodel.Amplitude.pickID"><code class="xref py py-func docutils literal notranslate"><span class="pre">Amplitude.pickID()</span></code></a></p></li>
<li><p><a class="reference internal" href="#seiscomp.datamodel.Arrival.pickID" title="seiscomp.datamodel.Arrival.pickID"><code class="xref py py-func docutils literal notranslate"><span class="pre">Arrival.pickID()</span></code></a></p></li>
<li><p><a class="reference internal" href="#seiscomp.datamodel.PickReference.pickID" title="seiscomp.datamodel.PickReference.pickID"><code class="xref py py-func docutils literal notranslate"><span class="pre">PickReference.pickID()</span></code></a></p></li>
</ul>
<p><strong>Methods</strong>:</p>
<dl class="method">
<dt id="seiscomp.datamodel.Pick.Cast">
<em class="property">static </em><code class="sig-name descname">Cast</code><span class="sig-paren">(</span><em class="sig-param">obj</em><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.Pick.Cast" title="Permalink to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>obj</strong> The object to be casted.</p>
</dd>
<dt class="field-even">Return type</dt>
<dd class="field-even"><p>An object of type Pick if the cast was successful,
None otherwise.</p>
</dd>
</dl>
<p>Cast an arbitrary object to Pick if the internal wrapped
representation is an Pick object. The cast is important if
instances of type <a class="reference internal" href="#api-python-datamodel-object"><span class="std std-ref">Object</span></a>
are passed to methods which need access to the real type.</p>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.Pick.Create">
<em class="property">static </em><code class="sig-name descname">Create</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.Pick.Create" title="Permalink to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Return type</dt>
<dd class="field-odd"><p>A new object of type Pick.</p>
</dd>
</dl>
<p>Creates and registers (if enabled) a Pick instance. The
publicID is auto-generated.</p>
</dd></dl>
<dl class="method">
<dt>
<em class="property">static </em><code class="sig-name descname">Create</code><span class="sig-paren">(</span><em class="sig-param">publicID</em><span class="sig-paren">)</span></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Return type</dt>
<dd class="field-odd"><p>A new object of type Pick.</p>
</dd>
</dl>
<p>Creates and registers (if enabled) a Pick instance with
passed publicID.</p>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.Pick.equal">
<code class="sig-name descname">equal</code><span class="sig-paren">(</span><em class="sig-param">other</em><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.Pick.equal" title="Permalink to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>other</strong> Another object of type Pick to compare this
instance to</p>
</dd>
<dt class="field-even">Return type</dt>
<dd class="field-even"><p>A Boolean value indicating True if both objects are equal or
False otherwise.</p>
</dd>
</dl>
<p>Compares two objects without its child objects. Both objects are compared
by value.</p>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.Pick.setTime">
<code class="sig-name descname">setTime</code><span class="sig-paren">(</span><em class="sig-param">time</em><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.Pick.setTime" title="Permalink to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>time</strong> <a class="reference internal" href="#api-python-datamodel-timequantity"><span class="std std-ref">TimeQuantity</span></a></p>
</dd>
</dl>
<p>Observed onset time of signal (“pick time”).</p>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.Pick.time">
<code class="sig-name descname">time</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.Pick.time" title="Permalink to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Return type</dt>
<dd class="field-odd"><p><a class="reference internal" href="#api-python-datamodel-timequantity"><span class="std std-ref">TimeQuantity</span></a></p>
</dd>
</dl>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.Pick.setWaveformID">
<code class="sig-name descname">setWaveformID</code><span class="sig-paren">(</span><em class="sig-param">waveformID</em><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.Pick.setWaveformID" title="Permalink to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>waveformID</strong> <a class="reference internal" href="#api-python-datamodel-waveformstreamid"><span class="std std-ref">WaveformStreamID</span></a></p>
</dd>
</dl>
<p>Identifes the waveform stream.</p>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.Pick.waveformID">
<code class="sig-name descname">waveformID</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.Pick.waveformID" title="Permalink to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Return type</dt>
<dd class="field-odd"><p><a class="reference internal" href="#api-python-datamodel-waveformstreamid"><span class="std std-ref">WaveformStreamID</span></a></p>
</dd>
</dl>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.Pick.setFilterID">
<code class="sig-name descname">setFilterID</code><span class="sig-paren">(</span><em class="sig-param">filterID</em><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.Pick.setFilterID" title="Permalink to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>filterID</strong> string</p>
</dd>
</dl>
<p>Identifies the filter or filter setup used for filtering the waveform
stream referenced by waveformID.</p>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.Pick.filterID">
<code class="sig-name descname">filterID</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.Pick.filterID" title="Permalink to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Return type</dt>
<dd class="field-odd"><p>string</p>
</dd>
</dl>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.Pick.setMethodID">
<code class="sig-name descname">setMethodID</code><span class="sig-paren">(</span><em class="sig-param">methodID</em><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.Pick.setMethodID" title="Permalink to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>methodID</strong> string</p>
</dd>
</dl>
<p>Identifies the picker that produced the pick. This can be either a
detection software program or a person.</p>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.Pick.methodID">
<code class="sig-name descname">methodID</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.Pick.methodID" title="Permalink to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Return type</dt>
<dd class="field-odd"><p>string</p>
</dd>
</dl>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.Pick.setHorizontalSlowness">
<code class="sig-name descname">setHorizontalSlowness</code><span class="sig-paren">(</span><em class="sig-param">horizontalSlowness</em><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.Pick.setHorizontalSlowness" title="Permalink to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>horizontalSlowness</strong> <a class="reference internal" href="#api-python-datamodel-realquantity"><span class="std std-ref">RealQuantity</span></a></p>
</dd>
</dl>
<p>Observed horizontal slowness of the signal. Most relevant in array
measurements
in s/deg.</p>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.Pick.horizontalSlowness">
<code class="sig-name descname">horizontalSlowness</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.Pick.horizontalSlowness" title="Permalink to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Return type</dt>
<dd class="field-odd"><p><a class="reference internal" href="#api-python-datamodel-realquantity"><span class="std std-ref">RealQuantity</span></a></p>
</dd>
</dl>
<div class="admonition note">
<p class="admonition-title">Note</p>
<p>As this attribute is optional, this method throws a ValueError if
the value of the attribute is not set.</p>
</div>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.Pick.setBackazimuth">
<code class="sig-name descname">setBackazimuth</code><span class="sig-paren">(</span><em class="sig-param">backazimuth</em><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.Pick.setBackazimuth" title="Permalink to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>backazimuth</strong> <a class="reference internal" href="#api-python-datamodel-realquantity"><span class="std std-ref">RealQuantity</span></a></p>
</dd>
</dl>
<p>Observed backazimuth of the signal. Most relevant in array measurements
in degrees.</p>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.Pick.backazimuth">
<code class="sig-name descname">backazimuth</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.Pick.backazimuth" title="Permalink to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Return type</dt>
<dd class="field-odd"><p><a class="reference internal" href="#api-python-datamodel-realquantity"><span class="std std-ref">RealQuantity</span></a></p>
</dd>
</dl>
<div class="admonition note">
<p class="admonition-title">Note</p>
<p>As this attribute is optional, this method throws a ValueError if
the value of the attribute is not set.</p>
</div>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.Pick.setSlownessMethodID">
<code class="sig-name descname">setSlownessMethodID</code><span class="sig-paren">(</span><em class="sig-param">slownessMethodID</em><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.Pick.setSlownessMethodID" title="Permalink to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>slownessMethodID</strong> string</p>
</dd>
</dl>
<p>Identifies the method that was used to determine the slowness.</p>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.Pick.slownessMethodID">
<code class="sig-name descname">slownessMethodID</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.Pick.slownessMethodID" title="Permalink to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Return type</dt>
<dd class="field-odd"><p>string</p>
</dd>
</dl>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.Pick.setOnset">
<code class="sig-name descname">setOnset</code><span class="sig-paren">(</span><em class="sig-param">onset</em><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.Pick.setOnset" title="Permalink to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>onset</strong> PickOnset</p>
</dd>
</dl>
<p>Flag that roughly categorizes the sharpness of the onset.</p>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.Pick.onset">
<code class="sig-name descname">onset</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.Pick.onset" title="Permalink to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Return type</dt>
<dd class="field-odd"><p>PickOnset</p>
</dd>
</dl>
<div class="admonition note">
<p class="admonition-title">Note</p>
<p>As this attribute is optional, this method throws a ValueError if
the value of the attribute is not set.</p>
</div>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.Pick.setPhaseHint">
<code class="sig-name descname">setPhaseHint</code><span class="sig-paren">(</span><em class="sig-param">phaseHint</em><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.Pick.setPhaseHint" title="Permalink to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>phaseHint</strong> <a class="reference internal" href="#api-python-datamodel-phase"><span class="std std-ref">Phase</span></a></p>
</dd>
</dl>
<p>Tentative phase identification as specified by the picker.</p>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.Pick.phaseHint">
<code class="sig-name descname">phaseHint</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.Pick.phaseHint" title="Permalink to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Return type</dt>
<dd class="field-odd"><p><a class="reference internal" href="#api-python-datamodel-phase"><span class="std std-ref">Phase</span></a></p>
</dd>
</dl>
<div class="admonition note">
<p class="admonition-title">Note</p>
<p>As this attribute is optional, this method throws a ValueError if
the value of the attribute is not set.</p>
</div>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.Pick.setPolarity">
<code class="sig-name descname">setPolarity</code><span class="sig-paren">(</span><em class="sig-param">polarity</em><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.Pick.setPolarity" title="Permalink to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>polarity</strong> PickPolarity</p>
</dd>
</dl>
<p>Indicates the polarity of first motion, usually from impulsive onsets.</p>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.Pick.polarity">
<code class="sig-name descname">polarity</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.Pick.polarity" title="Permalink to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Return type</dt>
<dd class="field-odd"><p>PickPolarity</p>
</dd>
</dl>
<div class="admonition note">
<p class="admonition-title">Note</p>
<p>As this attribute is optional, this method throws a ValueError if
the value of the attribute is not set.</p>
</div>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.Pick.setEvaluationMode">
<code class="sig-name descname">setEvaluationMode</code><span class="sig-paren">(</span><em class="sig-param">evaluationMode</em><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.Pick.setEvaluationMode" title="Permalink to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>evaluationMode</strong> EvaluationMode</p>
</dd>
</dl>
<p>Evaluation mode of Pick.</p>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.Pick.evaluationMode">
<code class="sig-name descname">evaluationMode</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.Pick.evaluationMode" title="Permalink to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Return type</dt>
<dd class="field-odd"><p>EvaluationMode</p>
</dd>
</dl>
<div class="admonition note">
<p class="admonition-title">Note</p>
<p>As this attribute is optional, this method throws a ValueError if
the value of the attribute is not set.</p>
</div>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.Pick.setEvaluationStatus">
<code class="sig-name descname">setEvaluationStatus</code><span class="sig-paren">(</span><em class="sig-param">evaluationStatus</em><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.Pick.setEvaluationStatus" title="Permalink to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>evaluationStatus</strong> EvaluationStatus</p>
</dd>
</dl>
<p>Evaluation status of Pick.</p>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.Pick.evaluationStatus">
<code class="sig-name descname">evaluationStatus</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.Pick.evaluationStatus" title="Permalink to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Return type</dt>
<dd class="field-odd"><p>EvaluationStatus</p>
</dd>
</dl>
<div class="admonition note">
<p class="admonition-title">Note</p>
<p>As this attribute is optional, this method throws a ValueError if
the value of the attribute is not set.</p>
</div>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.Pick.setCreationInfo">
<code class="sig-name descname">setCreationInfo</code><span class="sig-paren">(</span><em class="sig-param">creationInfo</em><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.Pick.setCreationInfo" title="Permalink to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>creationInfo</strong> <a class="reference internal" href="#api-python-datamodel-creationinfo"><span class="std std-ref">CreationInfo</span></a></p>
</dd>
</dl>
<p>CreationInfo for the Pick object.</p>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.Pick.creationInfo">
<code class="sig-name descname">creationInfo</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.Pick.creationInfo" title="Permalink to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Return type</dt>
<dd class="field-odd"><p><a class="reference internal" href="#api-python-datamodel-creationinfo"><span class="std std-ref">CreationInfo</span></a></p>
</dd>
</dl>
<div class="admonition note">
<p class="admonition-title">Note</p>
<p>As this attribute is optional, this method throws a ValueError if
the value of the attribute is not set.</p>
</div>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.Pick.add">
<code class="sig-name descname">add</code><span class="sig-paren">(</span><em class="sig-param">comment</em><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.Pick.add" title="Permalink to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>comment</strong> Object of type <a class="reference internal" href="#api-python-datamodel-comment"><span class="std std-ref">Comment</span></a></p>
</dd>
<dt class="field-even">Return type</dt>
<dd class="field-even"><p>A Boolean value indicating success with True, False otherwise.</p>
</dd>
</dl>
<p>Adds a Comment object to Pick. The object is not
copied but managed by this instance. Any change to the passed object
will also change the child.</p>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.Pick.remove">
<code class="sig-name descname">remove</code><span class="sig-paren">(</span><em class="sig-param">comment</em><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.Pick.remove" title="Permalink to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>comment</strong> Object of type <a class="reference internal" href="#api-python-datamodel-comment"><span class="std std-ref">Comment</span></a></p>
</dd>
<dt class="field-even">Return type</dt>
<dd class="field-even"><p>A Boolean value indicating success with True, False otherwise.</p>
</dd>
</dl>
<p>Removes a previously added Comment object from Pick.</p>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.Pick.removeComment">
<code class="sig-name descname">removeComment</code><span class="sig-paren">(</span><em class="sig-param">idx</em><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.Pick.removeComment" title="Permalink to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>idx</strong> An integer index of the object to be removed.</p>
</dd>
<dt class="field-even">Return type</dt>
<dd class="field-even"><p>A Boolean value indicating success with True, False otherwise.</p>
</dd>
</dl>
</dd></dl>
<dl class="method">
<dt>
<code class="sig-name descname">removeComment(commentIndex);</code></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>commentIndex</strong> The index of the object to be removed of type CommentIndex.</p>
</dd>
<dt class="field-even">Return type</dt>
<dd class="field-even"><p>A Boolean value indicating success with True, False otherwise.</p>
</dd>
</dl>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.Pick.commentCount">
<code class="sig-name descname">commentCount</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.Pick.commentCount" title="Permalink to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Return type</dt>
<dd class="field-odd"><p>integer value indicating the number of child objects.</p>
</dd>
</dl>
<p>Returns the number of Comment child objects.</p>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.Pick.comment">
<code class="sig-name descname">comment</code><span class="sig-paren">(</span><em class="sig-param">idx</em><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.Pick.comment" title="Permalink to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>idx</strong> An integer index of the object to be returned.</p>
</dd>
<dt class="field-even">Return type</dt>
<dd class="field-even"><p>Object of type <a class="reference internal" href="#api-python-datamodel-comment"><span class="std std-ref">Comment</span></a>.</p>
</dd>
</dl>
<p>Returns the Comment at index idx.</p>
</dd></dl>
<dl class="method">
<dt>
<code class="sig-name descname">comment</code><span class="sig-paren">(</span><em class="sig-param">commentIndex</em><span class="sig-paren">)</span></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>commentIndex</strong> The index of the object to be removed of type CommentIndex.</p>
</dd>
<dt class="field-even">Return type</dt>
<dd class="field-even"><p>Object of type <a class="reference internal" href="#api-python-datamodel-comment"><span class="std std-ref">Comment</span></a>.</p>
</dd>
</dl>
<p>Returns the Comment at given index. The indexes of all child objects
are compared by value which makes this function slower than the direct
integer index look-up.</p>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.Pick.eventParameters">
<code class="sig-name descname">eventParameters</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.Pick.eventParameters" title="Permalink to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Return type</dt>
<dd class="field-odd"><p><a class="reference internal" href="#seiscomp.datamodel.EventParameters" title="seiscomp.datamodel.EventParameters">EventParameters</a></p>
</dd>
</dl>
<p>Returns the parent EventParameters if available. Returns None
if the parent is not a EventParameters. This is a convenience wrapper
for parent().</p>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.Pick.assign">
<code class="sig-name descname">assign</code><span class="sig-paren">(</span><em class="sig-param">other</em><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.Pick.assign" title="Permalink to this definition"></a></dt>
<dd><p>This method implements the <a class="reference internal" href="#api-python-datamodel-object"><span class="std std-ref">Object</span></a> interface.</p>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.Pick.attachTo">
<code class="sig-name descname">attachTo</code><span class="sig-paren">(</span><em class="sig-param">parent</em><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.Pick.attachTo" title="Permalink to this definition"></a></dt>
<dd><p>This method implements the <a class="reference internal" href="#api-python-datamodel-object"><span class="std std-ref">Object</span></a> interface.</p>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.Pick.detachFrom">
<code class="sig-name descname">detachFrom</code><span class="sig-paren">(</span><em class="sig-param">parent</em><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.Pick.detachFrom" title="Permalink to this definition"></a></dt>
<dd><p>This method implements the <a class="reference internal" href="#api-python-datamodel-object"><span class="std std-ref">Object</span></a> interface.</p>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.Pick.detach">
<code class="sig-name descname">detach</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.Pick.detach" title="Permalink to this definition"></a></dt>
<dd><p>This method implements the <a class="reference internal" href="#api-python-datamodel-object"><span class="std std-ref">Object</span></a> interface.</p>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.Pick.clone">
<code class="sig-name descname">clone</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.Pick.clone" title="Permalink to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Return type</dt>
<dd class="field-odd"><p>A cloned Pick.</p>
</dd>
</dl>
<p>Returns a new instance that is a clone of the current instance. Child
objects are being ignored.</p>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.Pick.updateChild">
<code class="sig-name descname">updateChild</code><span class="sig-paren">(</span><em class="sig-param">ref</em><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.Pick.updateChild" title="Permalink to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>ref</strong> A child object derived from class Object.</p>
</dd>
<dt class="field-even">Return type</dt>
<dd class="field-even"><p>A Boolean flag indicating success with True, False otherwise</p>
</dd>
</dl>
<p>This method takes the passed reference object and searches for a child
with the same publicID (if derived from <a class="reference internal" href="#api-python-datamodel-publicobject"><span class="std std-ref">PublicObject</span></a>)
or the same index (if derived from <a class="reference internal" href="#api-python-datamodel-object"><span class="std std-ref">Object</span></a>).
The the child was found the reference objects attributes are copied to
the child object. Children of child are being ignored during this operation.
This method implements the <a class="reference internal" href="#api-python-datamodel-publicobject"><span class="std std-ref">PublicObject</span></a> interface.</p>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.Pick.accept">
<code class="sig-name descname">accept</code><span class="sig-paren">(</span><em class="sig-param">visitor</em><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.Pick.accept" title="Permalink to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>visitor</strong> A visitor.</p>
</dd>
</dl>
<p>This method implements the <a class="reference internal" href="#api-python-datamodel-publicobject"><span class="std std-ref">PublicObject</span></a> interface.</p>
</dd></dl>
</dd></dl>
</div>
<div class="section" id="pickreference">
<span id="api-python-datamodel-pickreference"></span><h3>PickReference<a class="headerlink" href="#pickreference" title="Permalink to this headline"></a></h3>
<dl class="class">
<dt id="seiscomp.datamodel.PickReference">
<em class="property">class </em><code class="sig-prename descclassname">seiscomp.datamodel.</code><code class="sig-name descname">PickReference</code><a class="headerlink" href="#seiscomp.datamodel.PickReference" title="Permalink to this definition"></a></dt>
<dd><p>Inherits <a class="reference internal" href="#api-python-datamodel-object"><span class="std std-ref">Object</span></a>.</p>
<p><strong>Parents</strong>:</p>
<ul class="simple">
<li><p><code class="docutils literal notranslate"><span class="pre">reading</span></code> <a class="reference internal" href="#api-python-datamodel-reading"><span class="std std-ref">Reading</span></a></p></li>
</ul>
<p><strong>Attributes</strong>:</p>
<ul class="simple">
<li><p><code class="docutils literal notranslate"><span class="pre">pickID</span></code> string</p></li>
</ul>
<p><strong>Methods</strong>:</p>
<dl class="method">
<dt id="seiscomp.datamodel.PickReference.Cast">
<em class="property">static </em><code class="sig-name descname">Cast</code><span class="sig-paren">(</span><em class="sig-param">obj</em><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.PickReference.Cast" title="Permalink to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>obj</strong> The object to be casted.</p>
</dd>
<dt class="field-even">Return type</dt>
<dd class="field-even"><p>An object of type PickReference if the cast was successful,
None otherwise.</p>
</dd>
</dl>
<p>Cast an arbitrary object to PickReference if the internal wrapped
representation is an PickReference object. The cast is important if
instances of type <a class="reference internal" href="#api-python-datamodel-object"><span class="std std-ref">Object</span></a>
are passed to methods which need access to the real type.</p>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.PickReference.equal">
<code class="sig-name descname">equal</code><span class="sig-paren">(</span><em class="sig-param">other</em><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.PickReference.equal" title="Permalink to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>other</strong> Another object of type PickReference to compare this
instance to</p>
</dd>
<dt class="field-even">Return type</dt>
<dd class="field-even"><p>A Boolean value indicating True if both objects are equal or
False otherwise.</p>
</dd>
</dl>
<p>Compares two objects without its child objects. Both objects are compared
by value.</p>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.PickReference.index">
<code class="sig-name descname">index</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.PickReference.index" title="Permalink to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Return type</dt>
<dd class="field-odd"><p><p>The objects index of type PickReferenceIndex.</p>
<p>Returns the objects index which is also used for the database as unique
constraint.</p>
</p>
</dd>
</dl>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.PickReference.equalIndex">
<code class="sig-name descname">equalIndex</code><span class="sig-paren">(</span><em class="sig-param">lhs</em><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.PickReference.equalIndex" title="Permalink to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>lhs</strong> <a class="reference internal" href="#api-python-datamodel-pickreference"><span class="std std-ref">PickReference</span></a></p>
</dd>
<dt class="field-even">Return type</dt>
<dd class="field-even"><p>A Boolean value indicating True if both indexes are equal or
False otherwise.</p>
</dd>
</dl>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.PickReference.setPickID">
<code class="sig-name descname">setPickID</code><span class="sig-paren">(</span><em class="sig-param">pickID</em><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.PickReference.setPickID" title="Permalink to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>pickID</strong> string</p>
</dd>
</dl>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.PickReference.pickID">
<code class="sig-name descname">pickID</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.PickReference.pickID" title="Permalink to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Return type</dt>
<dd class="field-odd"><p>string</p>
</dd>
</dl>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.PickReference.reading">
<code class="sig-name descname">reading</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.PickReference.reading" title="Permalink to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Return type</dt>
<dd class="field-odd"><p><a class="reference internal" href="#seiscomp.datamodel.Reading" title="seiscomp.datamodel.Reading">Reading</a></p>
</dd>
</dl>
<p>Returns the parent Reading if available. Returns None
if the parent is not a Reading. This is a convenience wrapper
for parent().</p>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.PickReference.assign">
<code class="sig-name descname">assign</code><span class="sig-paren">(</span><em class="sig-param">other</em><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.PickReference.assign" title="Permalink to this definition"></a></dt>
<dd><p>This method implements the <a class="reference internal" href="#api-python-datamodel-object"><span class="std std-ref">Object</span></a> interface.</p>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.PickReference.attachTo">
<code class="sig-name descname">attachTo</code><span class="sig-paren">(</span><em class="sig-param">parent</em><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.PickReference.attachTo" title="Permalink to this definition"></a></dt>
<dd><p>This method implements the <a class="reference internal" href="#api-python-datamodel-object"><span class="std std-ref">Object</span></a> interface.</p>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.PickReference.detachFrom">
<code class="sig-name descname">detachFrom</code><span class="sig-paren">(</span><em class="sig-param">parent</em><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.PickReference.detachFrom" title="Permalink to this definition"></a></dt>
<dd><p>This method implements the <a class="reference internal" href="#api-python-datamodel-object"><span class="std std-ref">Object</span></a> interface.</p>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.PickReference.detach">
<code class="sig-name descname">detach</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.PickReference.detach" title="Permalink to this definition"></a></dt>
<dd><p>This method implements the <a class="reference internal" href="#api-python-datamodel-object"><span class="std std-ref">Object</span></a> interface.</p>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.PickReference.clone">
<code class="sig-name descname">clone</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.PickReference.clone" title="Permalink to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Return type</dt>
<dd class="field-odd"><p>A cloned PickReference.</p>
</dd>
</dl>
<p>Returns a new instance that is a clone of the current instance. Child
objects are being ignored.</p>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.PickReference.accept">
<code class="sig-name descname">accept</code><span class="sig-paren">(</span><em class="sig-param">visitor</em><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.PickReference.accept" title="Permalink to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>visitor</strong> A visitor.</p>
</dd>
</dl>
<p>This method implements the <a class="reference internal" href="#api-python-datamodel-publicobject"><span class="std std-ref">PublicObject</span></a> interface.</p>
</dd></dl>
</dd></dl>
</div>
<div class="section" id="principalaxes">
<span id="api-python-datamodel-principalaxes"></span><h3>PrincipalAxes<a class="headerlink" href="#principalaxes" title="Permalink to this headline"></a></h3>
<dl class="class">
<dt id="seiscomp.datamodel.PrincipalAxes">
<em class="property">class </em><code class="sig-prename descclassname">seiscomp.datamodel.</code><code class="sig-name descname">PrincipalAxes</code><a class="headerlink" href="#seiscomp.datamodel.PrincipalAxes" title="Permalink to this definition"></a></dt>
<dd><p>Inherits <a class="reference internal" href="#api-python-datamodel-object"><span class="std std-ref">Object</span></a>.</p>
<p>This class describes the principal axes of a double-couple moment tensor
solution. tAxis and pAxis are required,
while nAxis is optional.</p>
<p><strong>Attributes</strong>:</p>
<ul class="simple">
<li><p><code class="docutils literal notranslate"><span class="pre">tAxis</span></code> <a class="reference internal" href="#api-python-datamodel-axis"><span class="std std-ref">Axis</span></a></p></li>
<li><p><code class="docutils literal notranslate"><span class="pre">pAxis</span></code> <a class="reference internal" href="#api-python-datamodel-axis"><span class="std std-ref">Axis</span></a></p></li>
<li><p><code class="docutils literal notranslate"><span class="pre">nAxis</span></code> <a class="reference internal" href="#api-python-datamodel-axis"><span class="std std-ref">Axis</span></a> (optional)</p></li>
</ul>
<p><strong>Used by</strong>:</p>
<ul class="simple">
<li><p><a class="reference internal" href="#seiscomp.datamodel.FocalMechanism.principalAxes" title="seiscomp.datamodel.FocalMechanism.principalAxes"><code class="xref py py-func docutils literal notranslate"><span class="pre">FocalMechanism.principalAxes()</span></code></a></p></li>
</ul>
<p><strong>Methods</strong>:</p>
<dl class="method">
<dt id="seiscomp.datamodel.PrincipalAxes.Cast">
<em class="property">static </em><code class="sig-name descname">Cast</code><span class="sig-paren">(</span><em class="sig-param">obj</em><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.PrincipalAxes.Cast" title="Permalink to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>obj</strong> The object to be casted.</p>
</dd>
<dt class="field-even">Return type</dt>
<dd class="field-even"><p>An object of type PrincipalAxes if the cast was successful,
None otherwise.</p>
</dd>
</dl>
<p>Cast an arbitrary object to PrincipalAxes if the internal wrapped
representation is an PrincipalAxes object. The cast is important if
instances of type <a class="reference internal" href="#api-python-datamodel-object"><span class="std std-ref">Object</span></a>
are passed to methods which need access to the real type.</p>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.PrincipalAxes.equal">
<code class="sig-name descname">equal</code><span class="sig-paren">(</span><em class="sig-param">other</em><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.PrincipalAxes.equal" title="Permalink to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>other</strong> Another object of type PrincipalAxes to compare this
instance to</p>
</dd>
<dt class="field-even">Return type</dt>
<dd class="field-even"><p>A Boolean value indicating True if both objects are equal or
False otherwise.</p>
</dd>
</dl>
<p>Compares two objects without its child objects. Both objects are compared
by value.</p>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.PrincipalAxes.setTAxis">
<code class="sig-name descname">setTAxis</code><span class="sig-paren">(</span><em class="sig-param">tAxis</em><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.PrincipalAxes.setTAxis" title="Permalink to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>tAxis</strong> <a class="reference internal" href="#api-python-datamodel-axis"><span class="std std-ref">Axis</span></a></p>
</dd>
</dl>
<p>T (tension) axis of a double-couple moment tensor solution.</p>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.PrincipalAxes.tAxis">
<code class="sig-name descname">tAxis</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.PrincipalAxes.tAxis" title="Permalink to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Return type</dt>
<dd class="field-odd"><p><a class="reference internal" href="#api-python-datamodel-axis"><span class="std std-ref">Axis</span></a></p>
</dd>
</dl>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.PrincipalAxes.setPAxis">
<code class="sig-name descname">setPAxis</code><span class="sig-paren">(</span><em class="sig-param">pAxis</em><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.PrincipalAxes.setPAxis" title="Permalink to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>pAxis</strong> <a class="reference internal" href="#api-python-datamodel-axis"><span class="std std-ref">Axis</span></a></p>
</dd>
</dl>
<p>P (pressure) axis of a double-couple moment tensor solution.</p>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.PrincipalAxes.pAxis">
<code class="sig-name descname">pAxis</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.PrincipalAxes.pAxis" title="Permalink to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Return type</dt>
<dd class="field-odd"><p><a class="reference internal" href="#api-python-datamodel-axis"><span class="std std-ref">Axis</span></a></p>
</dd>
</dl>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.PrincipalAxes.setNAxis">
<code class="sig-name descname">setNAxis</code><span class="sig-paren">(</span><em class="sig-param">nAxis</em><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.PrincipalAxes.setNAxis" title="Permalink to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>nAxis</strong> <a class="reference internal" href="#api-python-datamodel-axis"><span class="std std-ref">Axis</span></a></p>
</dd>
</dl>
<p>N (neutral) axis of a double-couple moment tensor solution.</p>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.PrincipalAxes.nAxis">
<code class="sig-name descname">nAxis</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.PrincipalAxes.nAxis" title="Permalink to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Return type</dt>
<dd class="field-odd"><p><a class="reference internal" href="#api-python-datamodel-axis"><span class="std std-ref">Axis</span></a></p>
</dd>
</dl>
<div class="admonition note">
<p class="admonition-title">Note</p>
<p>As this attribute is optional, this method throws a ValueError if
the value of the attribute is not set.</p>
</div>
</dd></dl>
</dd></dl>
</div>
<div class="section" id="qclog">
<span id="api-python-datamodel-qclog"></span><h3>QCLog<a class="headerlink" href="#qclog" title="Permalink to this headline"></a></h3>
<dl class="class">
<dt id="seiscomp.datamodel.QCLog">
<em class="property">class </em><code class="sig-prename descclassname">seiscomp.datamodel.</code><code class="sig-name descname">QCLog</code><a class="headerlink" href="#seiscomp.datamodel.QCLog" title="Permalink to this definition"></a></dt>
<dd><p>Inherits <a class="reference internal" href="#api-python-datamodel-publicobject"><span class="std std-ref">PublicObject</span></a>.</p>
<p><strong>Parents</strong>:</p>
<ul class="simple">
<li><p><code class="docutils literal notranslate"><span class="pre">qualityControl</span></code> <a class="reference internal" href="#api-python-datamodel-qualitycontrol"><span class="std std-ref">QualityControl</span></a></p></li>
</ul>
<p><strong>Attributes</strong>:</p>
<ul class="simple">
<li><p><code class="docutils literal notranslate"><span class="pre">publicID</span></code>: string</p></li>
<li><p><code class="docutils literal notranslate"><span class="pre">waveformID</span></code> <a class="reference internal" href="#api-python-datamodel-waveformstreamid"><span class="std std-ref">WaveformStreamID</span></a></p></li>
<li><p><code class="docutils literal notranslate"><span class="pre">creatorID</span></code> string</p></li>
<li><p><code class="docutils literal notranslate"><span class="pre">created</span></code> seiscomp.core.Time</p></li>
<li><p><code class="docutils literal notranslate"><span class="pre">start</span></code> seiscomp.core.Time</p></li>
<li><p><code class="docutils literal notranslate"><span class="pre">end</span></code> seiscomp.core.Time</p></li>
<li><p><code class="docutils literal notranslate"><span class="pre">message</span></code> string</p></li>
</ul>
<p><strong>Methods</strong>:</p>
<dl class="method">
<dt id="seiscomp.datamodel.QCLog.Cast">
<em class="property">static </em><code class="sig-name descname">Cast</code><span class="sig-paren">(</span><em class="sig-param">obj</em><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.QCLog.Cast" title="Permalink to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>obj</strong> The object to be casted.</p>
</dd>
<dt class="field-even">Return type</dt>
<dd class="field-even"><p>An object of type QCLog if the cast was successful,
None otherwise.</p>
</dd>
</dl>
<p>Cast an arbitrary object to QCLog if the internal wrapped
representation is an QCLog object. The cast is important if
instances of type <a class="reference internal" href="#api-python-datamodel-object"><span class="std std-ref">Object</span></a>
are passed to methods which need access to the real type.</p>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.QCLog.Create">
<em class="property">static </em><code class="sig-name descname">Create</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.QCLog.Create" title="Permalink to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Return type</dt>
<dd class="field-odd"><p>A new object of type QCLog.</p>
</dd>
</dl>
<p>Creates and registers (if enabled) a QCLog instance. The
publicID is auto-generated.</p>
</dd></dl>
<dl class="method">
<dt>
<em class="property">static </em><code class="sig-name descname">Create</code><span class="sig-paren">(</span><em class="sig-param">publicID</em><span class="sig-paren">)</span></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Return type</dt>
<dd class="field-odd"><p>A new object of type QCLog.</p>
</dd>
</dl>
<p>Creates and registers (if enabled) a QCLog instance with
passed publicID.</p>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.QCLog.equal">
<code class="sig-name descname">equal</code><span class="sig-paren">(</span><em class="sig-param">other</em><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.QCLog.equal" title="Permalink to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>other</strong> Another object of type QCLog to compare this
instance to</p>
</dd>
<dt class="field-even">Return type</dt>
<dd class="field-even"><p>A Boolean value indicating True if both objects are equal or
False otherwise.</p>
</dd>
</dl>
<p>Compares two objects without its child objects. Both objects are compared
by value.</p>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.QCLog.index">
<code class="sig-name descname">index</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.QCLog.index" title="Permalink to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Return type</dt>
<dd class="field-odd"><p><p>The objects index of type QCLogIndex.</p>
<p>Returns the objects index which is also used for the database as unique
constraint.</p>
</p>
</dd>
</dl>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.QCLog.equalIndex">
<code class="sig-name descname">equalIndex</code><span class="sig-paren">(</span><em class="sig-param">lhs</em><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.QCLog.equalIndex" title="Permalink to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>lhs</strong> <a class="reference internal" href="#api-python-datamodel-qclog"><span class="std std-ref">QCLog</span></a></p>
</dd>
<dt class="field-even">Return type</dt>
<dd class="field-even"><p>A Boolean value indicating True if both indexes are equal or
False otherwise.</p>
</dd>
</dl>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.QCLog.setWaveformID">
<code class="sig-name descname">setWaveformID</code><span class="sig-paren">(</span><em class="sig-param">waveformID</em><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.QCLog.setWaveformID" title="Permalink to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>waveformID</strong> <a class="reference internal" href="#api-python-datamodel-waveformstreamid"><span class="std std-ref">WaveformStreamID</span></a></p>
</dd>
</dl>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.QCLog.waveformID">
<code class="sig-name descname">waveformID</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.QCLog.waveformID" title="Permalink to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Return type</dt>
<dd class="field-odd"><p><a class="reference internal" href="#api-python-datamodel-waveformstreamid"><span class="std std-ref">WaveformStreamID</span></a></p>
</dd>
</dl>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.QCLog.setCreatorID">
<code class="sig-name descname">setCreatorID</code><span class="sig-paren">(</span><em class="sig-param">creatorID</em><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.QCLog.setCreatorID" title="Permalink to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>creatorID</strong> string</p>
</dd>
</dl>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.QCLog.creatorID">
<code class="sig-name descname">creatorID</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.QCLog.creatorID" title="Permalink to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Return type</dt>
<dd class="field-odd"><p>string</p>
</dd>
</dl>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.QCLog.setCreated">
<code class="sig-name descname">setCreated</code><span class="sig-paren">(</span><em class="sig-param">created</em><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.QCLog.setCreated" title="Permalink to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>created</strong> seiscomp.core.Time</p>
</dd>
</dl>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.QCLog.created">
<code class="sig-name descname">created</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.QCLog.created" title="Permalink to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Return type</dt>
<dd class="field-odd"><p>seiscomp.core.Time</p>
</dd>
</dl>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.QCLog.setStart">
<code class="sig-name descname">setStart</code><span class="sig-paren">(</span><em class="sig-param">start</em><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.QCLog.setStart" title="Permalink to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>start</strong> seiscomp.core.Time</p>
</dd>
</dl>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.QCLog.start">
<code class="sig-name descname">start</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.QCLog.start" title="Permalink to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Return type</dt>
<dd class="field-odd"><p>seiscomp.core.Time</p>
</dd>
</dl>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.QCLog.setEnd">
<code class="sig-name descname">setEnd</code><span class="sig-paren">(</span><em class="sig-param">end</em><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.QCLog.setEnd" title="Permalink to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>end</strong> seiscomp.core.Time</p>
</dd>
</dl>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.QCLog.end">
<code class="sig-name descname">end</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.QCLog.end" title="Permalink to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Return type</dt>
<dd class="field-odd"><p>seiscomp.core.Time</p>
</dd>
</dl>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.QCLog.setMessage">
<code class="sig-name descname">setMessage</code><span class="sig-paren">(</span><em class="sig-param">message</em><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.QCLog.setMessage" title="Permalink to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>message</strong> string</p>
</dd>
</dl>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.QCLog.message">
<code class="sig-name descname">message</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.QCLog.message" title="Permalink to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Return type</dt>
<dd class="field-odd"><p>string</p>
</dd>
</dl>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.QCLog.qualityControl">
<code class="sig-name descname">qualityControl</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.QCLog.qualityControl" title="Permalink to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Return type</dt>
<dd class="field-odd"><p><a class="reference internal" href="#seiscomp.datamodel.QualityControl" title="seiscomp.datamodel.QualityControl">QualityControl</a></p>
</dd>
</dl>
<p>Returns the parent QualityControl if available. Returns None
if the parent is not a QualityControl. This is a convenience wrapper
for parent().</p>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.QCLog.assign">
<code class="sig-name descname">assign</code><span class="sig-paren">(</span><em class="sig-param">other</em><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.QCLog.assign" title="Permalink to this definition"></a></dt>
<dd><p>This method implements the <a class="reference internal" href="#api-python-datamodel-object"><span class="std std-ref">Object</span></a> interface.</p>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.QCLog.attachTo">
<code class="sig-name descname">attachTo</code><span class="sig-paren">(</span><em class="sig-param">parent</em><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.QCLog.attachTo" title="Permalink to this definition"></a></dt>
<dd><p>This method implements the <a class="reference internal" href="#api-python-datamodel-object"><span class="std std-ref">Object</span></a> interface.</p>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.QCLog.detachFrom">
<code class="sig-name descname">detachFrom</code><span class="sig-paren">(</span><em class="sig-param">parent</em><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.QCLog.detachFrom" title="Permalink to this definition"></a></dt>
<dd><p>This method implements the <a class="reference internal" href="#api-python-datamodel-object"><span class="std std-ref">Object</span></a> interface.</p>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.QCLog.detach">
<code class="sig-name descname">detach</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.QCLog.detach" title="Permalink to this definition"></a></dt>
<dd><p>This method implements the <a class="reference internal" href="#api-python-datamodel-object"><span class="std std-ref">Object</span></a> interface.</p>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.QCLog.clone">
<code class="sig-name descname">clone</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.QCLog.clone" title="Permalink to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Return type</dt>
<dd class="field-odd"><p>A cloned QCLog.</p>
</dd>
</dl>
<p>Returns a new instance that is a clone of the current instance. Child
objects are being ignored.</p>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.QCLog.updateChild">
<code class="sig-name descname">updateChild</code><span class="sig-paren">(</span><em class="sig-param">ref</em><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.QCLog.updateChild" title="Permalink to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>ref</strong> A child object derived from class Object.</p>
</dd>
<dt class="field-even">Return type</dt>
<dd class="field-even"><p>A Boolean flag indicating success with True, False otherwise</p>
</dd>
</dl>
<p>This method takes the passed reference object and searches for a child
with the same publicID (if derived from <a class="reference internal" href="#api-python-datamodel-publicobject"><span class="std std-ref">PublicObject</span></a>)
or the same index (if derived from <a class="reference internal" href="#api-python-datamodel-object"><span class="std std-ref">Object</span></a>).
The the child was found the reference objects attributes are copied to
the child object. Children of child are being ignored during this operation.
This method implements the <a class="reference internal" href="#api-python-datamodel-publicobject"><span class="std std-ref">PublicObject</span></a> interface.</p>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.QCLog.accept">
<code class="sig-name descname">accept</code><span class="sig-paren">(</span><em class="sig-param">visitor</em><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.QCLog.accept" title="Permalink to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>visitor</strong> A visitor.</p>
</dd>
</dl>
<p>This method implements the <a class="reference internal" href="#api-python-datamodel-publicobject"><span class="std std-ref">PublicObject</span></a> interface.</p>
</dd></dl>
</dd></dl>
</div>
<div class="section" id="api-python-datamodel-qualitycontrol">
<span id="id17"></span><h3>QualityControl<a class="headerlink" href="#api-python-datamodel-qualitycontrol" title="Permalink to this headline"></a></h3>
<dl class="class">
<dt id="seiscomp.datamodel.QualityControl">
<em class="property">class </em><code class="sig-prename descclassname">seiscomp.datamodel.</code><code class="sig-name descname">QualityControl</code><a class="headerlink" href="#seiscomp.datamodel.QualityControl" title="Permalink to this definition"></a></dt>
<dd><p>Inherits <a class="reference internal" href="#api-python-datamodel-publicobject"><span class="std std-ref">PublicObject</span></a>.</p>
<p><strong>Children</strong>:</p>
<ul class="simple">
<li><p><code class="docutils literal notranslate"><span class="pre">qCLog</span></code> <a class="reference internal" href="#api-python-datamodel-qclog"><span class="std std-ref">QCLog</span></a></p></li>
<li><p><code class="docutils literal notranslate"><span class="pre">waveformQuality</span></code> <a class="reference internal" href="#api-python-datamodel-waveformquality"><span class="std std-ref">WaveformQuality</span></a></p></li>
<li><p><code class="docutils literal notranslate"><span class="pre">outage</span></code> <a class="reference internal" href="#api-python-datamodel-outage"><span class="std std-ref">Outage</span></a></p></li>
</ul>
<p><strong>Attributes</strong>:</p>
<ul class="simple">
<li><p><code class="docutils literal notranslate"><span class="pre">publicID</span></code>: string</p></li>
</ul>
<p><strong>Methods</strong>:</p>
<dl class="method">
<dt id="seiscomp.datamodel.QualityControl.Cast">
<em class="property">static </em><code class="sig-name descname">Cast</code><span class="sig-paren">(</span><em class="sig-param">obj</em><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.QualityControl.Cast" title="Permalink to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>obj</strong> The object to be casted.</p>
</dd>
<dt class="field-even">Return type</dt>
<dd class="field-even"><p>An object of type QualityControl if the cast was successful,
None otherwise.</p>
</dd>
</dl>
<p>Cast an arbitrary object to QualityControl if the internal wrapped
representation is an QualityControl object. The cast is important if
instances of type <a class="reference internal" href="#api-python-datamodel-object"><span class="std std-ref">Object</span></a>
are passed to methods which need access to the real type.</p>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.QualityControl.equal">
<code class="sig-name descname">equal</code><span class="sig-paren">(</span><em class="sig-param">other</em><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.QualityControl.equal" title="Permalink to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>other</strong> Another object of type QualityControl to compare this
instance to</p>
</dd>
<dt class="field-even">Return type</dt>
<dd class="field-even"><p>A Boolean value indicating True if both objects are equal or
False otherwise.</p>
</dd>
</dl>
<p>Compares two objects without its child objects. Both objects are compared
by value.</p>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.QualityControl.add">
<code class="sig-name descname">add</code><span class="sig-paren">(</span><em class="sig-param">qCLog</em><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.QualityControl.add" title="Permalink to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>qCLog</strong> Object of type <a class="reference internal" href="#api-python-datamodel-qclog"><span class="std std-ref">QCLog</span></a></p>
</dd>
<dt class="field-even">Return type</dt>
<dd class="field-even"><p>A Boolean value indicating success with True, False otherwise.</p>
</dd>
</dl>
<p>Adds a QCLog object to QualityControl. The object is not
copied but managed by this instance. Any change to the passed object
will also change the child.</p>
</dd></dl>
<dl class="method">
<dt>
<code class="sig-name descname">add</code><span class="sig-paren">(</span><em class="sig-param">waveformQuality</em><span class="sig-paren">)</span></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>waveformQuality</strong> Object of type <a class="reference internal" href="#api-python-datamodel-waveformquality"><span class="std std-ref">WaveformQuality</span></a></p>
</dd>
<dt class="field-even">Return type</dt>
<dd class="field-even"><p>A Boolean value indicating success with True, False otherwise.</p>
</dd>
</dl>
<p>Adds a WaveformQuality object to QualityControl. The object is not
copied but managed by this instance. Any change to the passed object
will also change the child.</p>
</dd></dl>
<dl class="method">
<dt>
<code class="sig-name descname">add</code><span class="sig-paren">(</span><em class="sig-param">outage</em><span class="sig-paren">)</span></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>outage</strong> Object of type <a class="reference internal" href="#api-python-datamodel-outage"><span class="std std-ref">Outage</span></a></p>
</dd>
<dt class="field-even">Return type</dt>
<dd class="field-even"><p>A Boolean value indicating success with True, False otherwise.</p>
</dd>
</dl>
<p>Adds a Outage object to QualityControl. The object is not
copied but managed by this instance. Any change to the passed object
will also change the child.</p>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.QualityControl.remove">
<code class="sig-name descname">remove</code><span class="sig-paren">(</span><em class="sig-param">qCLog</em><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.QualityControl.remove" title="Permalink to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>qCLog</strong> Object of type <a class="reference internal" href="#api-python-datamodel-qclog"><span class="std std-ref">QCLog</span></a></p>
</dd>
<dt class="field-even">Return type</dt>
<dd class="field-even"><p>A Boolean value indicating success with True, False otherwise.</p>
</dd>
</dl>
<p>Removes a previously added QCLog object from QualityControl.</p>
</dd></dl>
<dl class="method">
<dt>
<code class="sig-name descname">remove</code><span class="sig-paren">(</span><em class="sig-param">waveformQuality</em><span class="sig-paren">)</span></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>waveformQuality</strong> Object of type <a class="reference internal" href="#api-python-datamodel-waveformquality"><span class="std std-ref">WaveformQuality</span></a></p>
</dd>
<dt class="field-even">Return type</dt>
<dd class="field-even"><p>A Boolean value indicating success with True, False otherwise.</p>
</dd>
</dl>
<p>Removes a previously added WaveformQuality object from QualityControl.</p>
</dd></dl>
<dl class="method">
<dt>
<code class="sig-name descname">remove</code><span class="sig-paren">(</span><em class="sig-param">outage</em><span class="sig-paren">)</span></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>outage</strong> Object of type <a class="reference internal" href="#api-python-datamodel-outage"><span class="std std-ref">Outage</span></a></p>
</dd>
<dt class="field-even">Return type</dt>
<dd class="field-even"><p>A Boolean value indicating success with True, False otherwise.</p>
</dd>
</dl>
<p>Removes a previously added Outage object from QualityControl.</p>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.QualityControl.removeQCLog">
<code class="sig-name descname">removeQCLog</code><span class="sig-paren">(</span><em class="sig-param">idx</em><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.QualityControl.removeQCLog" title="Permalink to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>idx</strong> An integer index of the object to be removed.</p>
</dd>
<dt class="field-even">Return type</dt>
<dd class="field-even"><p>A Boolean value indicating success with True, False otherwise.</p>
</dd>
</dl>
</dd></dl>
<dl class="method">
<dt>
<code class="sig-name descname">removeQCLog(qCLogIndex);</code></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>qCLogIndex</strong> The index of the object to be removed of type QCLogIndex.</p>
</dd>
<dt class="field-even">Return type</dt>
<dd class="field-even"><p>A Boolean value indicating success with True, False otherwise.</p>
</dd>
</dl>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.QualityControl.removeWaveformQuality">
<code class="sig-name descname">removeWaveformQuality</code><span class="sig-paren">(</span><em class="sig-param">idx</em><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.QualityControl.removeWaveformQuality" title="Permalink to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>idx</strong> An integer index of the object to be removed.</p>
</dd>
<dt class="field-even">Return type</dt>
<dd class="field-even"><p>A Boolean value indicating success with True, False otherwise.</p>
</dd>
</dl>
</dd></dl>
<dl class="method">
<dt>
<code class="sig-name descname">removeWaveformQuality(waveformQualityIndex);</code></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>waveformQualityIndex</strong> The index of the object to be removed of type WaveformQualityIndex.</p>
</dd>
<dt class="field-even">Return type</dt>
<dd class="field-even"><p>A Boolean value indicating success with True, False otherwise.</p>
</dd>
</dl>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.QualityControl.removeOutage">
<code class="sig-name descname">removeOutage</code><span class="sig-paren">(</span><em class="sig-param">idx</em><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.QualityControl.removeOutage" title="Permalink to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>idx</strong> An integer index of the object to be removed.</p>
</dd>
<dt class="field-even">Return type</dt>
<dd class="field-even"><p>A Boolean value indicating success with True, False otherwise.</p>
</dd>
</dl>
</dd></dl>
<dl class="method">
<dt>
<code class="sig-name descname">removeOutage(outageIndex);</code></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>outageIndex</strong> The index of the object to be removed of type OutageIndex.</p>
</dd>
<dt class="field-even">Return type</dt>
<dd class="field-even"><p>A Boolean value indicating success with True, False otherwise.</p>
</dd>
</dl>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.QualityControl.qCLogCount">
<code class="sig-name descname">qCLogCount</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.QualityControl.qCLogCount" title="Permalink to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Return type</dt>
<dd class="field-odd"><p>integer value indicating the number of child objects.</p>
</dd>
</dl>
<p>Returns the number of QCLog child objects.</p>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.QualityControl.waveformQualityCount">
<code class="sig-name descname">waveformQualityCount</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.QualityControl.waveformQualityCount" title="Permalink to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Return type</dt>
<dd class="field-odd"><p>integer value indicating the number of child objects.</p>
</dd>
</dl>
<p>Returns the number of WaveformQuality child objects.</p>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.QualityControl.outageCount">
<code class="sig-name descname">outageCount</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.QualityControl.outageCount" title="Permalink to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Return type</dt>
<dd class="field-odd"><p>integer value indicating the number of child objects.</p>
</dd>
</dl>
<p>Returns the number of Outage child objects.</p>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.QualityControl.qCLog">
<code class="sig-name descname">qCLog</code><span class="sig-paren">(</span><em class="sig-param">idx</em><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.QualityControl.qCLog" title="Permalink to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>idx</strong> An integer index of the object to be returned.</p>
</dd>
<dt class="field-even">Return type</dt>
<dd class="field-even"><p>Object of type <a class="reference internal" href="#api-python-datamodel-qclog"><span class="std std-ref">QCLog</span></a>.</p>
</dd>
</dl>
<p>Returns the QCLog at index idx.</p>
</dd></dl>
<dl class="method">
<dt>
<code class="sig-name descname">qCLog</code><span class="sig-paren">(</span><em class="sig-param">qCLogIndex</em><span class="sig-paren">)</span></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>qCLogIndex</strong> The index of the object to be removed of type QCLogIndex.</p>
</dd>
<dt class="field-even">Return type</dt>
<dd class="field-even"><p>Object of type <a class="reference internal" href="#api-python-datamodel-qclog"><span class="std std-ref">QCLog</span></a>.</p>
</dd>
</dl>
<p>Returns the QCLog at given index. The indexes of all child objects
are compared by value which makes this function slower than the direct
integer index look-up.</p>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.QualityControl.waveformQuality">
<code class="sig-name descname">waveformQuality</code><span class="sig-paren">(</span><em class="sig-param">idx</em><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.QualityControl.waveformQuality" title="Permalink to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>idx</strong> An integer index of the object to be returned.</p>
</dd>
<dt class="field-even">Return type</dt>
<dd class="field-even"><p>Object of type <a class="reference internal" href="#api-python-datamodel-waveformquality"><span class="std std-ref">WaveformQuality</span></a>.</p>
</dd>
</dl>
<p>Returns the WaveformQuality at index idx.</p>
</dd></dl>
<dl class="method">
<dt>
<code class="sig-name descname">waveformQuality</code><span class="sig-paren">(</span><em class="sig-param">waveformQualityIndex</em><span class="sig-paren">)</span></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>waveformQualityIndex</strong> The index of the object to be removed of type WaveformQualityIndex.</p>
</dd>
<dt class="field-even">Return type</dt>
<dd class="field-even"><p>Object of type <a class="reference internal" href="#api-python-datamodel-waveformquality"><span class="std std-ref">WaveformQuality</span></a>.</p>
</dd>
</dl>
<p>Returns the WaveformQuality at given index. The indexes of all child objects
are compared by value which makes this function slower than the direct
integer index look-up.</p>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.QualityControl.outage">
<code class="sig-name descname">outage</code><span class="sig-paren">(</span><em class="sig-param">idx</em><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.QualityControl.outage" title="Permalink to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>idx</strong> An integer index of the object to be returned.</p>
</dd>
<dt class="field-even">Return type</dt>
<dd class="field-even"><p>Object of type <a class="reference internal" href="#api-python-datamodel-outage"><span class="std std-ref">Outage</span></a>.</p>
</dd>
</dl>
<p>Returns the Outage at index idx.</p>
</dd></dl>
<dl class="method">
<dt>
<code class="sig-name descname">outage</code><span class="sig-paren">(</span><em class="sig-param">outageIndex</em><span class="sig-paren">)</span></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>outageIndex</strong> The index of the object to be removed of type OutageIndex.</p>
</dd>
<dt class="field-even">Return type</dt>
<dd class="field-even"><p>Object of type <a class="reference internal" href="#api-python-datamodel-outage"><span class="std std-ref">Outage</span></a>.</p>
</dd>
</dl>
<p>Returns the Outage at given index. The indexes of all child objects
are compared by value which makes this function slower than the direct
integer index look-up.</p>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.QualityControl.findQCLog">
<code class="sig-name descname">findQCLog</code><span class="sig-paren">(</span><em class="sig-param">publicID</em><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.QualityControl.findQCLog" title="Permalink to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>publicID</strong> The publicID of the object to find.</p>
</dd>
<dt class="field-even">Return type</dt>
<dd class="field-even"><p>Object of type <a class="reference internal" href="#api-python-datamodel-qclog"><span class="std std-ref">QCLog</span></a>.</p>
</dd>
</dl>
<p>Returns the child object with a certain publicID, None otherwise.</p>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.QualityControl.assign">
<code class="sig-name descname">assign</code><span class="sig-paren">(</span><em class="sig-param">other</em><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.QualityControl.assign" title="Permalink to this definition"></a></dt>
<dd><p>This method implements the <a class="reference internal" href="#api-python-datamodel-object"><span class="std std-ref">Object</span></a> interface.</p>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.QualityControl.attachTo">
<code class="sig-name descname">attachTo</code><span class="sig-paren">(</span><em class="sig-param">parent</em><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.QualityControl.attachTo" title="Permalink to this definition"></a></dt>
<dd><p>This method implements the <a class="reference internal" href="#api-python-datamodel-object"><span class="std std-ref">Object</span></a> interface.</p>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.QualityControl.detachFrom">
<code class="sig-name descname">detachFrom</code><span class="sig-paren">(</span><em class="sig-param">parent</em><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.QualityControl.detachFrom" title="Permalink to this definition"></a></dt>
<dd><p>This method implements the <a class="reference internal" href="#api-python-datamodel-object"><span class="std std-ref">Object</span></a> interface.</p>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.QualityControl.detach">
<code class="sig-name descname">detach</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.QualityControl.detach" title="Permalink to this definition"></a></dt>
<dd><p>This method implements the <a class="reference internal" href="#api-python-datamodel-object"><span class="std std-ref">Object</span></a> interface.</p>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.QualityControl.clone">
<code class="sig-name descname">clone</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.QualityControl.clone" title="Permalink to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Return type</dt>
<dd class="field-odd"><p>A cloned QualityControl.</p>
</dd>
</dl>
<p>Returns a new instance that is a clone of the current instance. Child
objects are being ignored.</p>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.QualityControl.updateChild">
<code class="sig-name descname">updateChild</code><span class="sig-paren">(</span><em class="sig-param">ref</em><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.QualityControl.updateChild" title="Permalink to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>ref</strong> A child object derived from class Object.</p>
</dd>
<dt class="field-even">Return type</dt>
<dd class="field-even"><p>A Boolean flag indicating success with True, False otherwise</p>
</dd>
</dl>
<p>This method takes the passed reference object and searches for a child
with the same publicID (if derived from <a class="reference internal" href="#api-python-datamodel-publicobject"><span class="std std-ref">PublicObject</span></a>)
or the same index (if derived from <a class="reference internal" href="#api-python-datamodel-object"><span class="std std-ref">Object</span></a>).
The the child was found the reference objects attributes are copied to
the child object. Children of child are being ignored during this operation.
This method implements the <a class="reference internal" href="#api-python-datamodel-publicobject"><span class="std std-ref">PublicObject</span></a> interface.</p>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.QualityControl.accept">
<code class="sig-name descname">accept</code><span class="sig-paren">(</span><em class="sig-param">visitor</em><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.QualityControl.accept" title="Permalink to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>visitor</strong> A visitor.</p>
</dd>
</dl>
<p>This method implements the <a class="reference internal" href="#api-python-datamodel-publicobject"><span class="std std-ref">PublicObject</span></a> interface.</p>
</dd></dl>
</dd></dl>
</div>
<div class="section" id="reading">
<span id="api-python-datamodel-reading"></span><h3>Reading<a class="headerlink" href="#reading" title="Permalink to this headline"></a></h3>
<dl class="class">
<dt id="seiscomp.datamodel.Reading">
<em class="property">class </em><code class="sig-prename descclassname">seiscomp.datamodel.</code><code class="sig-name descname">Reading</code><a class="headerlink" href="#seiscomp.datamodel.Reading" title="Permalink to this definition"></a></dt>
<dd><p>Inherits <a class="reference internal" href="#api-python-datamodel-publicobject"><span class="std std-ref">PublicObject</span></a>.</p>
<p>This class groups Pick and Amplitude elements which are thought to belong
to the same event, but for which the event identification is not known.</p>
<p><strong>Parents</strong>:</p>
<ul class="simple">
<li><p><code class="docutils literal notranslate"><span class="pre">eventParameters</span></code> <a class="reference internal" href="#api-python-datamodel-eventparameters"><span class="std std-ref">EventParameters</span></a></p></li>
</ul>
<p><strong>Children</strong>:</p>
<ul class="simple">
<li><p><code class="docutils literal notranslate"><span class="pre">pickReference</span></code> <a class="reference internal" href="#api-python-datamodel-pickreference"><span class="std std-ref">PickReference</span></a></p></li>
<li><p><code class="docutils literal notranslate"><span class="pre">amplitudeReference</span></code> <a class="reference internal" href="#api-python-datamodel-amplitudereference"><span class="std std-ref">AmplitudeReference</span></a></p></li>
</ul>
<p><strong>Attributes</strong>:</p>
<ul class="simple">
<li><p><code class="docutils literal notranslate"><span class="pre">publicID</span></code>: string</p></li>
</ul>
<p><strong>Methods</strong>:</p>
<dl class="method">
<dt id="seiscomp.datamodel.Reading.Cast">
<em class="property">static </em><code class="sig-name descname">Cast</code><span class="sig-paren">(</span><em class="sig-param">obj</em><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.Reading.Cast" title="Permalink to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>obj</strong> The object to be casted.</p>
</dd>
<dt class="field-even">Return type</dt>
<dd class="field-even"><p>An object of type Reading if the cast was successful,
None otherwise.</p>
</dd>
</dl>
<p>Cast an arbitrary object to Reading if the internal wrapped
representation is an Reading object. The cast is important if
instances of type <a class="reference internal" href="#api-python-datamodel-object"><span class="std std-ref">Object</span></a>
are passed to methods which need access to the real type.</p>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.Reading.Create">
<em class="property">static </em><code class="sig-name descname">Create</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.Reading.Create" title="Permalink to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Return type</dt>
<dd class="field-odd"><p>A new object of type Reading.</p>
</dd>
</dl>
<p>Creates and registers (if enabled) a Reading instance. The
publicID is auto-generated.</p>
</dd></dl>
<dl class="method">
<dt>
<em class="property">static </em><code class="sig-name descname">Create</code><span class="sig-paren">(</span><em class="sig-param">publicID</em><span class="sig-paren">)</span></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Return type</dt>
<dd class="field-odd"><p>A new object of type Reading.</p>
</dd>
</dl>
<p>Creates and registers (if enabled) a Reading instance with
passed publicID.</p>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.Reading.equal">
<code class="sig-name descname">equal</code><span class="sig-paren">(</span><em class="sig-param">other</em><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.Reading.equal" title="Permalink to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>other</strong> Another object of type Reading to compare this
instance to</p>
</dd>
<dt class="field-even">Return type</dt>
<dd class="field-even"><p>A Boolean value indicating True if both objects are equal or
False otherwise.</p>
</dd>
</dl>
<p>Compares two objects without its child objects. Both objects are compared
by value.</p>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.Reading.add">
<code class="sig-name descname">add</code><span class="sig-paren">(</span><em class="sig-param">pickReference</em><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.Reading.add" title="Permalink to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>pickReference</strong> Object of type <a class="reference internal" href="#api-python-datamodel-pickreference"><span class="std std-ref">PickReference</span></a></p>
</dd>
<dt class="field-even">Return type</dt>
<dd class="field-even"><p>A Boolean value indicating success with True, False otherwise.</p>
</dd>
</dl>
<p>Adds a PickReference object to Reading. The object is not
copied but managed by this instance. Any change to the passed object
will also change the child.</p>
</dd></dl>
<dl class="method">
<dt>
<code class="sig-name descname">add</code><span class="sig-paren">(</span><em class="sig-param">amplitudeReference</em><span class="sig-paren">)</span></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>amplitudeReference</strong> Object of type <a class="reference internal" href="#api-python-datamodel-amplitudereference"><span class="std std-ref">AmplitudeReference</span></a></p>
</dd>
<dt class="field-even">Return type</dt>
<dd class="field-even"><p>A Boolean value indicating success with True, False otherwise.</p>
</dd>
</dl>
<p>Adds a AmplitudeReference object to Reading. The object is not
copied but managed by this instance. Any change to the passed object
will also change the child.</p>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.Reading.remove">
<code class="sig-name descname">remove</code><span class="sig-paren">(</span><em class="sig-param">pickReference</em><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.Reading.remove" title="Permalink to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>pickReference</strong> Object of type <a class="reference internal" href="#api-python-datamodel-pickreference"><span class="std std-ref">PickReference</span></a></p>
</dd>
<dt class="field-even">Return type</dt>
<dd class="field-even"><p>A Boolean value indicating success with True, False otherwise.</p>
</dd>
</dl>
<p>Removes a previously added PickReference object from Reading.</p>
</dd></dl>
<dl class="method">
<dt>
<code class="sig-name descname">remove</code><span class="sig-paren">(</span><em class="sig-param">amplitudeReference</em><span class="sig-paren">)</span></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>amplitudeReference</strong> Object of type <a class="reference internal" href="#api-python-datamodel-amplitudereference"><span class="std std-ref">AmplitudeReference</span></a></p>
</dd>
<dt class="field-even">Return type</dt>
<dd class="field-even"><p>A Boolean value indicating success with True, False otherwise.</p>
</dd>
</dl>
<p>Removes a previously added AmplitudeReference object from Reading.</p>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.Reading.removePickReference">
<code class="sig-name descname">removePickReference</code><span class="sig-paren">(</span><em class="sig-param">idx</em><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.Reading.removePickReference" title="Permalink to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>idx</strong> An integer index of the object to be removed.</p>
</dd>
<dt class="field-even">Return type</dt>
<dd class="field-even"><p>A Boolean value indicating success with True, False otherwise.</p>
</dd>
</dl>
</dd></dl>
<dl class="method">
<dt>
<code class="sig-name descname">removePickReference(pickReferenceIndex);</code></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>pickReferenceIndex</strong> The index of the object to be removed of type PickReferenceIndex.</p>
</dd>
<dt class="field-even">Return type</dt>
<dd class="field-even"><p>A Boolean value indicating success with True, False otherwise.</p>
</dd>
</dl>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.Reading.removeAmplitudeReference">
<code class="sig-name descname">removeAmplitudeReference</code><span class="sig-paren">(</span><em class="sig-param">idx</em><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.Reading.removeAmplitudeReference" title="Permalink to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>idx</strong> An integer index of the object to be removed.</p>
</dd>
<dt class="field-even">Return type</dt>
<dd class="field-even"><p>A Boolean value indicating success with True, False otherwise.</p>
</dd>
</dl>
</dd></dl>
<dl class="method">
<dt>
<code class="sig-name descname">removeAmplitudeReference(amplitudeReferenceIndex);</code></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>amplitudeReferenceIndex</strong> The index of the object to be removed of type AmplitudeReferenceIndex.</p>
</dd>
<dt class="field-even">Return type</dt>
<dd class="field-even"><p>A Boolean value indicating success with True, False otherwise.</p>
</dd>
</dl>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.Reading.pickReferenceCount">
<code class="sig-name descname">pickReferenceCount</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.Reading.pickReferenceCount" title="Permalink to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Return type</dt>
<dd class="field-odd"><p>integer value indicating the number of child objects.</p>
</dd>
</dl>
<p>Returns the number of PickReference child objects.</p>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.Reading.amplitudeReferenceCount">
<code class="sig-name descname">amplitudeReferenceCount</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.Reading.amplitudeReferenceCount" title="Permalink to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Return type</dt>
<dd class="field-odd"><p>integer value indicating the number of child objects.</p>
</dd>
</dl>
<p>Returns the number of AmplitudeReference child objects.</p>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.Reading.pickReference">
<code class="sig-name descname">pickReference</code><span class="sig-paren">(</span><em class="sig-param">idx</em><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.Reading.pickReference" title="Permalink to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>idx</strong> An integer index of the object to be returned.</p>
</dd>
<dt class="field-even">Return type</dt>
<dd class="field-even"><p>Object of type <a class="reference internal" href="#api-python-datamodel-pickreference"><span class="std std-ref">PickReference</span></a>.</p>
</dd>
</dl>
<p>Returns the PickReference at index idx.</p>
</dd></dl>
<dl class="method">
<dt>
<code class="sig-name descname">pickReference</code><span class="sig-paren">(</span><em class="sig-param">pickReferenceIndex</em><span class="sig-paren">)</span></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>pickReferenceIndex</strong> The index of the object to be removed of type PickReferenceIndex.</p>
</dd>
<dt class="field-even">Return type</dt>
<dd class="field-even"><p>Object of type <a class="reference internal" href="#api-python-datamodel-pickreference"><span class="std std-ref">PickReference</span></a>.</p>
</dd>
</dl>
<p>Returns the PickReference at given index. The indexes of all child objects
are compared by value which makes this function slower than the direct
integer index look-up.</p>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.Reading.amplitudeReference">
<code class="sig-name descname">amplitudeReference</code><span class="sig-paren">(</span><em class="sig-param">idx</em><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.Reading.amplitudeReference" title="Permalink to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>idx</strong> An integer index of the object to be returned.</p>
</dd>
<dt class="field-even">Return type</dt>
<dd class="field-even"><p>Object of type <a class="reference internal" href="#api-python-datamodel-amplitudereference"><span class="std std-ref">AmplitudeReference</span></a>.</p>
</dd>
</dl>
<p>Returns the AmplitudeReference at index idx.</p>
</dd></dl>
<dl class="method">
<dt>
<code class="sig-name descname">amplitudeReference</code><span class="sig-paren">(</span><em class="sig-param">amplitudeReferenceIndex</em><span class="sig-paren">)</span></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>amplitudeReferenceIndex</strong> The index of the object to be removed of type AmplitudeReferenceIndex.</p>
</dd>
<dt class="field-even">Return type</dt>
<dd class="field-even"><p>Object of type <a class="reference internal" href="#api-python-datamodel-amplitudereference"><span class="std std-ref">AmplitudeReference</span></a>.</p>
</dd>
</dl>
<p>Returns the AmplitudeReference at given index. The indexes of all child objects
are compared by value which makes this function slower than the direct
integer index look-up.</p>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.Reading.eventParameters">
<code class="sig-name descname">eventParameters</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.Reading.eventParameters" title="Permalink to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Return type</dt>
<dd class="field-odd"><p><a class="reference internal" href="#seiscomp.datamodel.EventParameters" title="seiscomp.datamodel.EventParameters">EventParameters</a></p>
</dd>
</dl>
<p>Returns the parent EventParameters if available. Returns None
if the parent is not a EventParameters. This is a convenience wrapper
for parent().</p>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.Reading.assign">
<code class="sig-name descname">assign</code><span class="sig-paren">(</span><em class="sig-param">other</em><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.Reading.assign" title="Permalink to this definition"></a></dt>
<dd><p>This method implements the <a class="reference internal" href="#api-python-datamodel-object"><span class="std std-ref">Object</span></a> interface.</p>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.Reading.attachTo">
<code class="sig-name descname">attachTo</code><span class="sig-paren">(</span><em class="sig-param">parent</em><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.Reading.attachTo" title="Permalink to this definition"></a></dt>
<dd><p>This method implements the <a class="reference internal" href="#api-python-datamodel-object"><span class="std std-ref">Object</span></a> interface.</p>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.Reading.detachFrom">
<code class="sig-name descname">detachFrom</code><span class="sig-paren">(</span><em class="sig-param">parent</em><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.Reading.detachFrom" title="Permalink to this definition"></a></dt>
<dd><p>This method implements the <a class="reference internal" href="#api-python-datamodel-object"><span class="std std-ref">Object</span></a> interface.</p>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.Reading.detach">
<code class="sig-name descname">detach</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.Reading.detach" title="Permalink to this definition"></a></dt>
<dd><p>This method implements the <a class="reference internal" href="#api-python-datamodel-object"><span class="std std-ref">Object</span></a> interface.</p>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.Reading.clone">
<code class="sig-name descname">clone</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.Reading.clone" title="Permalink to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Return type</dt>
<dd class="field-odd"><p>A cloned Reading.</p>
</dd>
</dl>
<p>Returns a new instance that is a clone of the current instance. Child
objects are being ignored.</p>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.Reading.updateChild">
<code class="sig-name descname">updateChild</code><span class="sig-paren">(</span><em class="sig-param">ref</em><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.Reading.updateChild" title="Permalink to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>ref</strong> A child object derived from class Object.</p>
</dd>
<dt class="field-even">Return type</dt>
<dd class="field-even"><p>A Boolean flag indicating success with True, False otherwise</p>
</dd>
</dl>
<p>This method takes the passed reference object and searches for a child
with the same publicID (if derived from <a class="reference internal" href="#api-python-datamodel-publicobject"><span class="std std-ref">PublicObject</span></a>)
or the same index (if derived from <a class="reference internal" href="#api-python-datamodel-object"><span class="std std-ref">Object</span></a>).
The the child was found the reference objects attributes are copied to
the child object. Children of child are being ignored during this operation.
This method implements the <a class="reference internal" href="#api-python-datamodel-publicobject"><span class="std std-ref">PublicObject</span></a> interface.</p>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.Reading.accept">
<code class="sig-name descname">accept</code><span class="sig-paren">(</span><em class="sig-param">visitor</em><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.Reading.accept" title="Permalink to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>visitor</strong> A visitor.</p>
</dd>
</dl>
<p>This method implements the <a class="reference internal" href="#api-python-datamodel-publicobject"><span class="std std-ref">PublicObject</span></a> interface.</p>
</dd></dl>
</dd></dl>
</div>
<div class="section" id="realarray">
<span id="api-python-datamodel-realarray"></span><h3>RealArray<a class="headerlink" href="#realarray" title="Permalink to this headline"></a></h3>
<dl class="class">
<dt id="seiscomp.datamodel.RealArray">
<em class="property">class </em><code class="sig-prename descclassname">seiscomp.datamodel.</code><code class="sig-name descname">RealArray</code><a class="headerlink" href="#seiscomp.datamodel.RealArray" title="Permalink to this definition"></a></dt>
<dd><p>Inherits <a class="reference internal" href="#api-python-datamodel-object"><span class="std std-ref">Object</span></a>.</p>
<p><strong>Attributes</strong>:</p>
<ul class="simple">
<li><p><code class="docutils literal notranslate"><span class="pre">content</span></code> float (optional)</p></li>
</ul>
<p><strong>Used by</strong>:</p>
<ul class="simple">
<li><p><a class="reference internal" href="#seiscomp.datamodel.RealPDF1D.variable" title="seiscomp.datamodel.RealPDF1D.variable"><code class="xref py py-func docutils literal notranslate"><span class="pre">RealPDF1D.variable()</span></code></a></p></li>
<li><p><a class="reference internal" href="#seiscomp.datamodel.RealPDF1D.probability" title="seiscomp.datamodel.RealPDF1D.probability"><code class="xref py py-func docutils literal notranslate"><span class="pre">RealPDF1D.probability()</span></code></a></p></li>
<li><p><a class="reference internal" href="#seiscomp.datamodel.ResponseFAP.tuples" title="seiscomp.datamodel.ResponseFAP.tuples"><code class="xref py py-func docutils literal notranslate"><span class="pre">ResponseFAP.tuples()</span></code></a></p></li>
<li><p><a class="reference internal" href="#seiscomp.datamodel.ResponseFIR.coefficients" title="seiscomp.datamodel.ResponseFIR.coefficients"><code class="xref py py-func docutils literal notranslate"><span class="pre">ResponseFIR.coefficients()</span></code></a></p></li>
<li><p><a class="reference internal" href="#seiscomp.datamodel.ResponseIIR.numerators" title="seiscomp.datamodel.ResponseIIR.numerators"><code class="xref py py-func docutils literal notranslate"><span class="pre">ResponseIIR.numerators()</span></code></a></p></li>
<li><p><a class="reference internal" href="#seiscomp.datamodel.ResponseIIR.denominators" title="seiscomp.datamodel.ResponseIIR.denominators"><code class="xref py py-func docutils literal notranslate"><span class="pre">ResponseIIR.denominators()</span></code></a></p></li>
<li><p><a class="reference internal" href="#seiscomp.datamodel.ResponsePolynomial.coefficients" title="seiscomp.datamodel.ResponsePolynomial.coefficients"><code class="xref py py-func docutils literal notranslate"><span class="pre">ResponsePolynomial.coefficients()</span></code></a></p></li>
<li><p><a class="reference internal" href="#seiscomp.datamodel.TimePDF1D.probability" title="seiscomp.datamodel.TimePDF1D.probability"><code class="xref py py-func docutils literal notranslate"><span class="pre">TimePDF1D.probability()</span></code></a></p></li>
</ul>
<p><strong>Methods</strong>:</p>
<dl class="method">
<dt id="seiscomp.datamodel.RealArray.Cast">
<em class="property">static </em><code class="sig-name descname">Cast</code><span class="sig-paren">(</span><em class="sig-param">obj</em><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.RealArray.Cast" title="Permalink to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>obj</strong> The object to be casted.</p>
</dd>
<dt class="field-even">Return type</dt>
<dd class="field-even"><p>An object of type RealArray if the cast was successful,
None otherwise.</p>
</dd>
</dl>
<p>Cast an arbitrary object to RealArray if the internal wrapped
representation is an RealArray object. The cast is important if
instances of type <a class="reference internal" href="#api-python-datamodel-object"><span class="std std-ref">Object</span></a>
are passed to methods which need access to the real type.</p>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.RealArray.equal">
<code class="sig-name descname">equal</code><span class="sig-paren">(</span><em class="sig-param">other</em><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.RealArray.equal" title="Permalink to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>other</strong> Another object of type RealArray to compare this
instance to</p>
</dd>
<dt class="field-even">Return type</dt>
<dd class="field-even"><p>A Boolean value indicating True if both objects are equal or
False otherwise.</p>
</dd>
</dl>
<p>Compares two objects without its child objects. Both objects are compared
by value.</p>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.RealArray.setContent">
<code class="sig-name descname">setContent</code><span class="sig-paren">(</span><em class="sig-param">content</em><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.RealArray.setContent" title="Permalink to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>content</strong> float</p>
</dd>
</dl>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.RealArray.content">
<code class="sig-name descname">content</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.RealArray.content" title="Permalink to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Return type</dt>
<dd class="field-odd"><p>float</p>
</dd>
</dl>
<div class="admonition note">
<p class="admonition-title">Note</p>
<p>As this attribute is optional, this method throws a ValueError if
the value of the attribute is not set.</p>
</div>
</dd></dl>
</dd></dl>
</div>
<div class="section" id="realpdf1d">
<span id="api-python-datamodel-realpdf1d"></span><h3>RealPDF1D<a class="headerlink" href="#realpdf1d" title="Permalink to this headline"></a></h3>
<dl class="class">
<dt id="seiscomp.datamodel.RealPDF1D">
<em class="property">class </em><code class="sig-prename descclassname">seiscomp.datamodel.</code><code class="sig-name descname">RealPDF1D</code><a class="headerlink" href="#seiscomp.datamodel.RealPDF1D" title="Permalink to this definition"></a></dt>
<dd><p>Inherits <a class="reference internal" href="#api-python-datamodel-object"><span class="std std-ref">Object</span></a>.</p>
<p>A probability density function description. It can be used in three
different modes:</p>
<p>1) “raw samples mode”</p>
<p>variable is a list of M values, no probability. The values represent
samples, no binning/probabilities made.</p>
<p>2) “implicitly binned PDF”</p>
<p>variable and probabilty arrays have length N. variable values to be
interpreted as “bin centers” (or representative values),
no bin edges given.</p>
<p>3) “explicitly binned PDF”</p>
<p>variable has length N+1, probability has length N. variable values
describe bin edges (upper bin edge is lower edge of next bin).</p>
<p><strong>Attributes</strong>:</p>
<ul class="simple">
<li><p><code class="docutils literal notranslate"><span class="pre">variable</span></code> <a class="reference internal" href="#api-python-datamodel-realarray"><span class="std std-ref">RealArray</span></a></p></li>
<li><p><code class="docutils literal notranslate"><span class="pre">probability</span></code> <a class="reference internal" href="#api-python-datamodel-realarray"><span class="std std-ref">RealArray</span></a></p></li>
</ul>
<p><strong>Used by</strong>:</p>
<ul class="simple">
<li><p><a class="reference internal" href="#seiscomp.datamodel.RealQuantity.pdf" title="seiscomp.datamodel.RealQuantity.pdf"><code class="xref py py-func docutils literal notranslate"><span class="pre">RealQuantity.pdf()</span></code></a></p></li>
</ul>
<p><strong>Methods</strong>:</p>
<dl class="method">
<dt id="seiscomp.datamodel.RealPDF1D.Cast">
<em class="property">static </em><code class="sig-name descname">Cast</code><span class="sig-paren">(</span><em class="sig-param">obj</em><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.RealPDF1D.Cast" title="Permalink to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>obj</strong> The object to be casted.</p>
</dd>
<dt class="field-even">Return type</dt>
<dd class="field-even"><p>An object of type RealPDF1D if the cast was successful,
None otherwise.</p>
</dd>
</dl>
<p>Cast an arbitrary object to RealPDF1D if the internal wrapped
representation is an RealPDF1D object. The cast is important if
instances of type <a class="reference internal" href="#api-python-datamodel-object"><span class="std std-ref">Object</span></a>
are passed to methods which need access to the real type.</p>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.RealPDF1D.equal">
<code class="sig-name descname">equal</code><span class="sig-paren">(</span><em class="sig-param">other</em><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.RealPDF1D.equal" title="Permalink to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>other</strong> Another object of type RealPDF1D to compare this
instance to</p>
</dd>
<dt class="field-even">Return type</dt>
<dd class="field-even"><p>A Boolean value indicating True if both objects are equal or
False otherwise.</p>
</dd>
</dl>
<p>Compares two objects without its child objects. Both objects are compared
by value.</p>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.RealPDF1D.setVariable">
<code class="sig-name descname">setVariable</code><span class="sig-paren">(</span><em class="sig-param">variable</em><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.RealPDF1D.setVariable" title="Permalink to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>variable</strong> <a class="reference internal" href="#api-python-datamodel-realarray"><span class="std std-ref">RealArray</span></a></p>
</dd>
</dl>
<p>List of values</p>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.RealPDF1D.variable">
<code class="sig-name descname">variable</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.RealPDF1D.variable" title="Permalink to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Return type</dt>
<dd class="field-odd"><p><a class="reference internal" href="#api-python-datamodel-realarray"><span class="std std-ref">RealArray</span></a></p>
</dd>
</dl>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.RealPDF1D.setProbability">
<code class="sig-name descname">setProbability</code><span class="sig-paren">(</span><em class="sig-param">probability</em><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.RealPDF1D.setProbability" title="Permalink to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>probability</strong> <a class="reference internal" href="#api-python-datamodel-realarray"><span class="std std-ref">RealArray</span></a></p>
</dd>
</dl>
<p>List of probabilities</p>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.RealPDF1D.probability">
<code class="sig-name descname">probability</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.RealPDF1D.probability" title="Permalink to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Return type</dt>
<dd class="field-odd"><p><a class="reference internal" href="#api-python-datamodel-realarray"><span class="std std-ref">RealArray</span></a></p>
</dd>
</dl>
</dd></dl>
</dd></dl>
</div>
<div class="section" id="realquantity">
<span id="api-python-datamodel-realquantity"></span><h3>RealQuantity<a class="headerlink" href="#realquantity" title="Permalink to this headline"></a></h3>
<dl class="class">
<dt id="seiscomp.datamodel.RealQuantity">
<em class="property">class </em><code class="sig-prename descclassname">seiscomp.datamodel.</code><code class="sig-name descname">RealQuantity</code><a class="headerlink" href="#seiscomp.datamodel.RealQuantity" title="Permalink to this definition"></a></dt>
<dd><p>Inherits <a class="reference internal" href="#api-python-datamodel-object"><span class="std std-ref">Object</span></a>.</p>
<p>Physical quantities expressed as floating point numbers are represented by their
measured or computed values and optional values for symmetric or upper
and lower uncertainties. The interpretation of these uncertainties is
not defined in the standard. They can contain statistically well-defined
error measures, but the mechanism can also be used to simply describe a
possible value range. If the confidence level of the uncertainty is known,
it can be listed in the optional attribute confidenceLevel.
Note that uncertainty, upperUncertainty, and lowerUncertainty are given as
absolute values of the deviation
from the main value.</p>
<p><strong>Attributes</strong>:</p>
<ul class="simple">
<li><p><code class="docutils literal notranslate"><span class="pre">value</span></code> float</p></li>
<li><p><code class="docutils literal notranslate"><span class="pre">uncertainty</span></code> float (optional)</p></li>
<li><p><code class="docutils literal notranslate"><span class="pre">lowerUncertainty</span></code> float (optional)</p></li>
<li><p><code class="docutils literal notranslate"><span class="pre">upperUncertainty</span></code> float (optional)</p></li>
<li><p><code class="docutils literal notranslate"><span class="pre">confidenceLevel</span></code> float (optional)</p></li>
<li><p><code class="docutils literal notranslate"><span class="pre">pdf</span></code> <a class="reference internal" href="#api-python-datamodel-realpdf1d"><span class="std std-ref">RealPDF1D</span></a> (optional)</p></li>
</ul>
<p><strong>Used by</strong>:</p>
<ul class="simple">
<li><p><a class="reference internal" href="#seiscomp.datamodel.Amplitude.amplitude" title="seiscomp.datamodel.Amplitude.amplitude"><code class="xref py py-func docutils literal notranslate"><span class="pre">Amplitude.amplitude()</span></code></a></p></li>
<li><p><a class="reference internal" href="#seiscomp.datamodel.Amplitude.period" title="seiscomp.datamodel.Amplitude.period"><code class="xref py py-func docutils literal notranslate"><span class="pre">Amplitude.period()</span></code></a></p></li>
<li><p><a class="reference internal" href="#seiscomp.datamodel.Axis.azimuth" title="seiscomp.datamodel.Axis.azimuth"><code class="xref py py-func docutils literal notranslate"><span class="pre">Axis.azimuth()</span></code></a></p></li>
<li><p><a class="reference internal" href="#seiscomp.datamodel.Axis.plunge" title="seiscomp.datamodel.Axis.plunge"><code class="xref py py-func docutils literal notranslate"><span class="pre">Axis.plunge()</span></code></a></p></li>
<li><p><a class="reference internal" href="#seiscomp.datamodel.Axis.length" title="seiscomp.datamodel.Axis.length"><code class="xref py py-func docutils literal notranslate"><span class="pre">Axis.length()</span></code></a></p></li>
<li><p><a class="reference internal" href="#seiscomp.datamodel.CompositeTime.second" title="seiscomp.datamodel.CompositeTime.second"><code class="xref py py-func docutils literal notranslate"><span class="pre">CompositeTime.second()</span></code></a></p></li>
<li><p><a class="reference internal" href="#seiscomp.datamodel.Magnitude.magnitude" title="seiscomp.datamodel.Magnitude.magnitude"><code class="xref py py-func docutils literal notranslate"><span class="pre">Magnitude.magnitude()</span></code></a></p></li>
<li><p><a class="reference internal" href="#seiscomp.datamodel.MomentTensor.scalarMoment" title="seiscomp.datamodel.MomentTensor.scalarMoment"><code class="xref py py-func docutils literal notranslate"><span class="pre">MomentTensor.scalarMoment()</span></code></a></p></li>
<li><p><a class="reference internal" href="#seiscomp.datamodel.NodalPlane.strike" title="seiscomp.datamodel.NodalPlane.strike"><code class="xref py py-func docutils literal notranslate"><span class="pre">NodalPlane.strike()</span></code></a></p></li>
<li><p><a class="reference internal" href="#seiscomp.datamodel.NodalPlane.dip" title="seiscomp.datamodel.NodalPlane.dip"><code class="xref py py-func docutils literal notranslate"><span class="pre">NodalPlane.dip()</span></code></a></p></li>
<li><p><a class="reference internal" href="#seiscomp.datamodel.NodalPlane.rake" title="seiscomp.datamodel.NodalPlane.rake"><code class="xref py py-func docutils literal notranslate"><span class="pre">NodalPlane.rake()</span></code></a></p></li>
<li><p><a class="reference internal" href="#seiscomp.datamodel.Origin.latitude" title="seiscomp.datamodel.Origin.latitude"><code class="xref py py-func docutils literal notranslate"><span class="pre">Origin.latitude()</span></code></a></p></li>
<li><p><a class="reference internal" href="#seiscomp.datamodel.Origin.longitude" title="seiscomp.datamodel.Origin.longitude"><code class="xref py py-func docutils literal notranslate"><span class="pre">Origin.longitude()</span></code></a></p></li>
<li><p><a class="reference internal" href="#seiscomp.datamodel.Origin.depth" title="seiscomp.datamodel.Origin.depth"><code class="xref py py-func docutils literal notranslate"><span class="pre">Origin.depth()</span></code></a></p></li>
<li><p><a class="reference internal" href="#seiscomp.datamodel.Pick.horizontalSlowness" title="seiscomp.datamodel.Pick.horizontalSlowness"><code class="xref py py-func docutils literal notranslate"><span class="pre">Pick.horizontalSlowness()</span></code></a></p></li>
<li><p><a class="reference internal" href="#seiscomp.datamodel.Pick.backazimuth" title="seiscomp.datamodel.Pick.backazimuth"><code class="xref py py-func docutils literal notranslate"><span class="pre">Pick.backazimuth()</span></code></a></p></li>
<li><p><a class="reference internal" href="#seiscomp.datamodel.StationMagnitude.magnitude" title="seiscomp.datamodel.StationMagnitude.magnitude"><code class="xref py py-func docutils literal notranslate"><span class="pre">StationMagnitude.magnitude()</span></code></a></p></li>
<li><p><a class="reference internal" href="#seiscomp.datamodel.Tensor.Mrr" title="seiscomp.datamodel.Tensor.Mrr"><code class="xref py py-func docutils literal notranslate"><span class="pre">Tensor.Mrr()</span></code></a></p></li>
<li><p><a class="reference internal" href="#seiscomp.datamodel.Tensor.Mtt" title="seiscomp.datamodel.Tensor.Mtt"><code class="xref py py-func docutils literal notranslate"><span class="pre">Tensor.Mtt()</span></code></a></p></li>
<li><p><a class="reference internal" href="#seiscomp.datamodel.Tensor.Mpp" title="seiscomp.datamodel.Tensor.Mpp"><code class="xref py py-func docutils literal notranslate"><span class="pre">Tensor.Mpp()</span></code></a></p></li>
<li><p><a class="reference internal" href="#seiscomp.datamodel.Tensor.Mrt" title="seiscomp.datamodel.Tensor.Mrt"><code class="xref py py-func docutils literal notranslate"><span class="pre">Tensor.Mrt()</span></code></a></p></li>
<li><p><a class="reference internal" href="#seiscomp.datamodel.Tensor.Mrp" title="seiscomp.datamodel.Tensor.Mrp"><code class="xref py py-func docutils literal notranslate"><span class="pre">Tensor.Mrp()</span></code></a></p></li>
<li><p><a class="reference internal" href="#seiscomp.datamodel.Tensor.Mtp" title="seiscomp.datamodel.Tensor.Mtp"><code class="xref py py-func docutils literal notranslate"><span class="pre">Tensor.Mtp()</span></code></a></p></li>
</ul>
<p><strong>Methods</strong>:</p>
<dl class="method">
<dt id="seiscomp.datamodel.RealQuantity.Cast">
<em class="property">static </em><code class="sig-name descname">Cast</code><span class="sig-paren">(</span><em class="sig-param">obj</em><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.RealQuantity.Cast" title="Permalink to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>obj</strong> The object to be casted.</p>
</dd>
<dt class="field-even">Return type</dt>
<dd class="field-even"><p>An object of type RealQuantity if the cast was successful,
None otherwise.</p>
</dd>
</dl>
<p>Cast an arbitrary object to RealQuantity if the internal wrapped
representation is an RealQuantity object. The cast is important if
instances of type <a class="reference internal" href="#api-python-datamodel-object"><span class="std std-ref">Object</span></a>
are passed to methods which need access to the real type.</p>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.RealQuantity.equal">
<code class="sig-name descname">equal</code><span class="sig-paren">(</span><em class="sig-param">other</em><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.RealQuantity.equal" title="Permalink to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>other</strong> Another object of type RealQuantity to compare this
instance to</p>
</dd>
<dt class="field-even">Return type</dt>
<dd class="field-even"><p>A Boolean value indicating True if both objects are equal or
False otherwise.</p>
</dd>
</dl>
<p>Compares two objects without its child objects. Both objects are compared
by value.</p>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.RealQuantity.setValue">
<code class="sig-name descname">setValue</code><span class="sig-paren">(</span><em class="sig-param">value</em><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.RealQuantity.setValue" title="Permalink to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>value</strong> float</p>
</dd>
</dl>
<p>Value of the quantity. The unit is implicitly defined and depends on the
context.</p>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.RealQuantity.value">
<code class="sig-name descname">value</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.RealQuantity.value" title="Permalink to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Return type</dt>
<dd class="field-odd"><p>float</p>
</dd>
</dl>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.RealQuantity.setUncertainty">
<code class="sig-name descname">setUncertainty</code><span class="sig-paren">(</span><em class="sig-param">uncertainty</em><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.RealQuantity.setUncertainty" title="Permalink to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>uncertainty</strong> float</p>
</dd>
</dl>
<p>Uncertainty as the absolute value of symmetric deviation from the main value.</p>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.RealQuantity.uncertainty">
<code class="sig-name descname">uncertainty</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.RealQuantity.uncertainty" title="Permalink to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Return type</dt>
<dd class="field-odd"><p>float</p>
</dd>
</dl>
<div class="admonition note">
<p class="admonition-title">Note</p>
<p>As this attribute is optional, this method throws a ValueError if
the value of the attribute is not set.</p>
</div>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.RealQuantity.setLowerUncertainty">
<code class="sig-name descname">setLowerUncertainty</code><span class="sig-paren">(</span><em class="sig-param">lowerUncertainty</em><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.RealQuantity.setLowerUncertainty" title="Permalink to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>lowerUncertainty</strong> float</p>
</dd>
</dl>
<p>Uncertainty as the absolute value of deviation from the main value towards
smaller values.</p>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.RealQuantity.lowerUncertainty">
<code class="sig-name descname">lowerUncertainty</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.RealQuantity.lowerUncertainty" title="Permalink to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Return type</dt>
<dd class="field-odd"><p>float</p>
</dd>
</dl>
<div class="admonition note">
<p class="admonition-title">Note</p>
<p>As this attribute is optional, this method throws a ValueError if
the value of the attribute is not set.</p>
</div>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.RealQuantity.setUpperUncertainty">
<code class="sig-name descname">setUpperUncertainty</code><span class="sig-paren">(</span><em class="sig-param">upperUncertainty</em><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.RealQuantity.setUpperUncertainty" title="Permalink to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>upperUncertainty</strong> float</p>
</dd>
</dl>
<p>Uncertainty as the absolute value of deviation from the main value towards
larger values.</p>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.RealQuantity.upperUncertainty">
<code class="sig-name descname">upperUncertainty</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.RealQuantity.upperUncertainty" title="Permalink to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Return type</dt>
<dd class="field-odd"><p>float</p>
</dd>
</dl>
<div class="admonition note">
<p class="admonition-title">Note</p>
<p>As this attribute is optional, this method throws a ValueError if
the value of the attribute is not set.</p>
</div>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.RealQuantity.setConfidenceLevel">
<code class="sig-name descname">setConfidenceLevel</code><span class="sig-paren">(</span><em class="sig-param">confidenceLevel</em><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.RealQuantity.setConfidenceLevel" title="Permalink to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>confidenceLevel</strong> float</p>
</dd>
</dl>
<p>Confidence level of the uncertainty, given in percent.</p>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.RealQuantity.confidenceLevel">
<code class="sig-name descname">confidenceLevel</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.RealQuantity.confidenceLevel" title="Permalink to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Return type</dt>
<dd class="field-odd"><p>float</p>
</dd>
</dl>
<div class="admonition note">
<p class="admonition-title">Note</p>
<p>As this attribute is optional, this method throws a ValueError if
the value of the attribute is not set.</p>
</div>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.RealQuantity.setPdf">
<code class="sig-name descname">setPdf</code><span class="sig-paren">(</span><em class="sig-param">pdf</em><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.RealQuantity.setPdf" title="Permalink to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>pdf</strong> <a class="reference internal" href="#api-python-datamodel-realpdf1d"><span class="std std-ref">RealPDF1D</span></a></p>
</dd>
</dl>
<p>Probability density function of the quantity.</p>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.RealQuantity.pdf">
<code class="sig-name descname">pdf</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.RealQuantity.pdf" title="Permalink to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Return type</dt>
<dd class="field-odd"><p><a class="reference internal" href="#api-python-datamodel-realpdf1d"><span class="std std-ref">RealPDF1D</span></a></p>
</dd>
</dl>
<div class="admonition note">
<p class="admonition-title">Note</p>
<p>As this attribute is optional, this method throws a ValueError if
the value of the attribute is not set.</p>
</div>
</dd></dl>
</dd></dl>
</div>
<div class="section" id="responsefap">
<span id="api-python-datamodel-responsefap"></span><h3>ResponseFAP<a class="headerlink" href="#responsefap" title="Permalink to this headline"></a></h3>
<dl class="class">
<dt id="seiscomp.datamodel.ResponseFAP">
<em class="property">class </em><code class="sig-prename descclassname">seiscomp.datamodel.</code><code class="sig-name descname">ResponseFAP</code><a class="headerlink" href="#seiscomp.datamodel.ResponseFAP" title="Permalink to this definition"></a></dt>
<dd><p>Inherits <a class="reference internal" href="#api-python-datamodel-publicobject"><span class="std std-ref">PublicObject</span></a>.</p>
<p>This type describes a sensor response composed of frequency/amplitude/phase
angle tuples. According to the SEED manual (blockette 55) this description
alone is not an acceptable response description.</p>
<p><strong>Parents</strong>:</p>
<ul class="simple">
<li><p><code class="docutils literal notranslate"><span class="pre">inventory</span></code> <a class="reference internal" href="#api-python-datamodel-inventory"><span class="std std-ref">Inventory</span></a></p></li>
</ul>
<p><strong>Attributes</strong>:</p>
<ul class="simple">
<li><p><code class="docutils literal notranslate"><span class="pre">publicID</span></code>: string</p></li>
<li><p><code class="docutils literal notranslate"><span class="pre">name</span></code> string</p></li>
<li><p><code class="docutils literal notranslate"><span class="pre">gain</span></code> float (optional)</p></li>
<li><p><code class="docutils literal notranslate"><span class="pre">gainFrequency</span></code> float (optional)</p></li>
<li><p><code class="docutils literal notranslate"><span class="pre">numberOfTuples</span></code> int (optional)</p></li>
<li><p><code class="docutils literal notranslate"><span class="pre">tuples</span></code> <a class="reference internal" href="#api-python-datamodel-realarray"><span class="std std-ref">RealArray</span></a> (optional)</p></li>
<li><p><code class="docutils literal notranslate"><span class="pre">remark</span></code> <a class="reference internal" href="#api-python-datamodel-blob"><span class="std std-ref">Blob</span></a> (optional)</p></li>
</ul>
<p><strong>Methods</strong>:</p>
<dl class="method">
<dt id="seiscomp.datamodel.ResponseFAP.Cast">
<em class="property">static </em><code class="sig-name descname">Cast</code><span class="sig-paren">(</span><em class="sig-param">obj</em><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.ResponseFAP.Cast" title="Permalink to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>obj</strong> The object to be casted.</p>
</dd>
<dt class="field-even">Return type</dt>
<dd class="field-even"><p>An object of type ResponseFAP if the cast was successful,
None otherwise.</p>
</dd>
</dl>
<p>Cast an arbitrary object to ResponseFAP if the internal wrapped
representation is an ResponseFAP object. The cast is important if
instances of type <a class="reference internal" href="#api-python-datamodel-object"><span class="std std-ref">Object</span></a>
are passed to methods which need access to the real type.</p>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.ResponseFAP.Create">
<em class="property">static </em><code class="sig-name descname">Create</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.ResponseFAP.Create" title="Permalink to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Return type</dt>
<dd class="field-odd"><p>A new object of type ResponseFAP.</p>
</dd>
</dl>
<p>Creates and registers (if enabled) a ResponseFAP instance. The
publicID is auto-generated.</p>
</dd></dl>
<dl class="method">
<dt>
<em class="property">static </em><code class="sig-name descname">Create</code><span class="sig-paren">(</span><em class="sig-param">publicID</em><span class="sig-paren">)</span></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Return type</dt>
<dd class="field-odd"><p>A new object of type ResponseFAP.</p>
</dd>
</dl>
<p>Creates and registers (if enabled) a ResponseFAP instance with
passed publicID.</p>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.ResponseFAP.equal">
<code class="sig-name descname">equal</code><span class="sig-paren">(</span><em class="sig-param">other</em><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.ResponseFAP.equal" title="Permalink to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>other</strong> Another object of type ResponseFAP to compare this
instance to</p>
</dd>
<dt class="field-even">Return type</dt>
<dd class="field-even"><p>A Boolean value indicating True if both objects are equal or
False otherwise.</p>
</dd>
</dl>
<p>Compares two objects without its child objects. Both objects are compared
by value.</p>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.ResponseFAP.index">
<code class="sig-name descname">index</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.ResponseFAP.index" title="Permalink to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Return type</dt>
<dd class="field-odd"><p><p>The objects index of type ResponseFAPIndex.</p>
<p>Returns the objects index which is also used for the database as unique
constraint.</p>
</p>
</dd>
</dl>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.ResponseFAP.equalIndex">
<code class="sig-name descname">equalIndex</code><span class="sig-paren">(</span><em class="sig-param">lhs</em><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.ResponseFAP.equalIndex" title="Permalink to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>lhs</strong> <a class="reference internal" href="#api-python-datamodel-responsefap"><span class="std std-ref">ResponseFAP</span></a></p>
</dd>
<dt class="field-even">Return type</dt>
<dd class="field-even"><p>A Boolean value indicating True if both indexes are equal or
False otherwise.</p>
</dd>
</dl>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.ResponseFAP.setName">
<code class="sig-name descname">setName</code><span class="sig-paren">(</span><em class="sig-param">name</em><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.ResponseFAP.setName" title="Permalink to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>name</strong> string</p>
</dd>
</dl>
<p>Unique response name</p>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.ResponseFAP.name">
<code class="sig-name descname">name</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.ResponseFAP.name" title="Permalink to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Return type</dt>
<dd class="field-odd"><p>string</p>
</dd>
</dl>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.ResponseFAP.setGain">
<code class="sig-name descname">setGain</code><span class="sig-paren">(</span><em class="sig-param">gain</em><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.ResponseFAP.setGain" title="Permalink to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>gain</strong> float</p>
</dd>
</dl>
<p>Gain of response (48.05/58.04)</p>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.ResponseFAP.gain">
<code class="sig-name descname">gain</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.ResponseFAP.gain" title="Permalink to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Return type</dt>
<dd class="field-odd"><p>float</p>
</dd>
</dl>
<div class="admonition note">
<p class="admonition-title">Note</p>
<p>As this attribute is optional, this method throws a ValueError if
the value of the attribute is not set.</p>
</div>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.ResponseFAP.setGainFrequency">
<code class="sig-name descname">setGainFrequency</code><span class="sig-paren">(</span><em class="sig-param">gainFrequency</em><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.ResponseFAP.setGainFrequency" title="Permalink to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>gainFrequency</strong> float</p>
</dd>
</dl>
<p>Gain frequency (48.06/58.05)</p>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.ResponseFAP.gainFrequency">
<code class="sig-name descname">gainFrequency</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.ResponseFAP.gainFrequency" title="Permalink to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Return type</dt>
<dd class="field-odd"><p>float</p>
</dd>
</dl>
<div class="admonition note">
<p class="admonition-title">Note</p>
<p>As this attribute is optional, this method throws a ValueError if
the value of the attribute is not set.</p>
</div>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.ResponseFAP.setNumberOfTuples">
<code class="sig-name descname">setNumberOfTuples</code><span class="sig-paren">(</span><em class="sig-param">numberOfTuples</em><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.ResponseFAP.setNumberOfTuples" title="Permalink to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>numberOfTuples</strong> int</p>
</dd>
</dl>
<p>The number of fap tuples in the response</p>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.ResponseFAP.numberOfTuples">
<code class="sig-name descname">numberOfTuples</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.ResponseFAP.numberOfTuples" title="Permalink to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Return type</dt>
<dd class="field-odd"><p>int</p>
</dd>
</dl>
<div class="admonition note">
<p class="admonition-title">Note</p>
<p>As this attribute is optional, this method throws a ValueError if
the value of the attribute is not set.</p>
</div>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.ResponseFAP.setTuples">
<code class="sig-name descname">setTuples</code><span class="sig-paren">(</span><em class="sig-param">tuples</em><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.ResponseFAP.setTuples" title="Permalink to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>tuples</strong> <a class="reference internal" href="#api-python-datamodel-realarray"><span class="std std-ref">RealArray</span></a></p>
</dd>
</dl>
<p>The tuples organized as linear array. The array size must be numberOfTuples
* 3. Each tuple consists of frequency (in Hz), amplitude and phase angle
(in degree).</p>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.ResponseFAP.tuples">
<code class="sig-name descname">tuples</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.ResponseFAP.tuples" title="Permalink to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Return type</dt>
<dd class="field-odd"><p><a class="reference internal" href="#api-python-datamodel-realarray"><span class="std std-ref">RealArray</span></a></p>
</dd>
</dl>
<div class="admonition note">
<p class="admonition-title">Note</p>
<p>As this attribute is optional, this method throws a ValueError if
the value of the attribute is not set.</p>
</div>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.ResponseFAP.setRemark">
<code class="sig-name descname">setRemark</code><span class="sig-paren">(</span><em class="sig-param">remark</em><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.ResponseFAP.setRemark" title="Permalink to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>remark</strong> <a class="reference internal" href="#api-python-datamodel-blob"><span class="std std-ref">Blob</span></a></p>
</dd>
</dl>
<p>Optional remark</p>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.ResponseFAP.remark">
<code class="sig-name descname">remark</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.ResponseFAP.remark" title="Permalink to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Return type</dt>
<dd class="field-odd"><p><a class="reference internal" href="#api-python-datamodel-blob"><span class="std std-ref">Blob</span></a></p>
</dd>
</dl>
<div class="admonition note">
<p class="admonition-title">Note</p>
<p>As this attribute is optional, this method throws a ValueError if
the value of the attribute is not set.</p>
</div>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.ResponseFAP.inventory">
<code class="sig-name descname">inventory</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.ResponseFAP.inventory" title="Permalink to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Return type</dt>
<dd class="field-odd"><p><a class="reference internal" href="#seiscomp.datamodel.Inventory" title="seiscomp.datamodel.Inventory">Inventory</a></p>
</dd>
</dl>
<p>Returns the parent Inventory if available. Returns None
if the parent is not a Inventory. This is a convenience wrapper
for parent().</p>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.ResponseFAP.assign">
<code class="sig-name descname">assign</code><span class="sig-paren">(</span><em class="sig-param">other</em><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.ResponseFAP.assign" title="Permalink to this definition"></a></dt>
<dd><p>This method implements the <a class="reference internal" href="#api-python-datamodel-object"><span class="std std-ref">Object</span></a> interface.</p>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.ResponseFAP.attachTo">
<code class="sig-name descname">attachTo</code><span class="sig-paren">(</span><em class="sig-param">parent</em><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.ResponseFAP.attachTo" title="Permalink to this definition"></a></dt>
<dd><p>This method implements the <a class="reference internal" href="#api-python-datamodel-object"><span class="std std-ref">Object</span></a> interface.</p>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.ResponseFAP.detachFrom">
<code class="sig-name descname">detachFrom</code><span class="sig-paren">(</span><em class="sig-param">parent</em><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.ResponseFAP.detachFrom" title="Permalink to this definition"></a></dt>
<dd><p>This method implements the <a class="reference internal" href="#api-python-datamodel-object"><span class="std std-ref">Object</span></a> interface.</p>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.ResponseFAP.detach">
<code class="sig-name descname">detach</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.ResponseFAP.detach" title="Permalink to this definition"></a></dt>
<dd><p>This method implements the <a class="reference internal" href="#api-python-datamodel-object"><span class="std std-ref">Object</span></a> interface.</p>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.ResponseFAP.clone">
<code class="sig-name descname">clone</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.ResponseFAP.clone" title="Permalink to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Return type</dt>
<dd class="field-odd"><p>A cloned ResponseFAP.</p>
</dd>
</dl>
<p>Returns a new instance that is a clone of the current instance. Child
objects are being ignored.</p>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.ResponseFAP.updateChild">
<code class="sig-name descname">updateChild</code><span class="sig-paren">(</span><em class="sig-param">ref</em><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.ResponseFAP.updateChild" title="Permalink to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>ref</strong> A child object derived from class Object.</p>
</dd>
<dt class="field-even">Return type</dt>
<dd class="field-even"><p>A Boolean flag indicating success with True, False otherwise</p>
</dd>
</dl>
<p>This method takes the passed reference object and searches for a child
with the same publicID (if derived from <a class="reference internal" href="#api-python-datamodel-publicobject"><span class="std std-ref">PublicObject</span></a>)
or the same index (if derived from <a class="reference internal" href="#api-python-datamodel-object"><span class="std std-ref">Object</span></a>).
The the child was found the reference objects attributes are copied to
the child object. Children of child are being ignored during this operation.
This method implements the <a class="reference internal" href="#api-python-datamodel-publicobject"><span class="std std-ref">PublicObject</span></a> interface.</p>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.ResponseFAP.accept">
<code class="sig-name descname">accept</code><span class="sig-paren">(</span><em class="sig-param">visitor</em><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.ResponseFAP.accept" title="Permalink to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>visitor</strong> A visitor.</p>
</dd>
</dl>
<p>This method implements the <a class="reference internal" href="#api-python-datamodel-publicobject"><span class="std std-ref">PublicObject</span></a> interface.</p>
</dd></dl>
</dd></dl>
</div>
<div class="section" id="responsefir">
<span id="api-python-datamodel-responsefir"></span><h3>ResponseFIR<a class="headerlink" href="#responsefir" title="Permalink to this headline"></a></h3>
<dl class="class">
<dt id="seiscomp.datamodel.ResponseFIR">
<em class="property">class </em><code class="sig-prename descclassname">seiscomp.datamodel.</code><code class="sig-name descname">ResponseFIR</code><a class="headerlink" href="#seiscomp.datamodel.ResponseFIR" title="Permalink to this definition"></a></dt>
<dd><p>Inherits <a class="reference internal" href="#api-python-datamodel-publicobject"><span class="std std-ref">PublicObject</span></a>.</p>
<p>This type describes a finite impulse response filter</p>
<p><strong>Parents</strong>:</p>
<ul class="simple">
<li><p><code class="docutils literal notranslate"><span class="pre">inventory</span></code> <a class="reference internal" href="#api-python-datamodel-inventory"><span class="std std-ref">Inventory</span></a></p></li>
</ul>
<p><strong>Attributes</strong>:</p>
<ul class="simple">
<li><p><code class="docutils literal notranslate"><span class="pre">publicID</span></code>: string</p></li>
<li><p><code class="docutils literal notranslate"><span class="pre">name</span></code> string</p></li>
<li><p><code class="docutils literal notranslate"><span class="pre">gain</span></code> float (optional)</p></li>
<li><p><code class="docutils literal notranslate"><span class="pre">gainFrequency</span></code> float (optional)</p></li>
<li><p><code class="docutils literal notranslate"><span class="pre">decimationFactor</span></code> int (optional)</p></li>
<li><p><code class="docutils literal notranslate"><span class="pre">delay</span></code> float (optional)</p></li>
<li><p><code class="docutils literal notranslate"><span class="pre">correction</span></code> float (optional)</p></li>
<li><p><code class="docutils literal notranslate"><span class="pre">numberOfCoefficients</span></code> int (optional)</p></li>
<li><p><code class="docutils literal notranslate"><span class="pre">symmetry</span></code> string</p></li>
<li><p><code class="docutils literal notranslate"><span class="pre">coefficients</span></code> <a class="reference internal" href="#api-python-datamodel-realarray"><span class="std std-ref">RealArray</span></a> (optional)</p></li>
<li><p><code class="docutils literal notranslate"><span class="pre">remark</span></code> <a class="reference internal" href="#api-python-datamodel-blob"><span class="std std-ref">Blob</span></a> (optional)</p></li>
</ul>
<p><strong>Methods</strong>:</p>
<dl class="method">
<dt id="seiscomp.datamodel.ResponseFIR.Cast">
<em class="property">static </em><code class="sig-name descname">Cast</code><span class="sig-paren">(</span><em class="sig-param">obj</em><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.ResponseFIR.Cast" title="Permalink to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>obj</strong> The object to be casted.</p>
</dd>
<dt class="field-even">Return type</dt>
<dd class="field-even"><p>An object of type ResponseFIR if the cast was successful,
None otherwise.</p>
</dd>
</dl>
<p>Cast an arbitrary object to ResponseFIR if the internal wrapped
representation is an ResponseFIR object. The cast is important if
instances of type <a class="reference internal" href="#api-python-datamodel-object"><span class="std std-ref">Object</span></a>
are passed to methods which need access to the real type.</p>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.ResponseFIR.Create">
<em class="property">static </em><code class="sig-name descname">Create</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.ResponseFIR.Create" title="Permalink to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Return type</dt>
<dd class="field-odd"><p>A new object of type ResponseFIR.</p>
</dd>
</dl>
<p>Creates and registers (if enabled) a ResponseFIR instance. The
publicID is auto-generated.</p>
</dd></dl>
<dl class="method">
<dt>
<em class="property">static </em><code class="sig-name descname">Create</code><span class="sig-paren">(</span><em class="sig-param">publicID</em><span class="sig-paren">)</span></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Return type</dt>
<dd class="field-odd"><p>A new object of type ResponseFIR.</p>
</dd>
</dl>
<p>Creates and registers (if enabled) a ResponseFIR instance with
passed publicID.</p>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.ResponseFIR.equal">
<code class="sig-name descname">equal</code><span class="sig-paren">(</span><em class="sig-param">other</em><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.ResponseFIR.equal" title="Permalink to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>other</strong> Another object of type ResponseFIR to compare this
instance to</p>
</dd>
<dt class="field-even">Return type</dt>
<dd class="field-even"><p>A Boolean value indicating True if both objects are equal or
False otherwise.</p>
</dd>
</dl>
<p>Compares two objects without its child objects. Both objects are compared
by value.</p>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.ResponseFIR.index">
<code class="sig-name descname">index</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.ResponseFIR.index" title="Permalink to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Return type</dt>
<dd class="field-odd"><p><p>The objects index of type ResponseFIRIndex.</p>
<p>Returns the objects index which is also used for the database as unique
constraint.</p>
</p>
</dd>
</dl>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.ResponseFIR.equalIndex">
<code class="sig-name descname">equalIndex</code><span class="sig-paren">(</span><em class="sig-param">lhs</em><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.ResponseFIR.equalIndex" title="Permalink to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>lhs</strong> <a class="reference internal" href="#api-python-datamodel-responsefir"><span class="std std-ref">ResponseFIR</span></a></p>
</dd>
<dt class="field-even">Return type</dt>
<dd class="field-even"><p>A Boolean value indicating True if both indexes are equal or
False otherwise.</p>
</dd>
</dl>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.ResponseFIR.setName">
<code class="sig-name descname">setName</code><span class="sig-paren">(</span><em class="sig-param">name</em><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.ResponseFIR.setName" title="Permalink to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>name</strong> string</p>
</dd>
</dl>
<p>Unique response name</p>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.ResponseFIR.name">
<code class="sig-name descname">name</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.ResponseFIR.name" title="Permalink to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Return type</dt>
<dd class="field-odd"><p>string</p>
</dd>
</dl>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.ResponseFIR.setGain">
<code class="sig-name descname">setGain</code><span class="sig-paren">(</span><em class="sig-param">gain</em><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.ResponseFIR.setGain" title="Permalink to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>gain</strong> float</p>
</dd>
</dl>
<p>Gain of response (48.05/58.04)</p>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.ResponseFIR.gain">
<code class="sig-name descname">gain</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.ResponseFIR.gain" title="Permalink to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Return type</dt>
<dd class="field-odd"><p>float</p>
</dd>
</dl>
<div class="admonition note">
<p class="admonition-title">Note</p>
<p>As this attribute is optional, this method throws a ValueError if
the value of the attribute is not set.</p>
</div>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.ResponseFIR.setGainFrequency">
<code class="sig-name descname">setGainFrequency</code><span class="sig-paren">(</span><em class="sig-param">gainFrequency</em><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.ResponseFIR.setGainFrequency" title="Permalink to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>gainFrequency</strong> float</p>
</dd>
</dl>
<p>Gain frequency (48.06/58.05)</p>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.ResponseFIR.gainFrequency">
<code class="sig-name descname">gainFrequency</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.ResponseFIR.gainFrequency" title="Permalink to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Return type</dt>
<dd class="field-odd"><p>float</p>
</dd>
</dl>
<div class="admonition note">
<p class="admonition-title">Note</p>
<p>As this attribute is optional, this method throws a ValueError if
the value of the attribute is not set.</p>
</div>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.ResponseFIR.setDecimationFactor">
<code class="sig-name descname">setDecimationFactor</code><span class="sig-paren">(</span><em class="sig-param">decimationFactor</em><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.ResponseFIR.setDecimationFactor" title="Permalink to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>decimationFactor</strong> int</p>
</dd>
</dl>
<p>Decimation factor (47.06/57.05)</p>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.ResponseFIR.decimationFactor">
<code class="sig-name descname">decimationFactor</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.ResponseFIR.decimationFactor" title="Permalink to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Return type</dt>
<dd class="field-odd"><p>int</p>
</dd>
</dl>
<div class="admonition note">
<p class="admonition-title">Note</p>
<p>As this attribute is optional, this method throws a ValueError if
the value of the attribute is not set.</p>
</div>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.ResponseFIR.setDelay">
<code class="sig-name descname">setDelay</code><span class="sig-paren">(</span><em class="sig-param">delay</em><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.ResponseFIR.setDelay" title="Permalink to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>delay</strong> float</p>
</dd>
</dl>
<p>Estimated delay (47.08/57.07)</p>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.ResponseFIR.delay">
<code class="sig-name descname">delay</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.ResponseFIR.delay" title="Permalink to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Return type</dt>
<dd class="field-odd"><p>float</p>
</dd>
</dl>
<div class="admonition note">
<p class="admonition-title">Note</p>
<p>As this attribute is optional, this method throws a ValueError if
the value of the attribute is not set.</p>
</div>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.ResponseFIR.setCorrection">
<code class="sig-name descname">setCorrection</code><span class="sig-paren">(</span><em class="sig-param">correction</em><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.ResponseFIR.setCorrection" title="Permalink to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>correction</strong> float</p>
</dd>
</dl>
<p>Applied correction (47.09/57.08)</p>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.ResponseFIR.correction">
<code class="sig-name descname">correction</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.ResponseFIR.correction" title="Permalink to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Return type</dt>
<dd class="field-odd"><p>float</p>
</dd>
</dl>
<div class="admonition note">
<p class="admonition-title">Note</p>
<p>As this attribute is optional, this method throws a ValueError if
the value of the attribute is not set.</p>
</div>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.ResponseFIR.setNumberOfCoefficients">
<code class="sig-name descname">setNumberOfCoefficients</code><span class="sig-paren">(</span><em class="sig-param">numberOfCoefficients</em><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.ResponseFIR.setNumberOfCoefficients" title="Permalink to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>numberOfCoefficients</strong> int</p>
</dd>
</dl>
<p>Number of coefficients (41.08/61.08)</p>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.ResponseFIR.numberOfCoefficients">
<code class="sig-name descname">numberOfCoefficients</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.ResponseFIR.numberOfCoefficients" title="Permalink to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Return type</dt>
<dd class="field-odd"><p>int</p>
</dd>
</dl>
<div class="admonition note">
<p class="admonition-title">Note</p>
<p>As this attribute is optional, this method throws a ValueError if
the value of the attribute is not set.</p>
</div>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.ResponseFIR.setSymmetry">
<code class="sig-name descname">setSymmetry</code><span class="sig-paren">(</span><em class="sig-param">symmetry</em><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.ResponseFIR.setSymmetry" title="Permalink to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>symmetry</strong> string</p>
</dd>
</dl>
<p>Symmetry code (41.05/61.05)</p>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.ResponseFIR.symmetry">
<code class="sig-name descname">symmetry</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.ResponseFIR.symmetry" title="Permalink to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Return type</dt>
<dd class="field-odd"><p>string</p>
</dd>
</dl>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.ResponseFIR.setCoefficients">
<code class="sig-name descname">setCoefficients</code><span class="sig-paren">(</span><em class="sig-param">coefficients</em><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.ResponseFIR.setCoefficients" title="Permalink to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>coefficients</strong> <a class="reference internal" href="#api-python-datamodel-realarray"><span class="std std-ref">RealArray</span></a></p>
</dd>
</dl>
<p>Coefficients normalized to gain=1.0 (41.09/61.09)</p>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.ResponseFIR.coefficients">
<code class="sig-name descname">coefficients</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.ResponseFIR.coefficients" title="Permalink to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Return type</dt>
<dd class="field-odd"><p><a class="reference internal" href="#api-python-datamodel-realarray"><span class="std std-ref">RealArray</span></a></p>
</dd>
</dl>
<div class="admonition note">
<p class="admonition-title">Note</p>
<p>As this attribute is optional, this method throws a ValueError if
the value of the attribute is not set.</p>
</div>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.ResponseFIR.setRemark">
<code class="sig-name descname">setRemark</code><span class="sig-paren">(</span><em class="sig-param">remark</em><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.ResponseFIR.setRemark" title="Permalink to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>remark</strong> <a class="reference internal" href="#api-python-datamodel-blob"><span class="std std-ref">Blob</span></a></p>
</dd>
</dl>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.ResponseFIR.remark">
<code class="sig-name descname">remark</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.ResponseFIR.remark" title="Permalink to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Return type</dt>
<dd class="field-odd"><p><a class="reference internal" href="#api-python-datamodel-blob"><span class="std std-ref">Blob</span></a></p>
</dd>
</dl>
<div class="admonition note">
<p class="admonition-title">Note</p>
<p>As this attribute is optional, this method throws a ValueError if
the value of the attribute is not set.</p>
</div>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.ResponseFIR.inventory">
<code class="sig-name descname">inventory</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.ResponseFIR.inventory" title="Permalink to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Return type</dt>
<dd class="field-odd"><p><a class="reference internal" href="#seiscomp.datamodel.Inventory" title="seiscomp.datamodel.Inventory">Inventory</a></p>
</dd>
</dl>
<p>Returns the parent Inventory if available. Returns None
if the parent is not a Inventory. This is a convenience wrapper
for parent().</p>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.ResponseFIR.assign">
<code class="sig-name descname">assign</code><span class="sig-paren">(</span><em class="sig-param">other</em><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.ResponseFIR.assign" title="Permalink to this definition"></a></dt>
<dd><p>This method implements the <a class="reference internal" href="#api-python-datamodel-object"><span class="std std-ref">Object</span></a> interface.</p>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.ResponseFIR.attachTo">
<code class="sig-name descname">attachTo</code><span class="sig-paren">(</span><em class="sig-param">parent</em><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.ResponseFIR.attachTo" title="Permalink to this definition"></a></dt>
<dd><p>This method implements the <a class="reference internal" href="#api-python-datamodel-object"><span class="std std-ref">Object</span></a> interface.</p>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.ResponseFIR.detachFrom">
<code class="sig-name descname">detachFrom</code><span class="sig-paren">(</span><em class="sig-param">parent</em><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.ResponseFIR.detachFrom" title="Permalink to this definition"></a></dt>
<dd><p>This method implements the <a class="reference internal" href="#api-python-datamodel-object"><span class="std std-ref">Object</span></a> interface.</p>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.ResponseFIR.detach">
<code class="sig-name descname">detach</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.ResponseFIR.detach" title="Permalink to this definition"></a></dt>
<dd><p>This method implements the <a class="reference internal" href="#api-python-datamodel-object"><span class="std std-ref">Object</span></a> interface.</p>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.ResponseFIR.clone">
<code class="sig-name descname">clone</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.ResponseFIR.clone" title="Permalink to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Return type</dt>
<dd class="field-odd"><p>A cloned ResponseFIR.</p>
</dd>
</dl>
<p>Returns a new instance that is a clone of the current instance. Child
objects are being ignored.</p>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.ResponseFIR.updateChild">
<code class="sig-name descname">updateChild</code><span class="sig-paren">(</span><em class="sig-param">ref</em><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.ResponseFIR.updateChild" title="Permalink to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>ref</strong> A child object derived from class Object.</p>
</dd>
<dt class="field-even">Return type</dt>
<dd class="field-even"><p>A Boolean flag indicating success with True, False otherwise</p>
</dd>
</dl>
<p>This method takes the passed reference object and searches for a child
with the same publicID (if derived from <a class="reference internal" href="#api-python-datamodel-publicobject"><span class="std std-ref">PublicObject</span></a>)
or the same index (if derived from <a class="reference internal" href="#api-python-datamodel-object"><span class="std std-ref">Object</span></a>).
The the child was found the reference objects attributes are copied to
the child object. Children of child are being ignored during this operation.
This method implements the <a class="reference internal" href="#api-python-datamodel-publicobject"><span class="std std-ref">PublicObject</span></a> interface.</p>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.ResponseFIR.accept">
<code class="sig-name descname">accept</code><span class="sig-paren">(</span><em class="sig-param">visitor</em><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.ResponseFIR.accept" title="Permalink to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>visitor</strong> A visitor.</p>
</dd>
</dl>
<p>This method implements the <a class="reference internal" href="#api-python-datamodel-publicobject"><span class="std std-ref">PublicObject</span></a> interface.</p>
</dd></dl>
</dd></dl>
</div>
<div class="section" id="responseiir">
<span id="api-python-datamodel-responseiir"></span><h3>ResponseIIR<a class="headerlink" href="#responseiir" title="Permalink to this headline"></a></h3>
<dl class="class">
<dt id="seiscomp.datamodel.ResponseIIR">
<em class="property">class </em><code class="sig-prename descclassname">seiscomp.datamodel.</code><code class="sig-name descname">ResponseIIR</code><a class="headerlink" href="#seiscomp.datamodel.ResponseIIR" title="Permalink to this definition"></a></dt>
<dd><p>Inherits <a class="reference internal" href="#api-python-datamodel-publicobject"><span class="std std-ref">PublicObject</span></a>.</p>
<p>This type describes a infinite impulse response filter</p>
<p><strong>Parents</strong>:</p>
<ul class="simple">
<li><p><code class="docutils literal notranslate"><span class="pre">inventory</span></code> <a class="reference internal" href="#api-python-datamodel-inventory"><span class="std std-ref">Inventory</span></a></p></li>
</ul>
<p><strong>Attributes</strong>:</p>
<ul class="simple">
<li><p><code class="docutils literal notranslate"><span class="pre">publicID</span></code>: string</p></li>
<li><p><code class="docutils literal notranslate"><span class="pre">name</span></code> string</p></li>
<li><p><code class="docutils literal notranslate"><span class="pre">type</span></code> string</p></li>
<li><p><code class="docutils literal notranslate"><span class="pre">gain</span></code> float (optional)</p></li>
<li><p><code class="docutils literal notranslate"><span class="pre">gainFrequency</span></code> float (optional)</p></li>
<li><p><code class="docutils literal notranslate"><span class="pre">decimationFactor</span></code> int (optional)</p></li>
<li><p><code class="docutils literal notranslate"><span class="pre">delay</span></code> float (optional)</p></li>
<li><p><code class="docutils literal notranslate"><span class="pre">correction</span></code> float (optional)</p></li>
<li><p><code class="docutils literal notranslate"><span class="pre">numberOfNumerators</span></code> int (optional)</p></li>
<li><p><code class="docutils literal notranslate"><span class="pre">numberOfDenominators</span></code> int (optional)</p></li>
<li><p><code class="docutils literal notranslate"><span class="pre">numerators</span></code> <a class="reference internal" href="#api-python-datamodel-realarray"><span class="std std-ref">RealArray</span></a> (optional)</p></li>
<li><p><code class="docutils literal notranslate"><span class="pre">denominators</span></code> <a class="reference internal" href="#api-python-datamodel-realarray"><span class="std std-ref">RealArray</span></a> (optional)</p></li>
<li><p><code class="docutils literal notranslate"><span class="pre">remark</span></code> <a class="reference internal" href="#api-python-datamodel-blob"><span class="std std-ref">Blob</span></a> (optional)</p></li>
</ul>
<p><strong>Methods</strong>:</p>
<dl class="method">
<dt id="seiscomp.datamodel.ResponseIIR.Cast">
<em class="property">static </em><code class="sig-name descname">Cast</code><span class="sig-paren">(</span><em class="sig-param">obj</em><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.ResponseIIR.Cast" title="Permalink to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>obj</strong> The object to be casted.</p>
</dd>
<dt class="field-even">Return type</dt>
<dd class="field-even"><p>An object of type ResponseIIR if the cast was successful,
None otherwise.</p>
</dd>
</dl>
<p>Cast an arbitrary object to ResponseIIR if the internal wrapped
representation is an ResponseIIR object. The cast is important if
instances of type <a class="reference internal" href="#api-python-datamodel-object"><span class="std std-ref">Object</span></a>
are passed to methods which need access to the real type.</p>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.ResponseIIR.Create">
<em class="property">static </em><code class="sig-name descname">Create</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.ResponseIIR.Create" title="Permalink to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Return type</dt>
<dd class="field-odd"><p>A new object of type ResponseIIR.</p>
</dd>
</dl>
<p>Creates and registers (if enabled) a ResponseIIR instance. The
publicID is auto-generated.</p>
</dd></dl>
<dl class="method">
<dt>
<em class="property">static </em><code class="sig-name descname">Create</code><span class="sig-paren">(</span><em class="sig-param">publicID</em><span class="sig-paren">)</span></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Return type</dt>
<dd class="field-odd"><p>A new object of type ResponseIIR.</p>
</dd>
</dl>
<p>Creates and registers (if enabled) a ResponseIIR instance with
passed publicID.</p>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.ResponseIIR.equal">
<code class="sig-name descname">equal</code><span class="sig-paren">(</span><em class="sig-param">other</em><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.ResponseIIR.equal" title="Permalink to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>other</strong> Another object of type ResponseIIR to compare this
instance to</p>
</dd>
<dt class="field-even">Return type</dt>
<dd class="field-even"><p>A Boolean value indicating True if both objects are equal or
False otherwise.</p>
</dd>
</dl>
<p>Compares two objects without its child objects. Both objects are compared
by value.</p>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.ResponseIIR.index">
<code class="sig-name descname">index</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.ResponseIIR.index" title="Permalink to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Return type</dt>
<dd class="field-odd"><p><p>The objects index of type ResponseIIRIndex.</p>
<p>Returns the objects index which is also used for the database as unique
constraint.</p>
</p>
</dd>
</dl>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.ResponseIIR.equalIndex">
<code class="sig-name descname">equalIndex</code><span class="sig-paren">(</span><em class="sig-param">lhs</em><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.ResponseIIR.equalIndex" title="Permalink to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>lhs</strong> <a class="reference internal" href="#api-python-datamodel-responseiir"><span class="std std-ref">ResponseIIR</span></a></p>
</dd>
<dt class="field-even">Return type</dt>
<dd class="field-even"><p>A Boolean value indicating True if both indexes are equal or
False otherwise.</p>
</dd>
</dl>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.ResponseIIR.setName">
<code class="sig-name descname">setName</code><span class="sig-paren">(</span><em class="sig-param">name</em><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.ResponseIIR.setName" title="Permalink to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>name</strong> string</p>
</dd>
</dl>
<p>Unique response name</p>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.ResponseIIR.name">
<code class="sig-name descname">name</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.ResponseIIR.name" title="Permalink to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Return type</dt>
<dd class="field-odd"><p>string</p>
</dd>
</dl>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.ResponseIIR.setType">
<code class="sig-name descname">setType</code><span class="sig-paren">(</span><em class="sig-param">type</em><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.ResponseIIR.setType" title="Permalink to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>type</strong> string</p>
</dd>
</dl>
<p>Response type (43.05/53.03/54.03): A - Laplace transform analog
response in rad/sec, B - Analog response in Hz, C - Composite (currently
undefined), D - Digital (Z - transform)</p>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.ResponseIIR.type">
<code class="sig-name descname">type</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.ResponseIIR.type" title="Permalink to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Return type</dt>
<dd class="field-odd"><p>string</p>
</dd>
</dl>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.ResponseIIR.setGain">
<code class="sig-name descname">setGain</code><span class="sig-paren">(</span><em class="sig-param">gain</em><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.ResponseIIR.setGain" title="Permalink to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>gain</strong> float</p>
</dd>
</dl>
<p>Gain of response (48.05/58.04)</p>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.ResponseIIR.gain">
<code class="sig-name descname">gain</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.ResponseIIR.gain" title="Permalink to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Return type</dt>
<dd class="field-odd"><p>float</p>
</dd>
</dl>
<div class="admonition note">
<p class="admonition-title">Note</p>
<p>As this attribute is optional, this method throws a ValueError if
the value of the attribute is not set.</p>
</div>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.ResponseIIR.setGainFrequency">
<code class="sig-name descname">setGainFrequency</code><span class="sig-paren">(</span><em class="sig-param">gainFrequency</em><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.ResponseIIR.setGainFrequency" title="Permalink to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>gainFrequency</strong> float</p>
</dd>
</dl>
<p>Gain frequency (48.06/58.05)</p>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.ResponseIIR.gainFrequency">
<code class="sig-name descname">gainFrequency</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.ResponseIIR.gainFrequency" title="Permalink to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Return type</dt>
<dd class="field-odd"><p>float</p>
</dd>
</dl>
<div class="admonition note">
<p class="admonition-title">Note</p>
<p>As this attribute is optional, this method throws a ValueError if
the value of the attribute is not set.</p>
</div>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.ResponseIIR.setDecimationFactor">
<code class="sig-name descname">setDecimationFactor</code><span class="sig-paren">(</span><em class="sig-param">decimationFactor</em><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.ResponseIIR.setDecimationFactor" title="Permalink to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>decimationFactor</strong> int</p>
</dd>
</dl>
<p>Decimation factor (47.06/57.05)</p>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.ResponseIIR.decimationFactor">
<code class="sig-name descname">decimationFactor</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.ResponseIIR.decimationFactor" title="Permalink to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Return type</dt>
<dd class="field-odd"><p>int</p>
</dd>
</dl>
<div class="admonition note">
<p class="admonition-title">Note</p>
<p>As this attribute is optional, this method throws a ValueError if
the value of the attribute is not set.</p>
</div>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.ResponseIIR.setDelay">
<code class="sig-name descname">setDelay</code><span class="sig-paren">(</span><em class="sig-param">delay</em><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.ResponseIIR.setDelay" title="Permalink to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>delay</strong> float</p>
</dd>
</dl>
<p>Estimated delay (47.08/57.07)</p>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.ResponseIIR.delay">
<code class="sig-name descname">delay</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.ResponseIIR.delay" title="Permalink to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Return type</dt>
<dd class="field-odd"><p>float</p>
</dd>
</dl>
<div class="admonition note">
<p class="admonition-title">Note</p>
<p>As this attribute is optional, this method throws a ValueError if
the value of the attribute is not set.</p>
</div>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.ResponseIIR.setCorrection">
<code class="sig-name descname">setCorrection</code><span class="sig-paren">(</span><em class="sig-param">correction</em><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.ResponseIIR.setCorrection" title="Permalink to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>correction</strong> float</p>
</dd>
</dl>
<p>Applied correction (47.09/57.08)</p>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.ResponseIIR.correction">
<code class="sig-name descname">correction</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.ResponseIIR.correction" title="Permalink to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Return type</dt>
<dd class="field-odd"><p>float</p>
</dd>
</dl>
<div class="admonition note">
<p class="admonition-title">Note</p>
<p>As this attribute is optional, this method throws a ValueError if
the value of the attribute is not set.</p>
</div>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.ResponseIIR.setNumberOfNumerators">
<code class="sig-name descname">setNumberOfNumerators</code><span class="sig-paren">(</span><em class="sig-param">numberOfNumerators</em><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.ResponseIIR.setNumberOfNumerators" title="Permalink to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>numberOfNumerators</strong> int</p>
</dd>
</dl>
<p>Number of numerators (54.07)</p>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.ResponseIIR.numberOfNumerators">
<code class="sig-name descname">numberOfNumerators</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.ResponseIIR.numberOfNumerators" title="Permalink to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Return type</dt>
<dd class="field-odd"><p>int</p>
</dd>
</dl>
<div class="admonition note">
<p class="admonition-title">Note</p>
<p>As this attribute is optional, this method throws a ValueError if
the value of the attribute is not set.</p>
</div>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.ResponseIIR.setNumberOfDenominators">
<code class="sig-name descname">setNumberOfDenominators</code><span class="sig-paren">(</span><em class="sig-param">numberOfDenominators</em><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.ResponseIIR.setNumberOfDenominators" title="Permalink to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>numberOfDenominators</strong> int</p>
</dd>
</dl>
<p>Number of denominators (54.10)</p>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.ResponseIIR.numberOfDenominators">
<code class="sig-name descname">numberOfDenominators</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.ResponseIIR.numberOfDenominators" title="Permalink to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Return type</dt>
<dd class="field-odd"><p>int</p>
</dd>
</dl>
<div class="admonition note">
<p class="admonition-title">Note</p>
<p>As this attribute is optional, this method throws a ValueError if
the value of the attribute is not set.</p>
</div>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.ResponseIIR.setNumerators">
<code class="sig-name descname">setNumerators</code><span class="sig-paren">(</span><em class="sig-param">numerators</em><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.ResponseIIR.setNumerators" title="Permalink to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>numerators</strong> <a class="reference internal" href="#api-python-datamodel-realarray"><span class="std std-ref">RealArray</span></a></p>
</dd>
</dl>
<p>Numerators (54.08-09)</p>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.ResponseIIR.numerators">
<code class="sig-name descname">numerators</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.ResponseIIR.numerators" title="Permalink to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Return type</dt>
<dd class="field-odd"><p><a class="reference internal" href="#api-python-datamodel-realarray"><span class="std std-ref">RealArray</span></a></p>
</dd>
</dl>
<div class="admonition note">
<p class="admonition-title">Note</p>
<p>As this attribute is optional, this method throws a ValueError if
the value of the attribute is not set.</p>
</div>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.ResponseIIR.setDenominators">
<code class="sig-name descname">setDenominators</code><span class="sig-paren">(</span><em class="sig-param">denominators</em><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.ResponseIIR.setDenominators" title="Permalink to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>denominators</strong> <a class="reference internal" href="#api-python-datamodel-realarray"><span class="std std-ref">RealArray</span></a></p>
</dd>
</dl>
<p>Denominators (54.11-12)</p>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.ResponseIIR.denominators">
<code class="sig-name descname">denominators</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.ResponseIIR.denominators" title="Permalink to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Return type</dt>
<dd class="field-odd"><p><a class="reference internal" href="#api-python-datamodel-realarray"><span class="std std-ref">RealArray</span></a></p>
</dd>
</dl>
<div class="admonition note">
<p class="admonition-title">Note</p>
<p>As this attribute is optional, this method throws a ValueError if
the value of the attribute is not set.</p>
</div>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.ResponseIIR.setRemark">
<code class="sig-name descname">setRemark</code><span class="sig-paren">(</span><em class="sig-param">remark</em><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.ResponseIIR.setRemark" title="Permalink to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>remark</strong> <a class="reference internal" href="#api-python-datamodel-blob"><span class="std std-ref">Blob</span></a></p>
</dd>
</dl>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.ResponseIIR.remark">
<code class="sig-name descname">remark</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.ResponseIIR.remark" title="Permalink to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Return type</dt>
<dd class="field-odd"><p><a class="reference internal" href="#api-python-datamodel-blob"><span class="std std-ref">Blob</span></a></p>
</dd>
</dl>
<div class="admonition note">
<p class="admonition-title">Note</p>
<p>As this attribute is optional, this method throws a ValueError if
the value of the attribute is not set.</p>
</div>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.ResponseIIR.inventory">
<code class="sig-name descname">inventory</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.ResponseIIR.inventory" title="Permalink to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Return type</dt>
<dd class="field-odd"><p><a class="reference internal" href="#seiscomp.datamodel.Inventory" title="seiscomp.datamodel.Inventory">Inventory</a></p>
</dd>
</dl>
<p>Returns the parent Inventory if available. Returns None
if the parent is not a Inventory. This is a convenience wrapper
for parent().</p>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.ResponseIIR.assign">
<code class="sig-name descname">assign</code><span class="sig-paren">(</span><em class="sig-param">other</em><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.ResponseIIR.assign" title="Permalink to this definition"></a></dt>
<dd><p>This method implements the <a class="reference internal" href="#api-python-datamodel-object"><span class="std std-ref">Object</span></a> interface.</p>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.ResponseIIR.attachTo">
<code class="sig-name descname">attachTo</code><span class="sig-paren">(</span><em class="sig-param">parent</em><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.ResponseIIR.attachTo" title="Permalink to this definition"></a></dt>
<dd><p>This method implements the <a class="reference internal" href="#api-python-datamodel-object"><span class="std std-ref">Object</span></a> interface.</p>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.ResponseIIR.detachFrom">
<code class="sig-name descname">detachFrom</code><span class="sig-paren">(</span><em class="sig-param">parent</em><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.ResponseIIR.detachFrom" title="Permalink to this definition"></a></dt>
<dd><p>This method implements the <a class="reference internal" href="#api-python-datamodel-object"><span class="std std-ref">Object</span></a> interface.</p>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.ResponseIIR.detach">
<code class="sig-name descname">detach</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.ResponseIIR.detach" title="Permalink to this definition"></a></dt>
<dd><p>This method implements the <a class="reference internal" href="#api-python-datamodel-object"><span class="std std-ref">Object</span></a> interface.</p>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.ResponseIIR.clone">
<code class="sig-name descname">clone</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.ResponseIIR.clone" title="Permalink to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Return type</dt>
<dd class="field-odd"><p>A cloned ResponseIIR.</p>
</dd>
</dl>
<p>Returns a new instance that is a clone of the current instance. Child
objects are being ignored.</p>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.ResponseIIR.updateChild">
<code class="sig-name descname">updateChild</code><span class="sig-paren">(</span><em class="sig-param">ref</em><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.ResponseIIR.updateChild" title="Permalink to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>ref</strong> A child object derived from class Object.</p>
</dd>
<dt class="field-even">Return type</dt>
<dd class="field-even"><p>A Boolean flag indicating success with True, False otherwise</p>
</dd>
</dl>
<p>This method takes the passed reference object and searches for a child
with the same publicID (if derived from <a class="reference internal" href="#api-python-datamodel-publicobject"><span class="std std-ref">PublicObject</span></a>)
or the same index (if derived from <a class="reference internal" href="#api-python-datamodel-object"><span class="std std-ref">Object</span></a>).
The the child was found the reference objects attributes are copied to
the child object. Children of child are being ignored during this operation.
This method implements the <a class="reference internal" href="#api-python-datamodel-publicobject"><span class="std std-ref">PublicObject</span></a> interface.</p>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.ResponseIIR.accept">
<code class="sig-name descname">accept</code><span class="sig-paren">(</span><em class="sig-param">visitor</em><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.ResponseIIR.accept" title="Permalink to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>visitor</strong> A visitor.</p>
</dd>
</dl>
<p>This method implements the <a class="reference internal" href="#api-python-datamodel-publicobject"><span class="std std-ref">PublicObject</span></a> interface.</p>
</dd></dl>
</dd></dl>
</div>
<div class="section" id="responsepaz">
<span id="api-python-datamodel-responsepaz"></span><h3>ResponsePAZ<a class="headerlink" href="#responsepaz" title="Permalink to this headline"></a></h3>
<dl class="class">
<dt id="seiscomp.datamodel.ResponsePAZ">
<em class="property">class </em><code class="sig-prename descclassname">seiscomp.datamodel.</code><code class="sig-name descname">ResponsePAZ</code><a class="headerlink" href="#seiscomp.datamodel.ResponsePAZ" title="Permalink to this definition"></a></dt>
<dd><p>Inherits <a class="reference internal" href="#api-python-datamodel-publicobject"><span class="std std-ref">PublicObject</span></a>.</p>
<p>This type describes a sensor response using poles and zeros</p>
<p><strong>Parents</strong>:</p>
<ul class="simple">
<li><p><code class="docutils literal notranslate"><span class="pre">inventory</span></code> <a class="reference internal" href="#api-python-datamodel-inventory"><span class="std std-ref">Inventory</span></a></p></li>
</ul>
<p><strong>Attributes</strong>:</p>
<ul class="simple">
<li><p><code class="docutils literal notranslate"><span class="pre">publicID</span></code>: string</p></li>
<li><p><code class="docutils literal notranslate"><span class="pre">name</span></code> string</p></li>
<li><p><code class="docutils literal notranslate"><span class="pre">type</span></code> string</p></li>
<li><p><code class="docutils literal notranslate"><span class="pre">gain</span></code> float (optional)</p></li>
<li><p><code class="docutils literal notranslate"><span class="pre">gainFrequency</span></code> float (optional)</p></li>
<li><p><code class="docutils literal notranslate"><span class="pre">normalizationFactor</span></code> float (optional)</p></li>
<li><p><code class="docutils literal notranslate"><span class="pre">normalizationFrequency</span></code> float (optional)</p></li>
<li><p><code class="docutils literal notranslate"><span class="pre">numberOfZeros</span></code> int (optional)</p></li>
<li><p><code class="docutils literal notranslate"><span class="pre">numberOfPoles</span></code> int (optional)</p></li>
<li><p><code class="docutils literal notranslate"><span class="pre">zeros</span></code> <a class="reference internal" href="#api-python-datamodel-complexarray"><span class="std std-ref">ComplexArray</span></a> (optional)</p></li>
<li><p><code class="docutils literal notranslate"><span class="pre">poles</span></code> <a class="reference internal" href="#api-python-datamodel-complexarray"><span class="std std-ref">ComplexArray</span></a> (optional)</p></li>
<li><p><code class="docutils literal notranslate"><span class="pre">remark</span></code> <a class="reference internal" href="#api-python-datamodel-blob"><span class="std std-ref">Blob</span></a> (optional)</p></li>
<li><p><code class="docutils literal notranslate"><span class="pre">decimationFactor</span></code> int (optional)</p></li>
<li><p><code class="docutils literal notranslate"><span class="pre">delay</span></code> float (optional)</p></li>
<li><p><code class="docutils literal notranslate"><span class="pre">correction</span></code> float (optional)</p></li>
</ul>
<p><strong>Methods</strong>:</p>
<dl class="method">
<dt id="seiscomp.datamodel.ResponsePAZ.Cast">
<em class="property">static </em><code class="sig-name descname">Cast</code><span class="sig-paren">(</span><em class="sig-param">obj</em><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.ResponsePAZ.Cast" title="Permalink to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>obj</strong> The object to be casted.</p>
</dd>
<dt class="field-even">Return type</dt>
<dd class="field-even"><p>An object of type ResponsePAZ if the cast was successful,
None otherwise.</p>
</dd>
</dl>
<p>Cast an arbitrary object to ResponsePAZ if the internal wrapped
representation is an ResponsePAZ object. The cast is important if
instances of type <a class="reference internal" href="#api-python-datamodel-object"><span class="std std-ref">Object</span></a>
are passed to methods which need access to the real type.</p>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.ResponsePAZ.Create">
<em class="property">static </em><code class="sig-name descname">Create</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.ResponsePAZ.Create" title="Permalink to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Return type</dt>
<dd class="field-odd"><p>A new object of type ResponsePAZ.</p>
</dd>
</dl>
<p>Creates and registers (if enabled) a ResponsePAZ instance. The
publicID is auto-generated.</p>
</dd></dl>
<dl class="method">
<dt>
<em class="property">static </em><code class="sig-name descname">Create</code><span class="sig-paren">(</span><em class="sig-param">publicID</em><span class="sig-paren">)</span></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Return type</dt>
<dd class="field-odd"><p>A new object of type ResponsePAZ.</p>
</dd>
</dl>
<p>Creates and registers (if enabled) a ResponsePAZ instance with
passed publicID.</p>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.ResponsePAZ.equal">
<code class="sig-name descname">equal</code><span class="sig-paren">(</span><em class="sig-param">other</em><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.ResponsePAZ.equal" title="Permalink to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>other</strong> Another object of type ResponsePAZ to compare this
instance to</p>
</dd>
<dt class="field-even">Return type</dt>
<dd class="field-even"><p>A Boolean value indicating True if both objects are equal or
False otherwise.</p>
</dd>
</dl>
<p>Compares two objects without its child objects. Both objects are compared
by value.</p>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.ResponsePAZ.index">
<code class="sig-name descname">index</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.ResponsePAZ.index" title="Permalink to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Return type</dt>
<dd class="field-odd"><p><p>The objects index of type ResponsePAZIndex.</p>
<p>Returns the objects index which is also used for the database as unique
constraint.</p>
</p>
</dd>
</dl>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.ResponsePAZ.equalIndex">
<code class="sig-name descname">equalIndex</code><span class="sig-paren">(</span><em class="sig-param">lhs</em><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.ResponsePAZ.equalIndex" title="Permalink to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>lhs</strong> <a class="reference internal" href="#api-python-datamodel-responsepaz"><span class="std std-ref">ResponsePAZ</span></a></p>
</dd>
<dt class="field-even">Return type</dt>
<dd class="field-even"><p>A Boolean value indicating True if both indexes are equal or
False otherwise.</p>
</dd>
</dl>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.ResponsePAZ.setName">
<code class="sig-name descname">setName</code><span class="sig-paren">(</span><em class="sig-param">name</em><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.ResponsePAZ.setName" title="Permalink to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>name</strong> string</p>
</dd>
</dl>
<p>Unique response name</p>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.ResponsePAZ.name">
<code class="sig-name descname">name</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.ResponsePAZ.name" title="Permalink to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Return type</dt>
<dd class="field-odd"><p>string</p>
</dd>
</dl>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.ResponsePAZ.setType">
<code class="sig-name descname">setType</code><span class="sig-paren">(</span><em class="sig-param">type</em><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.ResponsePAZ.setType" title="Permalink to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>type</strong> string</p>
</dd>
</dl>
<p>Response type (43.05/53.03): A - Laplace transform analog response in
rad/sec, B - Analog response in Hz, C - Composite (currently
undefined), D - Digital (Z - transform)</p>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.ResponsePAZ.type">
<code class="sig-name descname">type</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.ResponsePAZ.type" title="Permalink to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Return type</dt>
<dd class="field-odd"><p>string</p>
</dd>
</dl>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.ResponsePAZ.setGain">
<code class="sig-name descname">setGain</code><span class="sig-paren">(</span><em class="sig-param">gain</em><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.ResponsePAZ.setGain" title="Permalink to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>gain</strong> float</p>
</dd>
</dl>
<p>Gain of response (48.05/58.04)</p>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.ResponsePAZ.gain">
<code class="sig-name descname">gain</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.ResponsePAZ.gain" title="Permalink to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Return type</dt>
<dd class="field-odd"><p>float</p>
</dd>
</dl>
<div class="admonition note">
<p class="admonition-title">Note</p>
<p>As this attribute is optional, this method throws a ValueError if
the value of the attribute is not set.</p>
</div>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.ResponsePAZ.setGainFrequency">
<code class="sig-name descname">setGainFrequency</code><span class="sig-paren">(</span><em class="sig-param">gainFrequency</em><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.ResponsePAZ.setGainFrequency" title="Permalink to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>gainFrequency</strong> float</p>
</dd>
</dl>
<p>Gain frequency (48.06/58.05)</p>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.ResponsePAZ.gainFrequency">
<code class="sig-name descname">gainFrequency</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.ResponsePAZ.gainFrequency" title="Permalink to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Return type</dt>
<dd class="field-odd"><p>float</p>
</dd>
</dl>
<div class="admonition note">
<p class="admonition-title">Note</p>
<p>As this attribute is optional, this method throws a ValueError if
the value of the attribute is not set.</p>
</div>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.ResponsePAZ.setNormalizationFactor">
<code class="sig-name descname">setNormalizationFactor</code><span class="sig-paren">(</span><em class="sig-param">normalizationFactor</em><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.ResponsePAZ.setNormalizationFactor" title="Permalink to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>normalizationFactor</strong> float</p>
</dd>
</dl>
<p>A0 normalization factor (43.08/53.07)</p>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.ResponsePAZ.normalizationFactor">
<code class="sig-name descname">normalizationFactor</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.ResponsePAZ.normalizationFactor" title="Permalink to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Return type</dt>
<dd class="field-odd"><p>float</p>
</dd>
</dl>
<div class="admonition note">
<p class="admonition-title">Note</p>
<p>As this attribute is optional, this method throws a ValueError if
the value of the attribute is not set.</p>
</div>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.ResponsePAZ.setNormalizationFrequency">
<code class="sig-name descname">setNormalizationFrequency</code><span class="sig-paren">(</span><em class="sig-param">normalizationFrequency</em><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.ResponsePAZ.setNormalizationFrequency" title="Permalink to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>normalizationFrequency</strong> float</p>
</dd>
</dl>
<p>Normalization frequency (43.09/53.08)</p>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.ResponsePAZ.normalizationFrequency">
<code class="sig-name descname">normalizationFrequency</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.ResponsePAZ.normalizationFrequency" title="Permalink to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Return type</dt>
<dd class="field-odd"><p>float</p>
</dd>
</dl>
<div class="admonition note">
<p class="admonition-title">Note</p>
<p>As this attribute is optional, this method throws a ValueError if
the value of the attribute is not set.</p>
</div>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.ResponsePAZ.setNumberOfZeros">
<code class="sig-name descname">setNumberOfZeros</code><span class="sig-paren">(</span><em class="sig-param">numberOfZeros</em><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.ResponsePAZ.setNumberOfZeros" title="Permalink to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>numberOfZeros</strong> int</p>
</dd>
</dl>
<p>Number of zeros (43.10/53.09)</p>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.ResponsePAZ.numberOfZeros">
<code class="sig-name descname">numberOfZeros</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.ResponsePAZ.numberOfZeros" title="Permalink to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Return type</dt>
<dd class="field-odd"><p>int</p>
</dd>
</dl>
<div class="admonition note">
<p class="admonition-title">Note</p>
<p>As this attribute is optional, this method throws a ValueError if
the value of the attribute is not set.</p>
</div>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.ResponsePAZ.setNumberOfPoles">
<code class="sig-name descname">setNumberOfPoles</code><span class="sig-paren">(</span><em class="sig-param">numberOfPoles</em><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.ResponsePAZ.setNumberOfPoles" title="Permalink to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>numberOfPoles</strong> int</p>
</dd>
</dl>
<p>Number of poles (43.15/53.14)</p>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.ResponsePAZ.numberOfPoles">
<code class="sig-name descname">numberOfPoles</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.ResponsePAZ.numberOfPoles" title="Permalink to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Return type</dt>
<dd class="field-odd"><p>int</p>
</dd>
</dl>
<div class="admonition note">
<p class="admonition-title">Note</p>
<p>As this attribute is optional, this method throws a ValueError if
the value of the attribute is not set.</p>
</div>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.ResponsePAZ.setZeros">
<code class="sig-name descname">setZeros</code><span class="sig-paren">(</span><em class="sig-param">zeros</em><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.ResponsePAZ.setZeros" title="Permalink to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>zeros</strong> <a class="reference internal" href="#api-python-datamodel-complexarray"><span class="std std-ref">ComplexArray</span></a></p>
</dd>
</dl>
<p>Zeros (43.16-19/53.10-13)</p>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.ResponsePAZ.zeros">
<code class="sig-name descname">zeros</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.ResponsePAZ.zeros" title="Permalink to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Return type</dt>
<dd class="field-odd"><p><a class="reference internal" href="#api-python-datamodel-complexarray"><span class="std std-ref">ComplexArray</span></a></p>
</dd>
</dl>
<div class="admonition note">
<p class="admonition-title">Note</p>
<p>As this attribute is optional, this method throws a ValueError if
the value of the attribute is not set.</p>
</div>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.ResponsePAZ.setPoles">
<code class="sig-name descname">setPoles</code><span class="sig-paren">(</span><em class="sig-param">poles</em><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.ResponsePAZ.setPoles" title="Permalink to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>poles</strong> <a class="reference internal" href="#api-python-datamodel-complexarray"><span class="std std-ref">ComplexArray</span></a></p>
</dd>
</dl>
<p>Poles (43.11-14/53.15-18)</p>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.ResponsePAZ.poles">
<code class="sig-name descname">poles</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.ResponsePAZ.poles" title="Permalink to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Return type</dt>
<dd class="field-odd"><p><a class="reference internal" href="#api-python-datamodel-complexarray"><span class="std std-ref">ComplexArray</span></a></p>
</dd>
</dl>
<div class="admonition note">
<p class="admonition-title">Note</p>
<p>As this attribute is optional, this method throws a ValueError if
the value of the attribute is not set.</p>
</div>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.ResponsePAZ.setRemark">
<code class="sig-name descname">setRemark</code><span class="sig-paren">(</span><em class="sig-param">remark</em><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.ResponsePAZ.setRemark" title="Permalink to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>remark</strong> <a class="reference internal" href="#api-python-datamodel-blob"><span class="std std-ref">Blob</span></a></p>
</dd>
</dl>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.ResponsePAZ.remark">
<code class="sig-name descname">remark</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.ResponsePAZ.remark" title="Permalink to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Return type</dt>
<dd class="field-odd"><p><a class="reference internal" href="#api-python-datamodel-blob"><span class="std std-ref">Blob</span></a></p>
</dd>
</dl>
<div class="admonition note">
<p class="admonition-title">Note</p>
<p>As this attribute is optional, this method throws a ValueError if
the value of the attribute is not set.</p>
</div>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.ResponsePAZ.setDecimationFactor">
<code class="sig-name descname">setDecimationFactor</code><span class="sig-paren">(</span><em class="sig-param">decimationFactor</em><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.ResponsePAZ.setDecimationFactor" title="Permalink to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>decimationFactor</strong> int</p>
</dd>
</dl>
<p>Decimation factor (47.06/57.05)</p>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.ResponsePAZ.decimationFactor">
<code class="sig-name descname">decimationFactor</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.ResponsePAZ.decimationFactor" title="Permalink to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Return type</dt>
<dd class="field-odd"><p>int</p>
</dd>
</dl>
<div class="admonition note">
<p class="admonition-title">Note</p>
<p>As this attribute is optional, this method throws a ValueError if
the value of the attribute is not set.</p>
</div>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.ResponsePAZ.setDelay">
<code class="sig-name descname">setDelay</code><span class="sig-paren">(</span><em class="sig-param">delay</em><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.ResponsePAZ.setDelay" title="Permalink to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>delay</strong> float</p>
</dd>
</dl>
<p>Estimated delay (47.08/57.07)</p>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.ResponsePAZ.delay">
<code class="sig-name descname">delay</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.ResponsePAZ.delay" title="Permalink to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Return type</dt>
<dd class="field-odd"><p>float</p>
</dd>
</dl>
<div class="admonition note">
<p class="admonition-title">Note</p>
<p>As this attribute is optional, this method throws a ValueError if
the value of the attribute is not set.</p>
</div>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.ResponsePAZ.setCorrection">
<code class="sig-name descname">setCorrection</code><span class="sig-paren">(</span><em class="sig-param">correction</em><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.ResponsePAZ.setCorrection" title="Permalink to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>correction</strong> float</p>
</dd>
</dl>
<p>Applied correction (47.09/57.08)</p>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.ResponsePAZ.correction">
<code class="sig-name descname">correction</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.ResponsePAZ.correction" title="Permalink to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Return type</dt>
<dd class="field-odd"><p>float</p>
</dd>
</dl>
<div class="admonition note">
<p class="admonition-title">Note</p>
<p>As this attribute is optional, this method throws a ValueError if
the value of the attribute is not set.</p>
</div>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.ResponsePAZ.inventory">
<code class="sig-name descname">inventory</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.ResponsePAZ.inventory" title="Permalink to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Return type</dt>
<dd class="field-odd"><p><a class="reference internal" href="#seiscomp.datamodel.Inventory" title="seiscomp.datamodel.Inventory">Inventory</a></p>
</dd>
</dl>
<p>Returns the parent Inventory if available. Returns None
if the parent is not a Inventory. This is a convenience wrapper
for parent().</p>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.ResponsePAZ.assign">
<code class="sig-name descname">assign</code><span class="sig-paren">(</span><em class="sig-param">other</em><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.ResponsePAZ.assign" title="Permalink to this definition"></a></dt>
<dd><p>This method implements the <a class="reference internal" href="#api-python-datamodel-object"><span class="std std-ref">Object</span></a> interface.</p>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.ResponsePAZ.attachTo">
<code class="sig-name descname">attachTo</code><span class="sig-paren">(</span><em class="sig-param">parent</em><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.ResponsePAZ.attachTo" title="Permalink to this definition"></a></dt>
<dd><p>This method implements the <a class="reference internal" href="#api-python-datamodel-object"><span class="std std-ref">Object</span></a> interface.</p>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.ResponsePAZ.detachFrom">
<code class="sig-name descname">detachFrom</code><span class="sig-paren">(</span><em class="sig-param">parent</em><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.ResponsePAZ.detachFrom" title="Permalink to this definition"></a></dt>
<dd><p>This method implements the <a class="reference internal" href="#api-python-datamodel-object"><span class="std std-ref">Object</span></a> interface.</p>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.ResponsePAZ.detach">
<code class="sig-name descname">detach</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.ResponsePAZ.detach" title="Permalink to this definition"></a></dt>
<dd><p>This method implements the <a class="reference internal" href="#api-python-datamodel-object"><span class="std std-ref">Object</span></a> interface.</p>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.ResponsePAZ.clone">
<code class="sig-name descname">clone</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.ResponsePAZ.clone" title="Permalink to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Return type</dt>
<dd class="field-odd"><p>A cloned ResponsePAZ.</p>
</dd>
</dl>
<p>Returns a new instance that is a clone of the current instance. Child
objects are being ignored.</p>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.ResponsePAZ.updateChild">
<code class="sig-name descname">updateChild</code><span class="sig-paren">(</span><em class="sig-param">ref</em><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.ResponsePAZ.updateChild" title="Permalink to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>ref</strong> A child object derived from class Object.</p>
</dd>
<dt class="field-even">Return type</dt>
<dd class="field-even"><p>A Boolean flag indicating success with True, False otherwise</p>
</dd>
</dl>
<p>This method takes the passed reference object and searches for a child
with the same publicID (if derived from <a class="reference internal" href="#api-python-datamodel-publicobject"><span class="std std-ref">PublicObject</span></a>)
or the same index (if derived from <a class="reference internal" href="#api-python-datamodel-object"><span class="std std-ref">Object</span></a>).
The the child was found the reference objects attributes are copied to
the child object. Children of child are being ignored during this operation.
This method implements the <a class="reference internal" href="#api-python-datamodel-publicobject"><span class="std std-ref">PublicObject</span></a> interface.</p>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.ResponsePAZ.accept">
<code class="sig-name descname">accept</code><span class="sig-paren">(</span><em class="sig-param">visitor</em><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.ResponsePAZ.accept" title="Permalink to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>visitor</strong> A visitor.</p>
</dd>
</dl>
<p>This method implements the <a class="reference internal" href="#api-python-datamodel-publicobject"><span class="std std-ref">PublicObject</span></a> interface.</p>
</dd></dl>
</dd></dl>
</div>
<div class="section" id="responsepolynomial">
<span id="api-python-datamodel-responsepolynomial"></span><h3>ResponsePolynomial<a class="headerlink" href="#responsepolynomial" title="Permalink to this headline"></a></h3>
<dl class="class">
<dt id="seiscomp.datamodel.ResponsePolynomial">
<em class="property">class </em><code class="sig-prename descclassname">seiscomp.datamodel.</code><code class="sig-name descname">ResponsePolynomial</code><a class="headerlink" href="#seiscomp.datamodel.ResponsePolynomial" title="Permalink to this definition"></a></dt>
<dd><p>Inherits <a class="reference internal" href="#api-python-datamodel-publicobject"><span class="std std-ref">PublicObject</span></a>.</p>
<p>This type describes a sensor response using a polynomial</p>
<p><strong>Parents</strong>:</p>
<ul class="simple">
<li><p><code class="docutils literal notranslate"><span class="pre">inventory</span></code> <a class="reference internal" href="#api-python-datamodel-inventory"><span class="std std-ref">Inventory</span></a></p></li>
</ul>
<p><strong>Attributes</strong>:</p>
<ul class="simple">
<li><p><code class="docutils literal notranslate"><span class="pre">publicID</span></code>: string</p></li>
<li><p><code class="docutils literal notranslate"><span class="pre">name</span></code> string</p></li>
<li><p><code class="docutils literal notranslate"><span class="pre">gain</span></code> float (optional)</p></li>
<li><p><code class="docutils literal notranslate"><span class="pre">gainFrequency</span></code> float (optional)</p></li>
<li><p><code class="docutils literal notranslate"><span class="pre">frequencyUnit</span></code> string</p></li>
<li><p><code class="docutils literal notranslate"><span class="pre">approximationType</span></code> string</p></li>
<li><p><code class="docutils literal notranslate"><span class="pre">approximationLowerBound</span></code> float (optional)</p></li>
<li><p><code class="docutils literal notranslate"><span class="pre">approximationUpperBound</span></code> float (optional)</p></li>
<li><p><code class="docutils literal notranslate"><span class="pre">approximationError</span></code> float (optional)</p></li>
<li><p><code class="docutils literal notranslate"><span class="pre">numberOfCoefficients</span></code> int (optional)</p></li>
<li><p><code class="docutils literal notranslate"><span class="pre">coefficients</span></code> <a class="reference internal" href="#api-python-datamodel-realarray"><span class="std std-ref">RealArray</span></a> (optional)</p></li>
<li><p><code class="docutils literal notranslate"><span class="pre">remark</span></code> <a class="reference internal" href="#api-python-datamodel-blob"><span class="std std-ref">Blob</span></a> (optional)</p></li>
</ul>
<p><strong>Methods</strong>:</p>
<dl class="method">
<dt id="seiscomp.datamodel.ResponsePolynomial.Cast">
<em class="property">static </em><code class="sig-name descname">Cast</code><span class="sig-paren">(</span><em class="sig-param">obj</em><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.ResponsePolynomial.Cast" title="Permalink to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>obj</strong> The object to be casted.</p>
</dd>
<dt class="field-even">Return type</dt>
<dd class="field-even"><p>An object of type ResponsePolynomial if the cast was successful,
None otherwise.</p>
</dd>
</dl>
<p>Cast an arbitrary object to ResponsePolynomial if the internal wrapped
representation is an ResponsePolynomial object. The cast is important if
instances of type <a class="reference internal" href="#api-python-datamodel-object"><span class="std std-ref">Object</span></a>
are passed to methods which need access to the real type.</p>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.ResponsePolynomial.Create">
<em class="property">static </em><code class="sig-name descname">Create</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.ResponsePolynomial.Create" title="Permalink to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Return type</dt>
<dd class="field-odd"><p>A new object of type ResponsePolynomial.</p>
</dd>
</dl>
<p>Creates and registers (if enabled) a ResponsePolynomial instance. The
publicID is auto-generated.</p>
</dd></dl>
<dl class="method">
<dt>
<em class="property">static </em><code class="sig-name descname">Create</code><span class="sig-paren">(</span><em class="sig-param">publicID</em><span class="sig-paren">)</span></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Return type</dt>
<dd class="field-odd"><p>A new object of type ResponsePolynomial.</p>
</dd>
</dl>
<p>Creates and registers (if enabled) a ResponsePolynomial instance with
passed publicID.</p>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.ResponsePolynomial.equal">
<code class="sig-name descname">equal</code><span class="sig-paren">(</span><em class="sig-param">other</em><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.ResponsePolynomial.equal" title="Permalink to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>other</strong> Another object of type ResponsePolynomial to compare this
instance to</p>
</dd>
<dt class="field-even">Return type</dt>
<dd class="field-even"><p>A Boolean value indicating True if both objects are equal or
False otherwise.</p>
</dd>
</dl>
<p>Compares two objects without its child objects. Both objects are compared
by value.</p>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.ResponsePolynomial.index">
<code class="sig-name descname">index</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.ResponsePolynomial.index" title="Permalink to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Return type</dt>
<dd class="field-odd"><p><p>The objects index of type ResponsePolynomialIndex.</p>
<p>Returns the objects index which is also used for the database as unique
constraint.</p>
</p>
</dd>
</dl>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.ResponsePolynomial.equalIndex">
<code class="sig-name descname">equalIndex</code><span class="sig-paren">(</span><em class="sig-param">lhs</em><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.ResponsePolynomial.equalIndex" title="Permalink to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>lhs</strong> <a class="reference internal" href="#api-python-datamodel-responsepolynomial"><span class="std std-ref">ResponsePolynomial</span></a></p>
</dd>
<dt class="field-even">Return type</dt>
<dd class="field-even"><p>A Boolean value indicating True if both indexes are equal or
False otherwise.</p>
</dd>
</dl>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.ResponsePolynomial.setName">
<code class="sig-name descname">setName</code><span class="sig-paren">(</span><em class="sig-param">name</em><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.ResponsePolynomial.setName" title="Permalink to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>name</strong> string</p>
</dd>
</dl>
<p>Unique response name</p>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.ResponsePolynomial.name">
<code class="sig-name descname">name</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.ResponsePolynomial.name" title="Permalink to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Return type</dt>
<dd class="field-odd"><p>string</p>
</dd>
</dl>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.ResponsePolynomial.setGain">
<code class="sig-name descname">setGain</code><span class="sig-paren">(</span><em class="sig-param">gain</em><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.ResponsePolynomial.setGain" title="Permalink to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>gain</strong> float</p>
</dd>
</dl>
<p>Gain of response (48.05/58.04)</p>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.ResponsePolynomial.gain">
<code class="sig-name descname">gain</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.ResponsePolynomial.gain" title="Permalink to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Return type</dt>
<dd class="field-odd"><p>float</p>
</dd>
</dl>
<div class="admonition note">
<p class="admonition-title">Note</p>
<p>As this attribute is optional, this method throws a ValueError if
the value of the attribute is not set.</p>
</div>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.ResponsePolynomial.setGainFrequency">
<code class="sig-name descname">setGainFrequency</code><span class="sig-paren">(</span><em class="sig-param">gainFrequency</em><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.ResponsePolynomial.setGainFrequency" title="Permalink to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>gainFrequency</strong> float</p>
</dd>
</dl>
<p>Gain frequency (48.06/58.05)</p>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.ResponsePolynomial.gainFrequency">
<code class="sig-name descname">gainFrequency</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.ResponsePolynomial.gainFrequency" title="Permalink to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Return type</dt>
<dd class="field-odd"><p>float</p>
</dd>
</dl>
<div class="admonition note">
<p class="admonition-title">Note</p>
<p>As this attribute is optional, this method throws a ValueError if
the value of the attribute is not set.</p>
</div>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.ResponsePolynomial.setFrequencyUnit">
<code class="sig-name descname">setFrequencyUnit</code><span class="sig-paren">(</span><em class="sig-param">frequencyUnit</em><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.ResponsePolynomial.setFrequencyUnit" title="Permalink to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>frequencyUnit</strong> string</p>
</dd>
</dl>
<p>A single character describing valid frequency units (42.09/62.08): A -
rad/s, B - Hz</p>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.ResponsePolynomial.frequencyUnit">
<code class="sig-name descname">frequencyUnit</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.ResponsePolynomial.frequencyUnit" title="Permalink to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Return type</dt>
<dd class="field-odd"><p>string</p>
</dd>
</dl>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.ResponsePolynomial.setApproximationType">
<code class="sig-name descname">setApproximationType</code><span class="sig-paren">(</span><em class="sig-param">approximationType</em><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.ResponsePolynomial.setApproximationType" title="Permalink to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>approximationType</strong> string</p>
</dd>
</dl>
<p>A single character describing the type of polynomial approximation
(42.08/62.07): M - MacLaurin</p>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.ResponsePolynomial.approximationType">
<code class="sig-name descname">approximationType</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.ResponsePolynomial.approximationType" title="Permalink to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Return type</dt>
<dd class="field-odd"><p>string</p>
</dd>
</dl>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.ResponsePolynomial.setApproximationLowerBound">
<code class="sig-name descname">setApproximationLowerBound</code><span class="sig-paren">(</span><em class="sig-param">approximationLowerBound</em><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.ResponsePolynomial.setApproximationLowerBound" title="Permalink to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>approximationLowerBound</strong> float</p>
</dd>
</dl>
<p>Lower bound of approximation (42.12/62.11)</p>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.ResponsePolynomial.approximationLowerBound">
<code class="sig-name descname">approximationLowerBound</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.ResponsePolynomial.approximationLowerBound" title="Permalink to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Return type</dt>
<dd class="field-odd"><p>float</p>
</dd>
</dl>
<div class="admonition note">
<p class="admonition-title">Note</p>
<p>As this attribute is optional, this method throws a ValueError if
the value of the attribute is not set.</p>
</div>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.ResponsePolynomial.setApproximationUpperBound">
<code class="sig-name descname">setApproximationUpperBound</code><span class="sig-paren">(</span><em class="sig-param">approximationUpperBound</em><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.ResponsePolynomial.setApproximationUpperBound" title="Permalink to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>approximationUpperBound</strong> float</p>
</dd>
</dl>
<p>Upper bound of approximation (42.13/62.12)</p>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.ResponsePolynomial.approximationUpperBound">
<code class="sig-name descname">approximationUpperBound</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.ResponsePolynomial.approximationUpperBound" title="Permalink to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Return type</dt>
<dd class="field-odd"><p>float</p>
</dd>
</dl>
<div class="admonition note">
<p class="admonition-title">Note</p>
<p>As this attribute is optional, this method throws a ValueError if
the value of the attribute is not set.</p>
</div>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.ResponsePolynomial.setApproximationError">
<code class="sig-name descname">setApproximationError</code><span class="sig-paren">(</span><em class="sig-param">approximationError</em><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.ResponsePolynomial.setApproximationError" title="Permalink to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>approximationError</strong> float</p>
</dd>
</dl>
<p>The maximum absolute error of the polynomial approximation (42.14/62.13;
Put 0.0 if the value is unknown or actually zero)</p>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.ResponsePolynomial.approximationError">
<code class="sig-name descname">approximationError</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.ResponsePolynomial.approximationError" title="Permalink to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Return type</dt>
<dd class="field-odd"><p>float</p>
</dd>
</dl>
<div class="admonition note">
<p class="admonition-title">Note</p>
<p>As this attribute is optional, this method throws a ValueError if
the value of the attribute is not set.</p>
</div>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.ResponsePolynomial.setNumberOfCoefficients">
<code class="sig-name descname">setNumberOfCoefficients</code><span class="sig-paren">(</span><em class="sig-param">numberOfCoefficients</em><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.ResponsePolynomial.setNumberOfCoefficients" title="Permalink to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>numberOfCoefficients</strong> int</p>
</dd>
</dl>
<p>The number of coefficients in the polynomial approximation (42.15/62.14;
one more than the degree of the polynomial</p>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.ResponsePolynomial.numberOfCoefficients">
<code class="sig-name descname">numberOfCoefficients</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.ResponsePolynomial.numberOfCoefficients" title="Permalink to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Return type</dt>
<dd class="field-odd"><p>int</p>
</dd>
</dl>
<div class="admonition note">
<p class="admonition-title">Note</p>
<p>As this attribute is optional, this method throws a ValueError if
the value of the attribute is not set.</p>
</div>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.ResponsePolynomial.setCoefficients">
<code class="sig-name descname">setCoefficients</code><span class="sig-paren">(</span><em class="sig-param">coefficients</em><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.ResponsePolynomial.setCoefficients" title="Permalink to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>coefficients</strong> <a class="reference internal" href="#api-python-datamodel-realarray"><span class="std std-ref">RealArray</span></a></p>
</dd>
</dl>
<p>The polynomial coefficients, lowest order first (42.16/62.15)</p>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.ResponsePolynomial.coefficients">
<code class="sig-name descname">coefficients</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.ResponsePolynomial.coefficients" title="Permalink to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Return type</dt>
<dd class="field-odd"><p><a class="reference internal" href="#api-python-datamodel-realarray"><span class="std std-ref">RealArray</span></a></p>
</dd>
</dl>
<div class="admonition note">
<p class="admonition-title">Note</p>
<p>As this attribute is optional, this method throws a ValueError if
the value of the attribute is not set.</p>
</div>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.ResponsePolynomial.setRemark">
<code class="sig-name descname">setRemark</code><span class="sig-paren">(</span><em class="sig-param">remark</em><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.ResponsePolynomial.setRemark" title="Permalink to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>remark</strong> <a class="reference internal" href="#api-python-datamodel-blob"><span class="std std-ref">Blob</span></a></p>
</dd>
</dl>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.ResponsePolynomial.remark">
<code class="sig-name descname">remark</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.ResponsePolynomial.remark" title="Permalink to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Return type</dt>
<dd class="field-odd"><p><a class="reference internal" href="#api-python-datamodel-blob"><span class="std std-ref">Blob</span></a></p>
</dd>
</dl>
<div class="admonition note">
<p class="admonition-title">Note</p>
<p>As this attribute is optional, this method throws a ValueError if
the value of the attribute is not set.</p>
</div>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.ResponsePolynomial.inventory">
<code class="sig-name descname">inventory</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.ResponsePolynomial.inventory" title="Permalink to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Return type</dt>
<dd class="field-odd"><p><a class="reference internal" href="#seiscomp.datamodel.Inventory" title="seiscomp.datamodel.Inventory">Inventory</a></p>
</dd>
</dl>
<p>Returns the parent Inventory if available. Returns None
if the parent is not a Inventory. This is a convenience wrapper
for parent().</p>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.ResponsePolynomial.assign">
<code class="sig-name descname">assign</code><span class="sig-paren">(</span><em class="sig-param">other</em><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.ResponsePolynomial.assign" title="Permalink to this definition"></a></dt>
<dd><p>This method implements the <a class="reference internal" href="#api-python-datamodel-object"><span class="std std-ref">Object</span></a> interface.</p>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.ResponsePolynomial.attachTo">
<code class="sig-name descname">attachTo</code><span class="sig-paren">(</span><em class="sig-param">parent</em><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.ResponsePolynomial.attachTo" title="Permalink to this definition"></a></dt>
<dd><p>This method implements the <a class="reference internal" href="#api-python-datamodel-object"><span class="std std-ref">Object</span></a> interface.</p>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.ResponsePolynomial.detachFrom">
<code class="sig-name descname">detachFrom</code><span class="sig-paren">(</span><em class="sig-param">parent</em><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.ResponsePolynomial.detachFrom" title="Permalink to this definition"></a></dt>
<dd><p>This method implements the <a class="reference internal" href="#api-python-datamodel-object"><span class="std std-ref">Object</span></a> interface.</p>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.ResponsePolynomial.detach">
<code class="sig-name descname">detach</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.ResponsePolynomial.detach" title="Permalink to this definition"></a></dt>
<dd><p>This method implements the <a class="reference internal" href="#api-python-datamodel-object"><span class="std std-ref">Object</span></a> interface.</p>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.ResponsePolynomial.clone">
<code class="sig-name descname">clone</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.ResponsePolynomial.clone" title="Permalink to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Return type</dt>
<dd class="field-odd"><p>A cloned ResponsePolynomial.</p>
</dd>
</dl>
<p>Returns a new instance that is a clone of the current instance. Child
objects are being ignored.</p>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.ResponsePolynomial.updateChild">
<code class="sig-name descname">updateChild</code><span class="sig-paren">(</span><em class="sig-param">ref</em><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.ResponsePolynomial.updateChild" title="Permalink to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>ref</strong> A child object derived from class Object.</p>
</dd>
<dt class="field-even">Return type</dt>
<dd class="field-even"><p>A Boolean flag indicating success with True, False otherwise</p>
</dd>
</dl>
<p>This method takes the passed reference object and searches for a child
with the same publicID (if derived from <a class="reference internal" href="#api-python-datamodel-publicobject"><span class="std std-ref">PublicObject</span></a>)
or the same index (if derived from <a class="reference internal" href="#api-python-datamodel-object"><span class="std std-ref">Object</span></a>).
The the child was found the reference objects attributes are copied to
the child object. Children of child are being ignored during this operation.
This method implements the <a class="reference internal" href="#api-python-datamodel-publicobject"><span class="std std-ref">PublicObject</span></a> interface.</p>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.ResponsePolynomial.accept">
<code class="sig-name descname">accept</code><span class="sig-paren">(</span><em class="sig-param">visitor</em><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.ResponsePolynomial.accept" title="Permalink to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>visitor</strong> A visitor.</p>
</dd>
</dl>
<p>This method implements the <a class="reference internal" href="#api-python-datamodel-publicobject"><span class="std std-ref">PublicObject</span></a> interface.</p>
</dd></dl>
</dd></dl>
</div>
<div class="section" id="route">
<span id="api-python-datamodel-route"></span><h3>Route<a class="headerlink" href="#route" title="Permalink to this headline"></a></h3>
<dl class="class">
<dt id="seiscomp.datamodel.Route">
<em class="property">class </em><code class="sig-prename descclassname">seiscomp.datamodel.</code><code class="sig-name descname">Route</code><a class="headerlink" href="#seiscomp.datamodel.Route" title="Permalink to this definition"></a></dt>
<dd><p>Inherits <a class="reference internal" href="#api-python-datamodel-publicobject"><span class="std std-ref">PublicObject</span></a>.</p>
<p>This type describes an ArcLink route (collection of servers that provide
specific datastreams)</p>
<p><strong>Parents</strong>:</p>
<ul class="simple">
<li><p><code class="docutils literal notranslate"><span class="pre">routing</span></code> <a class="reference internal" href="#api-python-datamodel-routing"><span class="std std-ref">Routing</span></a></p></li>
</ul>
<p><strong>Children</strong>:</p>
<ul class="simple">
<li><p><code class="docutils literal notranslate"><span class="pre">routeArclink</span></code> <a class="reference internal" href="#api-python-datamodel-routearclink"><span class="std std-ref">RouteArclink</span></a></p></li>
<li><p><code class="docutils literal notranslate"><span class="pre">routeSeedlink</span></code> <a class="reference internal" href="#api-python-datamodel-routeseedlink"><span class="std std-ref">RouteSeedlink</span></a></p></li>
</ul>
<p><strong>Attributes</strong>:</p>
<ul class="simple">
<li><p><code class="docutils literal notranslate"><span class="pre">publicID</span></code>: string</p></li>
<li><p><code class="docutils literal notranslate"><span class="pre">networkCode</span></code> string</p></li>
<li><p><code class="docutils literal notranslate"><span class="pre">stationCode</span></code> string</p></li>
<li><p><code class="docutils literal notranslate"><span class="pre">locationCode</span></code> string</p></li>
<li><p><code class="docutils literal notranslate"><span class="pre">streamCode</span></code> string</p></li>
</ul>
<p><strong>Methods</strong>:</p>
<dl class="method">
<dt id="seiscomp.datamodel.Route.Cast">
<em class="property">static </em><code class="sig-name descname">Cast</code><span class="sig-paren">(</span><em class="sig-param">obj</em><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.Route.Cast" title="Permalink to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>obj</strong> The object to be casted.</p>
</dd>
<dt class="field-even">Return type</dt>
<dd class="field-even"><p>An object of type Route if the cast was successful,
None otherwise.</p>
</dd>
</dl>
<p>Cast an arbitrary object to Route if the internal wrapped
representation is an Route object. The cast is important if
instances of type <a class="reference internal" href="#api-python-datamodel-object"><span class="std std-ref">Object</span></a>
are passed to methods which need access to the real type.</p>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.Route.Create">
<em class="property">static </em><code class="sig-name descname">Create</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.Route.Create" title="Permalink to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Return type</dt>
<dd class="field-odd"><p>A new object of type Route.</p>
</dd>
</dl>
<p>Creates and registers (if enabled) a Route instance. The
publicID is auto-generated.</p>
</dd></dl>
<dl class="method">
<dt>
<em class="property">static </em><code class="sig-name descname">Create</code><span class="sig-paren">(</span><em class="sig-param">publicID</em><span class="sig-paren">)</span></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Return type</dt>
<dd class="field-odd"><p>A new object of type Route.</p>
</dd>
</dl>
<p>Creates and registers (if enabled) a Route instance with
passed publicID.</p>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.Route.equal">
<code class="sig-name descname">equal</code><span class="sig-paren">(</span><em class="sig-param">other</em><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.Route.equal" title="Permalink to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>other</strong> Another object of type Route to compare this
instance to</p>
</dd>
<dt class="field-even">Return type</dt>
<dd class="field-even"><p>A Boolean value indicating True if both objects are equal or
False otherwise.</p>
</dd>
</dl>
<p>Compares two objects without its child objects. Both objects are compared
by value.</p>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.Route.index">
<code class="sig-name descname">index</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.Route.index" title="Permalink to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Return type</dt>
<dd class="field-odd"><p><p>The objects index of type RouteIndex.</p>
<p>Returns the objects index which is also used for the database as unique
constraint.</p>
</p>
</dd>
</dl>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.Route.equalIndex">
<code class="sig-name descname">equalIndex</code><span class="sig-paren">(</span><em class="sig-param">lhs</em><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.Route.equalIndex" title="Permalink to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>lhs</strong> <a class="reference internal" href="#api-python-datamodel-route"><span class="std std-ref">Route</span></a></p>
</dd>
<dt class="field-even">Return type</dt>
<dd class="field-even"><p>A Boolean value indicating True if both indexes are equal or
False otherwise.</p>
</dd>
</dl>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.Route.setNetworkCode">
<code class="sig-name descname">setNetworkCode</code><span class="sig-paren">(</span><em class="sig-param">networkCode</em><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.Route.setNetworkCode" title="Permalink to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>networkCode</strong> string</p>
</dd>
</dl>
<p>Network code</p>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.Route.networkCode">
<code class="sig-name descname">networkCode</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.Route.networkCode" title="Permalink to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Return type</dt>
<dd class="field-odd"><p>string</p>
</dd>
</dl>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.Route.setStationCode">
<code class="sig-name descname">setStationCode</code><span class="sig-paren">(</span><em class="sig-param">stationCode</em><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.Route.setStationCode" title="Permalink to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>stationCode</strong> string</p>
</dd>
</dl>
<p>Station code (empty for any station)</p>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.Route.stationCode">
<code class="sig-name descname">stationCode</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.Route.stationCode" title="Permalink to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Return type</dt>
<dd class="field-odd"><p>string</p>
</dd>
</dl>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.Route.setLocationCode">
<code class="sig-name descname">setLocationCode</code><span class="sig-paren">(</span><em class="sig-param">locationCode</em><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.Route.setLocationCode" title="Permalink to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>locationCode</strong> string</p>
</dd>
</dl>
<p>Location code (empty for any location)</p>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.Route.locationCode">
<code class="sig-name descname">locationCode</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.Route.locationCode" title="Permalink to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Return type</dt>
<dd class="field-odd"><p>string</p>
</dd>
</dl>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.Route.setStreamCode">
<code class="sig-name descname">setStreamCode</code><span class="sig-paren">(</span><em class="sig-param">streamCode</em><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.Route.setStreamCode" title="Permalink to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>streamCode</strong> string</p>
</dd>
</dl>
<p>Stream (Channel) code (empty for any stream)</p>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.Route.streamCode">
<code class="sig-name descname">streamCode</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.Route.streamCode" title="Permalink to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Return type</dt>
<dd class="field-odd"><p>string</p>
</dd>
</dl>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.Route.add">
<code class="sig-name descname">add</code><span class="sig-paren">(</span><em class="sig-param">routeArclink</em><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.Route.add" title="Permalink to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>routeArclink</strong> Object of type <a class="reference internal" href="#api-python-datamodel-routearclink"><span class="std std-ref">RouteArclink</span></a></p>
</dd>
<dt class="field-even">Return type</dt>
<dd class="field-even"><p>A Boolean value indicating success with True, False otherwise.</p>
</dd>
</dl>
<p>Adds a RouteArclink object to Route. The object is not
copied but managed by this instance. Any change to the passed object
will also change the child.</p>
</dd></dl>
<dl class="method">
<dt>
<code class="sig-name descname">add</code><span class="sig-paren">(</span><em class="sig-param">routeSeedlink</em><span class="sig-paren">)</span></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>routeSeedlink</strong> Object of type <a class="reference internal" href="#api-python-datamodel-routeseedlink"><span class="std std-ref">RouteSeedlink</span></a></p>
</dd>
<dt class="field-even">Return type</dt>
<dd class="field-even"><p>A Boolean value indicating success with True, False otherwise.</p>
</dd>
</dl>
<p>Adds a RouteSeedlink object to Route. The object is not
copied but managed by this instance. Any change to the passed object
will also change the child.</p>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.Route.remove">
<code class="sig-name descname">remove</code><span class="sig-paren">(</span><em class="sig-param">routeArclink</em><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.Route.remove" title="Permalink to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>routeArclink</strong> Object of type <a class="reference internal" href="#api-python-datamodel-routearclink"><span class="std std-ref">RouteArclink</span></a></p>
</dd>
<dt class="field-even">Return type</dt>
<dd class="field-even"><p>A Boolean value indicating success with True, False otherwise.</p>
</dd>
</dl>
<p>Removes a previously added RouteArclink object from Route.</p>
</dd></dl>
<dl class="method">
<dt>
<code class="sig-name descname">remove</code><span class="sig-paren">(</span><em class="sig-param">routeSeedlink</em><span class="sig-paren">)</span></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>routeSeedlink</strong> Object of type <a class="reference internal" href="#api-python-datamodel-routeseedlink"><span class="std std-ref">RouteSeedlink</span></a></p>
</dd>
<dt class="field-even">Return type</dt>
<dd class="field-even"><p>A Boolean value indicating success with True, False otherwise.</p>
</dd>
</dl>
<p>Removes a previously added RouteSeedlink object from Route.</p>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.Route.removeRouteArclink">
<code class="sig-name descname">removeRouteArclink</code><span class="sig-paren">(</span><em class="sig-param">idx</em><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.Route.removeRouteArclink" title="Permalink to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>idx</strong> An integer index of the object to be removed.</p>
</dd>
<dt class="field-even">Return type</dt>
<dd class="field-even"><p>A Boolean value indicating success with True, False otherwise.</p>
</dd>
</dl>
</dd></dl>
<dl class="method">
<dt>
<code class="sig-name descname">removeRouteArclink(routeArclinkIndex);</code></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>routeArclinkIndex</strong> The index of the object to be removed of type RouteArclinkIndex.</p>
</dd>
<dt class="field-even">Return type</dt>
<dd class="field-even"><p>A Boolean value indicating success with True, False otherwise.</p>
</dd>
</dl>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.Route.removeRouteSeedlink">
<code class="sig-name descname">removeRouteSeedlink</code><span class="sig-paren">(</span><em class="sig-param">idx</em><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.Route.removeRouteSeedlink" title="Permalink to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>idx</strong> An integer index of the object to be removed.</p>
</dd>
<dt class="field-even">Return type</dt>
<dd class="field-even"><p>A Boolean value indicating success with True, False otherwise.</p>
</dd>
</dl>
</dd></dl>
<dl class="method">
<dt>
<code class="sig-name descname">removeRouteSeedlink(routeSeedlinkIndex);</code></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>routeSeedlinkIndex</strong> The index of the object to be removed of type RouteSeedlinkIndex.</p>
</dd>
<dt class="field-even">Return type</dt>
<dd class="field-even"><p>A Boolean value indicating success with True, False otherwise.</p>
</dd>
</dl>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.Route.routeArclinkCount">
<code class="sig-name descname">routeArclinkCount</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.Route.routeArclinkCount" title="Permalink to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Return type</dt>
<dd class="field-odd"><p>integer value indicating the number of child objects.</p>
</dd>
</dl>
<p>Returns the number of RouteArclink child objects.</p>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.Route.routeSeedlinkCount">
<code class="sig-name descname">routeSeedlinkCount</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.Route.routeSeedlinkCount" title="Permalink to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Return type</dt>
<dd class="field-odd"><p>integer value indicating the number of child objects.</p>
</dd>
</dl>
<p>Returns the number of RouteSeedlink child objects.</p>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.Route.routeArclink">
<code class="sig-name descname">routeArclink</code><span class="sig-paren">(</span><em class="sig-param">idx</em><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.Route.routeArclink" title="Permalink to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>idx</strong> An integer index of the object to be returned.</p>
</dd>
<dt class="field-even">Return type</dt>
<dd class="field-even"><p>Object of type <a class="reference internal" href="#api-python-datamodel-routearclink"><span class="std std-ref">RouteArclink</span></a>.</p>
</dd>
</dl>
<p>Returns the RouteArclink at index idx.</p>
</dd></dl>
<dl class="method">
<dt>
<code class="sig-name descname">routeArclink</code><span class="sig-paren">(</span><em class="sig-param">routeArclinkIndex</em><span class="sig-paren">)</span></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>routeArclinkIndex</strong> The index of the object to be removed of type RouteArclinkIndex.</p>
</dd>
<dt class="field-even">Return type</dt>
<dd class="field-even"><p>Object of type <a class="reference internal" href="#api-python-datamodel-routearclink"><span class="std std-ref">RouteArclink</span></a>.</p>
</dd>
</dl>
<p>Returns the RouteArclink at given index. The indexes of all child objects
are compared by value which makes this function slower than the direct
integer index look-up.</p>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.Route.routeSeedlink">
<code class="sig-name descname">routeSeedlink</code><span class="sig-paren">(</span><em class="sig-param">idx</em><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.Route.routeSeedlink" title="Permalink to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>idx</strong> An integer index of the object to be returned.</p>
</dd>
<dt class="field-even">Return type</dt>
<dd class="field-even"><p>Object of type <a class="reference internal" href="#api-python-datamodel-routeseedlink"><span class="std std-ref">RouteSeedlink</span></a>.</p>
</dd>
</dl>
<p>Returns the RouteSeedlink at index idx.</p>
</dd></dl>
<dl class="method">
<dt>
<code class="sig-name descname">routeSeedlink</code><span class="sig-paren">(</span><em class="sig-param">routeSeedlinkIndex</em><span class="sig-paren">)</span></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>routeSeedlinkIndex</strong> The index of the object to be removed of type RouteSeedlinkIndex.</p>
</dd>
<dt class="field-even">Return type</dt>
<dd class="field-even"><p>Object of type <a class="reference internal" href="#api-python-datamodel-routeseedlink"><span class="std std-ref">RouteSeedlink</span></a>.</p>
</dd>
</dl>
<p>Returns the RouteSeedlink at given index. The indexes of all child objects
are compared by value which makes this function slower than the direct
integer index look-up.</p>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.Route.routing">
<code class="sig-name descname">routing</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.Route.routing" title="Permalink to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Return type</dt>
<dd class="field-odd"><p><a class="reference internal" href="#seiscomp.datamodel.Routing" title="seiscomp.datamodel.Routing">Routing</a></p>
</dd>
</dl>
<p>Returns the parent Routing if available. Returns None
if the parent is not a Routing. This is a convenience wrapper
for parent().</p>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.Route.assign">
<code class="sig-name descname">assign</code><span class="sig-paren">(</span><em class="sig-param">other</em><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.Route.assign" title="Permalink to this definition"></a></dt>
<dd><p>This method implements the <a class="reference internal" href="#api-python-datamodel-object"><span class="std std-ref">Object</span></a> interface.</p>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.Route.attachTo">
<code class="sig-name descname">attachTo</code><span class="sig-paren">(</span><em class="sig-param">parent</em><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.Route.attachTo" title="Permalink to this definition"></a></dt>
<dd><p>This method implements the <a class="reference internal" href="#api-python-datamodel-object"><span class="std std-ref">Object</span></a> interface.</p>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.Route.detachFrom">
<code class="sig-name descname">detachFrom</code><span class="sig-paren">(</span><em class="sig-param">parent</em><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.Route.detachFrom" title="Permalink to this definition"></a></dt>
<dd><p>This method implements the <a class="reference internal" href="#api-python-datamodel-object"><span class="std std-ref">Object</span></a> interface.</p>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.Route.detach">
<code class="sig-name descname">detach</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.Route.detach" title="Permalink to this definition"></a></dt>
<dd><p>This method implements the <a class="reference internal" href="#api-python-datamodel-object"><span class="std std-ref">Object</span></a> interface.</p>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.Route.clone">
<code class="sig-name descname">clone</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.Route.clone" title="Permalink to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Return type</dt>
<dd class="field-odd"><p>A cloned Route.</p>
</dd>
</dl>
<p>Returns a new instance that is a clone of the current instance. Child
objects are being ignored.</p>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.Route.updateChild">
<code class="sig-name descname">updateChild</code><span class="sig-paren">(</span><em class="sig-param">ref</em><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.Route.updateChild" title="Permalink to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>ref</strong> A child object derived from class Object.</p>
</dd>
<dt class="field-even">Return type</dt>
<dd class="field-even"><p>A Boolean flag indicating success with True, False otherwise</p>
</dd>
</dl>
<p>This method takes the passed reference object and searches for a child
with the same publicID (if derived from <a class="reference internal" href="#api-python-datamodel-publicobject"><span class="std std-ref">PublicObject</span></a>)
or the same index (if derived from <a class="reference internal" href="#api-python-datamodel-object"><span class="std std-ref">Object</span></a>).
The the child was found the reference objects attributes are copied to
the child object. Children of child are being ignored during this operation.
This method implements the <a class="reference internal" href="#api-python-datamodel-publicobject"><span class="std std-ref">PublicObject</span></a> interface.</p>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.Route.accept">
<code class="sig-name descname">accept</code><span class="sig-paren">(</span><em class="sig-param">visitor</em><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.Route.accept" title="Permalink to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>visitor</strong> A visitor.</p>
</dd>
</dl>
<p>This method implements the <a class="reference internal" href="#api-python-datamodel-publicobject"><span class="std std-ref">PublicObject</span></a> interface.</p>
</dd></dl>
</dd></dl>
</div>
<div class="section" id="routearclink">
<span id="api-python-datamodel-routearclink"></span><h3>RouteArclink<a class="headerlink" href="#routearclink" title="Permalink to this headline"></a></h3>
<dl class="class">
<dt id="seiscomp.datamodel.RouteArclink">
<em class="property">class </em><code class="sig-prename descclassname">seiscomp.datamodel.</code><code class="sig-name descname">RouteArclink</code><a class="headerlink" href="#seiscomp.datamodel.RouteArclink" title="Permalink to this definition"></a></dt>
<dd><p>Inherits <a class="reference internal" href="#api-python-datamodel-object"><span class="std std-ref">Object</span></a>.</p>
<p>This type describes an ArcLink route (data source)</p>
<p><strong>Parents</strong>:</p>
<ul class="simple">
<li><p><code class="docutils literal notranslate"><span class="pre">route</span></code> <a class="reference internal" href="#api-python-datamodel-route"><span class="std std-ref">Route</span></a></p></li>
</ul>
<p><strong>Attributes</strong>:</p>
<ul class="simple">
<li><p><code class="docutils literal notranslate"><span class="pre">address</span></code> string</p></li>
<li><p><code class="docutils literal notranslate"><span class="pre">start</span></code> seiscomp.core.Time</p></li>
<li><p><code class="docutils literal notranslate"><span class="pre">end</span></code> seiscomp.core.Time (optional)</p></li>
<li><p><code class="docutils literal notranslate"><span class="pre">priority</span></code> int (optional)</p></li>
</ul>
<p><strong>Methods</strong>:</p>
<dl class="method">
<dt id="seiscomp.datamodel.RouteArclink.Cast">
<em class="property">static </em><code class="sig-name descname">Cast</code><span class="sig-paren">(</span><em class="sig-param">obj</em><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.RouteArclink.Cast" title="Permalink to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>obj</strong> The object to be casted.</p>
</dd>
<dt class="field-even">Return type</dt>
<dd class="field-even"><p>An object of type RouteArclink if the cast was successful,
None otherwise.</p>
</dd>
</dl>
<p>Cast an arbitrary object to RouteArclink if the internal wrapped
representation is an RouteArclink object. The cast is important if
instances of type <a class="reference internal" href="#api-python-datamodel-object"><span class="std std-ref">Object</span></a>
are passed to methods which need access to the real type.</p>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.RouteArclink.equal">
<code class="sig-name descname">equal</code><span class="sig-paren">(</span><em class="sig-param">other</em><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.RouteArclink.equal" title="Permalink to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>other</strong> Another object of type RouteArclink to compare this
instance to</p>
</dd>
<dt class="field-even">Return type</dt>
<dd class="field-even"><p>A Boolean value indicating True if both objects are equal or
False otherwise.</p>
</dd>
</dl>
<p>Compares two objects without its child objects. Both objects are compared
by value.</p>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.RouteArclink.index">
<code class="sig-name descname">index</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.RouteArclink.index" title="Permalink to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Return type</dt>
<dd class="field-odd"><p><p>The objects index of type RouteArclinkIndex.</p>
<p>Returns the objects index which is also used for the database as unique
constraint.</p>
</p>
</dd>
</dl>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.RouteArclink.equalIndex">
<code class="sig-name descname">equalIndex</code><span class="sig-paren">(</span><em class="sig-param">lhs</em><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.RouteArclink.equalIndex" title="Permalink to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>lhs</strong> <a class="reference internal" href="#api-python-datamodel-routearclink"><span class="std std-ref">RouteArclink</span></a></p>
</dd>
<dt class="field-even">Return type</dt>
<dd class="field-even"><p>A Boolean value indicating True if both indexes are equal or
False otherwise.</p>
</dd>
</dl>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.RouteArclink.setAddress">
<code class="sig-name descname">setAddress</code><span class="sig-paren">(</span><em class="sig-param">address</em><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.RouteArclink.setAddress" title="Permalink to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>address</strong> string</p>
</dd>
</dl>
<p>Server address in ip:port format</p>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.RouteArclink.address">
<code class="sig-name descname">address</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.RouteArclink.address" title="Permalink to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Return type</dt>
<dd class="field-odd"><p>string</p>
</dd>
</dl>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.RouteArclink.setStart">
<code class="sig-name descname">setStart</code><span class="sig-paren">(</span><em class="sig-param">start</em><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.RouteArclink.setStart" title="Permalink to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>start</strong> seiscomp.core.Time</p>
</dd>
</dl>
<p>Start of data</p>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.RouteArclink.start">
<code class="sig-name descname">start</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.RouteArclink.start" title="Permalink to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Return type</dt>
<dd class="field-odd"><p>seiscomp.core.Time</p>
</dd>
</dl>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.RouteArclink.setEnd">
<code class="sig-name descname">setEnd</code><span class="sig-paren">(</span><em class="sig-param">end</em><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.RouteArclink.setEnd" title="Permalink to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>end</strong> seiscomp.core.Time</p>
</dd>
</dl>
<p>End of data</p>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.RouteArclink.end">
<code class="sig-name descname">end</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.RouteArclink.end" title="Permalink to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Return type</dt>
<dd class="field-odd"><p>seiscomp.core.Time</p>
</dd>
</dl>
<div class="admonition note">
<p class="admonition-title">Note</p>
<p>As this attribute is optional, this method throws a ValueError if
the value of the attribute is not set.</p>
</div>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.RouteArclink.setPriority">
<code class="sig-name descname">setPriority</code><span class="sig-paren">(</span><em class="sig-param">priority</em><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.RouteArclink.setPriority" title="Permalink to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>priority</strong> int</p>
</dd>
</dl>
<p>priority (1 is highest)</p>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.RouteArclink.priority">
<code class="sig-name descname">priority</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.RouteArclink.priority" title="Permalink to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Return type</dt>
<dd class="field-odd"><p>int</p>
</dd>
</dl>
<div class="admonition note">
<p class="admonition-title">Note</p>
<p>As this attribute is optional, this method throws a ValueError if
the value of the attribute is not set.</p>
</div>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.RouteArclink.route">
<code class="sig-name descname">route</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.RouteArclink.route" title="Permalink to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Return type</dt>
<dd class="field-odd"><p><a class="reference internal" href="#seiscomp.datamodel.Route" title="seiscomp.datamodel.Route">Route</a></p>
</dd>
</dl>
<p>Returns the parent Route if available. Returns None
if the parent is not a Route. This is a convenience wrapper
for parent().</p>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.RouteArclink.assign">
<code class="sig-name descname">assign</code><span class="sig-paren">(</span><em class="sig-param">other</em><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.RouteArclink.assign" title="Permalink to this definition"></a></dt>
<dd><p>This method implements the <a class="reference internal" href="#api-python-datamodel-object"><span class="std std-ref">Object</span></a> interface.</p>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.RouteArclink.attachTo">
<code class="sig-name descname">attachTo</code><span class="sig-paren">(</span><em class="sig-param">parent</em><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.RouteArclink.attachTo" title="Permalink to this definition"></a></dt>
<dd><p>This method implements the <a class="reference internal" href="#api-python-datamodel-object"><span class="std std-ref">Object</span></a> interface.</p>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.RouteArclink.detachFrom">
<code class="sig-name descname">detachFrom</code><span class="sig-paren">(</span><em class="sig-param">parent</em><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.RouteArclink.detachFrom" title="Permalink to this definition"></a></dt>
<dd><p>This method implements the <a class="reference internal" href="#api-python-datamodel-object"><span class="std std-ref">Object</span></a> interface.</p>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.RouteArclink.detach">
<code class="sig-name descname">detach</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.RouteArclink.detach" title="Permalink to this definition"></a></dt>
<dd><p>This method implements the <a class="reference internal" href="#api-python-datamodel-object"><span class="std std-ref">Object</span></a> interface.</p>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.RouteArclink.clone">
<code class="sig-name descname">clone</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.RouteArclink.clone" title="Permalink to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Return type</dt>
<dd class="field-odd"><p>A cloned RouteArclink.</p>
</dd>
</dl>
<p>Returns a new instance that is a clone of the current instance. Child
objects are being ignored.</p>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.RouteArclink.accept">
<code class="sig-name descname">accept</code><span class="sig-paren">(</span><em class="sig-param">visitor</em><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.RouteArclink.accept" title="Permalink to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>visitor</strong> A visitor.</p>
</dd>
</dl>
<p>This method implements the <a class="reference internal" href="#api-python-datamodel-publicobject"><span class="std std-ref">PublicObject</span></a> interface.</p>
</dd></dl>
</dd></dl>
</div>
<div class="section" id="routeseedlink">
<span id="api-python-datamodel-routeseedlink"></span><h3>RouteSeedlink<a class="headerlink" href="#routeseedlink" title="Permalink to this headline"></a></h3>
<dl class="class">
<dt id="seiscomp.datamodel.RouteSeedlink">
<em class="property">class </em><code class="sig-prename descclassname">seiscomp.datamodel.</code><code class="sig-name descname">RouteSeedlink</code><a class="headerlink" href="#seiscomp.datamodel.RouteSeedlink" title="Permalink to this definition"></a></dt>
<dd><p>Inherits <a class="reference internal" href="#api-python-datamodel-object"><span class="std std-ref">Object</span></a>.</p>
<p>This type describes an SeedLink route (data source)</p>
<p><strong>Parents</strong>:</p>
<ul class="simple">
<li><p><code class="docutils literal notranslate"><span class="pre">route</span></code> <a class="reference internal" href="#api-python-datamodel-route"><span class="std std-ref">Route</span></a></p></li>
</ul>
<p><strong>Attributes</strong>:</p>
<ul class="simple">
<li><p><code class="docutils literal notranslate"><span class="pre">address</span></code> string</p></li>
<li><p><code class="docutils literal notranslate"><span class="pre">priority</span></code> int (optional)</p></li>
</ul>
<p><strong>Methods</strong>:</p>
<dl class="method">
<dt id="seiscomp.datamodel.RouteSeedlink.Cast">
<em class="property">static </em><code class="sig-name descname">Cast</code><span class="sig-paren">(</span><em class="sig-param">obj</em><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.RouteSeedlink.Cast" title="Permalink to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>obj</strong> The object to be casted.</p>
</dd>
<dt class="field-even">Return type</dt>
<dd class="field-even"><p>An object of type RouteSeedlink if the cast was successful,
None otherwise.</p>
</dd>
</dl>
<p>Cast an arbitrary object to RouteSeedlink if the internal wrapped
representation is an RouteSeedlink object. The cast is important if
instances of type <a class="reference internal" href="#api-python-datamodel-object"><span class="std std-ref">Object</span></a>
are passed to methods which need access to the real type.</p>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.RouteSeedlink.equal">
<code class="sig-name descname">equal</code><span class="sig-paren">(</span><em class="sig-param">other</em><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.RouteSeedlink.equal" title="Permalink to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>other</strong> Another object of type RouteSeedlink to compare this
instance to</p>
</dd>
<dt class="field-even">Return type</dt>
<dd class="field-even"><p>A Boolean value indicating True if both objects are equal or
False otherwise.</p>
</dd>
</dl>
<p>Compares two objects without its child objects. Both objects are compared
by value.</p>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.RouteSeedlink.index">
<code class="sig-name descname">index</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.RouteSeedlink.index" title="Permalink to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Return type</dt>
<dd class="field-odd"><p><p>The objects index of type RouteSeedlinkIndex.</p>
<p>Returns the objects index which is also used for the database as unique
constraint.</p>
</p>
</dd>
</dl>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.RouteSeedlink.equalIndex">
<code class="sig-name descname">equalIndex</code><span class="sig-paren">(</span><em class="sig-param">lhs</em><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.RouteSeedlink.equalIndex" title="Permalink to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>lhs</strong> <a class="reference internal" href="#api-python-datamodel-routeseedlink"><span class="std std-ref">RouteSeedlink</span></a></p>
</dd>
<dt class="field-even">Return type</dt>
<dd class="field-even"><p>A Boolean value indicating True if both indexes are equal or
False otherwise.</p>
</dd>
</dl>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.RouteSeedlink.setAddress">
<code class="sig-name descname">setAddress</code><span class="sig-paren">(</span><em class="sig-param">address</em><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.RouteSeedlink.setAddress" title="Permalink to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>address</strong> string</p>
</dd>
</dl>
<p>Server address in ip:port format</p>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.RouteSeedlink.address">
<code class="sig-name descname">address</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.RouteSeedlink.address" title="Permalink to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Return type</dt>
<dd class="field-odd"><p>string</p>
</dd>
</dl>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.RouteSeedlink.setPriority">
<code class="sig-name descname">setPriority</code><span class="sig-paren">(</span><em class="sig-param">priority</em><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.RouteSeedlink.setPriority" title="Permalink to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>priority</strong> int</p>
</dd>
</dl>
<p>priority (1 is highest)</p>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.RouteSeedlink.priority">
<code class="sig-name descname">priority</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.RouteSeedlink.priority" title="Permalink to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Return type</dt>
<dd class="field-odd"><p>int</p>
</dd>
</dl>
<div class="admonition note">
<p class="admonition-title">Note</p>
<p>As this attribute is optional, this method throws a ValueError if
the value of the attribute is not set.</p>
</div>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.RouteSeedlink.route">
<code class="sig-name descname">route</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.RouteSeedlink.route" title="Permalink to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Return type</dt>
<dd class="field-odd"><p><a class="reference internal" href="#seiscomp.datamodel.Route" title="seiscomp.datamodel.Route">Route</a></p>
</dd>
</dl>
<p>Returns the parent Route if available. Returns None
if the parent is not a Route. This is a convenience wrapper
for parent().</p>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.RouteSeedlink.assign">
<code class="sig-name descname">assign</code><span class="sig-paren">(</span><em class="sig-param">other</em><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.RouteSeedlink.assign" title="Permalink to this definition"></a></dt>
<dd><p>This method implements the <a class="reference internal" href="#api-python-datamodel-object"><span class="std std-ref">Object</span></a> interface.</p>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.RouteSeedlink.attachTo">
<code class="sig-name descname">attachTo</code><span class="sig-paren">(</span><em class="sig-param">parent</em><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.RouteSeedlink.attachTo" title="Permalink to this definition"></a></dt>
<dd><p>This method implements the <a class="reference internal" href="#api-python-datamodel-object"><span class="std std-ref">Object</span></a> interface.</p>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.RouteSeedlink.detachFrom">
<code class="sig-name descname">detachFrom</code><span class="sig-paren">(</span><em class="sig-param">parent</em><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.RouteSeedlink.detachFrom" title="Permalink to this definition"></a></dt>
<dd><p>This method implements the <a class="reference internal" href="#api-python-datamodel-object"><span class="std std-ref">Object</span></a> interface.</p>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.RouteSeedlink.detach">
<code class="sig-name descname">detach</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.RouteSeedlink.detach" title="Permalink to this definition"></a></dt>
<dd><p>This method implements the <a class="reference internal" href="#api-python-datamodel-object"><span class="std std-ref">Object</span></a> interface.</p>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.RouteSeedlink.clone">
<code class="sig-name descname">clone</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.RouteSeedlink.clone" title="Permalink to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Return type</dt>
<dd class="field-odd"><p>A cloned RouteSeedlink.</p>
</dd>
</dl>
<p>Returns a new instance that is a clone of the current instance. Child
objects are being ignored.</p>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.RouteSeedlink.accept">
<code class="sig-name descname">accept</code><span class="sig-paren">(</span><em class="sig-param">visitor</em><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.RouteSeedlink.accept" title="Permalink to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>visitor</strong> A visitor.</p>
</dd>
</dl>
<p>This method implements the <a class="reference internal" href="#api-python-datamodel-publicobject"><span class="std std-ref">PublicObject</span></a> interface.</p>
</dd></dl>
</dd></dl>
</div>
<div class="section" id="api-python-datamodel-routing">
<span id="id18"></span><h3>Routing<a class="headerlink" href="#api-python-datamodel-routing" title="Permalink to this headline"></a></h3>
<dl class="class">
<dt id="seiscomp.datamodel.Routing">
<em class="property">class </em><code class="sig-prename descclassname">seiscomp.datamodel.</code><code class="sig-name descname">Routing</code><a class="headerlink" href="#seiscomp.datamodel.Routing" title="Permalink to this definition"></a></dt>
<dd><p>Inherits <a class="reference internal" href="#api-python-datamodel-publicobject"><span class="std std-ref">PublicObject</span></a>.</p>
<p><strong>Children</strong>:</p>
<ul class="simple">
<li><p><code class="docutils literal notranslate"><span class="pre">route</span></code> <a class="reference internal" href="#api-python-datamodel-route"><span class="std std-ref">Route</span></a></p></li>
<li><p><code class="docutils literal notranslate"><span class="pre">access</span></code> <a class="reference internal" href="#api-python-datamodel-access"><span class="std std-ref">Access</span></a></p></li>
</ul>
<p><strong>Attributes</strong>:</p>
<ul class="simple">
<li><p><code class="docutils literal notranslate"><span class="pre">publicID</span></code>: string</p></li>
</ul>
<p><strong>Methods</strong>:</p>
<dl class="method">
<dt id="seiscomp.datamodel.Routing.Cast">
<em class="property">static </em><code class="sig-name descname">Cast</code><span class="sig-paren">(</span><em class="sig-param">obj</em><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.Routing.Cast" title="Permalink to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>obj</strong> The object to be casted.</p>
</dd>
<dt class="field-even">Return type</dt>
<dd class="field-even"><p>An object of type Routing if the cast was successful,
None otherwise.</p>
</dd>
</dl>
<p>Cast an arbitrary object to Routing if the internal wrapped
representation is an Routing object. The cast is important if
instances of type <a class="reference internal" href="#api-python-datamodel-object"><span class="std std-ref">Object</span></a>
are passed to methods which need access to the real type.</p>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.Routing.equal">
<code class="sig-name descname">equal</code><span class="sig-paren">(</span><em class="sig-param">other</em><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.Routing.equal" title="Permalink to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>other</strong> Another object of type Routing to compare this
instance to</p>
</dd>
<dt class="field-even">Return type</dt>
<dd class="field-even"><p>A Boolean value indicating True if both objects are equal or
False otherwise.</p>
</dd>
</dl>
<p>Compares two objects without its child objects. Both objects are compared
by value.</p>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.Routing.add">
<code class="sig-name descname">add</code><span class="sig-paren">(</span><em class="sig-param">route</em><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.Routing.add" title="Permalink to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>route</strong> Object of type <a class="reference internal" href="#api-python-datamodel-route"><span class="std std-ref">Route</span></a></p>
</dd>
<dt class="field-even">Return type</dt>
<dd class="field-even"><p>A Boolean value indicating success with True, False otherwise.</p>
</dd>
</dl>
<p>Adds a Route object to Routing. The object is not
copied but managed by this instance. Any change to the passed object
will also change the child.</p>
</dd></dl>
<dl class="method">
<dt>
<code class="sig-name descname">add</code><span class="sig-paren">(</span><em class="sig-param">access</em><span class="sig-paren">)</span></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>access</strong> Object of type <a class="reference internal" href="#api-python-datamodel-access"><span class="std std-ref">Access</span></a></p>
</dd>
<dt class="field-even">Return type</dt>
<dd class="field-even"><p>A Boolean value indicating success with True, False otherwise.</p>
</dd>
</dl>
<p>Adds a Access object to Routing. The object is not
copied but managed by this instance. Any change to the passed object
will also change the child.</p>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.Routing.remove">
<code class="sig-name descname">remove</code><span class="sig-paren">(</span><em class="sig-param">route</em><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.Routing.remove" title="Permalink to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>route</strong> Object of type <a class="reference internal" href="#api-python-datamodel-route"><span class="std std-ref">Route</span></a></p>
</dd>
<dt class="field-even">Return type</dt>
<dd class="field-even"><p>A Boolean value indicating success with True, False otherwise.</p>
</dd>
</dl>
<p>Removes a previously added Route object from Routing.</p>
</dd></dl>
<dl class="method">
<dt>
<code class="sig-name descname">remove</code><span class="sig-paren">(</span><em class="sig-param">access</em><span class="sig-paren">)</span></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>access</strong> Object of type <a class="reference internal" href="#api-python-datamodel-access"><span class="std std-ref">Access</span></a></p>
</dd>
<dt class="field-even">Return type</dt>
<dd class="field-even"><p>A Boolean value indicating success with True, False otherwise.</p>
</dd>
</dl>
<p>Removes a previously added Access object from Routing.</p>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.Routing.removeRoute">
<code class="sig-name descname">removeRoute</code><span class="sig-paren">(</span><em class="sig-param">idx</em><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.Routing.removeRoute" title="Permalink to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>idx</strong> An integer index of the object to be removed.</p>
</dd>
<dt class="field-even">Return type</dt>
<dd class="field-even"><p>A Boolean value indicating success with True, False otherwise.</p>
</dd>
</dl>
</dd></dl>
<dl class="method">
<dt>
<code class="sig-name descname">removeRoute(routeIndex);</code></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>routeIndex</strong> The index of the object to be removed of type RouteIndex.</p>
</dd>
<dt class="field-even">Return type</dt>
<dd class="field-even"><p>A Boolean value indicating success with True, False otherwise.</p>
</dd>
</dl>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.Routing.removeAccess">
<code class="sig-name descname">removeAccess</code><span class="sig-paren">(</span><em class="sig-param">idx</em><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.Routing.removeAccess" title="Permalink to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>idx</strong> An integer index of the object to be removed.</p>
</dd>
<dt class="field-even">Return type</dt>
<dd class="field-even"><p>A Boolean value indicating success with True, False otherwise.</p>
</dd>
</dl>
</dd></dl>
<dl class="method">
<dt>
<code class="sig-name descname">removeAccess(accessIndex);</code></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>accessIndex</strong> The index of the object to be removed of type AccessIndex.</p>
</dd>
<dt class="field-even">Return type</dt>
<dd class="field-even"><p>A Boolean value indicating success with True, False otherwise.</p>
</dd>
</dl>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.Routing.routeCount">
<code class="sig-name descname">routeCount</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.Routing.routeCount" title="Permalink to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Return type</dt>
<dd class="field-odd"><p>integer value indicating the number of child objects.</p>
</dd>
</dl>
<p>Returns the number of Route child objects.</p>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.Routing.accessCount">
<code class="sig-name descname">accessCount</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.Routing.accessCount" title="Permalink to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Return type</dt>
<dd class="field-odd"><p>integer value indicating the number of child objects.</p>
</dd>
</dl>
<p>Returns the number of Access child objects.</p>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.Routing.route">
<code class="sig-name descname">route</code><span class="sig-paren">(</span><em class="sig-param">idx</em><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.Routing.route" title="Permalink to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>idx</strong> An integer index of the object to be returned.</p>
</dd>
<dt class="field-even">Return type</dt>
<dd class="field-even"><p>Object of type <a class="reference internal" href="#api-python-datamodel-route"><span class="std std-ref">Route</span></a>.</p>
</dd>
</dl>
<p>Returns the Route at index idx.</p>
</dd></dl>
<dl class="method">
<dt>
<code class="sig-name descname">route</code><span class="sig-paren">(</span><em class="sig-param">routeIndex</em><span class="sig-paren">)</span></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>routeIndex</strong> The index of the object to be removed of type RouteIndex.</p>
</dd>
<dt class="field-even">Return type</dt>
<dd class="field-even"><p>Object of type <a class="reference internal" href="#api-python-datamodel-route"><span class="std std-ref">Route</span></a>.</p>
</dd>
</dl>
<p>Returns the Route at given index. The indexes of all child objects
are compared by value which makes this function slower than the direct
integer index look-up.</p>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.Routing.access">
<code class="sig-name descname">access</code><span class="sig-paren">(</span><em class="sig-param">idx</em><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.Routing.access" title="Permalink to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>idx</strong> An integer index of the object to be returned.</p>
</dd>
<dt class="field-even">Return type</dt>
<dd class="field-even"><p>Object of type <a class="reference internal" href="#api-python-datamodel-access"><span class="std std-ref">Access</span></a>.</p>
</dd>
</dl>
<p>Returns the Access at index idx.</p>
</dd></dl>
<dl class="method">
<dt>
<code class="sig-name descname">access</code><span class="sig-paren">(</span><em class="sig-param">accessIndex</em><span class="sig-paren">)</span></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>accessIndex</strong> The index of the object to be removed of type AccessIndex.</p>
</dd>
<dt class="field-even">Return type</dt>
<dd class="field-even"><p>Object of type <a class="reference internal" href="#api-python-datamodel-access"><span class="std std-ref">Access</span></a>.</p>
</dd>
</dl>
<p>Returns the Access at given index. The indexes of all child objects
are compared by value which makes this function slower than the direct
integer index look-up.</p>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.Routing.findRoute">
<code class="sig-name descname">findRoute</code><span class="sig-paren">(</span><em class="sig-param">publicID</em><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.Routing.findRoute" title="Permalink to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>publicID</strong> The publicID of the object to find.</p>
</dd>
<dt class="field-even">Return type</dt>
<dd class="field-even"><p>Object of type <a class="reference internal" href="#api-python-datamodel-route"><span class="std std-ref">Route</span></a>.</p>
</dd>
</dl>
<p>Returns the child object with a certain publicID, None otherwise.</p>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.Routing.assign">
<code class="sig-name descname">assign</code><span class="sig-paren">(</span><em class="sig-param">other</em><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.Routing.assign" title="Permalink to this definition"></a></dt>
<dd><p>This method implements the <a class="reference internal" href="#api-python-datamodel-object"><span class="std std-ref">Object</span></a> interface.</p>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.Routing.attachTo">
<code class="sig-name descname">attachTo</code><span class="sig-paren">(</span><em class="sig-param">parent</em><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.Routing.attachTo" title="Permalink to this definition"></a></dt>
<dd><p>This method implements the <a class="reference internal" href="#api-python-datamodel-object"><span class="std std-ref">Object</span></a> interface.</p>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.Routing.detachFrom">
<code class="sig-name descname">detachFrom</code><span class="sig-paren">(</span><em class="sig-param">parent</em><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.Routing.detachFrom" title="Permalink to this definition"></a></dt>
<dd><p>This method implements the <a class="reference internal" href="#api-python-datamodel-object"><span class="std std-ref">Object</span></a> interface.</p>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.Routing.detach">
<code class="sig-name descname">detach</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.Routing.detach" title="Permalink to this definition"></a></dt>
<dd><p>This method implements the <a class="reference internal" href="#api-python-datamodel-object"><span class="std std-ref">Object</span></a> interface.</p>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.Routing.clone">
<code class="sig-name descname">clone</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.Routing.clone" title="Permalink to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Return type</dt>
<dd class="field-odd"><p>A cloned Routing.</p>
</dd>
</dl>
<p>Returns a new instance that is a clone of the current instance. Child
objects are being ignored.</p>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.Routing.updateChild">
<code class="sig-name descname">updateChild</code><span class="sig-paren">(</span><em class="sig-param">ref</em><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.Routing.updateChild" title="Permalink to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>ref</strong> A child object derived from class Object.</p>
</dd>
<dt class="field-even">Return type</dt>
<dd class="field-even"><p>A Boolean flag indicating success with True, False otherwise</p>
</dd>
</dl>
<p>This method takes the passed reference object and searches for a child
with the same publicID (if derived from <a class="reference internal" href="#api-python-datamodel-publicobject"><span class="std std-ref">PublicObject</span></a>)
or the same index (if derived from <a class="reference internal" href="#api-python-datamodel-object"><span class="std std-ref">Object</span></a>).
The the child was found the reference objects attributes are copied to
the child object. Children of child are being ignored during this operation.
This method implements the <a class="reference internal" href="#api-python-datamodel-publicobject"><span class="std std-ref">PublicObject</span></a> interface.</p>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.Routing.accept">
<code class="sig-name descname">accept</code><span class="sig-paren">(</span><em class="sig-param">visitor</em><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.Routing.accept" title="Permalink to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>visitor</strong> A visitor.</p>
</dd>
</dl>
<p>This method implements the <a class="reference internal" href="#api-python-datamodel-publicobject"><span class="std std-ref">PublicObject</span></a> interface.</p>
</dd></dl>
</dd></dl>
</div>
<div class="section" id="sensor">
<span id="api-python-datamodel-sensor"></span><h3>Sensor<a class="headerlink" href="#sensor" title="Permalink to this headline"></a></h3>
<dl class="class">
<dt id="seiscomp.datamodel.Sensor">
<em class="property">class </em><code class="sig-prename descclassname">seiscomp.datamodel.</code><code class="sig-name descname">Sensor</code><a class="headerlink" href="#seiscomp.datamodel.Sensor" title="Permalink to this definition"></a></dt>
<dd><p>Inherits <a class="reference internal" href="#api-python-datamodel-publicobject"><span class="std std-ref">PublicObject</span></a>.</p>
<p>This type describes a sensor</p>
<p><strong>Parents</strong>:</p>
<ul class="simple">
<li><p><code class="docutils literal notranslate"><span class="pre">inventory</span></code> <a class="reference internal" href="#api-python-datamodel-inventory"><span class="std std-ref">Inventory</span></a></p></li>
</ul>
<p><strong>Children</strong>:</p>
<ul class="simple">
<li><p><code class="docutils literal notranslate"><span class="pre">sensorCalibration</span></code> <a class="reference internal" href="#api-python-datamodel-sensorcalibration"><span class="std std-ref">SensorCalibration</span></a></p></li>
</ul>
<p><strong>Attributes</strong>:</p>
<ul class="simple">
<li><p><code class="docutils literal notranslate"><span class="pre">publicID</span></code>: string</p></li>
<li><p><code class="docutils literal notranslate"><span class="pre">name</span></code> string</p></li>
<li><p><code class="docutils literal notranslate"><span class="pre">description</span></code> string</p></li>
<li><p><code class="docutils literal notranslate"><span class="pre">model</span></code> string</p></li>
<li><p><code class="docutils literal notranslate"><span class="pre">manufacturer</span></code> string</p></li>
<li><p><code class="docutils literal notranslate"><span class="pre">type</span></code> string</p></li>
<li><p><code class="docutils literal notranslate"><span class="pre">unit</span></code> string</p></li>
<li><p><code class="docutils literal notranslate"><span class="pre">lowFrequency</span></code> float (optional)</p></li>
<li><p><code class="docutils literal notranslate"><span class="pre">highFrequency</span></code> float (optional)</p></li>
<li><p><code class="docutils literal notranslate"><span class="pre">response</span></code> string</p></li>
<li><p><code class="docutils literal notranslate"><span class="pre">remark</span></code> <a class="reference internal" href="#api-python-datamodel-blob"><span class="std std-ref">Blob</span></a> (optional)</p></li>
</ul>
<p><strong>Referenced by</strong>:</p>
<ul class="simple">
<li><p><a class="reference internal" href="#seiscomp.datamodel.Stream.sensor" title="seiscomp.datamodel.Stream.sensor"><code class="xref py py-func docutils literal notranslate"><span class="pre">Stream.sensor()</span></code></a></p></li>
</ul>
<p><strong>Methods</strong>:</p>
<dl class="method">
<dt id="seiscomp.datamodel.Sensor.Cast">
<em class="property">static </em><code class="sig-name descname">Cast</code><span class="sig-paren">(</span><em class="sig-param">obj</em><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.Sensor.Cast" title="Permalink to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>obj</strong> The object to be casted.</p>
</dd>
<dt class="field-even">Return type</dt>
<dd class="field-even"><p>An object of type Sensor if the cast was successful,
None otherwise.</p>
</dd>
</dl>
<p>Cast an arbitrary object to Sensor if the internal wrapped
representation is an Sensor object. The cast is important if
instances of type <a class="reference internal" href="#api-python-datamodel-object"><span class="std std-ref">Object</span></a>
are passed to methods which need access to the real type.</p>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.Sensor.Create">
<em class="property">static </em><code class="sig-name descname">Create</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.Sensor.Create" title="Permalink to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Return type</dt>
<dd class="field-odd"><p>A new object of type Sensor.</p>
</dd>
</dl>
<p>Creates and registers (if enabled) a Sensor instance. The
publicID is auto-generated.</p>
</dd></dl>
<dl class="method">
<dt>
<em class="property">static </em><code class="sig-name descname">Create</code><span class="sig-paren">(</span><em class="sig-param">publicID</em><span class="sig-paren">)</span></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Return type</dt>
<dd class="field-odd"><p>A new object of type Sensor.</p>
</dd>
</dl>
<p>Creates and registers (if enabled) a Sensor instance with
passed publicID.</p>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.Sensor.equal">
<code class="sig-name descname">equal</code><span class="sig-paren">(</span><em class="sig-param">other</em><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.Sensor.equal" title="Permalink to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>other</strong> Another object of type Sensor to compare this
instance to</p>
</dd>
<dt class="field-even">Return type</dt>
<dd class="field-even"><p>A Boolean value indicating True if both objects are equal or
False otherwise.</p>
</dd>
</dl>
<p>Compares two objects without its child objects. Both objects are compared
by value.</p>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.Sensor.index">
<code class="sig-name descname">index</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.Sensor.index" title="Permalink to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Return type</dt>
<dd class="field-odd"><p><p>The objects index of type SensorIndex.</p>
<p>Returns the objects index which is also used for the database as unique
constraint.</p>
</p>
</dd>
</dl>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.Sensor.equalIndex">
<code class="sig-name descname">equalIndex</code><span class="sig-paren">(</span><em class="sig-param">lhs</em><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.Sensor.equalIndex" title="Permalink to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>lhs</strong> <a class="reference internal" href="#api-python-datamodel-sensor"><span class="std std-ref">Sensor</span></a></p>
</dd>
<dt class="field-even">Return type</dt>
<dd class="field-even"><p>A Boolean value indicating True if both indexes are equal or
False otherwise.</p>
</dd>
</dl>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.Sensor.setName">
<code class="sig-name descname">setName</code><span class="sig-paren">(</span><em class="sig-param">name</em><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.Sensor.setName" title="Permalink to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>name</strong> string</p>
</dd>
</dl>
<p>Unique sensor name</p>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.Sensor.name">
<code class="sig-name descname">name</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.Sensor.name" title="Permalink to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Return type</dt>
<dd class="field-odd"><p>string</p>
</dd>
</dl>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.Sensor.setDescription">
<code class="sig-name descname">setDescription</code><span class="sig-paren">(</span><em class="sig-param">description</em><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.Sensor.setDescription" title="Permalink to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>description</strong> string</p>
</dd>
</dl>
<p>Sensor description</p>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.Sensor.description">
<code class="sig-name descname">description</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.Sensor.description" title="Permalink to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Return type</dt>
<dd class="field-odd"><p>string</p>
</dd>
</dl>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.Sensor.setModel">
<code class="sig-name descname">setModel</code><span class="sig-paren">(</span><em class="sig-param">model</em><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.Sensor.setModel" title="Permalink to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>model</strong> string</p>
</dd>
</dl>
<p>Sensor model</p>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.Sensor.model">
<code class="sig-name descname">model</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.Sensor.model" title="Permalink to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Return type</dt>
<dd class="field-odd"><p>string</p>
</dd>
</dl>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.Sensor.setManufacturer">
<code class="sig-name descname">setManufacturer</code><span class="sig-paren">(</span><em class="sig-param">manufacturer</em><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.Sensor.setManufacturer" title="Permalink to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>manufacturer</strong> string</p>
</dd>
</dl>
<p>Sensor manufacturer</p>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.Sensor.manufacturer">
<code class="sig-name descname">manufacturer</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.Sensor.manufacturer" title="Permalink to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Return type</dt>
<dd class="field-odd"><p>string</p>
</dd>
</dl>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.Sensor.setType">
<code class="sig-name descname">setType</code><span class="sig-paren">(</span><em class="sig-param">type</em><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.Sensor.setType" title="Permalink to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>type</strong> string</p>
</dd>
</dl>
<p>Sensor type (VBB, BB, SP, SM, OBS)</p>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.Sensor.type">
<code class="sig-name descname">type</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.Sensor.type" title="Permalink to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Return type</dt>
<dd class="field-odd"><p>string</p>
</dd>
</dl>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.Sensor.setUnit">
<code class="sig-name descname">setUnit</code><span class="sig-paren">(</span><em class="sig-param">unit</em><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.Sensor.setUnit" title="Permalink to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>unit</strong> string</p>
</dd>
</dl>
<p>Unit of measurement (M, M/S, M/S**2, RAD/S, V, A, PA, C)</p>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.Sensor.unit">
<code class="sig-name descname">unit</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.Sensor.unit" title="Permalink to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Return type</dt>
<dd class="field-odd"><p>string</p>
</dd>
</dl>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.Sensor.setLowFrequency">
<code class="sig-name descname">setLowFrequency</code><span class="sig-paren">(</span><em class="sig-param">lowFrequency</em><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.Sensor.setLowFrequency" title="Permalink to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>lowFrequency</strong> float</p>
</dd>
</dl>
<p>Lower corner frequency (optional)</p>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.Sensor.lowFrequency">
<code class="sig-name descname">lowFrequency</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.Sensor.lowFrequency" title="Permalink to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Return type</dt>
<dd class="field-odd"><p>float</p>
</dd>
</dl>
<div class="admonition note">
<p class="admonition-title">Note</p>
<p>As this attribute is optional, this method throws a ValueError if
the value of the attribute is not set.</p>
</div>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.Sensor.setHighFrequency">
<code class="sig-name descname">setHighFrequency</code><span class="sig-paren">(</span><em class="sig-param">highFrequency</em><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.Sensor.setHighFrequency" title="Permalink to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>highFrequency</strong> float</p>
</dd>
</dl>
<p>Higher corner frequency (optional)</p>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.Sensor.highFrequency">
<code class="sig-name descname">highFrequency</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.Sensor.highFrequency" title="Permalink to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Return type</dt>
<dd class="field-odd"><p>float</p>
</dd>
</dl>
<div class="admonition note">
<p class="admonition-title">Note</p>
<p>As this attribute is optional, this method throws a ValueError if
the value of the attribute is not set.</p>
</div>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.Sensor.setResponse">
<code class="sig-name descname">setResponse</code><span class="sig-paren">(</span><em class="sig-param">response</em><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.Sensor.setResponse" title="Permalink to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>response</strong> string</p>
</dd>
</dl>
<p>Reference to responsePAZ/&#64;publicID or responsePolynomial/&#64;publicID or
responseFAP/&#64;publicID</p>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.Sensor.response">
<code class="sig-name descname">response</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.Sensor.response" title="Permalink to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Return type</dt>
<dd class="field-odd"><p>string</p>
</dd>
</dl>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.Sensor.setRemark">
<code class="sig-name descname">setRemark</code><span class="sig-paren">(</span><em class="sig-param">remark</em><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.Sensor.setRemark" title="Permalink to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>remark</strong> <a class="reference internal" href="#api-python-datamodel-blob"><span class="std std-ref">Blob</span></a></p>
</dd>
</dl>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.Sensor.remark">
<code class="sig-name descname">remark</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.Sensor.remark" title="Permalink to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Return type</dt>
<dd class="field-odd"><p><a class="reference internal" href="#api-python-datamodel-blob"><span class="std std-ref">Blob</span></a></p>
</dd>
</dl>
<div class="admonition note">
<p class="admonition-title">Note</p>
<p>As this attribute is optional, this method throws a ValueError if
the value of the attribute is not set.</p>
</div>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.Sensor.add">
<code class="sig-name descname">add</code><span class="sig-paren">(</span><em class="sig-param">sensorCalibration</em><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.Sensor.add" title="Permalink to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>sensorCalibration</strong> Object of type <a class="reference internal" href="#api-python-datamodel-sensorcalibration"><span class="std std-ref">SensorCalibration</span></a></p>
</dd>
<dt class="field-even">Return type</dt>
<dd class="field-even"><p>A Boolean value indicating success with True, False otherwise.</p>
</dd>
</dl>
<p>Adds a SensorCalibration object to Sensor. The object is not
copied but managed by this instance. Any change to the passed object
will also change the child.</p>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.Sensor.remove">
<code class="sig-name descname">remove</code><span class="sig-paren">(</span><em class="sig-param">sensorCalibration</em><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.Sensor.remove" title="Permalink to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>sensorCalibration</strong> Object of type <a class="reference internal" href="#api-python-datamodel-sensorcalibration"><span class="std std-ref">SensorCalibration</span></a></p>
</dd>
<dt class="field-even">Return type</dt>
<dd class="field-even"><p>A Boolean value indicating success with True, False otherwise.</p>
</dd>
</dl>
<p>Removes a previously added SensorCalibration object from Sensor.</p>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.Sensor.removeSensorCalibration">
<code class="sig-name descname">removeSensorCalibration</code><span class="sig-paren">(</span><em class="sig-param">idx</em><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.Sensor.removeSensorCalibration" title="Permalink to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>idx</strong> An integer index of the object to be removed.</p>
</dd>
<dt class="field-even">Return type</dt>
<dd class="field-even"><p>A Boolean value indicating success with True, False otherwise.</p>
</dd>
</dl>
</dd></dl>
<dl class="method">
<dt>
<code class="sig-name descname">removeSensorCalibration(sensorCalibrationIndex);</code></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>sensorCalibrationIndex</strong> The index of the object to be removed of type SensorCalibrationIndex.</p>
</dd>
<dt class="field-even">Return type</dt>
<dd class="field-even"><p>A Boolean value indicating success with True, False otherwise.</p>
</dd>
</dl>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.Sensor.sensorCalibrationCount">
<code class="sig-name descname">sensorCalibrationCount</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.Sensor.sensorCalibrationCount" title="Permalink to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Return type</dt>
<dd class="field-odd"><p>integer value indicating the number of child objects.</p>
</dd>
</dl>
<p>Returns the number of SensorCalibration child objects.</p>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.Sensor.sensorCalibration">
<code class="sig-name descname">sensorCalibration</code><span class="sig-paren">(</span><em class="sig-param">idx</em><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.Sensor.sensorCalibration" title="Permalink to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>idx</strong> An integer index of the object to be returned.</p>
</dd>
<dt class="field-even">Return type</dt>
<dd class="field-even"><p>Object of type <a class="reference internal" href="#api-python-datamodel-sensorcalibration"><span class="std std-ref">SensorCalibration</span></a>.</p>
</dd>
</dl>
<p>Returns the SensorCalibration at index idx.</p>
</dd></dl>
<dl class="method">
<dt>
<code class="sig-name descname">sensorCalibration</code><span class="sig-paren">(</span><em class="sig-param">sensorCalibrationIndex</em><span class="sig-paren">)</span></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>sensorCalibrationIndex</strong> The index of the object to be removed of type SensorCalibrationIndex.</p>
</dd>
<dt class="field-even">Return type</dt>
<dd class="field-even"><p>Object of type <a class="reference internal" href="#api-python-datamodel-sensorcalibration"><span class="std std-ref">SensorCalibration</span></a>.</p>
</dd>
</dl>
<p>Returns the SensorCalibration at given index. The indexes of all child objects
are compared by value which makes this function slower than the direct
integer index look-up.</p>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.Sensor.inventory">
<code class="sig-name descname">inventory</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.Sensor.inventory" title="Permalink to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Return type</dt>
<dd class="field-odd"><p><a class="reference internal" href="#seiscomp.datamodel.Inventory" title="seiscomp.datamodel.Inventory">Inventory</a></p>
</dd>
</dl>
<p>Returns the parent Inventory if available. Returns None
if the parent is not a Inventory. This is a convenience wrapper
for parent().</p>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.Sensor.assign">
<code class="sig-name descname">assign</code><span class="sig-paren">(</span><em class="sig-param">other</em><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.Sensor.assign" title="Permalink to this definition"></a></dt>
<dd><p>This method implements the <a class="reference internal" href="#api-python-datamodel-object"><span class="std std-ref">Object</span></a> interface.</p>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.Sensor.attachTo">
<code class="sig-name descname">attachTo</code><span class="sig-paren">(</span><em class="sig-param">parent</em><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.Sensor.attachTo" title="Permalink to this definition"></a></dt>
<dd><p>This method implements the <a class="reference internal" href="#api-python-datamodel-object"><span class="std std-ref">Object</span></a> interface.</p>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.Sensor.detachFrom">
<code class="sig-name descname">detachFrom</code><span class="sig-paren">(</span><em class="sig-param">parent</em><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.Sensor.detachFrom" title="Permalink to this definition"></a></dt>
<dd><p>This method implements the <a class="reference internal" href="#api-python-datamodel-object"><span class="std std-ref">Object</span></a> interface.</p>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.Sensor.detach">
<code class="sig-name descname">detach</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.Sensor.detach" title="Permalink to this definition"></a></dt>
<dd><p>This method implements the <a class="reference internal" href="#api-python-datamodel-object"><span class="std std-ref">Object</span></a> interface.</p>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.Sensor.clone">
<code class="sig-name descname">clone</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.Sensor.clone" title="Permalink to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Return type</dt>
<dd class="field-odd"><p>A cloned Sensor.</p>
</dd>
</dl>
<p>Returns a new instance that is a clone of the current instance. Child
objects are being ignored.</p>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.Sensor.updateChild">
<code class="sig-name descname">updateChild</code><span class="sig-paren">(</span><em class="sig-param">ref</em><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.Sensor.updateChild" title="Permalink to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>ref</strong> A child object derived from class Object.</p>
</dd>
<dt class="field-even">Return type</dt>
<dd class="field-even"><p>A Boolean flag indicating success with True, False otherwise</p>
</dd>
</dl>
<p>This method takes the passed reference object and searches for a child
with the same publicID (if derived from <a class="reference internal" href="#api-python-datamodel-publicobject"><span class="std std-ref">PublicObject</span></a>)
or the same index (if derived from <a class="reference internal" href="#api-python-datamodel-object"><span class="std std-ref">Object</span></a>).
The the child was found the reference objects attributes are copied to
the child object. Children of child are being ignored during this operation.
This method implements the <a class="reference internal" href="#api-python-datamodel-publicobject"><span class="std std-ref">PublicObject</span></a> interface.</p>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.Sensor.accept">
<code class="sig-name descname">accept</code><span class="sig-paren">(</span><em class="sig-param">visitor</em><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.Sensor.accept" title="Permalink to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>visitor</strong> A visitor.</p>
</dd>
</dl>
<p>This method implements the <a class="reference internal" href="#api-python-datamodel-publicobject"><span class="std std-ref">PublicObject</span></a> interface.</p>
</dd></dl>
</dd></dl>
</div>
<div class="section" id="sensorcalibration">
<span id="api-python-datamodel-sensorcalibration"></span><h3>SensorCalibration<a class="headerlink" href="#sensorcalibration" title="Permalink to this headline"></a></h3>
<dl class="class">
<dt id="seiscomp.datamodel.SensorCalibration">
<em class="property">class </em><code class="sig-prename descclassname">seiscomp.datamodel.</code><code class="sig-name descname">SensorCalibration</code><a class="headerlink" href="#seiscomp.datamodel.SensorCalibration" title="Permalink to this definition"></a></dt>
<dd><p>Inherits <a class="reference internal" href="#api-python-datamodel-object"><span class="std std-ref">Object</span></a>.</p>
<p>This type describes a sensor calibration</p>
<p><strong>Parents</strong>:</p>
<ul class="simple">
<li><p><code class="docutils literal notranslate"><span class="pre">sensor</span></code> <a class="reference internal" href="#api-python-datamodel-sensor"><span class="std std-ref">Sensor</span></a></p></li>
</ul>
<p><strong>Attributes</strong>:</p>
<ul class="simple">
<li><p><code class="docutils literal notranslate"><span class="pre">serialNumber</span></code> string</p></li>
<li><p><code class="docutils literal notranslate"><span class="pre">channel</span></code> int</p></li>
<li><p><code class="docutils literal notranslate"><span class="pre">start</span></code> seiscomp.core.Time</p></li>
<li><p><code class="docutils literal notranslate"><span class="pre">end</span></code> seiscomp.core.Time (optional)</p></li>
<li><p><code class="docutils literal notranslate"><span class="pre">gain</span></code> float (optional)</p></li>
<li><p><code class="docutils literal notranslate"><span class="pre">gainFrequency</span></code> float (optional)</p></li>
<li><p><code class="docutils literal notranslate"><span class="pre">remark</span></code> <a class="reference internal" href="#api-python-datamodel-blob"><span class="std std-ref">Blob</span></a> (optional)</p></li>
</ul>
<p><strong>Methods</strong>:</p>
<dl class="method">
<dt id="seiscomp.datamodel.SensorCalibration.Cast">
<em class="property">static </em><code class="sig-name descname">Cast</code><span class="sig-paren">(</span><em class="sig-param">obj</em><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.SensorCalibration.Cast" title="Permalink to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>obj</strong> The object to be casted.</p>
</dd>
<dt class="field-even">Return type</dt>
<dd class="field-even"><p>An object of type SensorCalibration if the cast was successful,
None otherwise.</p>
</dd>
</dl>
<p>Cast an arbitrary object to SensorCalibration if the internal wrapped
representation is an SensorCalibration object. The cast is important if
instances of type <a class="reference internal" href="#api-python-datamodel-object"><span class="std std-ref">Object</span></a>
are passed to methods which need access to the real type.</p>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.SensorCalibration.equal">
<code class="sig-name descname">equal</code><span class="sig-paren">(</span><em class="sig-param">other</em><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.SensorCalibration.equal" title="Permalink to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>other</strong> Another object of type SensorCalibration to compare this
instance to</p>
</dd>
<dt class="field-even">Return type</dt>
<dd class="field-even"><p>A Boolean value indicating True if both objects are equal or
False otherwise.</p>
</dd>
</dl>
<p>Compares two objects without its child objects. Both objects are compared
by value.</p>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.SensorCalibration.index">
<code class="sig-name descname">index</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.SensorCalibration.index" title="Permalink to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Return type</dt>
<dd class="field-odd"><p><p>The objects index of type SensorCalibrationIndex.</p>
<p>Returns the objects index which is also used for the database as unique
constraint.</p>
</p>
</dd>
</dl>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.SensorCalibration.equalIndex">
<code class="sig-name descname">equalIndex</code><span class="sig-paren">(</span><em class="sig-param">lhs</em><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.SensorCalibration.equalIndex" title="Permalink to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>lhs</strong> <a class="reference internal" href="#api-python-datamodel-sensorcalibration"><span class="std std-ref">SensorCalibration</span></a></p>
</dd>
<dt class="field-even">Return type</dt>
<dd class="field-even"><p>A Boolean value indicating True if both indexes are equal or
False otherwise.</p>
</dd>
</dl>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.SensorCalibration.setSerialNumber">
<code class="sig-name descname">setSerialNumber</code><span class="sig-paren">(</span><em class="sig-param">serialNumber</em><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.SensorCalibration.setSerialNumber" title="Permalink to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>serialNumber</strong> string</p>
</dd>
</dl>
<p>Referred from network/station/Stream/&#64;sensorSerialNumber</p>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.SensorCalibration.serialNumber">
<code class="sig-name descname">serialNumber</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.SensorCalibration.serialNumber" title="Permalink to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Return type</dt>
<dd class="field-odd"><p>string</p>
</dd>
</dl>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.SensorCalibration.setChannel">
<code class="sig-name descname">setChannel</code><span class="sig-paren">(</span><em class="sig-param">channel</em><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.SensorCalibration.setChannel" title="Permalink to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>channel</strong> int</p>
</dd>
</dl>
<p>Referred from network/station/Stream/&#64;sensorChannel</p>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.SensorCalibration.channel">
<code class="sig-name descname">channel</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.SensorCalibration.channel" title="Permalink to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Return type</dt>
<dd class="field-odd"><p>int</p>
</dd>
</dl>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.SensorCalibration.setStart">
<code class="sig-name descname">setStart</code><span class="sig-paren">(</span><em class="sig-param">start</em><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.SensorCalibration.setStart" title="Permalink to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>start</strong> seiscomp.core.Time</p>
</dd>
</dl>
<p>Start of validity</p>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.SensorCalibration.start">
<code class="sig-name descname">start</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.SensorCalibration.start" title="Permalink to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Return type</dt>
<dd class="field-odd"><p>seiscomp.core.Time</p>
</dd>
</dl>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.SensorCalibration.setEnd">
<code class="sig-name descname">setEnd</code><span class="sig-paren">(</span><em class="sig-param">end</em><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.SensorCalibration.setEnd" title="Permalink to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>end</strong> seiscomp.core.Time</p>
</dd>
</dl>
<p>End of validity</p>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.SensorCalibration.end">
<code class="sig-name descname">end</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.SensorCalibration.end" title="Permalink to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Return type</dt>
<dd class="field-odd"><p>seiscomp.core.Time</p>
</dd>
</dl>
<div class="admonition note">
<p class="admonition-title">Note</p>
<p>As this attribute is optional, this method throws a ValueError if
the value of the attribute is not set.</p>
</div>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.SensorCalibration.setGain">
<code class="sig-name descname">setGain</code><span class="sig-paren">(</span><em class="sig-param">gain</em><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.SensorCalibration.setGain" title="Permalink to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>gain</strong> float</p>
</dd>
</dl>
<p>Overrides nominal gain of calibrated sensor (48.05/58.04)</p>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.SensorCalibration.gain">
<code class="sig-name descname">gain</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.SensorCalibration.gain" title="Permalink to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Return type</dt>
<dd class="field-odd"><p>float</p>
</dd>
</dl>
<div class="admonition note">
<p class="admonition-title">Note</p>
<p>As this attribute is optional, this method throws a ValueError if
the value of the attribute is not set.</p>
</div>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.SensorCalibration.setGainFrequency">
<code class="sig-name descname">setGainFrequency</code><span class="sig-paren">(</span><em class="sig-param">gainFrequency</em><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.SensorCalibration.setGainFrequency" title="Permalink to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>gainFrequency</strong> float</p>
</dd>
</dl>
<p>Gain frequency (48.06/58.05)</p>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.SensorCalibration.gainFrequency">
<code class="sig-name descname">gainFrequency</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.SensorCalibration.gainFrequency" title="Permalink to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Return type</dt>
<dd class="field-odd"><p>float</p>
</dd>
</dl>
<div class="admonition note">
<p class="admonition-title">Note</p>
<p>As this attribute is optional, this method throws a ValueError if
the value of the attribute is not set.</p>
</div>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.SensorCalibration.setRemark">
<code class="sig-name descname">setRemark</code><span class="sig-paren">(</span><em class="sig-param">remark</em><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.SensorCalibration.setRemark" title="Permalink to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>remark</strong> <a class="reference internal" href="#api-python-datamodel-blob"><span class="std std-ref">Blob</span></a></p>
</dd>
</dl>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.SensorCalibration.remark">
<code class="sig-name descname">remark</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.SensorCalibration.remark" title="Permalink to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Return type</dt>
<dd class="field-odd"><p><a class="reference internal" href="#api-python-datamodel-blob"><span class="std std-ref">Blob</span></a></p>
</dd>
</dl>
<div class="admonition note">
<p class="admonition-title">Note</p>
<p>As this attribute is optional, this method throws a ValueError if
the value of the attribute is not set.</p>
</div>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.SensorCalibration.sensor">
<code class="sig-name descname">sensor</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.SensorCalibration.sensor" title="Permalink to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Return type</dt>
<dd class="field-odd"><p><a class="reference internal" href="#seiscomp.datamodel.Sensor" title="seiscomp.datamodel.Sensor">Sensor</a></p>
</dd>
</dl>
<p>Returns the parent Sensor if available. Returns None
if the parent is not a Sensor. This is a convenience wrapper
for parent().</p>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.SensorCalibration.assign">
<code class="sig-name descname">assign</code><span class="sig-paren">(</span><em class="sig-param">other</em><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.SensorCalibration.assign" title="Permalink to this definition"></a></dt>
<dd><p>This method implements the <a class="reference internal" href="#api-python-datamodel-object"><span class="std std-ref">Object</span></a> interface.</p>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.SensorCalibration.attachTo">
<code class="sig-name descname">attachTo</code><span class="sig-paren">(</span><em class="sig-param">parent</em><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.SensorCalibration.attachTo" title="Permalink to this definition"></a></dt>
<dd><p>This method implements the <a class="reference internal" href="#api-python-datamodel-object"><span class="std std-ref">Object</span></a> interface.</p>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.SensorCalibration.detachFrom">
<code class="sig-name descname">detachFrom</code><span class="sig-paren">(</span><em class="sig-param">parent</em><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.SensorCalibration.detachFrom" title="Permalink to this definition"></a></dt>
<dd><p>This method implements the <a class="reference internal" href="#api-python-datamodel-object"><span class="std std-ref">Object</span></a> interface.</p>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.SensorCalibration.detach">
<code class="sig-name descname">detach</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.SensorCalibration.detach" title="Permalink to this definition"></a></dt>
<dd><p>This method implements the <a class="reference internal" href="#api-python-datamodel-object"><span class="std std-ref">Object</span></a> interface.</p>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.SensorCalibration.clone">
<code class="sig-name descname">clone</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.SensorCalibration.clone" title="Permalink to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Return type</dt>
<dd class="field-odd"><p>A cloned SensorCalibration.</p>
</dd>
</dl>
<p>Returns a new instance that is a clone of the current instance. Child
objects are being ignored.</p>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.SensorCalibration.accept">
<code class="sig-name descname">accept</code><span class="sig-paren">(</span><em class="sig-param">visitor</em><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.SensorCalibration.accept" title="Permalink to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>visitor</strong> A visitor.</p>
</dd>
</dl>
<p>This method implements the <a class="reference internal" href="#api-python-datamodel-publicobject"><span class="std std-ref">PublicObject</span></a> interface.</p>
</dd></dl>
</dd></dl>
</div>
<div class="section" id="sensorlocation">
<span id="api-python-datamodel-sensorlocation"></span><h3>SensorLocation<a class="headerlink" href="#sensorlocation" title="Permalink to this headline"></a></h3>
<dl class="class">
<dt id="seiscomp.datamodel.SensorLocation">
<em class="property">class </em><code class="sig-prename descclassname">seiscomp.datamodel.</code><code class="sig-name descname">SensorLocation</code><a class="headerlink" href="#seiscomp.datamodel.SensorLocation" title="Permalink to this definition"></a></dt>
<dd><p>Inherits <a class="reference internal" href="#api-python-datamodel-publicobject"><span class="std std-ref">PublicObject</span></a>.</p>
<p>This type describes a sensor location</p>
<p><strong>Parents</strong>:</p>
<ul class="simple">
<li><p><code class="docutils literal notranslate"><span class="pre">station</span></code> <a class="reference internal" href="#api-python-datamodel-station"><span class="std std-ref">Station</span></a></p></li>
</ul>
<p><strong>Children</strong>:</p>
<ul class="simple">
<li><p><code class="docutils literal notranslate"><span class="pre">comment</span></code> <a class="reference internal" href="#api-python-datamodel-comment"><span class="std std-ref">Comment</span></a></p></li>
<li><p><code class="docutils literal notranslate"><span class="pre">auxStream</span></code> <a class="reference internal" href="#api-python-datamodel-auxstream"><span class="std std-ref">AuxStream</span></a></p></li>
<li><p><code class="docutils literal notranslate"><span class="pre">stream</span></code> <a class="reference internal" href="#api-python-datamodel-stream"><span class="std std-ref">Stream</span></a></p></li>
</ul>
<p><strong>Attributes</strong>:</p>
<ul class="simple">
<li><p><code class="docutils literal notranslate"><span class="pre">publicID</span></code>: string</p></li>
<li><p><code class="docutils literal notranslate"><span class="pre">code</span></code> string</p></li>
<li><p><code class="docutils literal notranslate"><span class="pre">start</span></code> seiscomp.core.Time</p></li>
<li><p><code class="docutils literal notranslate"><span class="pre">end</span></code> seiscomp.core.Time (optional)</p></li>
<li><p><code class="docutils literal notranslate"><span class="pre">latitude</span></code> float (optional)</p></li>
<li><p><code class="docutils literal notranslate"><span class="pre">longitude</span></code> float (optional)</p></li>
<li><p><code class="docutils literal notranslate"><span class="pre">elevation</span></code> float (optional)</p></li>
</ul>
<p><strong>Methods</strong>:</p>
<dl class="method">
<dt id="seiscomp.datamodel.SensorLocation.Cast">
<em class="property">static </em><code class="sig-name descname">Cast</code><span class="sig-paren">(</span><em class="sig-param">obj</em><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.SensorLocation.Cast" title="Permalink to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>obj</strong> The object to be casted.</p>
</dd>
<dt class="field-even">Return type</dt>
<dd class="field-even"><p>An object of type SensorLocation if the cast was successful,
None otherwise.</p>
</dd>
</dl>
<p>Cast an arbitrary object to SensorLocation if the internal wrapped
representation is an SensorLocation object. The cast is important if
instances of type <a class="reference internal" href="#api-python-datamodel-object"><span class="std std-ref">Object</span></a>
are passed to methods which need access to the real type.</p>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.SensorLocation.Create">
<em class="property">static </em><code class="sig-name descname">Create</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.SensorLocation.Create" title="Permalink to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Return type</dt>
<dd class="field-odd"><p>A new object of type SensorLocation.</p>
</dd>
</dl>
<p>Creates and registers (if enabled) a SensorLocation instance. The
publicID is auto-generated.</p>
</dd></dl>
<dl class="method">
<dt>
<em class="property">static </em><code class="sig-name descname">Create</code><span class="sig-paren">(</span><em class="sig-param">publicID</em><span class="sig-paren">)</span></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Return type</dt>
<dd class="field-odd"><p>A new object of type SensorLocation.</p>
</dd>
</dl>
<p>Creates and registers (if enabled) a SensorLocation instance with
passed publicID.</p>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.SensorLocation.equal">
<code class="sig-name descname">equal</code><span class="sig-paren">(</span><em class="sig-param">other</em><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.SensorLocation.equal" title="Permalink to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>other</strong> Another object of type SensorLocation to compare this
instance to</p>
</dd>
<dt class="field-even">Return type</dt>
<dd class="field-even"><p>A Boolean value indicating True if both objects are equal or
False otherwise.</p>
</dd>
</dl>
<p>Compares two objects without its child objects. Both objects are compared
by value.</p>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.SensorLocation.index">
<code class="sig-name descname">index</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.SensorLocation.index" title="Permalink to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Return type</dt>
<dd class="field-odd"><p><p>The objects index of type SensorLocationIndex.</p>
<p>Returns the objects index which is also used for the database as unique
constraint.</p>
</p>
</dd>
</dl>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.SensorLocation.equalIndex">
<code class="sig-name descname">equalIndex</code><span class="sig-paren">(</span><em class="sig-param">lhs</em><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.SensorLocation.equalIndex" title="Permalink to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>lhs</strong> <a class="reference internal" href="#api-python-datamodel-sensorlocation"><span class="std std-ref">SensorLocation</span></a></p>
</dd>
<dt class="field-even">Return type</dt>
<dd class="field-even"><p>A Boolean value indicating True if both indexes are equal or
False otherwise.</p>
</dd>
</dl>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.SensorLocation.setCode">
<code class="sig-name descname">setCode</code><span class="sig-paren">(</span><em class="sig-param">code</em><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.SensorLocation.setCode" title="Permalink to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>code</strong> string</p>
</dd>
</dl>
<p>Station code (52.03)</p>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.SensorLocation.code">
<code class="sig-name descname">code</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.SensorLocation.code" title="Permalink to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Return type</dt>
<dd class="field-odd"><p>string</p>
</dd>
</dl>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.SensorLocation.setStart">
<code class="sig-name descname">setStart</code><span class="sig-paren">(</span><em class="sig-param">start</em><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.SensorLocation.setStart" title="Permalink to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>start</strong> seiscomp.core.Time</p>
</dd>
</dl>
<p>Start of epoch in ISO datetime format</p>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.SensorLocation.start">
<code class="sig-name descname">start</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.SensorLocation.start" title="Permalink to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Return type</dt>
<dd class="field-odd"><p>seiscomp.core.Time</p>
</dd>
</dl>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.SensorLocation.setEnd">
<code class="sig-name descname">setEnd</code><span class="sig-paren">(</span><em class="sig-param">end</em><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.SensorLocation.setEnd" title="Permalink to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>end</strong> seiscomp.core.Time</p>
</dd>
</dl>
<p>End of epoch</p>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.SensorLocation.end">
<code class="sig-name descname">end</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.SensorLocation.end" title="Permalink to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Return type</dt>
<dd class="field-odd"><p>seiscomp.core.Time</p>
</dd>
</dl>
<div class="admonition note">
<p class="admonition-title">Note</p>
<p>As this attribute is optional, this method throws a ValueError if
the value of the attribute is not set.</p>
</div>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.SensorLocation.setLatitude">
<code class="sig-name descname">setLatitude</code><span class="sig-paren">(</span><em class="sig-param">latitude</em><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.SensorLocation.setLatitude" title="Permalink to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>latitude</strong> float</p>
</dd>
</dl>
<p>Sensor latitude (52.10) with respect to the World Geodetic System
1984 (WGS84) reference system (National Imagery and Mapping Agency
2000) in degrees.</p>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.SensorLocation.latitude">
<code class="sig-name descname">latitude</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.SensorLocation.latitude" title="Permalink to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Return type</dt>
<dd class="field-odd"><p>float</p>
</dd>
</dl>
<div class="admonition note">
<p class="admonition-title">Note</p>
<p>As this attribute is optional, this method throws a ValueError if
the value of the attribute is not set.</p>
</div>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.SensorLocation.setLongitude">
<code class="sig-name descname">setLongitude</code><span class="sig-paren">(</span><em class="sig-param">longitude</em><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.SensorLocation.setLongitude" title="Permalink to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>longitude</strong> float</p>
</dd>
</dl>
<p>Sensor longitude (52.11) with respect to the World Geodetic System
1984 (WGS84) reference system (National Imagery and Mapping Agency
2000) in degrees.</p>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.SensorLocation.longitude">
<code class="sig-name descname">longitude</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.SensorLocation.longitude" title="Permalink to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Return type</dt>
<dd class="field-odd"><p>float</p>
</dd>
</dl>
<div class="admonition note">
<p class="admonition-title">Note</p>
<p>As this attribute is optional, this method throws a ValueError if
the value of the attribute is not set.</p>
</div>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.SensorLocation.setElevation">
<code class="sig-name descname">setElevation</code><span class="sig-paren">(</span><em class="sig-param">elevation</em><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.SensorLocation.setElevation" title="Permalink to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>elevation</strong> float</p>
</dd>
</dl>
<p>Sensor elevation (52.12) with respect to the World Geodetic System
1984 (WGS84) reference system (National Imagery and Mapping Agency
2000) in meters.</p>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.SensorLocation.elevation">
<code class="sig-name descname">elevation</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.SensorLocation.elevation" title="Permalink to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Return type</dt>
<dd class="field-odd"><p>float</p>
</dd>
</dl>
<div class="admonition note">
<p class="admonition-title">Note</p>
<p>As this attribute is optional, this method throws a ValueError if
the value of the attribute is not set.</p>
</div>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.SensorLocation.add">
<code class="sig-name descname">add</code><span class="sig-paren">(</span><em class="sig-param">comment</em><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.SensorLocation.add" title="Permalink to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>comment</strong> Object of type <a class="reference internal" href="#api-python-datamodel-comment"><span class="std std-ref">Comment</span></a></p>
</dd>
<dt class="field-even">Return type</dt>
<dd class="field-even"><p>A Boolean value indicating success with True, False otherwise.</p>
</dd>
</dl>
<p>Adds a Comment object to SensorLocation. The object is not
copied but managed by this instance. Any change to the passed object
will also change the child.</p>
</dd></dl>
<dl class="method">
<dt>
<code class="sig-name descname">add</code><span class="sig-paren">(</span><em class="sig-param">auxStream</em><span class="sig-paren">)</span></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>auxStream</strong> Object of type <a class="reference internal" href="#api-python-datamodel-auxstream"><span class="std std-ref">AuxStream</span></a></p>
</dd>
<dt class="field-even">Return type</dt>
<dd class="field-even"><p>A Boolean value indicating success with True, False otherwise.</p>
</dd>
</dl>
<p>Adds a AuxStream object to SensorLocation. The object is not
copied but managed by this instance. Any change to the passed object
will also change the child.</p>
</dd></dl>
<dl class="method">
<dt>
<code class="sig-name descname">add</code><span class="sig-paren">(</span><em class="sig-param">stream</em><span class="sig-paren">)</span></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>stream</strong> Object of type <a class="reference internal" href="#api-python-datamodel-stream"><span class="std std-ref">Stream</span></a></p>
</dd>
<dt class="field-even">Return type</dt>
<dd class="field-even"><p>A Boolean value indicating success with True, False otherwise.</p>
</dd>
</dl>
<p>Adds a Stream object to SensorLocation. The object is not
copied but managed by this instance. Any change to the passed object
will also change the child.</p>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.SensorLocation.remove">
<code class="sig-name descname">remove</code><span class="sig-paren">(</span><em class="sig-param">comment</em><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.SensorLocation.remove" title="Permalink to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>comment</strong> Object of type <a class="reference internal" href="#api-python-datamodel-comment"><span class="std std-ref">Comment</span></a></p>
</dd>
<dt class="field-even">Return type</dt>
<dd class="field-even"><p>A Boolean value indicating success with True, False otherwise.</p>
</dd>
</dl>
<p>Removes a previously added Comment object from SensorLocation.</p>
</dd></dl>
<dl class="method">
<dt>
<code class="sig-name descname">remove</code><span class="sig-paren">(</span><em class="sig-param">auxStream</em><span class="sig-paren">)</span></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>auxStream</strong> Object of type <a class="reference internal" href="#api-python-datamodel-auxstream"><span class="std std-ref">AuxStream</span></a></p>
</dd>
<dt class="field-even">Return type</dt>
<dd class="field-even"><p>A Boolean value indicating success with True, False otherwise.</p>
</dd>
</dl>
<p>Removes a previously added AuxStream object from SensorLocation.</p>
</dd></dl>
<dl class="method">
<dt>
<code class="sig-name descname">remove</code><span class="sig-paren">(</span><em class="sig-param">stream</em><span class="sig-paren">)</span></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>stream</strong> Object of type <a class="reference internal" href="#api-python-datamodel-stream"><span class="std std-ref">Stream</span></a></p>
</dd>
<dt class="field-even">Return type</dt>
<dd class="field-even"><p>A Boolean value indicating success with True, False otherwise.</p>
</dd>
</dl>
<p>Removes a previously added Stream object from SensorLocation.</p>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.SensorLocation.removeComment">
<code class="sig-name descname">removeComment</code><span class="sig-paren">(</span><em class="sig-param">idx</em><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.SensorLocation.removeComment" title="Permalink to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>idx</strong> An integer index of the object to be removed.</p>
</dd>
<dt class="field-even">Return type</dt>
<dd class="field-even"><p>A Boolean value indicating success with True, False otherwise.</p>
</dd>
</dl>
</dd></dl>
<dl class="method">
<dt>
<code class="sig-name descname">removeComment(commentIndex);</code></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>commentIndex</strong> The index of the object to be removed of type CommentIndex.</p>
</dd>
<dt class="field-even">Return type</dt>
<dd class="field-even"><p>A Boolean value indicating success with True, False otherwise.</p>
</dd>
</dl>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.SensorLocation.removeAuxStream">
<code class="sig-name descname">removeAuxStream</code><span class="sig-paren">(</span><em class="sig-param">idx</em><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.SensorLocation.removeAuxStream" title="Permalink to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>idx</strong> An integer index of the object to be removed.</p>
</dd>
<dt class="field-even">Return type</dt>
<dd class="field-even"><p>A Boolean value indicating success with True, False otherwise.</p>
</dd>
</dl>
</dd></dl>
<dl class="method">
<dt>
<code class="sig-name descname">removeAuxStream(auxStreamIndex);</code></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>auxStreamIndex</strong> The index of the object to be removed of type AuxStreamIndex.</p>
</dd>
<dt class="field-even">Return type</dt>
<dd class="field-even"><p>A Boolean value indicating success with True, False otherwise.</p>
</dd>
</dl>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.SensorLocation.removeStream">
<code class="sig-name descname">removeStream</code><span class="sig-paren">(</span><em class="sig-param">idx</em><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.SensorLocation.removeStream" title="Permalink to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>idx</strong> An integer index of the object to be removed.</p>
</dd>
<dt class="field-even">Return type</dt>
<dd class="field-even"><p>A Boolean value indicating success with True, False otherwise.</p>
</dd>
</dl>
</dd></dl>
<dl class="method">
<dt>
<code class="sig-name descname">removeStream(streamIndex);</code></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>streamIndex</strong> The index of the object to be removed of type StreamIndex.</p>
</dd>
<dt class="field-even">Return type</dt>
<dd class="field-even"><p>A Boolean value indicating success with True, False otherwise.</p>
</dd>
</dl>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.SensorLocation.commentCount">
<code class="sig-name descname">commentCount</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.SensorLocation.commentCount" title="Permalink to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Return type</dt>
<dd class="field-odd"><p>integer value indicating the number of child objects.</p>
</dd>
</dl>
<p>Returns the number of Comment child objects.</p>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.SensorLocation.auxStreamCount">
<code class="sig-name descname">auxStreamCount</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.SensorLocation.auxStreamCount" title="Permalink to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Return type</dt>
<dd class="field-odd"><p>integer value indicating the number of child objects.</p>
</dd>
</dl>
<p>Returns the number of AuxStream child objects.</p>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.SensorLocation.streamCount">
<code class="sig-name descname">streamCount</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.SensorLocation.streamCount" title="Permalink to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Return type</dt>
<dd class="field-odd"><p>integer value indicating the number of child objects.</p>
</dd>
</dl>
<p>Returns the number of Stream child objects.</p>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.SensorLocation.comment">
<code class="sig-name descname">comment</code><span class="sig-paren">(</span><em class="sig-param">idx</em><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.SensorLocation.comment" title="Permalink to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>idx</strong> An integer index of the object to be returned.</p>
</dd>
<dt class="field-even">Return type</dt>
<dd class="field-even"><p>Object of type <a class="reference internal" href="#api-python-datamodel-comment"><span class="std std-ref">Comment</span></a>.</p>
</dd>
</dl>
<p>Returns the Comment at index idx.</p>
</dd></dl>
<dl class="method">
<dt>
<code class="sig-name descname">comment</code><span class="sig-paren">(</span><em class="sig-param">commentIndex</em><span class="sig-paren">)</span></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>commentIndex</strong> The index of the object to be removed of type CommentIndex.</p>
</dd>
<dt class="field-even">Return type</dt>
<dd class="field-even"><p>Object of type <a class="reference internal" href="#api-python-datamodel-comment"><span class="std std-ref">Comment</span></a>.</p>
</dd>
</dl>
<p>Returns the Comment at given index. The indexes of all child objects
are compared by value which makes this function slower than the direct
integer index look-up.</p>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.SensorLocation.auxStream">
<code class="sig-name descname">auxStream</code><span class="sig-paren">(</span><em class="sig-param">idx</em><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.SensorLocation.auxStream" title="Permalink to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>idx</strong> An integer index of the object to be returned.</p>
</dd>
<dt class="field-even">Return type</dt>
<dd class="field-even"><p>Object of type <a class="reference internal" href="#api-python-datamodel-auxstream"><span class="std std-ref">AuxStream</span></a>.</p>
</dd>
</dl>
<p>Returns the AuxStream at index idx.</p>
</dd></dl>
<dl class="method">
<dt>
<code class="sig-name descname">auxStream</code><span class="sig-paren">(</span><em class="sig-param">auxStreamIndex</em><span class="sig-paren">)</span></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>auxStreamIndex</strong> The index of the object to be removed of type AuxStreamIndex.</p>
</dd>
<dt class="field-even">Return type</dt>
<dd class="field-even"><p>Object of type <a class="reference internal" href="#api-python-datamodel-auxstream"><span class="std std-ref">AuxStream</span></a>.</p>
</dd>
</dl>
<p>Returns the AuxStream at given index. The indexes of all child objects
are compared by value which makes this function slower than the direct
integer index look-up.</p>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.SensorLocation.stream">
<code class="sig-name descname">stream</code><span class="sig-paren">(</span><em class="sig-param">idx</em><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.SensorLocation.stream" title="Permalink to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>idx</strong> An integer index of the object to be returned.</p>
</dd>
<dt class="field-even">Return type</dt>
<dd class="field-even"><p>Object of type <a class="reference internal" href="#api-python-datamodel-stream"><span class="std std-ref">Stream</span></a>.</p>
</dd>
</dl>
<p>Returns the Stream at index idx.</p>
</dd></dl>
<dl class="method">
<dt>
<code class="sig-name descname">stream</code><span class="sig-paren">(</span><em class="sig-param">streamIndex</em><span class="sig-paren">)</span></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>streamIndex</strong> The index of the object to be removed of type StreamIndex.</p>
</dd>
<dt class="field-even">Return type</dt>
<dd class="field-even"><p>Object of type <a class="reference internal" href="#api-python-datamodel-stream"><span class="std std-ref">Stream</span></a>.</p>
</dd>
</dl>
<p>Returns the Stream at given index. The indexes of all child objects
are compared by value which makes this function slower than the direct
integer index look-up.</p>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.SensorLocation.findStream">
<code class="sig-name descname">findStream</code><span class="sig-paren">(</span><em class="sig-param">publicID</em><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.SensorLocation.findStream" title="Permalink to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>publicID</strong> The publicID of the object to find.</p>
</dd>
<dt class="field-even">Return type</dt>
<dd class="field-even"><p>Object of type <a class="reference internal" href="#api-python-datamodel-stream"><span class="std std-ref">Stream</span></a>.</p>
</dd>
</dl>
<p>Returns the child object with a certain publicID, None otherwise.</p>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.SensorLocation.station">
<code class="sig-name descname">station</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.SensorLocation.station" title="Permalink to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Return type</dt>
<dd class="field-odd"><p><a class="reference internal" href="#seiscomp.datamodel.Station" title="seiscomp.datamodel.Station">Station</a></p>
</dd>
</dl>
<p>Returns the parent Station if available. Returns None
if the parent is not a Station. This is a convenience wrapper
for parent().</p>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.SensorLocation.assign">
<code class="sig-name descname">assign</code><span class="sig-paren">(</span><em class="sig-param">other</em><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.SensorLocation.assign" title="Permalink to this definition"></a></dt>
<dd><p>This method implements the <a class="reference internal" href="#api-python-datamodel-object"><span class="std std-ref">Object</span></a> interface.</p>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.SensorLocation.attachTo">
<code class="sig-name descname">attachTo</code><span class="sig-paren">(</span><em class="sig-param">parent</em><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.SensorLocation.attachTo" title="Permalink to this definition"></a></dt>
<dd><p>This method implements the <a class="reference internal" href="#api-python-datamodel-object"><span class="std std-ref">Object</span></a> interface.</p>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.SensorLocation.detachFrom">
<code class="sig-name descname">detachFrom</code><span class="sig-paren">(</span><em class="sig-param">parent</em><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.SensorLocation.detachFrom" title="Permalink to this definition"></a></dt>
<dd><p>This method implements the <a class="reference internal" href="#api-python-datamodel-object"><span class="std std-ref">Object</span></a> interface.</p>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.SensorLocation.detach">
<code class="sig-name descname">detach</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.SensorLocation.detach" title="Permalink to this definition"></a></dt>
<dd><p>This method implements the <a class="reference internal" href="#api-python-datamodel-object"><span class="std std-ref">Object</span></a> interface.</p>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.SensorLocation.clone">
<code class="sig-name descname">clone</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.SensorLocation.clone" title="Permalink to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Return type</dt>
<dd class="field-odd"><p>A cloned SensorLocation.</p>
</dd>
</dl>
<p>Returns a new instance that is a clone of the current instance. Child
objects are being ignored.</p>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.SensorLocation.updateChild">
<code class="sig-name descname">updateChild</code><span class="sig-paren">(</span><em class="sig-param">ref</em><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.SensorLocation.updateChild" title="Permalink to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>ref</strong> A child object derived from class Object.</p>
</dd>
<dt class="field-even">Return type</dt>
<dd class="field-even"><p>A Boolean flag indicating success with True, False otherwise</p>
</dd>
</dl>
<p>This method takes the passed reference object and searches for a child
with the same publicID (if derived from <a class="reference internal" href="#api-python-datamodel-publicobject"><span class="std std-ref">PublicObject</span></a>)
or the same index (if derived from <a class="reference internal" href="#api-python-datamodel-object"><span class="std std-ref">Object</span></a>).
The the child was found the reference objects attributes are copied to
the child object. Children of child are being ignored during this operation.
This method implements the <a class="reference internal" href="#api-python-datamodel-publicobject"><span class="std std-ref">PublicObject</span></a> interface.</p>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.SensorLocation.accept">
<code class="sig-name descname">accept</code><span class="sig-paren">(</span><em class="sig-param">visitor</em><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.SensorLocation.accept" title="Permalink to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>visitor</strong> A visitor.</p>
</dd>
</dl>
<p>This method implements the <a class="reference internal" href="#api-python-datamodel-publicobject"><span class="std std-ref">PublicObject</span></a> interface.</p>
</dd></dl>
</dd></dl>
</div>
<div class="section" id="setup">
<span id="api-python-datamodel-setup"></span><h3>Setup<a class="headerlink" href="#setup" title="Permalink to this headline"></a></h3>
<dl class="class">
<dt id="seiscomp.datamodel.Setup">
<em class="property">class </em><code class="sig-prename descclassname">seiscomp.datamodel.</code><code class="sig-name descname">Setup</code><a class="headerlink" href="#seiscomp.datamodel.Setup" title="Permalink to this definition"></a></dt>
<dd><p>Inherits <a class="reference internal" href="#api-python-datamodel-object"><span class="std std-ref">Object</span></a>.</p>
<p><strong>Parents</strong>:</p>
<ul class="simple">
<li><p><code class="docutils literal notranslate"><span class="pre">configStation</span></code> <a class="reference internal" href="#api-python-datamodel-configstation"><span class="std std-ref">ConfigStation</span></a></p></li>
</ul>
<p><strong>Attributes</strong>:</p>
<ul class="simple">
<li><p><code class="docutils literal notranslate"><span class="pre">name</span></code> string</p></li>
<li><p><code class="docutils literal notranslate"><span class="pre">parameterSetID</span></code> string</p></li>
<li><p><code class="docutils literal notranslate"><span class="pre">enabled</span></code> boolean</p></li>
</ul>
<p><strong>Methods</strong>:</p>
<dl class="method">
<dt id="seiscomp.datamodel.Setup.Cast">
<em class="property">static </em><code class="sig-name descname">Cast</code><span class="sig-paren">(</span><em class="sig-param">obj</em><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.Setup.Cast" title="Permalink to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>obj</strong> The object to be casted.</p>
</dd>
<dt class="field-even">Return type</dt>
<dd class="field-even"><p>An object of type Setup if the cast was successful,
None otherwise.</p>
</dd>
</dl>
<p>Cast an arbitrary object to Setup if the internal wrapped
representation is an Setup object. The cast is important if
instances of type <a class="reference internal" href="#api-python-datamodel-object"><span class="std std-ref">Object</span></a>
are passed to methods which need access to the real type.</p>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.Setup.equal">
<code class="sig-name descname">equal</code><span class="sig-paren">(</span><em class="sig-param">other</em><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.Setup.equal" title="Permalink to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>other</strong> Another object of type Setup to compare this
instance to</p>
</dd>
<dt class="field-even">Return type</dt>
<dd class="field-even"><p>A Boolean value indicating True if both objects are equal or
False otherwise.</p>
</dd>
</dl>
<p>Compares two objects without its child objects. Both objects are compared
by value.</p>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.Setup.index">
<code class="sig-name descname">index</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.Setup.index" title="Permalink to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Return type</dt>
<dd class="field-odd"><p><p>The objects index of type SetupIndex.</p>
<p>Returns the objects index which is also used for the database as unique
constraint.</p>
</p>
</dd>
</dl>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.Setup.equalIndex">
<code class="sig-name descname">equalIndex</code><span class="sig-paren">(</span><em class="sig-param">lhs</em><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.Setup.equalIndex" title="Permalink to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>lhs</strong> <a class="reference internal" href="#api-python-datamodel-setup"><span class="std std-ref">Setup</span></a></p>
</dd>
<dt class="field-even">Return type</dt>
<dd class="field-even"><p>A Boolean value indicating True if both indexes are equal or
False otherwise.</p>
</dd>
</dl>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.Setup.setName">
<code class="sig-name descname">setName</code><span class="sig-paren">(</span><em class="sig-param">name</em><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.Setup.setName" title="Permalink to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>name</strong> string</p>
</dd>
</dl>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.Setup.name">
<code class="sig-name descname">name</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.Setup.name" title="Permalink to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Return type</dt>
<dd class="field-odd"><p>string</p>
</dd>
</dl>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.Setup.setParameterSetID">
<code class="sig-name descname">setParameterSetID</code><span class="sig-paren">(</span><em class="sig-param">parameterSetID</em><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.Setup.setParameterSetID" title="Permalink to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>parameterSetID</strong> string</p>
</dd>
</dl>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.Setup.parameterSetID">
<code class="sig-name descname">parameterSetID</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.Setup.parameterSetID" title="Permalink to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Return type</dt>
<dd class="field-odd"><p>string</p>
</dd>
</dl>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.Setup.setEnabled">
<code class="sig-name descname">setEnabled</code><span class="sig-paren">(</span><em class="sig-param">enabled</em><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.Setup.setEnabled" title="Permalink to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>enabled</strong> boolean</p>
</dd>
</dl>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.Setup.enabled">
<code class="sig-name descname">enabled</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.Setup.enabled" title="Permalink to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Return type</dt>
<dd class="field-odd"><p>boolean</p>
</dd>
</dl>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.Setup.configStation">
<code class="sig-name descname">configStation</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.Setup.configStation" title="Permalink to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Return type</dt>
<dd class="field-odd"><p><a class="reference internal" href="#seiscomp.datamodel.ConfigStation" title="seiscomp.datamodel.ConfigStation">ConfigStation</a></p>
</dd>
</dl>
<p>Returns the parent ConfigStation if available. Returns None
if the parent is not a ConfigStation. This is a convenience wrapper
for parent().</p>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.Setup.assign">
<code class="sig-name descname">assign</code><span class="sig-paren">(</span><em class="sig-param">other</em><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.Setup.assign" title="Permalink to this definition"></a></dt>
<dd><p>This method implements the <a class="reference internal" href="#api-python-datamodel-object"><span class="std std-ref">Object</span></a> interface.</p>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.Setup.attachTo">
<code class="sig-name descname">attachTo</code><span class="sig-paren">(</span><em class="sig-param">parent</em><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.Setup.attachTo" title="Permalink to this definition"></a></dt>
<dd><p>This method implements the <a class="reference internal" href="#api-python-datamodel-object"><span class="std std-ref">Object</span></a> interface.</p>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.Setup.detachFrom">
<code class="sig-name descname">detachFrom</code><span class="sig-paren">(</span><em class="sig-param">parent</em><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.Setup.detachFrom" title="Permalink to this definition"></a></dt>
<dd><p>This method implements the <a class="reference internal" href="#api-python-datamodel-object"><span class="std std-ref">Object</span></a> interface.</p>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.Setup.detach">
<code class="sig-name descname">detach</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.Setup.detach" title="Permalink to this definition"></a></dt>
<dd><p>This method implements the <a class="reference internal" href="#api-python-datamodel-object"><span class="std std-ref">Object</span></a> interface.</p>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.Setup.clone">
<code class="sig-name descname">clone</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.Setup.clone" title="Permalink to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Return type</dt>
<dd class="field-odd"><p>A cloned Setup.</p>
</dd>
</dl>
<p>Returns a new instance that is a clone of the current instance. Child
objects are being ignored.</p>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.Setup.accept">
<code class="sig-name descname">accept</code><span class="sig-paren">(</span><em class="sig-param">visitor</em><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.Setup.accept" title="Permalink to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>visitor</strong> A visitor.</p>
</dd>
</dl>
<p>This method implements the <a class="reference internal" href="#api-python-datamodel-publicobject"><span class="std std-ref">PublicObject</span></a> interface.</p>
</dd></dl>
</dd></dl>
</div>
<div class="section" id="sourcetimefunction">
<span id="api-python-datamodel-sourcetimefunction"></span><h3>SourceTimeFunction<a class="headerlink" href="#sourcetimefunction" title="Permalink to this headline"></a></h3>
<dl class="class">
<dt id="seiscomp.datamodel.SourceTimeFunction">
<em class="property">class </em><code class="sig-prename descclassname">seiscomp.datamodel.</code><code class="sig-name descname">SourceTimeFunction</code><a class="headerlink" href="#seiscomp.datamodel.SourceTimeFunction" title="Permalink to this definition"></a></dt>
<dd><p>Inherits <a class="reference internal" href="#api-python-datamodel-object"><span class="std std-ref">Object</span></a>.</p>
<p>Source time function used in moment-tensor inversion.</p>
<p><strong>Attributes</strong>:</p>
<ul class="simple">
<li><p><code class="docutils literal notranslate"><span class="pre">type</span></code> <a class="reference internal" href="#api-python-datamodel-sourcetimefunctiontype"><span class="std std-ref">SourceTimeFunctionType</span></a></p></li>
<li><p><code class="docutils literal notranslate"><span class="pre">duration</span></code> float</p></li>
<li><p><code class="docutils literal notranslate"><span class="pre">riseTime</span></code> float (optional)</p></li>
<li><p><code class="docutils literal notranslate"><span class="pre">decayTime</span></code> float (optional)</p></li>
</ul>
<p><strong>Used by</strong>:</p>
<ul class="simple">
<li><p><a class="reference internal" href="#seiscomp.datamodel.MomentTensor.sourceTimeFunction" title="seiscomp.datamodel.MomentTensor.sourceTimeFunction"><code class="xref py py-func docutils literal notranslate"><span class="pre">MomentTensor.sourceTimeFunction()</span></code></a></p></li>
</ul>
<p><strong>Methods</strong>:</p>
<dl class="method">
<dt id="seiscomp.datamodel.SourceTimeFunction.Cast">
<em class="property">static </em><code class="sig-name descname">Cast</code><span class="sig-paren">(</span><em class="sig-param">obj</em><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.SourceTimeFunction.Cast" title="Permalink to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>obj</strong> The object to be casted.</p>
</dd>
<dt class="field-even">Return type</dt>
<dd class="field-even"><p>An object of type SourceTimeFunction if the cast was successful,
None otherwise.</p>
</dd>
</dl>
<p>Cast an arbitrary object to SourceTimeFunction if the internal wrapped
representation is an SourceTimeFunction object. The cast is important if
instances of type <a class="reference internal" href="#api-python-datamodel-object"><span class="std std-ref">Object</span></a>
are passed to methods which need access to the real type.</p>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.SourceTimeFunction.equal">
<code class="sig-name descname">equal</code><span class="sig-paren">(</span><em class="sig-param">other</em><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.SourceTimeFunction.equal" title="Permalink to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>other</strong> Another object of type SourceTimeFunction to compare this
instance to</p>
</dd>
<dt class="field-even">Return type</dt>
<dd class="field-even"><p>A Boolean value indicating True if both objects are equal or
False otherwise.</p>
</dd>
</dl>
<p>Compares two objects without its child objects. Both objects are compared
by value.</p>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.SourceTimeFunction.setType">
<code class="sig-name descname">setType</code><span class="sig-paren">(</span><em class="sig-param">type</em><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.SourceTimeFunction.setType" title="Permalink to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>type</strong> SourceTimeFunctionType</p>
</dd>
</dl>
<p>Type of source time function. Values can be taken from the following:
BOX_CAR, TRIANGLE, TRAPEZOID, UNKNOWN_FUNCTION.</p>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.SourceTimeFunction.type">
<code class="sig-name descname">type</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.SourceTimeFunction.type" title="Permalink to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Return type</dt>
<dd class="field-odd"><p>SourceTimeFunctionType</p>
</dd>
</dl>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.SourceTimeFunction.setDuration">
<code class="sig-name descname">setDuration</code><span class="sig-paren">(</span><em class="sig-param">duration</em><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.SourceTimeFunction.setDuration" title="Permalink to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>duration</strong> float</p>
</dd>
</dl>
<p>Source time function duration in seconds.</p>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.SourceTimeFunction.duration">
<code class="sig-name descname">duration</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.SourceTimeFunction.duration" title="Permalink to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Return type</dt>
<dd class="field-odd"><p>float</p>
</dd>
</dl>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.SourceTimeFunction.setRiseTime">
<code class="sig-name descname">setRiseTime</code><span class="sig-paren">(</span><em class="sig-param">riseTime</em><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.SourceTimeFunction.setRiseTime" title="Permalink to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>riseTime</strong> float</p>
</dd>
</dl>
<p>Source time function rise time in seconds.</p>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.SourceTimeFunction.riseTime">
<code class="sig-name descname">riseTime</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.SourceTimeFunction.riseTime" title="Permalink to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Return type</dt>
<dd class="field-odd"><p>float</p>
</dd>
</dl>
<div class="admonition note">
<p class="admonition-title">Note</p>
<p>As this attribute is optional, this method throws a ValueError if
the value of the attribute is not set.</p>
</div>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.SourceTimeFunction.setDecayTime">
<code class="sig-name descname">setDecayTime</code><span class="sig-paren">(</span><em class="sig-param">decayTime</em><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.SourceTimeFunction.setDecayTime" title="Permalink to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>decayTime</strong> float</p>
</dd>
</dl>
<p>Source time function decay time in seconds.</p>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.SourceTimeFunction.decayTime">
<code class="sig-name descname">decayTime</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.SourceTimeFunction.decayTime" title="Permalink to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Return type</dt>
<dd class="field-odd"><p>float</p>
</dd>
</dl>
<div class="admonition note">
<p class="admonition-title">Note</p>
<p>As this attribute is optional, this method throws a ValueError if
the value of the attribute is not set.</p>
</div>
</dd></dl>
</dd></dl>
</div>
<div class="section" id="station">
<span id="api-python-datamodel-station"></span><h3>Station<a class="headerlink" href="#station" title="Permalink to this headline"></a></h3>
<dl class="class">
<dt id="seiscomp.datamodel.Station">
<em class="property">class </em><code class="sig-prename descclassname">seiscomp.datamodel.</code><code class="sig-name descname">Station</code><a class="headerlink" href="#seiscomp.datamodel.Station" title="Permalink to this definition"></a></dt>
<dd><p>Inherits <a class="reference internal" href="#api-python-datamodel-publicobject"><span class="std std-ref">PublicObject</span></a>.</p>
<p>This type describes a seismic station</p>
<p><strong>Parents</strong>:</p>
<ul class="simple">
<li><p><code class="docutils literal notranslate"><span class="pre">network</span></code> <a class="reference internal" href="#api-python-datamodel-network"><span class="std std-ref">Network</span></a></p></li>
</ul>
<p><strong>Children</strong>:</p>
<ul class="simple">
<li><p><code class="docutils literal notranslate"><span class="pre">comment</span></code> <a class="reference internal" href="#api-python-datamodel-comment"><span class="std std-ref">Comment</span></a></p></li>
<li><p><code class="docutils literal notranslate"><span class="pre">sensorLocation</span></code> <a class="reference internal" href="#api-python-datamodel-sensorlocation"><span class="std std-ref">SensorLocation</span></a></p></li>
</ul>
<p><strong>Attributes</strong>:</p>
<ul class="simple">
<li><p><code class="docutils literal notranslate"><span class="pre">publicID</span></code>: string</p></li>
<li><p><code class="docutils literal notranslate"><span class="pre">code</span></code> string</p></li>
<li><p><code class="docutils literal notranslate"><span class="pre">start</span></code> seiscomp.core.Time</p></li>
<li><p><code class="docutils literal notranslate"><span class="pre">end</span></code> seiscomp.core.Time (optional)</p></li>
<li><p><code class="docutils literal notranslate"><span class="pre">description</span></code> string</p></li>
<li><p><code class="docutils literal notranslate"><span class="pre">latitude</span></code> float (optional)</p></li>
<li><p><code class="docutils literal notranslate"><span class="pre">longitude</span></code> float (optional)</p></li>
<li><p><code class="docutils literal notranslate"><span class="pre">elevation</span></code> float (optional)</p></li>
<li><p><code class="docutils literal notranslate"><span class="pre">place</span></code> string</p></li>
<li><p><code class="docutils literal notranslate"><span class="pre">country</span></code> string</p></li>
<li><p><code class="docutils literal notranslate"><span class="pre">affiliation</span></code> string</p></li>
<li><p><code class="docutils literal notranslate"><span class="pre">type</span></code> string</p></li>
<li><p><code class="docutils literal notranslate"><span class="pre">archive</span></code> string</p></li>
<li><p><code class="docutils literal notranslate"><span class="pre">archiveNetworkCode</span></code> string</p></li>
<li><p><code class="docutils literal notranslate"><span class="pre">restricted</span></code> boolean (optional)</p></li>
<li><p><code class="docutils literal notranslate"><span class="pre">shared</span></code> boolean (optional)</p></li>
<li><p><code class="docutils literal notranslate"><span class="pre">remark</span></code> <a class="reference internal" href="#api-python-datamodel-blob"><span class="std std-ref">Blob</span></a> (optional)</p></li>
</ul>
<p><strong>Referenced by</strong>:</p>
<ul class="simple">
<li><p><a class="reference internal" href="#seiscomp.datamodel.StationReference.stationID" title="seiscomp.datamodel.StationReference.stationID"><code class="xref py py-func docutils literal notranslate"><span class="pre">StationReference.stationID()</span></code></a></p></li>
</ul>
<p><strong>Methods</strong>:</p>
<dl class="method">
<dt id="seiscomp.datamodel.Station.Cast">
<em class="property">static </em><code class="sig-name descname">Cast</code><span class="sig-paren">(</span><em class="sig-param">obj</em><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.Station.Cast" title="Permalink to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>obj</strong> The object to be casted.</p>
</dd>
<dt class="field-even">Return type</dt>
<dd class="field-even"><p>An object of type Station if the cast was successful,
None otherwise.</p>
</dd>
</dl>
<p>Cast an arbitrary object to Station if the internal wrapped
representation is an Station object. The cast is important if
instances of type <a class="reference internal" href="#api-python-datamodel-object"><span class="std std-ref">Object</span></a>
are passed to methods which need access to the real type.</p>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.Station.Create">
<em class="property">static </em><code class="sig-name descname">Create</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.Station.Create" title="Permalink to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Return type</dt>
<dd class="field-odd"><p>A new object of type Station.</p>
</dd>
</dl>
<p>Creates and registers (if enabled) a Station instance. The
publicID is auto-generated.</p>
</dd></dl>
<dl class="method">
<dt>
<em class="property">static </em><code class="sig-name descname">Create</code><span class="sig-paren">(</span><em class="sig-param">publicID</em><span class="sig-paren">)</span></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Return type</dt>
<dd class="field-odd"><p>A new object of type Station.</p>
</dd>
</dl>
<p>Creates and registers (if enabled) a Station instance with
passed publicID.</p>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.Station.equal">
<code class="sig-name descname">equal</code><span class="sig-paren">(</span><em class="sig-param">other</em><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.Station.equal" title="Permalink to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>other</strong> Another object of type Station to compare this
instance to</p>
</dd>
<dt class="field-even">Return type</dt>
<dd class="field-even"><p>A Boolean value indicating True if both objects are equal or
False otherwise.</p>
</dd>
</dl>
<p>Compares two objects without its child objects. Both objects are compared
by value.</p>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.Station.index">
<code class="sig-name descname">index</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.Station.index" title="Permalink to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Return type</dt>
<dd class="field-odd"><p><p>The objects index of type StationIndex.</p>
<p>Returns the objects index which is also used for the database as unique
constraint.</p>
</p>
</dd>
</dl>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.Station.equalIndex">
<code class="sig-name descname">equalIndex</code><span class="sig-paren">(</span><em class="sig-param">lhs</em><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.Station.equalIndex" title="Permalink to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>lhs</strong> <a class="reference internal" href="#api-python-datamodel-station"><span class="std std-ref">Station</span></a></p>
</dd>
<dt class="field-even">Return type</dt>
<dd class="field-even"><p>A Boolean value indicating True if both indexes are equal or
False otherwise.</p>
</dd>
</dl>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.Station.setCode">
<code class="sig-name descname">setCode</code><span class="sig-paren">(</span><em class="sig-param">code</em><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.Station.setCode" title="Permalink to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>code</strong> string</p>
</dd>
</dl>
<p>Station code (50.03)</p>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.Station.code">
<code class="sig-name descname">code</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.Station.code" title="Permalink to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Return type</dt>
<dd class="field-odd"><p>string</p>
</dd>
</dl>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.Station.setStart">
<code class="sig-name descname">setStart</code><span class="sig-paren">(</span><em class="sig-param">start</em><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.Station.setStart" title="Permalink to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>start</strong> seiscomp.core.Time</p>
</dd>
</dl>
<p>Start of station epoch in ISO datetime format</p>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.Station.start">
<code class="sig-name descname">start</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.Station.start" title="Permalink to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Return type</dt>
<dd class="field-odd"><p>seiscomp.core.Time</p>
</dd>
</dl>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.Station.setEnd">
<code class="sig-name descname">setEnd</code><span class="sig-paren">(</span><em class="sig-param">end</em><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.Station.setEnd" title="Permalink to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>end</strong> seiscomp.core.Time</p>
</dd>
</dl>
<p>End of station epoch. Empty string if the station is open</p>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.Station.end">
<code class="sig-name descname">end</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.Station.end" title="Permalink to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Return type</dt>
<dd class="field-odd"><p>seiscomp.core.Time</p>
</dd>
</dl>
<div class="admonition note">
<p class="admonition-title">Note</p>
<p>As this attribute is optional, this method throws a ValueError if
the value of the attribute is not set.</p>
</div>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.Station.setDescription">
<code class="sig-name descname">setDescription</code><span class="sig-paren">(</span><em class="sig-param">description</em><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.Station.setDescription" title="Permalink to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>description</strong> string</p>
</dd>
</dl>
<p>Station description in ASCII (50.09)</p>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.Station.description">
<code class="sig-name descname">description</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.Station.description" title="Permalink to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Return type</dt>
<dd class="field-odd"><p>string</p>
</dd>
</dl>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.Station.setLatitude">
<code class="sig-name descname">setLatitude</code><span class="sig-paren">(</span><em class="sig-param">latitude</em><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.Station.setLatitude" title="Permalink to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>latitude</strong> float</p>
</dd>
</dl>
<p>Station latitude (50.04) with respect to the World Geodetic System
1984 (WGS84) reference system (National Imagery and Mapping Agency
2000) in degrees.</p>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.Station.latitude">
<code class="sig-name descname">latitude</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.Station.latitude" title="Permalink to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Return type</dt>
<dd class="field-odd"><p>float</p>
</dd>
</dl>
<div class="admonition note">
<p class="admonition-title">Note</p>
<p>As this attribute is optional, this method throws a ValueError if
the value of the attribute is not set.</p>
</div>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.Station.setLongitude">
<code class="sig-name descname">setLongitude</code><span class="sig-paren">(</span><em class="sig-param">longitude</em><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.Station.setLongitude" title="Permalink to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>longitude</strong> float</p>
</dd>
</dl>
<p>Station longitude (50.05) with respect to the World Geodetic System
1984 (WGS84) reference system (National Imagery and Mapping Agency
2000) in degrees.</p>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.Station.longitude">
<code class="sig-name descname">longitude</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.Station.longitude" title="Permalink to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Return type</dt>
<dd class="field-odd"><p>float</p>
</dd>
</dl>
<div class="admonition note">
<p class="admonition-title">Note</p>
<p>As this attribute is optional, this method throws a ValueError if
the value of the attribute is not set.</p>
</div>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.Station.setElevation">
<code class="sig-name descname">setElevation</code><span class="sig-paren">(</span><em class="sig-param">elevation</em><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.Station.setElevation" title="Permalink to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>elevation</strong> float</p>
</dd>
</dl>
<p>Station elevation (50.06) with respect to the World Geodetic System
1984 (WGS84) reference system (National Imagery and Mapping Agency
2000) in meters.</p>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.Station.elevation">
<code class="sig-name descname">elevation</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.Station.elevation" title="Permalink to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Return type</dt>
<dd class="field-odd"><p>float</p>
</dd>
</dl>
<div class="admonition note">
<p class="admonition-title">Note</p>
<p>As this attribute is optional, this method throws a ValueError if
the value of the attribute is not set.</p>
</div>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.Station.setPlace">
<code class="sig-name descname">setPlace</code><span class="sig-paren">(</span><em class="sig-param">place</em><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.Station.setPlace" title="Permalink to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>place</strong> string</p>
</dd>
</dl>
<p>Place where the station is located (UTF-8)</p>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.Station.place">
<code class="sig-name descname">place</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.Station.place" title="Permalink to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Return type</dt>
<dd class="field-odd"><p>string</p>
</dd>
</dl>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.Station.setCountry">
<code class="sig-name descname">setCountry</code><span class="sig-paren">(</span><em class="sig-param">country</em><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.Station.setCountry" title="Permalink to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>country</strong> string</p>
</dd>
</dl>
<p>Country where the station is located (UTF-8)</p>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.Station.country">
<code class="sig-name descname">country</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.Station.country" title="Permalink to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Return type</dt>
<dd class="field-odd"><p>string</p>
</dd>
</dl>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.Station.setAffiliation">
<code class="sig-name descname">setAffiliation</code><span class="sig-paren">(</span><em class="sig-param">affiliation</em><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.Station.setAffiliation" title="Permalink to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>affiliation</strong> string</p>
</dd>
</dl>
<p>Station affiliation (eg., GEOFON)</p>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.Station.affiliation">
<code class="sig-name descname">affiliation</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.Station.affiliation" title="Permalink to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Return type</dt>
<dd class="field-odd"><p>string</p>
</dd>
</dl>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.Station.setType">
<code class="sig-name descname">setType</code><span class="sig-paren">(</span><em class="sig-param">type</em><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.Station.setType" title="Permalink to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>type</strong> string</p>
</dd>
</dl>
<p>Type of station (eg., VBB, SP)</p>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.Station.type">
<code class="sig-name descname">type</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.Station.type" title="Permalink to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Return type</dt>
<dd class="field-odd"><p>string</p>
</dd>
</dl>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.Station.setArchive">
<code class="sig-name descname">setArchive</code><span class="sig-paren">(</span><em class="sig-param">archive</em><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.Station.setArchive" title="Permalink to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>archive</strong> string</p>
</dd>
</dl>
<p>Archive/Datacenter ID (metadata authority)</p>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.Station.archive">
<code class="sig-name descname">archive</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.Station.archive" title="Permalink to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Return type</dt>
<dd class="field-odd"><p>string</p>
</dd>
</dl>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.Station.setArchiveNetworkCode">
<code class="sig-name descname">setArchiveNetworkCode</code><span class="sig-paren">(</span><em class="sig-param">archiveNetworkCode</em><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.Station.setArchiveNetworkCode" title="Permalink to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>archiveNetworkCode</strong> string</p>
</dd>
</dl>
<p>Internal network code, under which this station is archived</p>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.Station.archiveNetworkCode">
<code class="sig-name descname">archiveNetworkCode</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.Station.archiveNetworkCode" title="Permalink to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Return type</dt>
<dd class="field-odd"><p>string</p>
</dd>
</dl>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.Station.setRestricted">
<code class="sig-name descname">setRestricted</code><span class="sig-paren">(</span><em class="sig-param">restricted</em><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.Station.setRestricted" title="Permalink to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>restricted</strong> boolean</p>
</dd>
</dl>
<p>Whether the station is “restricted”</p>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.Station.restricted">
<code class="sig-name descname">restricted</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.Station.restricted" title="Permalink to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Return type</dt>
<dd class="field-odd"><p>boolean</p>
</dd>
</dl>
<div class="admonition note">
<p class="admonition-title">Note</p>
<p>As this attribute is optional, this method throws a ValueError if
the value of the attribute is not set.</p>
</div>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.Station.setShared">
<code class="sig-name descname">setShared</code><span class="sig-paren">(</span><em class="sig-param">shared</em><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.Station.setShared" title="Permalink to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>shared</strong> boolean</p>
</dd>
</dl>
<p>Whether the metadata is synchronized with other datacenters</p>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.Station.shared">
<code class="sig-name descname">shared</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.Station.shared" title="Permalink to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Return type</dt>
<dd class="field-odd"><p>boolean</p>
</dd>
</dl>
<div class="admonition note">
<p class="admonition-title">Note</p>
<p>As this attribute is optional, this method throws a ValueError if
the value of the attribute is not set.</p>
</div>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.Station.setRemark">
<code class="sig-name descname">setRemark</code><span class="sig-paren">(</span><em class="sig-param">remark</em><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.Station.setRemark" title="Permalink to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>remark</strong> <a class="reference internal" href="#api-python-datamodel-blob"><span class="std std-ref">Blob</span></a></p>
</dd>
</dl>
<p>Any notes</p>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.Station.remark">
<code class="sig-name descname">remark</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.Station.remark" title="Permalink to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Return type</dt>
<dd class="field-odd"><p><a class="reference internal" href="#api-python-datamodel-blob"><span class="std std-ref">Blob</span></a></p>
</dd>
</dl>
<div class="admonition note">
<p class="admonition-title">Note</p>
<p>As this attribute is optional, this method throws a ValueError if
the value of the attribute is not set.</p>
</div>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.Station.add">
<code class="sig-name descname">add</code><span class="sig-paren">(</span><em class="sig-param">comment</em><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.Station.add" title="Permalink to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>comment</strong> Object of type <a class="reference internal" href="#api-python-datamodel-comment"><span class="std std-ref">Comment</span></a></p>
</dd>
<dt class="field-even">Return type</dt>
<dd class="field-even"><p>A Boolean value indicating success with True, False otherwise.</p>
</dd>
</dl>
<p>Adds a Comment object to Station. The object is not
copied but managed by this instance. Any change to the passed object
will also change the child.</p>
</dd></dl>
<dl class="method">
<dt>
<code class="sig-name descname">add</code><span class="sig-paren">(</span><em class="sig-param">sensorLocation</em><span class="sig-paren">)</span></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>sensorLocation</strong> Object of type <a class="reference internal" href="#api-python-datamodel-sensorlocation"><span class="std std-ref">SensorLocation</span></a></p>
</dd>
<dt class="field-even">Return type</dt>
<dd class="field-even"><p>A Boolean value indicating success with True, False otherwise.</p>
</dd>
</dl>
<p>Adds a SensorLocation object to Station. The object is not
copied but managed by this instance. Any change to the passed object
will also change the child.</p>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.Station.remove">
<code class="sig-name descname">remove</code><span class="sig-paren">(</span><em class="sig-param">comment</em><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.Station.remove" title="Permalink to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>comment</strong> Object of type <a class="reference internal" href="#api-python-datamodel-comment"><span class="std std-ref">Comment</span></a></p>
</dd>
<dt class="field-even">Return type</dt>
<dd class="field-even"><p>A Boolean value indicating success with True, False otherwise.</p>
</dd>
</dl>
<p>Removes a previously added Comment object from Station.</p>
</dd></dl>
<dl class="method">
<dt>
<code class="sig-name descname">remove</code><span class="sig-paren">(</span><em class="sig-param">sensorLocation</em><span class="sig-paren">)</span></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>sensorLocation</strong> Object of type <a class="reference internal" href="#api-python-datamodel-sensorlocation"><span class="std std-ref">SensorLocation</span></a></p>
</dd>
<dt class="field-even">Return type</dt>
<dd class="field-even"><p>A Boolean value indicating success with True, False otherwise.</p>
</dd>
</dl>
<p>Removes a previously added SensorLocation object from Station.</p>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.Station.removeComment">
<code class="sig-name descname">removeComment</code><span class="sig-paren">(</span><em class="sig-param">idx</em><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.Station.removeComment" title="Permalink to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>idx</strong> An integer index of the object to be removed.</p>
</dd>
<dt class="field-even">Return type</dt>
<dd class="field-even"><p>A Boolean value indicating success with True, False otherwise.</p>
</dd>
</dl>
</dd></dl>
<dl class="method">
<dt>
<code class="sig-name descname">removeComment(commentIndex);</code></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>commentIndex</strong> The index of the object to be removed of type CommentIndex.</p>
</dd>
<dt class="field-even">Return type</dt>
<dd class="field-even"><p>A Boolean value indicating success with True, False otherwise.</p>
</dd>
</dl>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.Station.removeSensorLocation">
<code class="sig-name descname">removeSensorLocation</code><span class="sig-paren">(</span><em class="sig-param">idx</em><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.Station.removeSensorLocation" title="Permalink to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>idx</strong> An integer index of the object to be removed.</p>
</dd>
<dt class="field-even">Return type</dt>
<dd class="field-even"><p>A Boolean value indicating success with True, False otherwise.</p>
</dd>
</dl>
</dd></dl>
<dl class="method">
<dt>
<code class="sig-name descname">removeSensorLocation(sensorLocationIndex);</code></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>sensorLocationIndex</strong> The index of the object to be removed of type SensorLocationIndex.</p>
</dd>
<dt class="field-even">Return type</dt>
<dd class="field-even"><p>A Boolean value indicating success with True, False otherwise.</p>
</dd>
</dl>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.Station.commentCount">
<code class="sig-name descname">commentCount</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.Station.commentCount" title="Permalink to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Return type</dt>
<dd class="field-odd"><p>integer value indicating the number of child objects.</p>
</dd>
</dl>
<p>Returns the number of Comment child objects.</p>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.Station.sensorLocationCount">
<code class="sig-name descname">sensorLocationCount</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.Station.sensorLocationCount" title="Permalink to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Return type</dt>
<dd class="field-odd"><p>integer value indicating the number of child objects.</p>
</dd>
</dl>
<p>Returns the number of SensorLocation child objects.</p>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.Station.comment">
<code class="sig-name descname">comment</code><span class="sig-paren">(</span><em class="sig-param">idx</em><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.Station.comment" title="Permalink to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>idx</strong> An integer index of the object to be returned.</p>
</dd>
<dt class="field-even">Return type</dt>
<dd class="field-even"><p>Object of type <a class="reference internal" href="#api-python-datamodel-comment"><span class="std std-ref">Comment</span></a>.</p>
</dd>
</dl>
<p>Returns the Comment at index idx.</p>
</dd></dl>
<dl class="method">
<dt>
<code class="sig-name descname">comment</code><span class="sig-paren">(</span><em class="sig-param">commentIndex</em><span class="sig-paren">)</span></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>commentIndex</strong> The index of the object to be removed of type CommentIndex.</p>
</dd>
<dt class="field-even">Return type</dt>
<dd class="field-even"><p>Object of type <a class="reference internal" href="#api-python-datamodel-comment"><span class="std std-ref">Comment</span></a>.</p>
</dd>
</dl>
<p>Returns the Comment at given index. The indexes of all child objects
are compared by value which makes this function slower than the direct
integer index look-up.</p>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.Station.sensorLocation">
<code class="sig-name descname">sensorLocation</code><span class="sig-paren">(</span><em class="sig-param">idx</em><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.Station.sensorLocation" title="Permalink to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>idx</strong> An integer index of the object to be returned.</p>
</dd>
<dt class="field-even">Return type</dt>
<dd class="field-even"><p>Object of type <a class="reference internal" href="#api-python-datamodel-sensorlocation"><span class="std std-ref">SensorLocation</span></a>.</p>
</dd>
</dl>
<p>Returns the SensorLocation at index idx.</p>
</dd></dl>
<dl class="method">
<dt>
<code class="sig-name descname">sensorLocation</code><span class="sig-paren">(</span><em class="sig-param">sensorLocationIndex</em><span class="sig-paren">)</span></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>sensorLocationIndex</strong> The index of the object to be removed of type SensorLocationIndex.</p>
</dd>
<dt class="field-even">Return type</dt>
<dd class="field-even"><p>Object of type <a class="reference internal" href="#api-python-datamodel-sensorlocation"><span class="std std-ref">SensorLocation</span></a>.</p>
</dd>
</dl>
<p>Returns the SensorLocation at given index. The indexes of all child objects
are compared by value which makes this function slower than the direct
integer index look-up.</p>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.Station.findSensorLocation">
<code class="sig-name descname">findSensorLocation</code><span class="sig-paren">(</span><em class="sig-param">publicID</em><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.Station.findSensorLocation" title="Permalink to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>publicID</strong> The publicID of the object to find.</p>
</dd>
<dt class="field-even">Return type</dt>
<dd class="field-even"><p>Object of type <a class="reference internal" href="#api-python-datamodel-sensorlocation"><span class="std std-ref">SensorLocation</span></a>.</p>
</dd>
</dl>
<p>Returns the child object with a certain publicID, None otherwise.</p>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.Station.network">
<code class="sig-name descname">network</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.Station.network" title="Permalink to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Return type</dt>
<dd class="field-odd"><p><a class="reference internal" href="#seiscomp.datamodel.Network" title="seiscomp.datamodel.Network">Network</a></p>
</dd>
</dl>
<p>Returns the parent Network if available. Returns None
if the parent is not a Network. This is a convenience wrapper
for parent().</p>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.Station.assign">
<code class="sig-name descname">assign</code><span class="sig-paren">(</span><em class="sig-param">other</em><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.Station.assign" title="Permalink to this definition"></a></dt>
<dd><p>This method implements the <a class="reference internal" href="#api-python-datamodel-object"><span class="std std-ref">Object</span></a> interface.</p>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.Station.attachTo">
<code class="sig-name descname">attachTo</code><span class="sig-paren">(</span><em class="sig-param">parent</em><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.Station.attachTo" title="Permalink to this definition"></a></dt>
<dd><p>This method implements the <a class="reference internal" href="#api-python-datamodel-object"><span class="std std-ref">Object</span></a> interface.</p>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.Station.detachFrom">
<code class="sig-name descname">detachFrom</code><span class="sig-paren">(</span><em class="sig-param">parent</em><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.Station.detachFrom" title="Permalink to this definition"></a></dt>
<dd><p>This method implements the <a class="reference internal" href="#api-python-datamodel-object"><span class="std std-ref">Object</span></a> interface.</p>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.Station.detach">
<code class="sig-name descname">detach</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.Station.detach" title="Permalink to this definition"></a></dt>
<dd><p>This method implements the <a class="reference internal" href="#api-python-datamodel-object"><span class="std std-ref">Object</span></a> interface.</p>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.Station.clone">
<code class="sig-name descname">clone</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.Station.clone" title="Permalink to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Return type</dt>
<dd class="field-odd"><p>A cloned Station.</p>
</dd>
</dl>
<p>Returns a new instance that is a clone of the current instance. Child
objects are being ignored.</p>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.Station.updateChild">
<code class="sig-name descname">updateChild</code><span class="sig-paren">(</span><em class="sig-param">ref</em><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.Station.updateChild" title="Permalink to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>ref</strong> A child object derived from class Object.</p>
</dd>
<dt class="field-even">Return type</dt>
<dd class="field-even"><p>A Boolean flag indicating success with True, False otherwise</p>
</dd>
</dl>
<p>This method takes the passed reference object and searches for a child
with the same publicID (if derived from <a class="reference internal" href="#api-python-datamodel-publicobject"><span class="std std-ref">PublicObject</span></a>)
or the same index (if derived from <a class="reference internal" href="#api-python-datamodel-object"><span class="std std-ref">Object</span></a>).
The the child was found the reference objects attributes are copied to
the child object. Children of child are being ignored during this operation.
This method implements the <a class="reference internal" href="#api-python-datamodel-publicobject"><span class="std std-ref">PublicObject</span></a> interface.</p>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.Station.accept">
<code class="sig-name descname">accept</code><span class="sig-paren">(</span><em class="sig-param">visitor</em><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.Station.accept" title="Permalink to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>visitor</strong> A visitor.</p>
</dd>
</dl>
<p>This method implements the <a class="reference internal" href="#api-python-datamodel-publicobject"><span class="std std-ref">PublicObject</span></a> interface.</p>
</dd></dl>
</dd></dl>
</div>
<div class="section" id="stationgroup">
<span id="api-python-datamodel-stationgroup"></span><h3>StationGroup<a class="headerlink" href="#stationgroup" title="Permalink to this headline"></a></h3>
<dl class="class">
<dt id="seiscomp.datamodel.StationGroup">
<em class="property">class </em><code class="sig-prename descclassname">seiscomp.datamodel.</code><code class="sig-name descname">StationGroup</code><a class="headerlink" href="#seiscomp.datamodel.StationGroup" title="Permalink to this definition"></a></dt>
<dd><p>Inherits <a class="reference internal" href="#api-python-datamodel-publicobject"><span class="std std-ref">PublicObject</span></a>.</p>
<p>This type describes a group of stations, an array or a virtual network</p>
<p><strong>Parents</strong>:</p>
<ul class="simple">
<li><p><code class="docutils literal notranslate"><span class="pre">inventory</span></code> <a class="reference internal" href="#api-python-datamodel-inventory"><span class="std std-ref">Inventory</span></a></p></li>
</ul>
<p><strong>Children</strong>:</p>
<ul class="simple">
<li><p><code class="docutils literal notranslate"><span class="pre">stationReference</span></code> <a class="reference internal" href="#api-python-datamodel-stationreference"><span class="std std-ref">StationReference</span></a></p></li>
</ul>
<p><strong>Attributes</strong>:</p>
<ul class="simple">
<li><p><code class="docutils literal notranslate"><span class="pre">publicID</span></code>: string</p></li>
<li><p><code class="docutils literal notranslate"><span class="pre">type</span></code> <a class="reference internal" href="#api-python-datamodel-stationgrouptype"><span class="std std-ref">StationGroupType</span></a> (optional)</p></li>
<li><p><code class="docutils literal notranslate"><span class="pre">code</span></code> string</p></li>
<li><p><code class="docutils literal notranslate"><span class="pre">start</span></code> seiscomp.core.Time (optional)</p></li>
<li><p><code class="docutils literal notranslate"><span class="pre">end</span></code> seiscomp.core.Time (optional)</p></li>
<li><p><code class="docutils literal notranslate"><span class="pre">description</span></code> string</p></li>
<li><p><code class="docutils literal notranslate"><span class="pre">latitude</span></code> float (optional)</p></li>
<li><p><code class="docutils literal notranslate"><span class="pre">longitude</span></code> float (optional)</p></li>
<li><p><code class="docutils literal notranslate"><span class="pre">elevation</span></code> float (optional)</p></li>
</ul>
<p><strong>Methods</strong>:</p>
<dl class="method">
<dt id="seiscomp.datamodel.StationGroup.Cast">
<em class="property">static </em><code class="sig-name descname">Cast</code><span class="sig-paren">(</span><em class="sig-param">obj</em><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.StationGroup.Cast" title="Permalink to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>obj</strong> The object to be casted.</p>
</dd>
<dt class="field-even">Return type</dt>
<dd class="field-even"><p>An object of type StationGroup if the cast was successful,
None otherwise.</p>
</dd>
</dl>
<p>Cast an arbitrary object to StationGroup if the internal wrapped
representation is an StationGroup object. The cast is important if
instances of type <a class="reference internal" href="#api-python-datamodel-object"><span class="std std-ref">Object</span></a>
are passed to methods which need access to the real type.</p>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.StationGroup.Create">
<em class="property">static </em><code class="sig-name descname">Create</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.StationGroup.Create" title="Permalink to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Return type</dt>
<dd class="field-odd"><p>A new object of type StationGroup.</p>
</dd>
</dl>
<p>Creates and registers (if enabled) a StationGroup instance. The
publicID is auto-generated.</p>
</dd></dl>
<dl class="method">
<dt>
<em class="property">static </em><code class="sig-name descname">Create</code><span class="sig-paren">(</span><em class="sig-param">publicID</em><span class="sig-paren">)</span></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Return type</dt>
<dd class="field-odd"><p>A new object of type StationGroup.</p>
</dd>
</dl>
<p>Creates and registers (if enabled) a StationGroup instance with
passed publicID.</p>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.StationGroup.equal">
<code class="sig-name descname">equal</code><span class="sig-paren">(</span><em class="sig-param">other</em><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.StationGroup.equal" title="Permalink to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>other</strong> Another object of type StationGroup to compare this
instance to</p>
</dd>
<dt class="field-even">Return type</dt>
<dd class="field-even"><p>A Boolean value indicating True if both objects are equal or
False otherwise.</p>
</dd>
</dl>
<p>Compares two objects without its child objects. Both objects are compared
by value.</p>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.StationGroup.index">
<code class="sig-name descname">index</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.StationGroup.index" title="Permalink to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Return type</dt>
<dd class="field-odd"><p><p>The objects index of type StationGroupIndex.</p>
<p>Returns the objects index which is also used for the database as unique
constraint.</p>
</p>
</dd>
</dl>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.StationGroup.equalIndex">
<code class="sig-name descname">equalIndex</code><span class="sig-paren">(</span><em class="sig-param">lhs</em><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.StationGroup.equalIndex" title="Permalink to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>lhs</strong> <a class="reference internal" href="#api-python-datamodel-stationgroup"><span class="std std-ref">StationGroup</span></a></p>
</dd>
<dt class="field-even">Return type</dt>
<dd class="field-even"><p>A Boolean value indicating True if both indexes are equal or
False otherwise.</p>
</dd>
</dl>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.StationGroup.setType">
<code class="sig-name descname">setType</code><span class="sig-paren">(</span><em class="sig-param">type</em><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.StationGroup.setType" title="Permalink to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>type</strong> StationGroupType</p>
</dd>
</dl>
<p>ARRAY or DEPLOYMENT</p>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.StationGroup.type">
<code class="sig-name descname">type</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.StationGroup.type" title="Permalink to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Return type</dt>
<dd class="field-odd"><p>StationGroupType</p>
</dd>
</dl>
<div class="admonition note">
<p class="admonition-title">Note</p>
<p>As this attribute is optional, this method throws a ValueError if
the value of the attribute is not set.</p>
</div>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.StationGroup.setCode">
<code class="sig-name descname">setCode</code><span class="sig-paren">(</span><em class="sig-param">code</em><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.StationGroup.setCode" title="Permalink to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>code</strong> string</p>
</dd>
</dl>
<p>Virtual network code (up to 20 characters)</p>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.StationGroup.code">
<code class="sig-name descname">code</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.StationGroup.code" title="Permalink to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Return type</dt>
<dd class="field-odd"><p>string</p>
</dd>
</dl>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.StationGroup.setStart">
<code class="sig-name descname">setStart</code><span class="sig-paren">(</span><em class="sig-param">start</em><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.StationGroup.setStart" title="Permalink to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>start</strong> seiscomp.core.Time</p>
</dd>
</dl>
<p>Start of epoch in ISO datetime format</p>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.StationGroup.start">
<code class="sig-name descname">start</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.StationGroup.start" title="Permalink to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Return type</dt>
<dd class="field-odd"><p>seiscomp.core.Time</p>
</dd>
</dl>
<div class="admonition note">
<p class="admonition-title">Note</p>
<p>As this attribute is optional, this method throws a ValueError if
the value of the attribute is not set.</p>
</div>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.StationGroup.setEnd">
<code class="sig-name descname">setEnd</code><span class="sig-paren">(</span><em class="sig-param">end</em><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.StationGroup.setEnd" title="Permalink to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>end</strong> seiscomp.core.Time</p>
</dd>
</dl>
<p>End of epoch (empty string if the station is open)</p>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.StationGroup.end">
<code class="sig-name descname">end</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.StationGroup.end" title="Permalink to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Return type</dt>
<dd class="field-odd"><p>seiscomp.core.Time</p>
</dd>
</dl>
<div class="admonition note">
<p class="admonition-title">Note</p>
<p>As this attribute is optional, this method throws a ValueError if
the value of the attribute is not set.</p>
</div>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.StationGroup.setDescription">
<code class="sig-name descname">setDescription</code><span class="sig-paren">(</span><em class="sig-param">description</em><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.StationGroup.setDescription" title="Permalink to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>description</strong> string</p>
</dd>
</dl>
<p>Station group description</p>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.StationGroup.description">
<code class="sig-name descname">description</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.StationGroup.description" title="Permalink to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Return type</dt>
<dd class="field-odd"><p>string</p>
</dd>
</dl>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.StationGroup.setLatitude">
<code class="sig-name descname">setLatitude</code><span class="sig-paren">(</span><em class="sig-param">latitude</em><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.StationGroup.setLatitude" title="Permalink to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>latitude</strong> float</p>
</dd>
</dl>
<p>Optional latitude (eg., of the central station) with respect to the
World Geodetic System 1984 (WGS84) reference system (National
Imagery and Mapping Agency 2000) in degrees. The uncertainties are
given in kilometers.</p>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.StationGroup.latitude">
<code class="sig-name descname">latitude</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.StationGroup.latitude" title="Permalink to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Return type</dt>
<dd class="field-odd"><p>float</p>
</dd>
</dl>
<div class="admonition note">
<p class="admonition-title">Note</p>
<p>As this attribute is optional, this method throws a ValueError if
the value of the attribute is not set.</p>
</div>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.StationGroup.setLongitude">
<code class="sig-name descname">setLongitude</code><span class="sig-paren">(</span><em class="sig-param">longitude</em><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.StationGroup.setLongitude" title="Permalink to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>longitude</strong> float</p>
</dd>
</dl>
<p>Optional longitude (eg., of the central station) with respect to the
World Geodetic System 1984 (WGS84) reference system (National
Imagery and Mapping Agency 2000) in degrees.</p>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.StationGroup.longitude">
<code class="sig-name descname">longitude</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.StationGroup.longitude" title="Permalink to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Return type</dt>
<dd class="field-odd"><p>float</p>
</dd>
</dl>
<div class="admonition note">
<p class="admonition-title">Note</p>
<p>As this attribute is optional, this method throws a ValueError if
the value of the attribute is not set.</p>
</div>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.StationGroup.setElevation">
<code class="sig-name descname">setElevation</code><span class="sig-paren">(</span><em class="sig-param">elevation</em><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.StationGroup.setElevation" title="Permalink to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>elevation</strong> float</p>
</dd>
</dl>
<p>Optional elevation (eg., of the central station) with respect to the
World Geodetic System 1984 (WGS84) reference system (National Imagery
and Mapping Agency 2000) in meters.</p>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.StationGroup.elevation">
<code class="sig-name descname">elevation</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.StationGroup.elevation" title="Permalink to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Return type</dt>
<dd class="field-odd"><p>float</p>
</dd>
</dl>
<div class="admonition note">
<p class="admonition-title">Note</p>
<p>As this attribute is optional, this method throws a ValueError if
the value of the attribute is not set.</p>
</div>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.StationGroup.add">
<code class="sig-name descname">add</code><span class="sig-paren">(</span><em class="sig-param">stationReference</em><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.StationGroup.add" title="Permalink to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>stationReference</strong> Object of type <a class="reference internal" href="#api-python-datamodel-stationreference"><span class="std std-ref">StationReference</span></a></p>
</dd>
<dt class="field-even">Return type</dt>
<dd class="field-even"><p>A Boolean value indicating success with True, False otherwise.</p>
</dd>
</dl>
<p>Adds a StationReference object to StationGroup. The object is not
copied but managed by this instance. Any change to the passed object
will also change the child.</p>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.StationGroup.remove">
<code class="sig-name descname">remove</code><span class="sig-paren">(</span><em class="sig-param">stationReference</em><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.StationGroup.remove" title="Permalink to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>stationReference</strong> Object of type <a class="reference internal" href="#api-python-datamodel-stationreference"><span class="std std-ref">StationReference</span></a></p>
</dd>
<dt class="field-even">Return type</dt>
<dd class="field-even"><p>A Boolean value indicating success with True, False otherwise.</p>
</dd>
</dl>
<p>Removes a previously added StationReference object from StationGroup.</p>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.StationGroup.removeStationReference">
<code class="sig-name descname">removeStationReference</code><span class="sig-paren">(</span><em class="sig-param">idx</em><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.StationGroup.removeStationReference" title="Permalink to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>idx</strong> An integer index of the object to be removed.</p>
</dd>
<dt class="field-even">Return type</dt>
<dd class="field-even"><p>A Boolean value indicating success with True, False otherwise.</p>
</dd>
</dl>
</dd></dl>
<dl class="method">
<dt>
<code class="sig-name descname">removeStationReference(stationReferenceIndex);</code></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>stationReferenceIndex</strong> The index of the object to be removed of type StationReferenceIndex.</p>
</dd>
<dt class="field-even">Return type</dt>
<dd class="field-even"><p>A Boolean value indicating success with True, False otherwise.</p>
</dd>
</dl>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.StationGroup.stationReferenceCount">
<code class="sig-name descname">stationReferenceCount</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.StationGroup.stationReferenceCount" title="Permalink to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Return type</dt>
<dd class="field-odd"><p>integer value indicating the number of child objects.</p>
</dd>
</dl>
<p>Returns the number of StationReference child objects.</p>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.StationGroup.stationReference">
<code class="sig-name descname">stationReference</code><span class="sig-paren">(</span><em class="sig-param">idx</em><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.StationGroup.stationReference" title="Permalink to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>idx</strong> An integer index of the object to be returned.</p>
</dd>
<dt class="field-even">Return type</dt>
<dd class="field-even"><p>Object of type <a class="reference internal" href="#api-python-datamodel-stationreference"><span class="std std-ref">StationReference</span></a>.</p>
</dd>
</dl>
<p>Returns the StationReference at index idx.</p>
</dd></dl>
<dl class="method">
<dt>
<code class="sig-name descname">stationReference</code><span class="sig-paren">(</span><em class="sig-param">stationReferenceIndex</em><span class="sig-paren">)</span></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>stationReferenceIndex</strong> The index of the object to be removed of type StationReferenceIndex.</p>
</dd>
<dt class="field-even">Return type</dt>
<dd class="field-even"><p>Object of type <a class="reference internal" href="#api-python-datamodel-stationreference"><span class="std std-ref">StationReference</span></a>.</p>
</dd>
</dl>
<p>Returns the StationReference at given index. The indexes of all child objects
are compared by value which makes this function slower than the direct
integer index look-up.</p>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.StationGroup.inventory">
<code class="sig-name descname">inventory</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.StationGroup.inventory" title="Permalink to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Return type</dt>
<dd class="field-odd"><p><a class="reference internal" href="#seiscomp.datamodel.Inventory" title="seiscomp.datamodel.Inventory">Inventory</a></p>
</dd>
</dl>
<p>Returns the parent Inventory if available. Returns None
if the parent is not a Inventory. This is a convenience wrapper
for parent().</p>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.StationGroup.assign">
<code class="sig-name descname">assign</code><span class="sig-paren">(</span><em class="sig-param">other</em><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.StationGroup.assign" title="Permalink to this definition"></a></dt>
<dd><p>This method implements the <a class="reference internal" href="#api-python-datamodel-object"><span class="std std-ref">Object</span></a> interface.</p>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.StationGroup.attachTo">
<code class="sig-name descname">attachTo</code><span class="sig-paren">(</span><em class="sig-param">parent</em><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.StationGroup.attachTo" title="Permalink to this definition"></a></dt>
<dd><p>This method implements the <a class="reference internal" href="#api-python-datamodel-object"><span class="std std-ref">Object</span></a> interface.</p>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.StationGroup.detachFrom">
<code class="sig-name descname">detachFrom</code><span class="sig-paren">(</span><em class="sig-param">parent</em><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.StationGroup.detachFrom" title="Permalink to this definition"></a></dt>
<dd><p>This method implements the <a class="reference internal" href="#api-python-datamodel-object"><span class="std std-ref">Object</span></a> interface.</p>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.StationGroup.detach">
<code class="sig-name descname">detach</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.StationGroup.detach" title="Permalink to this definition"></a></dt>
<dd><p>This method implements the <a class="reference internal" href="#api-python-datamodel-object"><span class="std std-ref">Object</span></a> interface.</p>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.StationGroup.clone">
<code class="sig-name descname">clone</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.StationGroup.clone" title="Permalink to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Return type</dt>
<dd class="field-odd"><p>A cloned StationGroup.</p>
</dd>
</dl>
<p>Returns a new instance that is a clone of the current instance. Child
objects are being ignored.</p>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.StationGroup.updateChild">
<code class="sig-name descname">updateChild</code><span class="sig-paren">(</span><em class="sig-param">ref</em><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.StationGroup.updateChild" title="Permalink to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>ref</strong> A child object derived from class Object.</p>
</dd>
<dt class="field-even">Return type</dt>
<dd class="field-even"><p>A Boolean flag indicating success with True, False otherwise</p>
</dd>
</dl>
<p>This method takes the passed reference object and searches for a child
with the same publicID (if derived from <a class="reference internal" href="#api-python-datamodel-publicobject"><span class="std std-ref">PublicObject</span></a>)
or the same index (if derived from <a class="reference internal" href="#api-python-datamodel-object"><span class="std std-ref">Object</span></a>).
The the child was found the reference objects attributes are copied to
the child object. Children of child are being ignored during this operation.
This method implements the <a class="reference internal" href="#api-python-datamodel-publicobject"><span class="std std-ref">PublicObject</span></a> interface.</p>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.StationGroup.accept">
<code class="sig-name descname">accept</code><span class="sig-paren">(</span><em class="sig-param">visitor</em><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.StationGroup.accept" title="Permalink to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>visitor</strong> A visitor.</p>
</dd>
</dl>
<p>This method implements the <a class="reference internal" href="#api-python-datamodel-publicobject"><span class="std std-ref">PublicObject</span></a> interface.</p>
</dd></dl>
</dd></dl>
</div>
<div class="section" id="stationmagnitude">
<span id="api-python-datamodel-stationmagnitude"></span><h3>StationMagnitude<a class="headerlink" href="#stationmagnitude" title="Permalink to this headline"></a></h3>
<dl class="class">
<dt id="seiscomp.datamodel.StationMagnitude">
<em class="property">class </em><code class="sig-prename descclassname">seiscomp.datamodel.</code><code class="sig-name descname">StationMagnitude</code><a class="headerlink" href="#seiscomp.datamodel.StationMagnitude" title="Permalink to this definition"></a></dt>
<dd><p>Inherits <a class="reference internal" href="#api-python-datamodel-publicobject"><span class="std std-ref">PublicObject</span></a>.</p>
<p>This class describes the magnitude derived from a single waveform stream.</p>
<p><strong>Parents</strong>:</p>
<ul class="simple">
<li><p><code class="docutils literal notranslate"><span class="pre">origin</span></code> <a class="reference internal" href="#api-python-datamodel-origin"><span class="std std-ref">Origin</span></a></p></li>
</ul>
<p><strong>Children</strong>:</p>
<ul class="simple">
<li><p><code class="docutils literal notranslate"><span class="pre">comment</span></code> <a class="reference internal" href="#api-python-datamodel-comment"><span class="std std-ref">Comment</span></a></p></li>
</ul>
<p><strong>Attributes</strong>:</p>
<ul class="simple">
<li><p><code class="docutils literal notranslate"><span class="pre">publicID</span></code>: string</p></li>
<li><p><code class="docutils literal notranslate"><span class="pre">originID</span></code> string</p></li>
<li><p><code class="docutils literal notranslate"><span class="pre">magnitude</span></code> <a class="reference internal" href="#api-python-datamodel-realquantity"><span class="std std-ref">RealQuantity</span></a></p></li>
<li><p><code class="docutils literal notranslate"><span class="pre">type</span></code> string</p></li>
<li><p><code class="docutils literal notranslate"><span class="pre">amplitudeID</span></code> string</p></li>
<li><p><code class="docutils literal notranslate"><span class="pre">methodID</span></code> string</p></li>
<li><p><code class="docutils literal notranslate"><span class="pre">waveformID</span></code> <a class="reference internal" href="#api-python-datamodel-waveformstreamid"><span class="std std-ref">WaveformStreamID</span></a> (optional)</p></li>
<li><p><code class="docutils literal notranslate"><span class="pre">passedQC</span></code> boolean (optional)</p></li>
<li><p><code class="docutils literal notranslate"><span class="pre">creationInfo</span></code> <a class="reference internal" href="#api-python-datamodel-creationinfo"><span class="std std-ref">CreationInfo</span></a> (optional)</p></li>
</ul>
<p><strong>Methods</strong>:</p>
<dl class="method">
<dt id="seiscomp.datamodel.StationMagnitude.Cast">
<em class="property">static </em><code class="sig-name descname">Cast</code><span class="sig-paren">(</span><em class="sig-param">obj</em><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.StationMagnitude.Cast" title="Permalink to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>obj</strong> The object to be casted.</p>
</dd>
<dt class="field-even">Return type</dt>
<dd class="field-even"><p>An object of type StationMagnitude if the cast was successful,
None otherwise.</p>
</dd>
</dl>
<p>Cast an arbitrary object to StationMagnitude if the internal wrapped
representation is an StationMagnitude object. The cast is important if
instances of type <a class="reference internal" href="#api-python-datamodel-object"><span class="std std-ref">Object</span></a>
are passed to methods which need access to the real type.</p>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.StationMagnitude.Create">
<em class="property">static </em><code class="sig-name descname">Create</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.StationMagnitude.Create" title="Permalink to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Return type</dt>
<dd class="field-odd"><p>A new object of type StationMagnitude.</p>
</dd>
</dl>
<p>Creates and registers (if enabled) a StationMagnitude instance. The
publicID is auto-generated.</p>
</dd></dl>
<dl class="method">
<dt>
<em class="property">static </em><code class="sig-name descname">Create</code><span class="sig-paren">(</span><em class="sig-param">publicID</em><span class="sig-paren">)</span></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Return type</dt>
<dd class="field-odd"><p>A new object of type StationMagnitude.</p>
</dd>
</dl>
<p>Creates and registers (if enabled) a StationMagnitude instance with
passed publicID.</p>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.StationMagnitude.equal">
<code class="sig-name descname">equal</code><span class="sig-paren">(</span><em class="sig-param">other</em><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.StationMagnitude.equal" title="Permalink to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>other</strong> Another object of type StationMagnitude to compare this
instance to</p>
</dd>
<dt class="field-even">Return type</dt>
<dd class="field-even"><p>A Boolean value indicating True if both objects are equal or
False otherwise.</p>
</dd>
</dl>
<p>Compares two objects without its child objects. Both objects are compared
by value.</p>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.StationMagnitude.setOriginID">
<code class="sig-name descname">setOriginID</code><span class="sig-paren">(</span><em class="sig-param">originID</em><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.StationMagnitude.setOriginID" title="Permalink to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>originID</strong> string</p>
</dd>
</dl>
<p>Reference to an origins publicID if the StationMagnitude has an associated
Origin.</p>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.StationMagnitude.originID">
<code class="sig-name descname">originID</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.StationMagnitude.originID" title="Permalink to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Return type</dt>
<dd class="field-odd"><p>string</p>
</dd>
</dl>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.StationMagnitude.setMagnitude">
<code class="sig-name descname">setMagnitude</code><span class="sig-paren">(</span><em class="sig-param">magnitude</em><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.StationMagnitude.setMagnitude" title="Permalink to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>magnitude</strong> <a class="reference internal" href="#api-python-datamodel-realquantity"><span class="std std-ref">RealQuantity</span></a></p>
</dd>
</dl>
<p>Estimated magnitude as RealQuantity.</p>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.StationMagnitude.magnitude">
<code class="sig-name descname">magnitude</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.StationMagnitude.magnitude" title="Permalink to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Return type</dt>
<dd class="field-odd"><p><a class="reference internal" href="#api-python-datamodel-realquantity"><span class="std std-ref">RealQuantity</span></a></p>
</dd>
</dl>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.StationMagnitude.setType">
<code class="sig-name descname">setType</code><span class="sig-paren">(</span><em class="sig-param">type</em><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.StationMagnitude.setType" title="Permalink to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>type</strong> string</p>
</dd>
</dl>
<p>See class Magnitude.</p>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.StationMagnitude.type">
<code class="sig-name descname">type</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.StationMagnitude.type" title="Permalink to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Return type</dt>
<dd class="field-odd"><p>string</p>
</dd>
</dl>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.StationMagnitude.setAmplitudeID">
<code class="sig-name descname">setAmplitudeID</code><span class="sig-paren">(</span><em class="sig-param">amplitudeID</em><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.StationMagnitude.setAmplitudeID" title="Permalink to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>amplitudeID</strong> string</p>
</dd>
</dl>
<p>Identifies the data source of the StationMagnitude. For magnitudes derived
from amplitudes in
waveforms (e. g., local magnitude ML ), amplitudeID points to publicID in
class Amplitude.</p>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.StationMagnitude.amplitudeID">
<code class="sig-name descname">amplitudeID</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.StationMagnitude.amplitudeID" title="Permalink to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Return type</dt>
<dd class="field-odd"><p>string</p>
</dd>
</dl>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.StationMagnitude.setMethodID">
<code class="sig-name descname">setMethodID</code><span class="sig-paren">(</span><em class="sig-param">methodID</em><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.StationMagnitude.setMethodID" title="Permalink to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>methodID</strong> string</p>
</dd>
</dl>
<p>See class Magnitude.</p>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.StationMagnitude.methodID">
<code class="sig-name descname">methodID</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.StationMagnitude.methodID" title="Permalink to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Return type</dt>
<dd class="field-odd"><p>string</p>
</dd>
</dl>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.StationMagnitude.setWaveformID">
<code class="sig-name descname">setWaveformID</code><span class="sig-paren">(</span><em class="sig-param">waveformID</em><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.StationMagnitude.setWaveformID" title="Permalink to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>waveformID</strong> <a class="reference internal" href="#api-python-datamodel-waveformstreamid"><span class="std std-ref">WaveformStreamID</span></a></p>
</dd>
</dl>
<p>Identifies the waveform stream. This element can be helpful if no
amplitude is referenced, or the amplitude is not available in the
context. Otherwise, it would duplicate the waveformID provided there
and can be omitted.</p>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.StationMagnitude.waveformID">
<code class="sig-name descname">waveformID</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.StationMagnitude.waveformID" title="Permalink to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Return type</dt>
<dd class="field-odd"><p><a class="reference internal" href="#api-python-datamodel-waveformstreamid"><span class="std std-ref">WaveformStreamID</span></a></p>
</dd>
</dl>
<div class="admonition note">
<p class="admonition-title">Note</p>
<p>As this attribute is optional, this method throws a ValueError if
the value of the attribute is not set.</p>
</div>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.StationMagnitude.setPassedQC">
<code class="sig-name descname">setPassedQC</code><span class="sig-paren">(</span><em class="sig-param">passedQC</em><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.StationMagnitude.setPassedQC" title="Permalink to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>passedQC</strong> boolean</p>
</dd>
</dl>
<p>An optional flag that indicates whether a station magnitude has passed
the quality control or not. For example, if a station magnitude is
out of the defined distance range but should be associated to a network
magnitude for further analysis then this flag can be set to false.
If the flag is not set, it defaults to true.</p>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.StationMagnitude.passedQC">
<code class="sig-name descname">passedQC</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.StationMagnitude.passedQC" title="Permalink to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Return type</dt>
<dd class="field-odd"><p>boolean</p>
</dd>
</dl>
<div class="admonition note">
<p class="admonition-title">Note</p>
<p>As this attribute is optional, this method throws a ValueError if
the value of the attribute is not set.</p>
</div>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.StationMagnitude.setCreationInfo">
<code class="sig-name descname">setCreationInfo</code><span class="sig-paren">(</span><em class="sig-param">creationInfo</em><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.StationMagnitude.setCreationInfo" title="Permalink to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>creationInfo</strong> <a class="reference internal" href="#api-python-datamodel-creationinfo"><span class="std std-ref">CreationInfo</span></a></p>
</dd>
</dl>
<p>CreationInfo for the StationMagnitude object.</p>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.StationMagnitude.creationInfo">
<code class="sig-name descname">creationInfo</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.StationMagnitude.creationInfo" title="Permalink to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Return type</dt>
<dd class="field-odd"><p><a class="reference internal" href="#api-python-datamodel-creationinfo"><span class="std std-ref">CreationInfo</span></a></p>
</dd>
</dl>
<div class="admonition note">
<p class="admonition-title">Note</p>
<p>As this attribute is optional, this method throws a ValueError if
the value of the attribute is not set.</p>
</div>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.StationMagnitude.add">
<code class="sig-name descname">add</code><span class="sig-paren">(</span><em class="sig-param">comment</em><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.StationMagnitude.add" title="Permalink to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>comment</strong> Object of type <a class="reference internal" href="#api-python-datamodel-comment"><span class="std std-ref">Comment</span></a></p>
</dd>
<dt class="field-even">Return type</dt>
<dd class="field-even"><p>A Boolean value indicating success with True, False otherwise.</p>
</dd>
</dl>
<p>Adds a Comment object to StationMagnitude. The object is not
copied but managed by this instance. Any change to the passed object
will also change the child.</p>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.StationMagnitude.remove">
<code class="sig-name descname">remove</code><span class="sig-paren">(</span><em class="sig-param">comment</em><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.StationMagnitude.remove" title="Permalink to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>comment</strong> Object of type <a class="reference internal" href="#api-python-datamodel-comment"><span class="std std-ref">Comment</span></a></p>
</dd>
<dt class="field-even">Return type</dt>
<dd class="field-even"><p>A Boolean value indicating success with True, False otherwise.</p>
</dd>
</dl>
<p>Removes a previously added Comment object from StationMagnitude.</p>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.StationMagnitude.removeComment">
<code class="sig-name descname">removeComment</code><span class="sig-paren">(</span><em class="sig-param">idx</em><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.StationMagnitude.removeComment" title="Permalink to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>idx</strong> An integer index of the object to be removed.</p>
</dd>
<dt class="field-even">Return type</dt>
<dd class="field-even"><p>A Boolean value indicating success with True, False otherwise.</p>
</dd>
</dl>
</dd></dl>
<dl class="method">
<dt>
<code class="sig-name descname">removeComment(commentIndex);</code></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>commentIndex</strong> The index of the object to be removed of type CommentIndex.</p>
</dd>
<dt class="field-even">Return type</dt>
<dd class="field-even"><p>A Boolean value indicating success with True, False otherwise.</p>
</dd>
</dl>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.StationMagnitude.commentCount">
<code class="sig-name descname">commentCount</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.StationMagnitude.commentCount" title="Permalink to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Return type</dt>
<dd class="field-odd"><p>integer value indicating the number of child objects.</p>
</dd>
</dl>
<p>Returns the number of Comment child objects.</p>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.StationMagnitude.comment">
<code class="sig-name descname">comment</code><span class="sig-paren">(</span><em class="sig-param">idx</em><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.StationMagnitude.comment" title="Permalink to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>idx</strong> An integer index of the object to be returned.</p>
</dd>
<dt class="field-even">Return type</dt>
<dd class="field-even"><p>Object of type <a class="reference internal" href="#api-python-datamodel-comment"><span class="std std-ref">Comment</span></a>.</p>
</dd>
</dl>
<p>Returns the Comment at index idx.</p>
</dd></dl>
<dl class="method">
<dt>
<code class="sig-name descname">comment</code><span class="sig-paren">(</span><em class="sig-param">commentIndex</em><span class="sig-paren">)</span></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>commentIndex</strong> The index of the object to be removed of type CommentIndex.</p>
</dd>
<dt class="field-even">Return type</dt>
<dd class="field-even"><p>Object of type <a class="reference internal" href="#api-python-datamodel-comment"><span class="std std-ref">Comment</span></a>.</p>
</dd>
</dl>
<p>Returns the Comment at given index. The indexes of all child objects
are compared by value which makes this function slower than the direct
integer index look-up.</p>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.StationMagnitude.origin">
<code class="sig-name descname">origin</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.StationMagnitude.origin" title="Permalink to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Return type</dt>
<dd class="field-odd"><p><a class="reference internal" href="#seiscomp.datamodel.Origin" title="seiscomp.datamodel.Origin">Origin</a></p>
</dd>
</dl>
<p>Returns the parent Origin if available. Returns None
if the parent is not a Origin. This is a convenience wrapper
for parent().</p>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.StationMagnitude.assign">
<code class="sig-name descname">assign</code><span class="sig-paren">(</span><em class="sig-param">other</em><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.StationMagnitude.assign" title="Permalink to this definition"></a></dt>
<dd><p>This method implements the <a class="reference internal" href="#api-python-datamodel-object"><span class="std std-ref">Object</span></a> interface.</p>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.StationMagnitude.attachTo">
<code class="sig-name descname">attachTo</code><span class="sig-paren">(</span><em class="sig-param">parent</em><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.StationMagnitude.attachTo" title="Permalink to this definition"></a></dt>
<dd><p>This method implements the <a class="reference internal" href="#api-python-datamodel-object"><span class="std std-ref">Object</span></a> interface.</p>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.StationMagnitude.detachFrom">
<code class="sig-name descname">detachFrom</code><span class="sig-paren">(</span><em class="sig-param">parent</em><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.StationMagnitude.detachFrom" title="Permalink to this definition"></a></dt>
<dd><p>This method implements the <a class="reference internal" href="#api-python-datamodel-object"><span class="std std-ref">Object</span></a> interface.</p>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.StationMagnitude.detach">
<code class="sig-name descname">detach</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.StationMagnitude.detach" title="Permalink to this definition"></a></dt>
<dd><p>This method implements the <a class="reference internal" href="#api-python-datamodel-object"><span class="std std-ref">Object</span></a> interface.</p>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.StationMagnitude.clone">
<code class="sig-name descname">clone</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.StationMagnitude.clone" title="Permalink to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Return type</dt>
<dd class="field-odd"><p>A cloned StationMagnitude.</p>
</dd>
</dl>
<p>Returns a new instance that is a clone of the current instance. Child
objects are being ignored.</p>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.StationMagnitude.updateChild">
<code class="sig-name descname">updateChild</code><span class="sig-paren">(</span><em class="sig-param">ref</em><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.StationMagnitude.updateChild" title="Permalink to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>ref</strong> A child object derived from class Object.</p>
</dd>
<dt class="field-even">Return type</dt>
<dd class="field-even"><p>A Boolean flag indicating success with True, False otherwise</p>
</dd>
</dl>
<p>This method takes the passed reference object and searches for a child
with the same publicID (if derived from <a class="reference internal" href="#api-python-datamodel-publicobject"><span class="std std-ref">PublicObject</span></a>)
or the same index (if derived from <a class="reference internal" href="#api-python-datamodel-object"><span class="std std-ref">Object</span></a>).
The the child was found the reference objects attributes are copied to
the child object. Children of child are being ignored during this operation.
This method implements the <a class="reference internal" href="#api-python-datamodel-publicobject"><span class="std std-ref">PublicObject</span></a> interface.</p>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.StationMagnitude.accept">
<code class="sig-name descname">accept</code><span class="sig-paren">(</span><em class="sig-param">visitor</em><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.StationMagnitude.accept" title="Permalink to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>visitor</strong> A visitor.</p>
</dd>
</dl>
<p>This method implements the <a class="reference internal" href="#api-python-datamodel-publicobject"><span class="std std-ref">PublicObject</span></a> interface.</p>
</dd></dl>
</dd></dl>
</div>
<div class="section" id="stationmagnitudecontribution">
<span id="api-python-datamodel-stationmagnitudecontribution"></span><h3>StationMagnitudeContribution<a class="headerlink" href="#stationmagnitudecontribution" title="Permalink to this headline"></a></h3>
<dl class="class">
<dt id="seiscomp.datamodel.StationMagnitudeContribution">
<em class="property">class </em><code class="sig-prename descclassname">seiscomp.datamodel.</code><code class="sig-name descname">StationMagnitudeContribution</code><a class="headerlink" href="#seiscomp.datamodel.StationMagnitudeContribution" title="Permalink to this definition"></a></dt>
<dd><p>Inherits <a class="reference internal" href="#api-python-datamodel-object"><span class="std std-ref">Object</span></a>.</p>
<p>This class describes the weighting of magnitude values from several
StationMagnitude objects for computing a
network magnitude estimation.</p>
<p><strong>Parents</strong>:</p>
<ul class="simple">
<li><p><code class="docutils literal notranslate"><span class="pre">magnitude</span></code> <a class="reference internal" href="#api-python-datamodel-magnitude"><span class="std std-ref">Magnitude</span></a></p></li>
</ul>
<p><strong>Attributes</strong>:</p>
<ul class="simple">
<li><p><code class="docutils literal notranslate"><span class="pre">stationMagnitudeID</span></code> string</p></li>
<li><p><code class="docutils literal notranslate"><span class="pre">residual</span></code> float (optional)</p></li>
<li><p><code class="docutils literal notranslate"><span class="pre">weight</span></code> float (optional)</p></li>
</ul>
<p><strong>Methods</strong>:</p>
<dl class="method">
<dt id="seiscomp.datamodel.StationMagnitudeContribution.Cast">
<em class="property">static </em><code class="sig-name descname">Cast</code><span class="sig-paren">(</span><em class="sig-param">obj</em><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.StationMagnitudeContribution.Cast" title="Permalink to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>obj</strong> The object to be casted.</p>
</dd>
<dt class="field-even">Return type</dt>
<dd class="field-even"><p>An object of type StationMagnitudeContribution if the cast was successful,
None otherwise.</p>
</dd>
</dl>
<p>Cast an arbitrary object to StationMagnitudeContribution if the internal wrapped
representation is an StationMagnitudeContribution object. The cast is important if
instances of type <a class="reference internal" href="#api-python-datamodel-object"><span class="std std-ref">Object</span></a>
are passed to methods which need access to the real type.</p>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.StationMagnitudeContribution.equal">
<code class="sig-name descname">equal</code><span class="sig-paren">(</span><em class="sig-param">other</em><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.StationMagnitudeContribution.equal" title="Permalink to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>other</strong> Another object of type StationMagnitudeContribution to compare this
instance to</p>
</dd>
<dt class="field-even">Return type</dt>
<dd class="field-even"><p>A Boolean value indicating True if both objects are equal or
False otherwise.</p>
</dd>
</dl>
<p>Compares two objects without its child objects. Both objects are compared
by value.</p>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.StationMagnitudeContribution.index">
<code class="sig-name descname">index</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.StationMagnitudeContribution.index" title="Permalink to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Return type</dt>
<dd class="field-odd"><p><p>The objects index of type StationMagnitudeContributionIndex.</p>
<p>Returns the objects index which is also used for the database as unique
constraint.</p>
</p>
</dd>
</dl>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.StationMagnitudeContribution.equalIndex">
<code class="sig-name descname">equalIndex</code><span class="sig-paren">(</span><em class="sig-param">lhs</em><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.StationMagnitudeContribution.equalIndex" title="Permalink to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>lhs</strong> <a class="reference internal" href="#api-python-datamodel-stationmagnitudecontribution"><span class="std std-ref">StationMagnitudeContribution</span></a></p>
</dd>
<dt class="field-even">Return type</dt>
<dd class="field-even"><p>A Boolean value indicating True if both indexes are equal or
False otherwise.</p>
</dd>
</dl>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.StationMagnitudeContribution.setStationMagnitudeID">
<code class="sig-name descname">setStationMagnitudeID</code><span class="sig-paren">(</span><em class="sig-param">stationMagnitudeID</em><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.StationMagnitudeContribution.setStationMagnitudeID" title="Permalink to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>stationMagnitudeID</strong> string</p>
</dd>
</dl>
<p>Refers to the publicID of a StationMagnitude object.</p>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.StationMagnitudeContribution.stationMagnitudeID">
<code class="sig-name descname">stationMagnitudeID</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.StationMagnitudeContribution.stationMagnitudeID" title="Permalink to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Return type</dt>
<dd class="field-odd"><p>string</p>
</dd>
</dl>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.StationMagnitudeContribution.setResidual">
<code class="sig-name descname">setResidual</code><span class="sig-paren">(</span><em class="sig-param">residual</em><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.StationMagnitudeContribution.setResidual" title="Permalink to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>residual</strong> float</p>
</dd>
</dl>
<p>Residual of magnitude computation.</p>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.StationMagnitudeContribution.residual">
<code class="sig-name descname">residual</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.StationMagnitudeContribution.residual" title="Permalink to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Return type</dt>
<dd class="field-odd"><p>float</p>
</dd>
</dl>
<div class="admonition note">
<p class="admonition-title">Note</p>
<p>As this attribute is optional, this method throws a ValueError if
the value of the attribute is not set.</p>
</div>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.StationMagnitudeContribution.setWeight">
<code class="sig-name descname">setWeight</code><span class="sig-paren">(</span><em class="sig-param">weight</em><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.StationMagnitudeContribution.setWeight" title="Permalink to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>weight</strong> float</p>
</dd>
</dl>
<p>Weight of the magnitude value from class StationMagnitude for computing
the magnitude value in class Magnitude. Note that there is no rule
for the sum of the weights of all station magnitude contributions
to a specific network magnitude. In particular, the weights are not
required to sum up to unity.</p>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.StationMagnitudeContribution.weight">
<code class="sig-name descname">weight</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.StationMagnitudeContribution.weight" title="Permalink to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Return type</dt>
<dd class="field-odd"><p>float</p>
</dd>
</dl>
<div class="admonition note">
<p class="admonition-title">Note</p>
<p>As this attribute is optional, this method throws a ValueError if
the value of the attribute is not set.</p>
</div>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.StationMagnitudeContribution.magnitude">
<code class="sig-name descname">magnitude</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.StationMagnitudeContribution.magnitude" title="Permalink to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Return type</dt>
<dd class="field-odd"><p><a class="reference internal" href="#seiscomp.datamodel.Magnitude" title="seiscomp.datamodel.Magnitude">Magnitude</a></p>
</dd>
</dl>
<p>Returns the parent Magnitude if available. Returns None
if the parent is not a Magnitude. This is a convenience wrapper
for parent().</p>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.StationMagnitudeContribution.assign">
<code class="sig-name descname">assign</code><span class="sig-paren">(</span><em class="sig-param">other</em><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.StationMagnitudeContribution.assign" title="Permalink to this definition"></a></dt>
<dd><p>This method implements the <a class="reference internal" href="#api-python-datamodel-object"><span class="std std-ref">Object</span></a> interface.</p>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.StationMagnitudeContribution.attachTo">
<code class="sig-name descname">attachTo</code><span class="sig-paren">(</span><em class="sig-param">parent</em><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.StationMagnitudeContribution.attachTo" title="Permalink to this definition"></a></dt>
<dd><p>This method implements the <a class="reference internal" href="#api-python-datamodel-object"><span class="std std-ref">Object</span></a> interface.</p>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.StationMagnitudeContribution.detachFrom">
<code class="sig-name descname">detachFrom</code><span class="sig-paren">(</span><em class="sig-param">parent</em><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.StationMagnitudeContribution.detachFrom" title="Permalink to this definition"></a></dt>
<dd><p>This method implements the <a class="reference internal" href="#api-python-datamodel-object"><span class="std std-ref">Object</span></a> interface.</p>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.StationMagnitudeContribution.detach">
<code class="sig-name descname">detach</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.StationMagnitudeContribution.detach" title="Permalink to this definition"></a></dt>
<dd><p>This method implements the <a class="reference internal" href="#api-python-datamodel-object"><span class="std std-ref">Object</span></a> interface.</p>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.StationMagnitudeContribution.clone">
<code class="sig-name descname">clone</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.StationMagnitudeContribution.clone" title="Permalink to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Return type</dt>
<dd class="field-odd"><p>A cloned StationMagnitudeContribution.</p>
</dd>
</dl>
<p>Returns a new instance that is a clone of the current instance. Child
objects are being ignored.</p>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.StationMagnitudeContribution.accept">
<code class="sig-name descname">accept</code><span class="sig-paren">(</span><em class="sig-param">visitor</em><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.StationMagnitudeContribution.accept" title="Permalink to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>visitor</strong> A visitor.</p>
</dd>
</dl>
<p>This method implements the <a class="reference internal" href="#api-python-datamodel-publicobject"><span class="std std-ref">PublicObject</span></a> interface.</p>
</dd></dl>
</dd></dl>
</div>
<div class="section" id="stationreference">
<span id="api-python-datamodel-stationreference"></span><h3>StationReference<a class="headerlink" href="#stationreference" title="Permalink to this headline"></a></h3>
<dl class="class">
<dt id="seiscomp.datamodel.StationReference">
<em class="property">class </em><code class="sig-prename descclassname">seiscomp.datamodel.</code><code class="sig-name descname">StationReference</code><a class="headerlink" href="#seiscomp.datamodel.StationReference" title="Permalink to this definition"></a></dt>
<dd><p>Inherits <a class="reference internal" href="#api-python-datamodel-object"><span class="std std-ref">Object</span></a>.</p>
<p>This type describes a station reference within a station group</p>
<p><strong>Parents</strong>:</p>
<ul class="simple">
<li><p><code class="docutils literal notranslate"><span class="pre">stationGroup</span></code> <a class="reference internal" href="#api-python-datamodel-stationgroup"><span class="std std-ref">StationGroup</span></a></p></li>
</ul>
<p><strong>Attributes</strong>:</p>
<ul class="simple">
<li><p><code class="docutils literal notranslate"><span class="pre">stationID</span></code> string</p></li>
</ul>
<p><strong>Methods</strong>:</p>
<dl class="method">
<dt id="seiscomp.datamodel.StationReference.Cast">
<em class="property">static </em><code class="sig-name descname">Cast</code><span class="sig-paren">(</span><em class="sig-param">obj</em><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.StationReference.Cast" title="Permalink to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>obj</strong> The object to be casted.</p>
</dd>
<dt class="field-even">Return type</dt>
<dd class="field-even"><p>An object of type StationReference if the cast was successful,
None otherwise.</p>
</dd>
</dl>
<p>Cast an arbitrary object to StationReference if the internal wrapped
representation is an StationReference object. The cast is important if
instances of type <a class="reference internal" href="#api-python-datamodel-object"><span class="std std-ref">Object</span></a>
are passed to methods which need access to the real type.</p>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.StationReference.equal">
<code class="sig-name descname">equal</code><span class="sig-paren">(</span><em class="sig-param">other</em><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.StationReference.equal" title="Permalink to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>other</strong> Another object of type StationReference to compare this
instance to</p>
</dd>
<dt class="field-even">Return type</dt>
<dd class="field-even"><p>A Boolean value indicating True if both objects are equal or
False otherwise.</p>
</dd>
</dl>
<p>Compares two objects without its child objects. Both objects are compared
by value.</p>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.StationReference.index">
<code class="sig-name descname">index</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.StationReference.index" title="Permalink to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Return type</dt>
<dd class="field-odd"><p><p>The objects index of type StationReferenceIndex.</p>
<p>Returns the objects index which is also used for the database as unique
constraint.</p>
</p>
</dd>
</dl>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.StationReference.equalIndex">
<code class="sig-name descname">equalIndex</code><span class="sig-paren">(</span><em class="sig-param">lhs</em><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.StationReference.equalIndex" title="Permalink to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>lhs</strong> <a class="reference internal" href="#api-python-datamodel-stationreference"><span class="std std-ref">StationReference</span></a></p>
</dd>
<dt class="field-even">Return type</dt>
<dd class="field-even"><p>A Boolean value indicating True if both indexes are equal or
False otherwise.</p>
</dd>
</dl>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.StationReference.setStationID">
<code class="sig-name descname">setStationID</code><span class="sig-paren">(</span><em class="sig-param">stationID</em><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.StationReference.setStationID" title="Permalink to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>stationID</strong> string</p>
</dd>
</dl>
<p>Reference to network/station/&#64;publicID</p>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.StationReference.stationID">
<code class="sig-name descname">stationID</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.StationReference.stationID" title="Permalink to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Return type</dt>
<dd class="field-odd"><p>string</p>
</dd>
</dl>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.StationReference.stationGroup">
<code class="sig-name descname">stationGroup</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.StationReference.stationGroup" title="Permalink to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Return type</dt>
<dd class="field-odd"><p><a class="reference internal" href="#seiscomp.datamodel.StationGroup" title="seiscomp.datamodel.StationGroup">StationGroup</a></p>
</dd>
</dl>
<p>Returns the parent StationGroup if available. Returns None
if the parent is not a StationGroup. This is a convenience wrapper
for parent().</p>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.StationReference.assign">
<code class="sig-name descname">assign</code><span class="sig-paren">(</span><em class="sig-param">other</em><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.StationReference.assign" title="Permalink to this definition"></a></dt>
<dd><p>This method implements the <a class="reference internal" href="#api-python-datamodel-object"><span class="std std-ref">Object</span></a> interface.</p>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.StationReference.attachTo">
<code class="sig-name descname">attachTo</code><span class="sig-paren">(</span><em class="sig-param">parent</em><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.StationReference.attachTo" title="Permalink to this definition"></a></dt>
<dd><p>This method implements the <a class="reference internal" href="#api-python-datamodel-object"><span class="std std-ref">Object</span></a> interface.</p>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.StationReference.detachFrom">
<code class="sig-name descname">detachFrom</code><span class="sig-paren">(</span><em class="sig-param">parent</em><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.StationReference.detachFrom" title="Permalink to this definition"></a></dt>
<dd><p>This method implements the <a class="reference internal" href="#api-python-datamodel-object"><span class="std std-ref">Object</span></a> interface.</p>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.StationReference.detach">
<code class="sig-name descname">detach</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.StationReference.detach" title="Permalink to this definition"></a></dt>
<dd><p>This method implements the <a class="reference internal" href="#api-python-datamodel-object"><span class="std std-ref">Object</span></a> interface.</p>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.StationReference.clone">
<code class="sig-name descname">clone</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.StationReference.clone" title="Permalink to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Return type</dt>
<dd class="field-odd"><p>A cloned StationReference.</p>
</dd>
</dl>
<p>Returns a new instance that is a clone of the current instance. Child
objects are being ignored.</p>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.StationReference.accept">
<code class="sig-name descname">accept</code><span class="sig-paren">(</span><em class="sig-param">visitor</em><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.StationReference.accept" title="Permalink to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>visitor</strong> A visitor.</p>
</dd>
</dl>
<p>This method implements the <a class="reference internal" href="#api-python-datamodel-publicobject"><span class="std std-ref">PublicObject</span></a> interface.</p>
</dd></dl>
</dd></dl>
</div>
<div class="section" id="stream">
<span id="api-python-datamodel-stream"></span><h3>Stream<a class="headerlink" href="#stream" title="Permalink to this headline"></a></h3>
<dl class="class">
<dt id="seiscomp.datamodel.Stream">
<em class="property">class </em><code class="sig-prename descclassname">seiscomp.datamodel.</code><code class="sig-name descname">Stream</code><a class="headerlink" href="#seiscomp.datamodel.Stream" title="Permalink to this definition"></a></dt>
<dd><p>Inherits <a class="reference internal" href="#api-python-datamodel-publicobject"><span class="std std-ref">PublicObject</span></a>.</p>
<p>This type describes a stream (channel) with defined frequency response</p>
<p><strong>Parents</strong>:</p>
<ul class="simple">
<li><p><code class="docutils literal notranslate"><span class="pre">sensorLocation</span></code> <a class="reference internal" href="#api-python-datamodel-sensorlocation"><span class="std std-ref">SensorLocation</span></a></p></li>
</ul>
<p><strong>Children</strong>:</p>
<ul class="simple">
<li><p><code class="docutils literal notranslate"><span class="pre">comment</span></code> <a class="reference internal" href="#api-python-datamodel-comment"><span class="std std-ref">Comment</span></a></p></li>
</ul>
<p><strong>Attributes</strong>:</p>
<ul class="simple">
<li><p><code class="docutils literal notranslate"><span class="pre">publicID</span></code>: string</p></li>
<li><p><code class="docutils literal notranslate"><span class="pre">code</span></code> string</p></li>
<li><p><code class="docutils literal notranslate"><span class="pre">start</span></code> seiscomp.core.Time</p></li>
<li><p><code class="docutils literal notranslate"><span class="pre">end</span></code> seiscomp.core.Time (optional)</p></li>
<li><p><code class="docutils literal notranslate"><span class="pre">datalogger</span></code> string</p></li>
<li><p><code class="docutils literal notranslate"><span class="pre">dataloggerSerialNumber</span></code> string</p></li>
<li><p><code class="docutils literal notranslate"><span class="pre">dataloggerChannel</span></code> int (optional)</p></li>
<li><p><code class="docutils literal notranslate"><span class="pre">sensor</span></code> string</p></li>
<li><p><code class="docutils literal notranslate"><span class="pre">sensorSerialNumber</span></code> string</p></li>
<li><p><code class="docutils literal notranslate"><span class="pre">sensorChannel</span></code> int (optional)</p></li>
<li><p><code class="docutils literal notranslate"><span class="pre">clockSerialNumber</span></code> string</p></li>
<li><p><code class="docutils literal notranslate"><span class="pre">sampleRateNumerator</span></code> int (optional)</p></li>
<li><p><code class="docutils literal notranslate"><span class="pre">sampleRateDenominator</span></code> int (optional)</p></li>
<li><p><code class="docutils literal notranslate"><span class="pre">depth</span></code> float (optional)</p></li>
<li><p><code class="docutils literal notranslate"><span class="pre">azimuth</span></code> float (optional)</p></li>
<li><p><code class="docutils literal notranslate"><span class="pre">dip</span></code> float (optional)</p></li>
<li><p><code class="docutils literal notranslate"><span class="pre">gain</span></code> float (optional)</p></li>
<li><p><code class="docutils literal notranslate"><span class="pre">gainFrequency</span></code> float (optional)</p></li>
<li><p><code class="docutils literal notranslate"><span class="pre">gainUnit</span></code> string</p></li>
<li><p><code class="docutils literal notranslate"><span class="pre">format</span></code> string</p></li>
<li><p><code class="docutils literal notranslate"><span class="pre">flags</span></code> string</p></li>
<li><p><code class="docutils literal notranslate"><span class="pre">restricted</span></code> boolean (optional)</p></li>
<li><p><code class="docutils literal notranslate"><span class="pre">shared</span></code> boolean (optional)</p></li>
</ul>
<p><strong>Methods</strong>:</p>
<dl class="method">
<dt id="seiscomp.datamodel.Stream.Cast">
<em class="property">static </em><code class="sig-name descname">Cast</code><span class="sig-paren">(</span><em class="sig-param">obj</em><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.Stream.Cast" title="Permalink to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>obj</strong> The object to be casted.</p>
</dd>
<dt class="field-even">Return type</dt>
<dd class="field-even"><p>An object of type Stream if the cast was successful,
None otherwise.</p>
</dd>
</dl>
<p>Cast an arbitrary object to Stream if the internal wrapped
representation is an Stream object. The cast is important if
instances of type <a class="reference internal" href="#api-python-datamodel-object"><span class="std std-ref">Object</span></a>
are passed to methods which need access to the real type.</p>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.Stream.Create">
<em class="property">static </em><code class="sig-name descname">Create</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.Stream.Create" title="Permalink to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Return type</dt>
<dd class="field-odd"><p>A new object of type Stream.</p>
</dd>
</dl>
<p>Creates and registers (if enabled) a Stream instance. The
publicID is auto-generated.</p>
</dd></dl>
<dl class="method">
<dt>
<em class="property">static </em><code class="sig-name descname">Create</code><span class="sig-paren">(</span><em class="sig-param">publicID</em><span class="sig-paren">)</span></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Return type</dt>
<dd class="field-odd"><p>A new object of type Stream.</p>
</dd>
</dl>
<p>Creates and registers (if enabled) a Stream instance with
passed publicID.</p>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.Stream.equal">
<code class="sig-name descname">equal</code><span class="sig-paren">(</span><em class="sig-param">other</em><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.Stream.equal" title="Permalink to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>other</strong> Another object of type Stream to compare this
instance to</p>
</dd>
<dt class="field-even">Return type</dt>
<dd class="field-even"><p>A Boolean value indicating True if both objects are equal or
False otherwise.</p>
</dd>
</dl>
<p>Compares two objects without its child objects. Both objects are compared
by value.</p>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.Stream.index">
<code class="sig-name descname">index</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.Stream.index" title="Permalink to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Return type</dt>
<dd class="field-odd"><p><p>The objects index of type StreamIndex.</p>
<p>Returns the objects index which is also used for the database as unique
constraint.</p>
</p>
</dd>
</dl>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.Stream.equalIndex">
<code class="sig-name descname">equalIndex</code><span class="sig-paren">(</span><em class="sig-param">lhs</em><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.Stream.equalIndex" title="Permalink to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>lhs</strong> <a class="reference internal" href="#api-python-datamodel-stream"><span class="std std-ref">Stream</span></a></p>
</dd>
<dt class="field-even">Return type</dt>
<dd class="field-even"><p>A Boolean value indicating True if both indexes are equal or
False otherwise.</p>
</dd>
</dl>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.Stream.setCode">
<code class="sig-name descname">setCode</code><span class="sig-paren">(</span><em class="sig-param">code</em><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.Stream.setCode" title="Permalink to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>code</strong> string</p>
</dd>
</dl>
<p>Stream code (52.04)</p>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.Stream.code">
<code class="sig-name descname">code</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.Stream.code" title="Permalink to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Return type</dt>
<dd class="field-odd"><p>string</p>
</dd>
</dl>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.Stream.setStart">
<code class="sig-name descname">setStart</code><span class="sig-paren">(</span><em class="sig-param">start</em><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.Stream.setStart" title="Permalink to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>start</strong> seiscomp.core.Time</p>
</dd>
</dl>
<p>Start of epoch in ISO datetime format (52.22)</p>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.Stream.start">
<code class="sig-name descname">start</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.Stream.start" title="Permalink to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Return type</dt>
<dd class="field-odd"><p>seiscomp.core.Time</p>
</dd>
</dl>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.Stream.setEnd">
<code class="sig-name descname">setEnd</code><span class="sig-paren">(</span><em class="sig-param">end</em><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.Stream.setEnd" title="Permalink to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>end</strong> seiscomp.core.Time</p>
</dd>
</dl>
<p>End of epoch (52.23)</p>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.Stream.end">
<code class="sig-name descname">end</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.Stream.end" title="Permalink to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Return type</dt>
<dd class="field-odd"><p>seiscomp.core.Time</p>
</dd>
</dl>
<div class="admonition note">
<p class="admonition-title">Note</p>
<p>As this attribute is optional, this method throws a ValueError if
the value of the attribute is not set.</p>
</div>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.Stream.setDatalogger">
<code class="sig-name descname">setDatalogger</code><span class="sig-paren">(</span><em class="sig-param">datalogger</em><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.Stream.setDatalogger" title="Permalink to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>datalogger</strong> string</p>
</dd>
</dl>
<p>Reference to datalogger/&#64;publicID</p>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.Stream.datalogger">
<code class="sig-name descname">datalogger</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.Stream.datalogger" title="Permalink to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Return type</dt>
<dd class="field-odd"><p>string</p>
</dd>
</dl>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.Stream.setDataloggerSerialNumber">
<code class="sig-name descname">setDataloggerSerialNumber</code><span class="sig-paren">(</span><em class="sig-param">dataloggerSerialNumber</em><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.Stream.setDataloggerSerialNumber" title="Permalink to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>dataloggerSerialNumber</strong> string</p>
</dd>
</dl>
<p>Reference to datalogger/calibration/&#64;serialNumber</p>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.Stream.dataloggerSerialNumber">
<code class="sig-name descname">dataloggerSerialNumber</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.Stream.dataloggerSerialNumber" title="Permalink to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Return type</dt>
<dd class="field-odd"><p>string</p>
</dd>
</dl>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.Stream.setDataloggerChannel">
<code class="sig-name descname">setDataloggerChannel</code><span class="sig-paren">(</span><em class="sig-param">dataloggerChannel</em><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.Stream.setDataloggerChannel" title="Permalink to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>dataloggerChannel</strong> int</p>
</dd>
</dl>
<p>Reference to datalogger/calibration/&#64;channel</p>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.Stream.dataloggerChannel">
<code class="sig-name descname">dataloggerChannel</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.Stream.dataloggerChannel" title="Permalink to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Return type</dt>
<dd class="field-odd"><p>int</p>
</dd>
</dl>
<div class="admonition note">
<p class="admonition-title">Note</p>
<p>As this attribute is optional, this method throws a ValueError if
the value of the attribute is not set.</p>
</div>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.Stream.setSensor">
<code class="sig-name descname">setSensor</code><span class="sig-paren">(</span><em class="sig-param">sensor</em><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.Stream.setSensor" title="Permalink to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>sensor</strong> string</p>
</dd>
</dl>
<p>Reference to sensor/&#64;publicID</p>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.Stream.sensor">
<code class="sig-name descname">sensor</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.Stream.sensor" title="Permalink to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Return type</dt>
<dd class="field-odd"><p>string</p>
</dd>
</dl>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.Stream.setSensorSerialNumber">
<code class="sig-name descname">setSensorSerialNumber</code><span class="sig-paren">(</span><em class="sig-param">sensorSerialNumber</em><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.Stream.setSensorSerialNumber" title="Permalink to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>sensorSerialNumber</strong> string</p>
</dd>
</dl>
<p>Reference to sensor/calibration/&#64;serialNumber</p>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.Stream.sensorSerialNumber">
<code class="sig-name descname">sensorSerialNumber</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.Stream.sensorSerialNumber" title="Permalink to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Return type</dt>
<dd class="field-odd"><p>string</p>
</dd>
</dl>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.Stream.setSensorChannel">
<code class="sig-name descname">setSensorChannel</code><span class="sig-paren">(</span><em class="sig-param">sensorChannel</em><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.Stream.setSensorChannel" title="Permalink to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>sensorChannel</strong> int</p>
</dd>
</dl>
<p>Reference to sensor/calibration/&#64;channel</p>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.Stream.sensorChannel">
<code class="sig-name descname">sensorChannel</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.Stream.sensorChannel" title="Permalink to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Return type</dt>
<dd class="field-odd"><p>int</p>
</dd>
</dl>
<div class="admonition note">
<p class="admonition-title">Note</p>
<p>As this attribute is optional, this method throws a ValueError if
the value of the attribute is not set.</p>
</div>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.Stream.setClockSerialNumber">
<code class="sig-name descname">setClockSerialNumber</code><span class="sig-paren">(</span><em class="sig-param">clockSerialNumber</em><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.Stream.setClockSerialNumber" title="Permalink to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>clockSerialNumber</strong> string</p>
</dd>
</dl>
<p>Serial no. of clock (GPS). Mostly unused</p>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.Stream.clockSerialNumber">
<code class="sig-name descname">clockSerialNumber</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.Stream.clockSerialNumber" title="Permalink to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Return type</dt>
<dd class="field-odd"><p>string</p>
</dd>
</dl>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.Stream.setSampleRateNumerator">
<code class="sig-name descname">setSampleRateNumerator</code><span class="sig-paren">(</span><em class="sig-param">sampleRateNumerator</em><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.Stream.setSampleRateNumerator" title="Permalink to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>sampleRateNumerator</strong> int</p>
</dd>
</dl>
<p>Sample rate numerator (always &gt;0, eg., not identical to 52.18)</p>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.Stream.sampleRateNumerator">
<code class="sig-name descname">sampleRateNumerator</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.Stream.sampleRateNumerator" title="Permalink to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Return type</dt>
<dd class="field-odd"><p>int</p>
</dd>
</dl>
<div class="admonition note">
<p class="admonition-title">Note</p>
<p>As this attribute is optional, this method throws a ValueError if
the value of the attribute is not set.</p>
</div>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.Stream.setSampleRateDenominator">
<code class="sig-name descname">setSampleRateDenominator</code><span class="sig-paren">(</span><em class="sig-param">sampleRateDenominator</em><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.Stream.setSampleRateDenominator" title="Permalink to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>sampleRateDenominator</strong> int</p>
</dd>
</dl>
<p>Sample rate denominator (always &gt;0, eg., not identical to 52.19)</p>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.Stream.sampleRateDenominator">
<code class="sig-name descname">sampleRateDenominator</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.Stream.sampleRateDenominator" title="Permalink to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Return type</dt>
<dd class="field-odd"><p>int</p>
</dd>
</dl>
<div class="admonition note">
<p class="admonition-title">Note</p>
<p>As this attribute is optional, this method throws a ValueError if
the value of the attribute is not set.</p>
</div>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.Stream.setDepth">
<code class="sig-name descname">setDepth</code><span class="sig-paren">(</span><em class="sig-param">depth</em><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.Stream.setDepth" title="Permalink to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>depth</strong> float</p>
</dd>
</dl>
<p>Depth (52.13) of the sensor below sensorLocation in meters</p>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.Stream.depth">
<code class="sig-name descname">depth</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.Stream.depth" title="Permalink to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Return type</dt>
<dd class="field-odd"><p>float</p>
</dd>
</dl>
<div class="admonition note">
<p class="admonition-title">Note</p>
<p>As this attribute is optional, this method throws a ValueError if
the value of the attribute is not set.</p>
</div>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.Stream.setAzimuth">
<code class="sig-name descname">setAzimuth</code><span class="sig-paren">(</span><em class="sig-param">azimuth</em><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.Stream.setAzimuth" title="Permalink to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>azimuth</strong> float</p>
</dd>
</dl>
<p>Azimuth (52.14)</p>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.Stream.azimuth">
<code class="sig-name descname">azimuth</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.Stream.azimuth" title="Permalink to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Return type</dt>
<dd class="field-odd"><p>float</p>
</dd>
</dl>
<div class="admonition note">
<p class="admonition-title">Note</p>
<p>As this attribute is optional, this method throws a ValueError if
the value of the attribute is not set.</p>
</div>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.Stream.setDip">
<code class="sig-name descname">setDip</code><span class="sig-paren">(</span><em class="sig-param">dip</em><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.Stream.setDip" title="Permalink to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>dip</strong> float</p>
</dd>
</dl>
<p>Dip (52.15)</p>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.Stream.dip">
<code class="sig-name descname">dip</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.Stream.dip" title="Permalink to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Return type</dt>
<dd class="field-odd"><p>float</p>
</dd>
</dl>
<div class="admonition note">
<p class="admonition-title">Note</p>
<p>As this attribute is optional, this method throws a ValueError if
the value of the attribute is not set.</p>
</div>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.Stream.setGain">
<code class="sig-name descname">setGain</code><span class="sig-paren">(</span><em class="sig-param">gain</em><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.Stream.setGain" title="Permalink to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>gain</strong> float</p>
</dd>
</dl>
<p>Overall sensitivity (58.04) in counts/gainUnit</p>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.Stream.gain">
<code class="sig-name descname">gain</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.Stream.gain" title="Permalink to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Return type</dt>
<dd class="field-odd"><p>float</p>
</dd>
</dl>
<div class="admonition note">
<p class="admonition-title">Note</p>
<p>As this attribute is optional, this method throws a ValueError if
the value of the attribute is not set.</p>
</div>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.Stream.setGainFrequency">
<code class="sig-name descname">setGainFrequency</code><span class="sig-paren">(</span><em class="sig-param">gainFrequency</em><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.Stream.setGainFrequency" title="Permalink to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>gainFrequency</strong> float</p>
</dd>
</dl>
<p>Gain frequency (58.05)</p>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.Stream.gainFrequency">
<code class="sig-name descname">gainFrequency</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.Stream.gainFrequency" title="Permalink to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Return type</dt>
<dd class="field-odd"><p>float</p>
</dd>
</dl>
<div class="admonition note">
<p class="admonition-title">Note</p>
<p>As this attribute is optional, this method throws a ValueError if
the value of the attribute is not set.</p>
</div>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.Stream.setGainUnit">
<code class="sig-name descname">setGainUnit</code><span class="sig-paren">(</span><em class="sig-param">gainUnit</em><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.Stream.setGainUnit" title="Permalink to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>gainUnit</strong> string</p>
</dd>
</dl>
<p>Sensors unit of measurement (eg., M/S, M/S**2)</p>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.Stream.gainUnit">
<code class="sig-name descname">gainUnit</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.Stream.gainUnit" title="Permalink to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Return type</dt>
<dd class="field-odd"><p>string</p>
</dd>
</dl>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.Stream.setFormat">
<code class="sig-name descname">setFormat</code><span class="sig-paren">(</span><em class="sig-param">format</em><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.Stream.setFormat" title="Permalink to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>format</strong> string</p>
</dd>
</dl>
<p>Data format, eg.: “steim1”, “steim2”, “mseedN” (N = encoding format
in blockette 1000)</p>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.Stream.format">
<code class="sig-name descname">format</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.Stream.format" title="Permalink to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Return type</dt>
<dd class="field-odd"><p>string</p>
</dd>
</dl>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.Stream.setFlags">
<code class="sig-name descname">setFlags</code><span class="sig-paren">(</span><em class="sig-param">flags</em><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.Stream.setFlags" title="Permalink to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>flags</strong> string</p>
</dd>
</dl>
<p>Channel flags (52.21)</p>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.Stream.flags">
<code class="sig-name descname">flags</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.Stream.flags" title="Permalink to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Return type</dt>
<dd class="field-odd"><p>string</p>
</dd>
</dl>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.Stream.setRestricted">
<code class="sig-name descname">setRestricted</code><span class="sig-paren">(</span><em class="sig-param">restricted</em><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.Stream.setRestricted" title="Permalink to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>restricted</strong> boolean</p>
</dd>
</dl>
<p>Whether the stream is “restricted”</p>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.Stream.restricted">
<code class="sig-name descname">restricted</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.Stream.restricted" title="Permalink to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Return type</dt>
<dd class="field-odd"><p>boolean</p>
</dd>
</dl>
<div class="admonition note">
<p class="admonition-title">Note</p>
<p>As this attribute is optional, this method throws a ValueError if
the value of the attribute is not set.</p>
</div>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.Stream.setShared">
<code class="sig-name descname">setShared</code><span class="sig-paren">(</span><em class="sig-param">shared</em><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.Stream.setShared" title="Permalink to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>shared</strong> boolean</p>
</dd>
</dl>
<p>Whether the metadata is synchronized with other datacenters</p>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.Stream.shared">
<code class="sig-name descname">shared</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.Stream.shared" title="Permalink to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Return type</dt>
<dd class="field-odd"><p>boolean</p>
</dd>
</dl>
<div class="admonition note">
<p class="admonition-title">Note</p>
<p>As this attribute is optional, this method throws a ValueError if
the value of the attribute is not set.</p>
</div>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.Stream.add">
<code class="sig-name descname">add</code><span class="sig-paren">(</span><em class="sig-param">comment</em><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.Stream.add" title="Permalink to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>comment</strong> Object of type <a class="reference internal" href="#api-python-datamodel-comment"><span class="std std-ref">Comment</span></a></p>
</dd>
<dt class="field-even">Return type</dt>
<dd class="field-even"><p>A Boolean value indicating success with True, False otherwise.</p>
</dd>
</dl>
<p>Adds a Comment object to Stream. The object is not
copied but managed by this instance. Any change to the passed object
will also change the child.</p>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.Stream.remove">
<code class="sig-name descname">remove</code><span class="sig-paren">(</span><em class="sig-param">comment</em><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.Stream.remove" title="Permalink to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>comment</strong> Object of type <a class="reference internal" href="#api-python-datamodel-comment"><span class="std std-ref">Comment</span></a></p>
</dd>
<dt class="field-even">Return type</dt>
<dd class="field-even"><p>A Boolean value indicating success with True, False otherwise.</p>
</dd>
</dl>
<p>Removes a previously added Comment object from Stream.</p>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.Stream.removeComment">
<code class="sig-name descname">removeComment</code><span class="sig-paren">(</span><em class="sig-param">idx</em><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.Stream.removeComment" title="Permalink to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>idx</strong> An integer index of the object to be removed.</p>
</dd>
<dt class="field-even">Return type</dt>
<dd class="field-even"><p>A Boolean value indicating success with True, False otherwise.</p>
</dd>
</dl>
</dd></dl>
<dl class="method">
<dt>
<code class="sig-name descname">removeComment(commentIndex);</code></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>commentIndex</strong> The index of the object to be removed of type CommentIndex.</p>
</dd>
<dt class="field-even">Return type</dt>
<dd class="field-even"><p>A Boolean value indicating success with True, False otherwise.</p>
</dd>
</dl>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.Stream.commentCount">
<code class="sig-name descname">commentCount</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.Stream.commentCount" title="Permalink to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Return type</dt>
<dd class="field-odd"><p>integer value indicating the number of child objects.</p>
</dd>
</dl>
<p>Returns the number of Comment child objects.</p>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.Stream.comment">
<code class="sig-name descname">comment</code><span class="sig-paren">(</span><em class="sig-param">idx</em><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.Stream.comment" title="Permalink to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>idx</strong> An integer index of the object to be returned.</p>
</dd>
<dt class="field-even">Return type</dt>
<dd class="field-even"><p>Object of type <a class="reference internal" href="#api-python-datamodel-comment"><span class="std std-ref">Comment</span></a>.</p>
</dd>
</dl>
<p>Returns the Comment at index idx.</p>
</dd></dl>
<dl class="method">
<dt>
<code class="sig-name descname">comment</code><span class="sig-paren">(</span><em class="sig-param">commentIndex</em><span class="sig-paren">)</span></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>commentIndex</strong> The index of the object to be removed of type CommentIndex.</p>
</dd>
<dt class="field-even">Return type</dt>
<dd class="field-even"><p>Object of type <a class="reference internal" href="#api-python-datamodel-comment"><span class="std std-ref">Comment</span></a>.</p>
</dd>
</dl>
<p>Returns the Comment at given index. The indexes of all child objects
are compared by value which makes this function slower than the direct
integer index look-up.</p>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.Stream.sensorLocation">
<code class="sig-name descname">sensorLocation</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.Stream.sensorLocation" title="Permalink to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Return type</dt>
<dd class="field-odd"><p><a class="reference internal" href="#seiscomp.datamodel.SensorLocation" title="seiscomp.datamodel.SensorLocation">SensorLocation</a></p>
</dd>
</dl>
<p>Returns the parent SensorLocation if available. Returns None
if the parent is not a SensorLocation. This is a convenience wrapper
for parent().</p>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.Stream.assign">
<code class="sig-name descname">assign</code><span class="sig-paren">(</span><em class="sig-param">other</em><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.Stream.assign" title="Permalink to this definition"></a></dt>
<dd><p>This method implements the <a class="reference internal" href="#api-python-datamodel-object"><span class="std std-ref">Object</span></a> interface.</p>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.Stream.attachTo">
<code class="sig-name descname">attachTo</code><span class="sig-paren">(</span><em class="sig-param">parent</em><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.Stream.attachTo" title="Permalink to this definition"></a></dt>
<dd><p>This method implements the <a class="reference internal" href="#api-python-datamodel-object"><span class="std std-ref">Object</span></a> interface.</p>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.Stream.detachFrom">
<code class="sig-name descname">detachFrom</code><span class="sig-paren">(</span><em class="sig-param">parent</em><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.Stream.detachFrom" title="Permalink to this definition"></a></dt>
<dd><p>This method implements the <a class="reference internal" href="#api-python-datamodel-object"><span class="std std-ref">Object</span></a> interface.</p>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.Stream.detach">
<code class="sig-name descname">detach</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.Stream.detach" title="Permalink to this definition"></a></dt>
<dd><p>This method implements the <a class="reference internal" href="#api-python-datamodel-object"><span class="std std-ref">Object</span></a> interface.</p>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.Stream.clone">
<code class="sig-name descname">clone</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.Stream.clone" title="Permalink to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Return type</dt>
<dd class="field-odd"><p>A cloned Stream.</p>
</dd>
</dl>
<p>Returns a new instance that is a clone of the current instance. Child
objects are being ignored.</p>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.Stream.updateChild">
<code class="sig-name descname">updateChild</code><span class="sig-paren">(</span><em class="sig-param">ref</em><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.Stream.updateChild" title="Permalink to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>ref</strong> A child object derived from class Object.</p>
</dd>
<dt class="field-even">Return type</dt>
<dd class="field-even"><p>A Boolean flag indicating success with True, False otherwise</p>
</dd>
</dl>
<p>This method takes the passed reference object and searches for a child
with the same publicID (if derived from <a class="reference internal" href="#api-python-datamodel-publicobject"><span class="std std-ref">PublicObject</span></a>)
or the same index (if derived from <a class="reference internal" href="#api-python-datamodel-object"><span class="std std-ref">Object</span></a>).
The the child was found the reference objects attributes are copied to
the child object. Children of child are being ignored during this operation.
This method implements the <a class="reference internal" href="#api-python-datamodel-publicobject"><span class="std std-ref">PublicObject</span></a> interface.</p>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.Stream.accept">
<code class="sig-name descname">accept</code><span class="sig-paren">(</span><em class="sig-param">visitor</em><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.Stream.accept" title="Permalink to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>visitor</strong> A visitor.</p>
</dd>
</dl>
<p>This method implements the <a class="reference internal" href="#api-python-datamodel-publicobject"><span class="std std-ref">PublicObject</span></a> interface.</p>
</dd></dl>
</dd></dl>
</div>
<div class="section" id="tensor">
<span id="api-python-datamodel-tensor"></span><h3>Tensor<a class="headerlink" href="#tensor" title="Permalink to this headline"></a></h3>
<dl class="class">
<dt id="seiscomp.datamodel.Tensor">
<em class="property">class </em><code class="sig-prename descclassname">seiscomp.datamodel.</code><code class="sig-name descname">Tensor</code><a class="headerlink" href="#seiscomp.datamodel.Tensor" title="Permalink to this definition"></a></dt>
<dd><p>Inherits <a class="reference internal" href="#api-python-datamodel-object"><span class="std std-ref">Object</span></a>.</p>
<p>The Tensor class represents the six moment-tensor elements Mrr , Mtt ,
Mpp , Mrt , Mrp , Mtp in the spherical coordinate system defined by local
upward vertical (r), North-South (t), and West-East (p) directions. See
Aki and Richards (1980) for conversions to other coordinate systems.</p>
<p><strong>Attributes</strong>:</p>
<ul class="simple">
<li><p><code class="docutils literal notranslate"><span class="pre">Mrr</span></code> <a class="reference internal" href="#api-python-datamodel-realquantity"><span class="std std-ref">RealQuantity</span></a></p></li>
<li><p><code class="docutils literal notranslate"><span class="pre">Mtt</span></code> <a class="reference internal" href="#api-python-datamodel-realquantity"><span class="std std-ref">RealQuantity</span></a></p></li>
<li><p><code class="docutils literal notranslate"><span class="pre">Mpp</span></code> <a class="reference internal" href="#api-python-datamodel-realquantity"><span class="std std-ref">RealQuantity</span></a></p></li>
<li><p><code class="docutils literal notranslate"><span class="pre">Mrt</span></code> <a class="reference internal" href="#api-python-datamodel-realquantity"><span class="std std-ref">RealQuantity</span></a></p></li>
<li><p><code class="docutils literal notranslate"><span class="pre">Mrp</span></code> <a class="reference internal" href="#api-python-datamodel-realquantity"><span class="std std-ref">RealQuantity</span></a></p></li>
<li><p><code class="docutils literal notranslate"><span class="pre">Mtp</span></code> <a class="reference internal" href="#api-python-datamodel-realquantity"><span class="std std-ref">RealQuantity</span></a></p></li>
</ul>
<p><strong>Used by</strong>:</p>
<ul class="simple">
<li><p><a class="reference internal" href="#seiscomp.datamodel.MomentTensor.tensor" title="seiscomp.datamodel.MomentTensor.tensor"><code class="xref py py-func docutils literal notranslate"><span class="pre">MomentTensor.tensor()</span></code></a></p></li>
</ul>
<p><strong>Methods</strong>:</p>
<dl class="method">
<dt id="seiscomp.datamodel.Tensor.Cast">
<em class="property">static </em><code class="sig-name descname">Cast</code><span class="sig-paren">(</span><em class="sig-param">obj</em><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.Tensor.Cast" title="Permalink to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>obj</strong> The object to be casted.</p>
</dd>
<dt class="field-even">Return type</dt>
<dd class="field-even"><p>An object of type Tensor if the cast was successful,
None otherwise.</p>
</dd>
</dl>
<p>Cast an arbitrary object to Tensor if the internal wrapped
representation is an Tensor object. The cast is important if
instances of type <a class="reference internal" href="#api-python-datamodel-object"><span class="std std-ref">Object</span></a>
are passed to methods which need access to the real type.</p>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.Tensor.equal">
<code class="sig-name descname">equal</code><span class="sig-paren">(</span><em class="sig-param">other</em><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.Tensor.equal" title="Permalink to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>other</strong> Another object of type Tensor to compare this
instance to</p>
</dd>
<dt class="field-even">Return type</dt>
<dd class="field-even"><p>A Boolean value indicating True if both objects are equal or
False otherwise.</p>
</dd>
</dl>
<p>Compares two objects without its child objects. Both objects are compared
by value.</p>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.Tensor.setMrr">
<code class="sig-name descname">setMrr</code><span class="sig-paren">(</span><em class="sig-param">Mrr</em><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.Tensor.setMrr" title="Permalink to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>Mrr</strong> <a class="reference internal" href="#api-python-datamodel-realquantity"><span class="std std-ref">RealQuantity</span></a></p>
</dd>
</dl>
<p>Moment-tensor element Mrr in Nm.</p>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.Tensor.Mrr">
<code class="sig-name descname">Mrr</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.Tensor.Mrr" title="Permalink to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Return type</dt>
<dd class="field-odd"><p><a class="reference internal" href="#api-python-datamodel-realquantity"><span class="std std-ref">RealQuantity</span></a></p>
</dd>
</dl>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.Tensor.setMtt">
<code class="sig-name descname">setMtt</code><span class="sig-paren">(</span><em class="sig-param">Mtt</em><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.Tensor.setMtt" title="Permalink to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>Mtt</strong> <a class="reference internal" href="#api-python-datamodel-realquantity"><span class="std std-ref">RealQuantity</span></a></p>
</dd>
</dl>
<p>Moment-tensor element Mtt in Nm.</p>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.Tensor.Mtt">
<code class="sig-name descname">Mtt</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.Tensor.Mtt" title="Permalink to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Return type</dt>
<dd class="field-odd"><p><a class="reference internal" href="#api-python-datamodel-realquantity"><span class="std std-ref">RealQuantity</span></a></p>
</dd>
</dl>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.Tensor.setMpp">
<code class="sig-name descname">setMpp</code><span class="sig-paren">(</span><em class="sig-param">Mpp</em><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.Tensor.setMpp" title="Permalink to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>Mpp</strong> <a class="reference internal" href="#api-python-datamodel-realquantity"><span class="std std-ref">RealQuantity</span></a></p>
</dd>
</dl>
<p>Moment-tensor element Mpp in Nm.</p>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.Tensor.Mpp">
<code class="sig-name descname">Mpp</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.Tensor.Mpp" title="Permalink to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Return type</dt>
<dd class="field-odd"><p><a class="reference internal" href="#api-python-datamodel-realquantity"><span class="std std-ref">RealQuantity</span></a></p>
</dd>
</dl>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.Tensor.setMrt">
<code class="sig-name descname">setMrt</code><span class="sig-paren">(</span><em class="sig-param">Mrt</em><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.Tensor.setMrt" title="Permalink to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>Mrt</strong> <a class="reference internal" href="#api-python-datamodel-realquantity"><span class="std std-ref">RealQuantity</span></a></p>
</dd>
</dl>
<p>Moment-tensor element Mrt in Nm.</p>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.Tensor.Mrt">
<code class="sig-name descname">Mrt</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.Tensor.Mrt" title="Permalink to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Return type</dt>
<dd class="field-odd"><p><a class="reference internal" href="#api-python-datamodel-realquantity"><span class="std std-ref">RealQuantity</span></a></p>
</dd>
</dl>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.Tensor.setMrp">
<code class="sig-name descname">setMrp</code><span class="sig-paren">(</span><em class="sig-param">Mrp</em><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.Tensor.setMrp" title="Permalink to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>Mrp</strong> <a class="reference internal" href="#api-python-datamodel-realquantity"><span class="std std-ref">RealQuantity</span></a></p>
</dd>
</dl>
<p>Moment-tensor element Mrp in Nm.</p>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.Tensor.Mrp">
<code class="sig-name descname">Mrp</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.Tensor.Mrp" title="Permalink to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Return type</dt>
<dd class="field-odd"><p><a class="reference internal" href="#api-python-datamodel-realquantity"><span class="std std-ref">RealQuantity</span></a></p>
</dd>
</dl>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.Tensor.setMtp">
<code class="sig-name descname">setMtp</code><span class="sig-paren">(</span><em class="sig-param">Mtp</em><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.Tensor.setMtp" title="Permalink to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>Mtp</strong> <a class="reference internal" href="#api-python-datamodel-realquantity"><span class="std std-ref">RealQuantity</span></a></p>
</dd>
</dl>
<p>Moment-tensor element Mtp in Nm.</p>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.Tensor.Mtp">
<code class="sig-name descname">Mtp</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.Tensor.Mtp" title="Permalink to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Return type</dt>
<dd class="field-odd"><p><a class="reference internal" href="#api-python-datamodel-realquantity"><span class="std std-ref">RealQuantity</span></a></p>
</dd>
</dl>
</dd></dl>
</dd></dl>
</div>
<div class="section" id="timearray">
<span id="api-python-datamodel-timearray"></span><h3>TimeArray<a class="headerlink" href="#timearray" title="Permalink to this headline"></a></h3>
<dl class="class">
<dt id="seiscomp.datamodel.TimeArray">
<em class="property">class </em><code class="sig-prename descclassname">seiscomp.datamodel.</code><code class="sig-name descname">TimeArray</code><a class="headerlink" href="#seiscomp.datamodel.TimeArray" title="Permalink to this definition"></a></dt>
<dd><p>Inherits <a class="reference internal" href="#api-python-datamodel-object"><span class="std std-ref">Object</span></a>.</p>
<p><strong>Attributes</strong>:</p>
<ul class="simple">
<li><p><code class="docutils literal notranslate"><span class="pre">content</span></code> seiscomp.core.Time (optional)</p></li>
</ul>
<p><strong>Used by</strong>:</p>
<ul class="simple">
<li><p><a class="reference internal" href="#seiscomp.datamodel.TimePDF1D.variable" title="seiscomp.datamodel.TimePDF1D.variable"><code class="xref py py-func docutils literal notranslate"><span class="pre">TimePDF1D.variable()</span></code></a></p></li>
</ul>
<p><strong>Methods</strong>:</p>
<dl class="method">
<dt id="seiscomp.datamodel.TimeArray.Cast">
<em class="property">static </em><code class="sig-name descname">Cast</code><span class="sig-paren">(</span><em class="sig-param">obj</em><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.TimeArray.Cast" title="Permalink to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>obj</strong> The object to be casted.</p>
</dd>
<dt class="field-even">Return type</dt>
<dd class="field-even"><p>An object of type TimeArray if the cast was successful,
None otherwise.</p>
</dd>
</dl>
<p>Cast an arbitrary object to TimeArray if the internal wrapped
representation is an TimeArray object. The cast is important if
instances of type <a class="reference internal" href="#api-python-datamodel-object"><span class="std std-ref">Object</span></a>
are passed to methods which need access to the real type.</p>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.TimeArray.equal">
<code class="sig-name descname">equal</code><span class="sig-paren">(</span><em class="sig-param">other</em><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.TimeArray.equal" title="Permalink to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>other</strong> Another object of type TimeArray to compare this
instance to</p>
</dd>
<dt class="field-even">Return type</dt>
<dd class="field-even"><p>A Boolean value indicating True if both objects are equal or
False otherwise.</p>
</dd>
</dl>
<p>Compares two objects without its child objects. Both objects are compared
by value.</p>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.TimeArray.setContent">
<code class="sig-name descname">setContent</code><span class="sig-paren">(</span><em class="sig-param">content</em><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.TimeArray.setContent" title="Permalink to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>content</strong> seiscomp.core.Time</p>
</dd>
</dl>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.TimeArray.content">
<code class="sig-name descname">content</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.TimeArray.content" title="Permalink to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Return type</dt>
<dd class="field-odd"><p>seiscomp.core.Time</p>
</dd>
</dl>
<div class="admonition note">
<p class="admonition-title">Note</p>
<p>As this attribute is optional, this method throws a ValueError if
the value of the attribute is not set.</p>
</div>
</dd></dl>
</dd></dl>
</div>
<div class="section" id="timepdf1d">
<span id="api-python-datamodel-timepdf1d"></span><h3>TimePDF1D<a class="headerlink" href="#timepdf1d" title="Permalink to this headline"></a></h3>
<dl class="class">
<dt id="seiscomp.datamodel.TimePDF1D">
<em class="property">class </em><code class="sig-prename descclassname">seiscomp.datamodel.</code><code class="sig-name descname">TimePDF1D</code><a class="headerlink" href="#seiscomp.datamodel.TimePDF1D" title="Permalink to this definition"></a></dt>
<dd><p>Inherits <a class="reference internal" href="#api-python-datamodel-object"><span class="std std-ref">Object</span></a>.</p>
<p>A probability density function description. It can be used in three
different modes:</p>
<p>1) “raw samples mode”</p>
<p>variable is a list of M values, no probability. The values represent
samples, no binning/probabilities made.</p>
<p>2) “implicitly binned PDF”</p>
<p>variable and probabilty arrays have length N. variable values to be
interpreted as “bin centers” (or representative values),
no bin edges given.</p>
<p>3) “explicitly binned PDF”</p>
<p>variable has length N+1, probability has length N. variable values
describe bin edges (upper bin edge is lower edge of next bin).</p>
<p><strong>Attributes</strong>:</p>
<ul class="simple">
<li><p><code class="docutils literal notranslate"><span class="pre">variable</span></code> <a class="reference internal" href="#api-python-datamodel-timearray"><span class="std std-ref">TimeArray</span></a></p></li>
<li><p><code class="docutils literal notranslate"><span class="pre">probability</span></code> <a class="reference internal" href="#api-python-datamodel-realarray"><span class="std std-ref">RealArray</span></a></p></li>
</ul>
<p><strong>Used by</strong>:</p>
<ul class="simple">
<li><p><a class="reference internal" href="#seiscomp.datamodel.TimeQuantity.pdf" title="seiscomp.datamodel.TimeQuantity.pdf"><code class="xref py py-func docutils literal notranslate"><span class="pre">TimeQuantity.pdf()</span></code></a></p></li>
</ul>
<p><strong>Methods</strong>:</p>
<dl class="method">
<dt id="seiscomp.datamodel.TimePDF1D.Cast">
<em class="property">static </em><code class="sig-name descname">Cast</code><span class="sig-paren">(</span><em class="sig-param">obj</em><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.TimePDF1D.Cast" title="Permalink to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>obj</strong> The object to be casted.</p>
</dd>
<dt class="field-even">Return type</dt>
<dd class="field-even"><p>An object of type TimePDF1D if the cast was successful,
None otherwise.</p>
</dd>
</dl>
<p>Cast an arbitrary object to TimePDF1D if the internal wrapped
representation is an TimePDF1D object. The cast is important if
instances of type <a class="reference internal" href="#api-python-datamodel-object"><span class="std std-ref">Object</span></a>
are passed to methods which need access to the real type.</p>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.TimePDF1D.equal">
<code class="sig-name descname">equal</code><span class="sig-paren">(</span><em class="sig-param">other</em><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.TimePDF1D.equal" title="Permalink to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>other</strong> Another object of type TimePDF1D to compare this
instance to</p>
</dd>
<dt class="field-even">Return type</dt>
<dd class="field-even"><p>A Boolean value indicating True if both objects are equal or
False otherwise.</p>
</dd>
</dl>
<p>Compares two objects without its child objects. Both objects are compared
by value.</p>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.TimePDF1D.setVariable">
<code class="sig-name descname">setVariable</code><span class="sig-paren">(</span><em class="sig-param">variable</em><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.TimePDF1D.setVariable" title="Permalink to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>variable</strong> <a class="reference internal" href="#api-python-datamodel-timearray"><span class="std std-ref">TimeArray</span></a></p>
</dd>
</dl>
<p>List of datetimes</p>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.TimePDF1D.variable">
<code class="sig-name descname">variable</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.TimePDF1D.variable" title="Permalink to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Return type</dt>
<dd class="field-odd"><p><a class="reference internal" href="#api-python-datamodel-timearray"><span class="std std-ref">TimeArray</span></a></p>
</dd>
</dl>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.TimePDF1D.setProbability">
<code class="sig-name descname">setProbability</code><span class="sig-paren">(</span><em class="sig-param">probability</em><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.TimePDF1D.setProbability" title="Permalink to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>probability</strong> <a class="reference internal" href="#api-python-datamodel-realarray"><span class="std std-ref">RealArray</span></a></p>
</dd>
</dl>
<p>List of probabilities</p>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.TimePDF1D.probability">
<code class="sig-name descname">probability</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.TimePDF1D.probability" title="Permalink to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Return type</dt>
<dd class="field-odd"><p><a class="reference internal" href="#api-python-datamodel-realarray"><span class="std std-ref">RealArray</span></a></p>
</dd>
</dl>
</dd></dl>
</dd></dl>
</div>
<div class="section" id="timequantity">
<span id="api-python-datamodel-timequantity"></span><h3>TimeQuantity<a class="headerlink" href="#timequantity" title="Permalink to this headline"></a></h3>
<dl class="class">
<dt id="seiscomp.datamodel.TimeQuantity">
<em class="property">class </em><code class="sig-prename descclassname">seiscomp.datamodel.</code><code class="sig-name descname">TimeQuantity</code><a class="headerlink" href="#seiscomp.datamodel.TimeQuantity" title="Permalink to this definition"></a></dt>
<dd><p>Inherits <a class="reference internal" href="#api-python-datamodel-object"><span class="std std-ref">Object</span></a>.</p>
<p>This type describes a point in time, given in ISO 8601 format, with
optional symmetric or asymmetric uncertainties given in seconds. The
time has to be specified in UTC.</p>
<p><strong>Attributes</strong>:</p>
<ul class="simple">
<li><p><code class="docutils literal notranslate"><span class="pre">value</span></code> seiscomp.core.Time</p></li>
<li><p><code class="docutils literal notranslate"><span class="pre">uncertainty</span></code> float (optional)</p></li>
<li><p><code class="docutils literal notranslate"><span class="pre">lowerUncertainty</span></code> float (optional)</p></li>
<li><p><code class="docutils literal notranslate"><span class="pre">upperUncertainty</span></code> float (optional)</p></li>
<li><p><code class="docutils literal notranslate"><span class="pre">confidenceLevel</span></code> float (optional)</p></li>
<li><p><code class="docutils literal notranslate"><span class="pre">pdf</span></code> <a class="reference internal" href="#api-python-datamodel-timepdf1d"><span class="std std-ref">TimePDF1D</span></a> (optional)</p></li>
</ul>
<p><strong>Used by</strong>:</p>
<ul class="simple">
<li><p><a class="reference internal" href="#seiscomp.datamodel.Amplitude.scalingTime" title="seiscomp.datamodel.Amplitude.scalingTime"><code class="xref py py-func docutils literal notranslate"><span class="pre">Amplitude.scalingTime()</span></code></a></p></li>
<li><p><a class="reference internal" href="#seiscomp.datamodel.Origin.time" title="seiscomp.datamodel.Origin.time"><code class="xref py py-func docutils literal notranslate"><span class="pre">Origin.time()</span></code></a></p></li>
<li><p><a class="reference internal" href="#seiscomp.datamodel.Pick.time" title="seiscomp.datamodel.Pick.time"><code class="xref py py-func docutils literal notranslate"><span class="pre">Pick.time()</span></code></a></p></li>
</ul>
<p><strong>Methods</strong>:</p>
<dl class="method">
<dt id="seiscomp.datamodel.TimeQuantity.Cast">
<em class="property">static </em><code class="sig-name descname">Cast</code><span class="sig-paren">(</span><em class="sig-param">obj</em><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.TimeQuantity.Cast" title="Permalink to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>obj</strong> The object to be casted.</p>
</dd>
<dt class="field-even">Return type</dt>
<dd class="field-even"><p>An object of type TimeQuantity if the cast was successful,
None otherwise.</p>
</dd>
</dl>
<p>Cast an arbitrary object to TimeQuantity if the internal wrapped
representation is an TimeQuantity object. The cast is important if
instances of type <a class="reference internal" href="#api-python-datamodel-object"><span class="std std-ref">Object</span></a>
are passed to methods which need access to the real type.</p>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.TimeQuantity.equal">
<code class="sig-name descname">equal</code><span class="sig-paren">(</span><em class="sig-param">other</em><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.TimeQuantity.equal" title="Permalink to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>other</strong> Another object of type TimeQuantity to compare this
instance to</p>
</dd>
<dt class="field-even">Return type</dt>
<dd class="field-even"><p>A Boolean value indicating True if both objects are equal or
False otherwise.</p>
</dd>
</dl>
<p>Compares two objects without its child objects. Both objects are compared
by value.</p>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.TimeQuantity.setValue">
<code class="sig-name descname">setValue</code><span class="sig-paren">(</span><em class="sig-param">value</em><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.TimeQuantity.setValue" title="Permalink to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>value</strong> seiscomp.core.Time</p>
</dd>
</dl>
<p>Point in time (UTC), given in ISO 8601 format.</p>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.TimeQuantity.value">
<code class="sig-name descname">value</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.TimeQuantity.value" title="Permalink to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Return type</dt>
<dd class="field-odd"><p>seiscomp.core.Time</p>
</dd>
</dl>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.TimeQuantity.setUncertainty">
<code class="sig-name descname">setUncertainty</code><span class="sig-paren">(</span><em class="sig-param">uncertainty</em><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.TimeQuantity.setUncertainty" title="Permalink to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>uncertainty</strong> float</p>
</dd>
</dl>
<p>Symmetric uncertainty of point in time in seconds.</p>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.TimeQuantity.uncertainty">
<code class="sig-name descname">uncertainty</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.TimeQuantity.uncertainty" title="Permalink to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Return type</dt>
<dd class="field-odd"><p>float</p>
</dd>
</dl>
<div class="admonition note">
<p class="admonition-title">Note</p>
<p>As this attribute is optional, this method throws a ValueError if
the value of the attribute is not set.</p>
</div>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.TimeQuantity.setLowerUncertainty">
<code class="sig-name descname">setLowerUncertainty</code><span class="sig-paren">(</span><em class="sig-param">lowerUncertainty</em><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.TimeQuantity.setLowerUncertainty" title="Permalink to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>lowerUncertainty</strong> float</p>
</dd>
</dl>
<p>Lower uncertainty of point in time in seconds.</p>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.TimeQuantity.lowerUncertainty">
<code class="sig-name descname">lowerUncertainty</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.TimeQuantity.lowerUncertainty" title="Permalink to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Return type</dt>
<dd class="field-odd"><p>float</p>
</dd>
</dl>
<div class="admonition note">
<p class="admonition-title">Note</p>
<p>As this attribute is optional, this method throws a ValueError if
the value of the attribute is not set.</p>
</div>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.TimeQuantity.setUpperUncertainty">
<code class="sig-name descname">setUpperUncertainty</code><span class="sig-paren">(</span><em class="sig-param">upperUncertainty</em><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.TimeQuantity.setUpperUncertainty" title="Permalink to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>upperUncertainty</strong> float</p>
</dd>
</dl>
<p>Upper uncertainty of point in time in seconds.</p>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.TimeQuantity.upperUncertainty">
<code class="sig-name descname">upperUncertainty</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.TimeQuantity.upperUncertainty" title="Permalink to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Return type</dt>
<dd class="field-odd"><p>float</p>
</dd>
</dl>
<div class="admonition note">
<p class="admonition-title">Note</p>
<p>As this attribute is optional, this method throws a ValueError if
the value of the attribute is not set.</p>
</div>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.TimeQuantity.setConfidenceLevel">
<code class="sig-name descname">setConfidenceLevel</code><span class="sig-paren">(</span><em class="sig-param">confidenceLevel</em><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.TimeQuantity.setConfidenceLevel" title="Permalink to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>confidenceLevel</strong> float</p>
</dd>
</dl>
<p>Confidence level of the uncertainty, given in percent.</p>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.TimeQuantity.confidenceLevel">
<code class="sig-name descname">confidenceLevel</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.TimeQuantity.confidenceLevel" title="Permalink to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Return type</dt>
<dd class="field-odd"><p>float</p>
</dd>
</dl>
<div class="admonition note">
<p class="admonition-title">Note</p>
<p>As this attribute is optional, this method throws a ValueError if
the value of the attribute is not set.</p>
</div>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.TimeQuantity.setPdf">
<code class="sig-name descname">setPdf</code><span class="sig-paren">(</span><em class="sig-param">pdf</em><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.TimeQuantity.setPdf" title="Permalink to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>pdf</strong> <a class="reference internal" href="#api-python-datamodel-timepdf1d"><span class="std std-ref">TimePDF1D</span></a></p>
</dd>
</dl>
<p>Probability density function of the quantity.</p>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.TimeQuantity.pdf">
<code class="sig-name descname">pdf</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.TimeQuantity.pdf" title="Permalink to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Return type</dt>
<dd class="field-odd"><p><a class="reference internal" href="#api-python-datamodel-timepdf1d"><span class="std std-ref">TimePDF1D</span></a></p>
</dd>
</dl>
<div class="admonition note">
<p class="admonition-title">Note</p>
<p>As this attribute is optional, this method throws a ValueError if
the value of the attribute is not set.</p>
</div>
</dd></dl>
</dd></dl>
</div>
<div class="section" id="timewindow">
<span id="api-python-datamodel-timewindow"></span><h3>TimeWindow<a class="headerlink" href="#timewindow" title="Permalink to this headline"></a></h3>
<dl class="class">
<dt id="seiscomp.datamodel.TimeWindow">
<em class="property">class </em><code class="sig-prename descclassname">seiscomp.datamodel.</code><code class="sig-name descname">TimeWindow</code><a class="headerlink" href="#seiscomp.datamodel.TimeWindow" title="Permalink to this definition"></a></dt>
<dd><p>Inherits <a class="reference internal" href="#api-python-datamodel-object"><span class="std std-ref">Object</span></a>.</p>
<p>Describes a time window for amplitude measurements, given by a central point in
time, and points in time
before and after this central point. Both points before and after may coincide
with the central point.</p>
<p><strong>Attributes</strong>:</p>
<ul class="simple">
<li><p><code class="docutils literal notranslate"><span class="pre">reference</span></code> seiscomp.core.Time</p></li>
<li><p><code class="docutils literal notranslate"><span class="pre">begin</span></code> float</p></li>
<li><p><code class="docutils literal notranslate"><span class="pre">end</span></code> float</p></li>
</ul>
<p><strong>Used by</strong>:</p>
<ul class="simple">
<li><p><a class="reference internal" href="#seiscomp.datamodel.Amplitude.timeWindow" title="seiscomp.datamodel.Amplitude.timeWindow"><code class="xref py py-func docutils literal notranslate"><span class="pre">Amplitude.timeWindow()</span></code></a></p></li>
</ul>
<p><strong>Methods</strong>:</p>
<dl class="method">
<dt id="seiscomp.datamodel.TimeWindow.Cast">
<em class="property">static </em><code class="sig-name descname">Cast</code><span class="sig-paren">(</span><em class="sig-param">obj</em><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.TimeWindow.Cast" title="Permalink to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>obj</strong> The object to be casted.</p>
</dd>
<dt class="field-even">Return type</dt>
<dd class="field-even"><p>An object of type TimeWindow if the cast was successful,
None otherwise.</p>
</dd>
</dl>
<p>Cast an arbitrary object to TimeWindow if the internal wrapped
representation is an TimeWindow object. The cast is important if
instances of type <a class="reference internal" href="#api-python-datamodel-object"><span class="std std-ref">Object</span></a>
are passed to methods which need access to the real type.</p>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.TimeWindow.equal">
<code class="sig-name descname">equal</code><span class="sig-paren">(</span><em class="sig-param">other</em><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.TimeWindow.equal" title="Permalink to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>other</strong> Another object of type TimeWindow to compare this
instance to</p>
</dd>
<dt class="field-even">Return type</dt>
<dd class="field-even"><p>A Boolean value indicating True if both objects are equal or
False otherwise.</p>
</dd>
</dl>
<p>Compares two objects without its child objects. Both objects are compared
by value.</p>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.TimeWindow.setReference">
<code class="sig-name descname">setReference</code><span class="sig-paren">(</span><em class="sig-param">reference</em><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.TimeWindow.setReference" title="Permalink to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>reference</strong> seiscomp.core.Time</p>
</dd>
</dl>
<p>Reference point in time (“central” point), in ISO 8601 format. It
has to be given in UTC.</p>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.TimeWindow.reference">
<code class="sig-name descname">reference</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.TimeWindow.reference" title="Permalink to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Return type</dt>
<dd class="field-odd"><p>seiscomp.core.Time</p>
</dd>
</dl>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.TimeWindow.setBegin">
<code class="sig-name descname">setBegin</code><span class="sig-paren">(</span><em class="sig-param">begin</em><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.TimeWindow.setBegin" title="Permalink to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>begin</strong> float</p>
</dd>
</dl>
<p>Absolute value of duration of time interval before reference point
in time window. The value may be zero, but not negative in seconds.</p>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.TimeWindow.begin">
<code class="sig-name descname">begin</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.TimeWindow.begin" title="Permalink to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Return type</dt>
<dd class="field-odd"><p>float</p>
</dd>
</dl>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.TimeWindow.setEnd">
<code class="sig-name descname">setEnd</code><span class="sig-paren">(</span><em class="sig-param">end</em><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.TimeWindow.setEnd" title="Permalink to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>end</strong> float</p>
</dd>
</dl>
<p>Absolute value of duration of time interval after reference point in
time window. The value may be zero, but not negative in seconds.</p>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.TimeWindow.end">
<code class="sig-name descname">end</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.TimeWindow.end" title="Permalink to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Return type</dt>
<dd class="field-odd"><p>float</p>
</dd>
</dl>
</dd></dl>
</dd></dl>
</div>
<div class="section" id="waveformquality">
<span id="api-python-datamodel-waveformquality"></span><h3>WaveformQuality<a class="headerlink" href="#waveformquality" title="Permalink to this headline"></a></h3>
<dl class="class">
<dt id="seiscomp.datamodel.WaveformQuality">
<em class="property">class </em><code class="sig-prename descclassname">seiscomp.datamodel.</code><code class="sig-name descname">WaveformQuality</code><a class="headerlink" href="#seiscomp.datamodel.WaveformQuality" title="Permalink to this definition"></a></dt>
<dd><p>Inherits <a class="reference internal" href="#api-python-datamodel-object"><span class="std std-ref">Object</span></a>.</p>
<p><strong>Parents</strong>:</p>
<ul class="simple">
<li><p><code class="docutils literal notranslate"><span class="pre">qualityControl</span></code> <a class="reference internal" href="#api-python-datamodel-qualitycontrol"><span class="std std-ref">QualityControl</span></a></p></li>
</ul>
<p><strong>Attributes</strong>:</p>
<ul class="simple">
<li><p><code class="docutils literal notranslate"><span class="pre">waveformID</span></code> <a class="reference internal" href="#api-python-datamodel-waveformstreamid"><span class="std std-ref">WaveformStreamID</span></a></p></li>
<li><p><code class="docutils literal notranslate"><span class="pre">creatorID</span></code> string</p></li>
<li><p><code class="docutils literal notranslate"><span class="pre">created</span></code> seiscomp.core.Time</p></li>
<li><p><code class="docutils literal notranslate"><span class="pre">start</span></code> seiscomp.core.Time</p></li>
<li><p><code class="docutils literal notranslate"><span class="pre">end</span></code> seiscomp.core.Time (optional)</p></li>
<li><p><code class="docutils literal notranslate"><span class="pre">type</span></code> string</p></li>
<li><p><code class="docutils literal notranslate"><span class="pre">parameter</span></code> string</p></li>
<li><p><code class="docutils literal notranslate"><span class="pre">value</span></code> float</p></li>
<li><p><code class="docutils literal notranslate"><span class="pre">lowerUncertainty</span></code> float (optional)</p></li>
<li><p><code class="docutils literal notranslate"><span class="pre">upperUncertainty</span></code> float (optional)</p></li>
<li><p><code class="docutils literal notranslate"><span class="pre">windowLength</span></code> float (optional)</p></li>
</ul>
<p><strong>Methods</strong>:</p>
<dl class="method">
<dt id="seiscomp.datamodel.WaveformQuality.Cast">
<em class="property">static </em><code class="sig-name descname">Cast</code><span class="sig-paren">(</span><em class="sig-param">obj</em><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.WaveformQuality.Cast" title="Permalink to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>obj</strong> The object to be casted.</p>
</dd>
<dt class="field-even">Return type</dt>
<dd class="field-even"><p>An object of type WaveformQuality if the cast was successful,
None otherwise.</p>
</dd>
</dl>
<p>Cast an arbitrary object to WaveformQuality if the internal wrapped
representation is an WaveformQuality object. The cast is important if
instances of type <a class="reference internal" href="#api-python-datamodel-object"><span class="std std-ref">Object</span></a>
are passed to methods which need access to the real type.</p>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.WaveformQuality.equal">
<code class="sig-name descname">equal</code><span class="sig-paren">(</span><em class="sig-param">other</em><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.WaveformQuality.equal" title="Permalink to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>other</strong> Another object of type WaveformQuality to compare this
instance to</p>
</dd>
<dt class="field-even">Return type</dt>
<dd class="field-even"><p>A Boolean value indicating True if both objects are equal or
False otherwise.</p>
</dd>
</dl>
<p>Compares two objects without its child objects. Both objects are compared
by value.</p>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.WaveformQuality.index">
<code class="sig-name descname">index</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.WaveformQuality.index" title="Permalink to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Return type</dt>
<dd class="field-odd"><p><p>The objects index of type WaveformQualityIndex.</p>
<p>Returns the objects index which is also used for the database as unique
constraint.</p>
</p>
</dd>
</dl>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.WaveformQuality.equalIndex">
<code class="sig-name descname">equalIndex</code><span class="sig-paren">(</span><em class="sig-param">lhs</em><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.WaveformQuality.equalIndex" title="Permalink to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>lhs</strong> <a class="reference internal" href="#api-python-datamodel-waveformquality"><span class="std std-ref">WaveformQuality</span></a></p>
</dd>
<dt class="field-even">Return type</dt>
<dd class="field-even"><p>A Boolean value indicating True if both indexes are equal or
False otherwise.</p>
</dd>
</dl>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.WaveformQuality.setWaveformID">
<code class="sig-name descname">setWaveformID</code><span class="sig-paren">(</span><em class="sig-param">waveformID</em><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.WaveformQuality.setWaveformID" title="Permalink to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>waveformID</strong> <a class="reference internal" href="#api-python-datamodel-waveformstreamid"><span class="std std-ref">WaveformStreamID</span></a></p>
</dd>
</dl>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.WaveformQuality.waveformID">
<code class="sig-name descname">waveformID</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.WaveformQuality.waveformID" title="Permalink to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Return type</dt>
<dd class="field-odd"><p><a class="reference internal" href="#api-python-datamodel-waveformstreamid"><span class="std std-ref">WaveformStreamID</span></a></p>
</dd>
</dl>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.WaveformQuality.setCreatorID">
<code class="sig-name descname">setCreatorID</code><span class="sig-paren">(</span><em class="sig-param">creatorID</em><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.WaveformQuality.setCreatorID" title="Permalink to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>creatorID</strong> string</p>
</dd>
</dl>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.WaveformQuality.creatorID">
<code class="sig-name descname">creatorID</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.WaveformQuality.creatorID" title="Permalink to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Return type</dt>
<dd class="field-odd"><p>string</p>
</dd>
</dl>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.WaveformQuality.setCreated">
<code class="sig-name descname">setCreated</code><span class="sig-paren">(</span><em class="sig-param">created</em><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.WaveformQuality.setCreated" title="Permalink to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>created</strong> seiscomp.core.Time</p>
</dd>
</dl>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.WaveformQuality.created">
<code class="sig-name descname">created</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.WaveformQuality.created" title="Permalink to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Return type</dt>
<dd class="field-odd"><p>seiscomp.core.Time</p>
</dd>
</dl>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.WaveformQuality.setStart">
<code class="sig-name descname">setStart</code><span class="sig-paren">(</span><em class="sig-param">start</em><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.WaveformQuality.setStart" title="Permalink to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>start</strong> seiscomp.core.Time</p>
</dd>
</dl>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.WaveformQuality.start">
<code class="sig-name descname">start</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.WaveformQuality.start" title="Permalink to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Return type</dt>
<dd class="field-odd"><p>seiscomp.core.Time</p>
</dd>
</dl>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.WaveformQuality.setEnd">
<code class="sig-name descname">setEnd</code><span class="sig-paren">(</span><em class="sig-param">end</em><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.WaveformQuality.setEnd" title="Permalink to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>end</strong> seiscomp.core.Time</p>
</dd>
</dl>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.WaveformQuality.end">
<code class="sig-name descname">end</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.WaveformQuality.end" title="Permalink to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Return type</dt>
<dd class="field-odd"><p>seiscomp.core.Time</p>
</dd>
</dl>
<div class="admonition note">
<p class="admonition-title">Note</p>
<p>As this attribute is optional, this method throws a ValueError if
the value of the attribute is not set.</p>
</div>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.WaveformQuality.setType">
<code class="sig-name descname">setType</code><span class="sig-paren">(</span><em class="sig-param">type</em><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.WaveformQuality.setType" title="Permalink to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>type</strong> string</p>
</dd>
</dl>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.WaveformQuality.type">
<code class="sig-name descname">type</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.WaveformQuality.type" title="Permalink to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Return type</dt>
<dd class="field-odd"><p>string</p>
</dd>
</dl>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.WaveformQuality.setParameter">
<code class="sig-name descname">setParameter</code><span class="sig-paren">(</span><em class="sig-param">parameter</em><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.WaveformQuality.setParameter" title="Permalink to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>parameter</strong> string</p>
</dd>
</dl>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.WaveformQuality.parameter">
<code class="sig-name descname">parameter</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.WaveformQuality.parameter" title="Permalink to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Return type</dt>
<dd class="field-odd"><p>string</p>
</dd>
</dl>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.WaveformQuality.setValue">
<code class="sig-name descname">setValue</code><span class="sig-paren">(</span><em class="sig-param">value</em><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.WaveformQuality.setValue" title="Permalink to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>value</strong> float</p>
</dd>
</dl>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.WaveformQuality.value">
<code class="sig-name descname">value</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.WaveformQuality.value" title="Permalink to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Return type</dt>
<dd class="field-odd"><p>float</p>
</dd>
</dl>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.WaveformQuality.setLowerUncertainty">
<code class="sig-name descname">setLowerUncertainty</code><span class="sig-paren">(</span><em class="sig-param">lowerUncertainty</em><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.WaveformQuality.setLowerUncertainty" title="Permalink to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>lowerUncertainty</strong> float</p>
</dd>
</dl>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.WaveformQuality.lowerUncertainty">
<code class="sig-name descname">lowerUncertainty</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.WaveformQuality.lowerUncertainty" title="Permalink to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Return type</dt>
<dd class="field-odd"><p>float</p>
</dd>
</dl>
<div class="admonition note">
<p class="admonition-title">Note</p>
<p>As this attribute is optional, this method throws a ValueError if
the value of the attribute is not set.</p>
</div>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.WaveformQuality.setUpperUncertainty">
<code class="sig-name descname">setUpperUncertainty</code><span class="sig-paren">(</span><em class="sig-param">upperUncertainty</em><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.WaveformQuality.setUpperUncertainty" title="Permalink to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>upperUncertainty</strong> float</p>
</dd>
</dl>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.WaveformQuality.upperUncertainty">
<code class="sig-name descname">upperUncertainty</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.WaveformQuality.upperUncertainty" title="Permalink to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Return type</dt>
<dd class="field-odd"><p>float</p>
</dd>
</dl>
<div class="admonition note">
<p class="admonition-title">Note</p>
<p>As this attribute is optional, this method throws a ValueError if
the value of the attribute is not set.</p>
</div>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.WaveformQuality.setWindowLength">
<code class="sig-name descname">setWindowLength</code><span class="sig-paren">(</span><em class="sig-param">windowLength</em><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.WaveformQuality.setWindowLength" title="Permalink to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>windowLength</strong> float</p>
</dd>
</dl>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.WaveformQuality.windowLength">
<code class="sig-name descname">windowLength</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.WaveformQuality.windowLength" title="Permalink to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Return type</dt>
<dd class="field-odd"><p>float</p>
</dd>
</dl>
<div class="admonition note">
<p class="admonition-title">Note</p>
<p>As this attribute is optional, this method throws a ValueError if
the value of the attribute is not set.</p>
</div>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.WaveformQuality.qualityControl">
<code class="sig-name descname">qualityControl</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.WaveformQuality.qualityControl" title="Permalink to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Return type</dt>
<dd class="field-odd"><p><a class="reference internal" href="#seiscomp.datamodel.QualityControl" title="seiscomp.datamodel.QualityControl">QualityControl</a></p>
</dd>
</dl>
<p>Returns the parent QualityControl if available. Returns None
if the parent is not a QualityControl. This is a convenience wrapper
for parent().</p>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.WaveformQuality.assign">
<code class="sig-name descname">assign</code><span class="sig-paren">(</span><em class="sig-param">other</em><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.WaveformQuality.assign" title="Permalink to this definition"></a></dt>
<dd><p>This method implements the <a class="reference internal" href="#api-python-datamodel-object"><span class="std std-ref">Object</span></a> interface.</p>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.WaveformQuality.attachTo">
<code class="sig-name descname">attachTo</code><span class="sig-paren">(</span><em class="sig-param">parent</em><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.WaveformQuality.attachTo" title="Permalink to this definition"></a></dt>
<dd><p>This method implements the <a class="reference internal" href="#api-python-datamodel-object"><span class="std std-ref">Object</span></a> interface.</p>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.WaveformQuality.detachFrom">
<code class="sig-name descname">detachFrom</code><span class="sig-paren">(</span><em class="sig-param">parent</em><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.WaveformQuality.detachFrom" title="Permalink to this definition"></a></dt>
<dd><p>This method implements the <a class="reference internal" href="#api-python-datamodel-object"><span class="std std-ref">Object</span></a> interface.</p>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.WaveformQuality.detach">
<code class="sig-name descname">detach</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.WaveformQuality.detach" title="Permalink to this definition"></a></dt>
<dd><p>This method implements the <a class="reference internal" href="#api-python-datamodel-object"><span class="std std-ref">Object</span></a> interface.</p>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.WaveformQuality.clone">
<code class="sig-name descname">clone</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.WaveformQuality.clone" title="Permalink to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Return type</dt>
<dd class="field-odd"><p>A cloned WaveformQuality.</p>
</dd>
</dl>
<p>Returns a new instance that is a clone of the current instance. Child
objects are being ignored.</p>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.WaveformQuality.accept">
<code class="sig-name descname">accept</code><span class="sig-paren">(</span><em class="sig-param">visitor</em><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.WaveformQuality.accept" title="Permalink to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>visitor</strong> A visitor.</p>
</dd>
</dl>
<p>This method implements the <a class="reference internal" href="#api-python-datamodel-publicobject"><span class="std std-ref">PublicObject</span></a> interface.</p>
</dd></dl>
</dd></dl>
</div>
<div class="section" id="waveformstreamid">
<span id="api-python-datamodel-waveformstreamid"></span><h3>WaveformStreamID<a class="headerlink" href="#waveformstreamid" title="Permalink to this headline"></a></h3>
<dl class="class">
<dt id="seiscomp.datamodel.WaveformStreamID">
<em class="property">class </em><code class="sig-prename descclassname">seiscomp.datamodel.</code><code class="sig-name descname">WaveformStreamID</code><a class="headerlink" href="#seiscomp.datamodel.WaveformStreamID" title="Permalink to this definition"></a></dt>
<dd><p>Inherits <a class="reference internal" href="#api-python-datamodel-object"><span class="std std-ref">Object</span></a>.</p>
<p>Reference to a stream description in an inventory. This is mostly
equivalent to the combination of networkCode, stationCode, locationCode
and channelCode. However, additional information, e. g., sampling rate,
can be referenced by the resourceURI. It is recommended to use
resourceURI as a flexible, abstract, and unique stream ID that allows to
describe different processing levels, or resampled/filtered products of
the same initial stream, without violating the intrinsic meaning of the
legacy identifiers (network, station, channel, and location codes).
However, for operation in the context of legacy systems, the classical
identifier components are supported.</p>
<p><strong>Attributes</strong>:</p>
<ul class="simple">
<li><p><code class="docutils literal notranslate"><span class="pre">networkCode</span></code> string</p></li>
<li><p><code class="docutils literal notranslate"><span class="pre">stationCode</span></code> string</p></li>
<li><p><code class="docutils literal notranslate"><span class="pre">locationCode</span></code> string</p></li>
<li><p><code class="docutils literal notranslate"><span class="pre">channelCode</span></code> string</p></li>
<li><p><code class="docutils literal notranslate"><span class="pre">resourceURI</span></code> string</p></li>
</ul>
<p><strong>Used by</strong>:</p>
<ul class="simple">
<li><p><a class="reference internal" href="#seiscomp.datamodel.Amplitude.waveformID" title="seiscomp.datamodel.Amplitude.waveformID"><code class="xref py py-func docutils literal notranslate"><span class="pre">Amplitude.waveformID()</span></code></a></p></li>
<li><p><a class="reference internal" href="#seiscomp.datamodel.ArclinkRequestLine.streamID" title="seiscomp.datamodel.ArclinkRequestLine.streamID"><code class="xref py py-func docutils literal notranslate"><span class="pre">ArclinkRequestLine.streamID()</span></code></a></p></li>
<li><p><a class="reference internal" href="#seiscomp.datamodel.DataExtent.waveformID" title="seiscomp.datamodel.DataExtent.waveformID"><code class="xref py py-func docutils literal notranslate"><span class="pre">DataExtent.waveformID()</span></code></a></p></li>
<li><p><a class="reference internal" href="#seiscomp.datamodel.MomentTensorStationContribution.waveformID" title="seiscomp.datamodel.MomentTensorStationContribution.waveformID"><code class="xref py py-func docutils literal notranslate"><span class="pre">MomentTensorStationContribution.waveformID()</span></code></a></p></li>
<li><p><a class="reference internal" href="#seiscomp.datamodel.Outage.waveformID" title="seiscomp.datamodel.Outage.waveformID"><code class="xref py py-func docutils literal notranslate"><span class="pre">Outage.waveformID()</span></code></a></p></li>
<li><p><a class="reference internal" href="#seiscomp.datamodel.Pick.waveformID" title="seiscomp.datamodel.Pick.waveformID"><code class="xref py py-func docutils literal notranslate"><span class="pre">Pick.waveformID()</span></code></a></p></li>
<li><p><a class="reference internal" href="#seiscomp.datamodel.QCLog.waveformID" title="seiscomp.datamodel.QCLog.waveformID"><code class="xref py py-func docutils literal notranslate"><span class="pre">QCLog.waveformID()</span></code></a></p></li>
<li><p><a class="reference internal" href="#seiscomp.datamodel.StationMagnitude.waveformID" title="seiscomp.datamodel.StationMagnitude.waveformID"><code class="xref py py-func docutils literal notranslate"><span class="pre">StationMagnitude.waveformID()</span></code></a></p></li>
<li><p><a class="reference internal" href="#seiscomp.datamodel.WaveformQuality.waveformID" title="seiscomp.datamodel.WaveformQuality.waveformID"><code class="xref py py-func docutils literal notranslate"><span class="pre">WaveformQuality.waveformID()</span></code></a></p></li>
</ul>
<p><strong>Methods</strong>:</p>
<dl class="method">
<dt id="seiscomp.datamodel.WaveformStreamID.Cast">
<em class="property">static </em><code class="sig-name descname">Cast</code><span class="sig-paren">(</span><em class="sig-param">obj</em><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.WaveformStreamID.Cast" title="Permalink to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>obj</strong> The object to be casted.</p>
</dd>
<dt class="field-even">Return type</dt>
<dd class="field-even"><p>An object of type WaveformStreamID if the cast was successful,
None otherwise.</p>
</dd>
</dl>
<p>Cast an arbitrary object to WaveformStreamID if the internal wrapped
representation is an WaveformStreamID object. The cast is important if
instances of type <a class="reference internal" href="#api-python-datamodel-object"><span class="std std-ref">Object</span></a>
are passed to methods which need access to the real type.</p>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.WaveformStreamID.equal">
<code class="sig-name descname">equal</code><span class="sig-paren">(</span><em class="sig-param">other</em><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.WaveformStreamID.equal" title="Permalink to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>other</strong> Another object of type WaveformStreamID to compare this
instance to</p>
</dd>
<dt class="field-even">Return type</dt>
<dd class="field-even"><p>A Boolean value indicating True if both objects are equal or
False otherwise.</p>
</dd>
</dl>
<p>Compares two objects without its child objects. Both objects are compared
by value.</p>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.WaveformStreamID.setNetworkCode">
<code class="sig-name descname">setNetworkCode</code><span class="sig-paren">(</span><em class="sig-param">networkCode</em><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.WaveformStreamID.setNetworkCode" title="Permalink to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>networkCode</strong> string</p>
</dd>
</dl>
<p>Network code. String with a maximum length of 8 characters.</p>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.WaveformStreamID.networkCode">
<code class="sig-name descname">networkCode</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.WaveformStreamID.networkCode" title="Permalink to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Return type</dt>
<dd class="field-odd"><p>string</p>
</dd>
</dl>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.WaveformStreamID.setStationCode">
<code class="sig-name descname">setStationCode</code><span class="sig-paren">(</span><em class="sig-param">stationCode</em><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.WaveformStreamID.setStationCode" title="Permalink to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>stationCode</strong> string</p>
</dd>
</dl>
<p>Station code. String with a maximum length of 8 characters.</p>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.WaveformStreamID.stationCode">
<code class="sig-name descname">stationCode</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.WaveformStreamID.stationCode" title="Permalink to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Return type</dt>
<dd class="field-odd"><p>string</p>
</dd>
</dl>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.WaveformStreamID.setLocationCode">
<code class="sig-name descname">setLocationCode</code><span class="sig-paren">(</span><em class="sig-param">locationCode</em><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.WaveformStreamID.setLocationCode" title="Permalink to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>locationCode</strong> string</p>
</dd>
</dl>
<p>Location code. String with a maximum length of 8 characters.</p>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.WaveformStreamID.locationCode">
<code class="sig-name descname">locationCode</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.WaveformStreamID.locationCode" title="Permalink to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Return type</dt>
<dd class="field-odd"><p>string</p>
</dd>
</dl>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.WaveformStreamID.setChannelCode">
<code class="sig-name descname">setChannelCode</code><span class="sig-paren">(</span><em class="sig-param">channelCode</em><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.WaveformStreamID.setChannelCode" title="Permalink to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>channelCode</strong> string</p>
</dd>
</dl>
<p>Channel code. String with a maximum length of 8 characters.</p>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.WaveformStreamID.channelCode">
<code class="sig-name descname">channelCode</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.WaveformStreamID.channelCode" title="Permalink to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Return type</dt>
<dd class="field-odd"><p>string</p>
</dd>
</dl>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.WaveformStreamID.setResourceURI">
<code class="sig-name descname">setResourceURI</code><span class="sig-paren">(</span><em class="sig-param">resourceURI</em><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.WaveformStreamID.setResourceURI" title="Permalink to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>resourceURI</strong> string</p>
</dd>
</dl>
<p>Optional resource identifier for the waveform stream. QuakeML adopts
in many places resource descriptors with a well-defined syntax for
unambiguous resource identification. Resource identifiers are designed
to be backward compatible with existing descriptors. In SeisComP this
identifier is not used at all.</p>
</dd></dl>
<dl class="method">
<dt id="seiscomp.datamodel.WaveformStreamID.resourceURI">
<code class="sig-name descname">resourceURI</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#seiscomp.datamodel.WaveformStreamID.resourceURI" title="Permalink to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Return type</dt>
<dd class="field-odd"><p>string</p>
</dd>
</dl>
</dd></dl>
</dd></dl>
<script>
window.onload = function() {
let graphvizs = document.getElementsByClassName("graphviz");
for ( let graphviz of graphvizs ) {
obj = graphviz.firstElementChild;
if ( obj === undefined || obj.tagName !== "OBJECT" ) {
continue;
}
let url = obj.data;
let div = obj.parentElement;
console.log(div.tagName);
if ( url === undefined || div === undefined || div.tagName !== "DIV" ) {
continue;
}
let caption = div.nextElementSibling;
if ( caption === undefined ) {
continue;
}
let svg = document.createElement("a");
svg.appendChild(document.createTextNode("[SVG]"));
svg.setAttribute("href", "#")
svg.onclick = function() { window.open(url); };
caption.appendChild(svg);
}
}
</script></div>
</div>
</div>
<div id="anchors-bottom"></div>
</div>
<div class="sidebar" role="navigation" aria-label="main navigation">
<div id="anchors-top"></div>
<div id="anchors" class="content">
<div id="searchbox" style="display: none" role="search">
<h3 id="searchlabel">Quick search</h3>
<div class="searchformwrapper">
<form class="search" action="../search.html" method="get">
<input type="text" name="q" aria-labelledby="searchlabel" />
<input type="submit" value="Go" />
</form>
</div>
</div>
<script>$('#searchbox').show(0);</script>
<h3><a href="../index.html">Table of Contents</a></h3>
<ul>
<li><a class="reference internal" href="#">seiscomp.datamodel</a><ul>
<li><a class="reference internal" href="#base-objects">Base Objects</a></li>
<li><a class="reference internal" href="#domain-overview">Domain Overview</a><ul>
<li><a class="reference internal" href="#eventparameters">EventParameters</a></li>
<li><a class="reference internal" href="#config">Config</a></li>
<li><a class="reference internal" href="#qualitycontrol">QualityControl</a></li>
<li><a class="reference internal" href="#inventory">Inventory</a></li>
<li><a class="reference internal" href="#routing">Routing</a></li>
<li><a class="reference internal" href="#journaling">Journaling</a></li>
<li><a class="reference internal" href="#arclinklog">ArclinkLog</a></li>
<li><a class="reference internal" href="#dataavailability">DataAvailability</a></li>
</ul>
</li>
<li><a class="reference internal" href="#enumerations">Enumerations</a></li>
<li><a class="reference internal" href="#reference">Reference</a><ul>
<li><a class="reference internal" href="#object">Object</a></li>
<li><a class="reference internal" href="#publicobject">PublicObject</a></li>
<li><a class="reference internal" href="#notifier">Notifier</a></li>
<li><a class="reference internal" href="#access">Access</a></li>
<li><a class="reference internal" href="#amplitude">Amplitude</a></li>
<li><a class="reference internal" href="#amplitudereference">AmplitudeReference</a></li>
<li><a class="reference internal" href="#api-python-datamodel-arclinklog">ArclinkLog</a></li>
<li><a class="reference internal" href="#arclinkrequest">ArclinkRequest</a></li>
<li><a class="reference internal" href="#arclinkrequestline">ArclinkRequestLine</a></li>
<li><a class="reference internal" href="#arclinkrequestsummary">ArclinkRequestSummary</a></li>
<li><a class="reference internal" href="#arclinkstatusline">ArclinkStatusLine</a></li>
<li><a class="reference internal" href="#arclinkuser">ArclinkUser</a></li>
<li><a class="reference internal" href="#arrival">Arrival</a></li>
<li><a class="reference internal" href="#auxdevice">AuxDevice</a></li>
<li><a class="reference internal" href="#auxsource">AuxSource</a></li>
<li><a class="reference internal" href="#auxstream">AuxStream</a></li>
<li><a class="reference internal" href="#axis">Axis</a></li>
<li><a class="reference internal" href="#blob">Blob</a></li>
<li><a class="reference internal" href="#comment">Comment</a></li>
<li><a class="reference internal" href="#complexarray">ComplexArray</a></li>
<li><a class="reference internal" href="#compositetime">CompositeTime</a></li>
<li><a class="reference internal" href="#confidenceellipsoid">ConfidenceEllipsoid</a></li>
<li><a class="reference internal" href="#api-python-datamodel-config">Config</a></li>
<li><a class="reference internal" href="#configmodule">ConfigModule</a></li>
<li><a class="reference internal" href="#configstation">ConfigStation</a></li>
<li><a class="reference internal" href="#creationinfo">CreationInfo</a></li>
<li><a class="reference internal" href="#dataattributeextent">DataAttributeExtent</a></li>
<li><a class="reference internal" href="#api-python-datamodel-dataavailability">DataAvailability</a></li>
<li><a class="reference internal" href="#dataextent">DataExtent</a></li>
<li><a class="reference internal" href="#datasegment">DataSegment</a></li>
<li><a class="reference internal" href="#dataused">DataUsed</a></li>
<li><a class="reference internal" href="#datalogger">Datalogger</a></li>
<li><a class="reference internal" href="#dataloggercalibration">DataloggerCalibration</a></li>
<li><a class="reference internal" href="#decimation">Decimation</a></li>
<li><a class="reference internal" href="#event">Event</a></li>
<li><a class="reference internal" href="#eventdescription">EventDescription</a></li>
<li><a class="reference internal" href="#api-python-datamodel-eventparameters">EventParameters</a></li>
<li><a class="reference internal" href="#focalmechanism">FocalMechanism</a></li>
<li><a class="reference internal" href="#focalmechanismreference">FocalMechanismReference</a></li>
<li><a class="reference internal" href="#integerquantity">IntegerQuantity</a></li>
<li><a class="reference internal" href="#api-python-datamodel-inventory">Inventory</a></li>
<li><a class="reference internal" href="#journalentry">JournalEntry</a></li>
<li><a class="reference internal" href="#api-python-datamodel-journaling">Journaling</a></li>
<li><a class="reference internal" href="#magnitude">Magnitude</a></li>
<li><a class="reference internal" href="#momenttensor">MomentTensor</a></li>
<li><a class="reference internal" href="#momenttensorcomponentcontribution">MomentTensorComponentContribution</a></li>
<li><a class="reference internal" href="#momenttensorphasesetting">MomentTensorPhaseSetting</a></li>
<li><a class="reference internal" href="#momenttensorstationcontribution">MomentTensorStationContribution</a></li>
<li><a class="reference internal" href="#network">Network</a></li>
<li><a class="reference internal" href="#nodalplane">NodalPlane</a></li>
<li><a class="reference internal" href="#nodalplanes">NodalPlanes</a></li>
<li><a class="reference internal" href="#origin">Origin</a></li>
<li><a class="reference internal" href="#originquality">OriginQuality</a></li>
<li><a class="reference internal" href="#originreference">OriginReference</a></li>
<li><a class="reference internal" href="#originuncertainty">OriginUncertainty</a></li>
<li><a class="reference internal" href="#outage">Outage</a></li>
<li><a class="reference internal" href="#parameter">Parameter</a></li>
<li><a class="reference internal" href="#parameterset">ParameterSet</a></li>
<li><a class="reference internal" href="#phase">Phase</a></li>
<li><a class="reference internal" href="#pick">Pick</a></li>
<li><a class="reference internal" href="#pickreference">PickReference</a></li>
<li><a class="reference internal" href="#principalaxes">PrincipalAxes</a></li>
<li><a class="reference internal" href="#qclog">QCLog</a></li>
<li><a class="reference internal" href="#api-python-datamodel-qualitycontrol">QualityControl</a></li>
<li><a class="reference internal" href="#reading">Reading</a></li>
<li><a class="reference internal" href="#realarray">RealArray</a></li>
<li><a class="reference internal" href="#realpdf1d">RealPDF1D</a></li>
<li><a class="reference internal" href="#realquantity">RealQuantity</a></li>
<li><a class="reference internal" href="#responsefap">ResponseFAP</a></li>
<li><a class="reference internal" href="#responsefir">ResponseFIR</a></li>
<li><a class="reference internal" href="#responseiir">ResponseIIR</a></li>
<li><a class="reference internal" href="#responsepaz">ResponsePAZ</a></li>
<li><a class="reference internal" href="#responsepolynomial">ResponsePolynomial</a></li>
<li><a class="reference internal" href="#route">Route</a></li>
<li><a class="reference internal" href="#routearclink">RouteArclink</a></li>
<li><a class="reference internal" href="#routeseedlink">RouteSeedlink</a></li>
<li><a class="reference internal" href="#api-python-datamodel-routing">Routing</a></li>
<li><a class="reference internal" href="#sensor">Sensor</a></li>
<li><a class="reference internal" href="#sensorcalibration">SensorCalibration</a></li>
<li><a class="reference internal" href="#sensorlocation">SensorLocation</a></li>
<li><a class="reference internal" href="#setup">Setup</a></li>
<li><a class="reference internal" href="#sourcetimefunction">SourceTimeFunction</a></li>
<li><a class="reference internal" href="#station">Station</a></li>
<li><a class="reference internal" href="#stationgroup">StationGroup</a></li>
<li><a class="reference internal" href="#stationmagnitude">StationMagnitude</a></li>
<li><a class="reference internal" href="#stationmagnitudecontribution">StationMagnitudeContribution</a></li>
<li><a class="reference internal" href="#stationreference">StationReference</a></li>
<li><a class="reference internal" href="#stream">Stream</a></li>
<li><a class="reference internal" href="#tensor">Tensor</a></li>
<li><a class="reference internal" href="#timearray">TimeArray</a></li>
<li><a class="reference internal" href="#timepdf1d">TimePDF1D</a></li>
<li><a class="reference internal" href="#timequantity">TimeQuantity</a></li>
<li><a class="reference internal" href="#timewindow">TimeWindow</a></li>
<li><a class="reference internal" href="#waveformquality">WaveformQuality</a></li>
<li><a class="reference internal" href="#waveformstreamid">WaveformStreamID</a></li>
</ul>
</li>
</ul>
</li>
</ul>
<h4>Previous topic</h4>
<p class="topless"><a href="sdk-python-packages.html"
title="previous chapter">Packages</a></p>
<h4>Next topic</h4>
<p class="topless"><a href="api-python-client.html"
title="next chapter">seiscomp.client</a></p>
<div role="note" aria-label="source link">
<h3>This Page</h3>
<ul class="this-page-menu">
<li><a href="../_sources/base/api-python.rst.txt"
rel="nofollow">Show Source</a></li>
</ul>
</div>
</div>
</div>
</div>
</div>
<div class="footer">
<div class="container">
<div class="horizontal layout content">
<a class="fade-in" href="https://www.gempa.de" target="_blank">
<img class="brand" src="../_static/brands/gempa.svg"/>
</a>
<div class="stretched align-center fitted content">
<div>
Version <b>5.3.0</b> Release
</div>
<div class="copyright">
Copyright &copy; gempa GmbH, GFZ Potsdam.
</div>
</div>
<a class="fade-in" href="https://www.gfz-potsdam.de" target="_blank">
<img class="brand" src="../_static/brands/gfz.svg"/>
</a>
</div>
</div>
</div>
</body>
</html>