dataforge-core/dataforge-meta/space.kscience.dataforge.misc/index.html

184 lines
19 KiB
HTML
Raw Permalink Normal View History

<html>
<head>
<meta name="viewport" content="width=device-width, initial-scale=1" charset="UTF-8">
<title>space.kscience.dataforge.misc</title>
</head><body><link href="../../images/logo-icon.svg" rel="icon" type="image/svg"><script>var pathToRoot = "../../";</script><script type="text/javascript" src="../../scripts/sourceset_dependencies.js" async></script><link href="../../styles/style.css" rel="Stylesheet"><link href="../../styles/logo-styles.css" rel="Stylesheet"><link href="../../styles/jetbrains-mono.css" rel="Stylesheet"><link href="../../styles/main.css" rel="Stylesheet"><script type="text/javascript" src="../../scripts/clipboard.js" async></script><script type="text/javascript" src="../../scripts/navigation-loader.js" async></script><script type="text/javascript" src="../../scripts/platform-content-handler.js" async></script><script type="text/javascript" src="../../scripts/main.js" async></script>
<div id="container">
<div id="leftColumn"><a href="../../index.html">
<div id="logo"></div>
</a>
<div id="paneSearch"></div>
<div id="sideMenu"></div>
</div>
<div id="main">
<script type="text/javascript" src="../../scripts/main.js"></script><div id="leftToggler"><span class="icon-toggler"></span></div>
<div class="main-content" id="content" pageids="dataforge-meta::space.kscience.dataforge.misc////PointingToDeclaration//1576389700">
<div class="navigation-wrapper" id="navigation-wrapper">
<div class="breadcrumbs"><a href="../index.html">dataforge-meta</a>/<a href="index.html">space.kscience.dataforge.misc</a></div>
<div class="pull-right d-flex">
<div class="filter-section" id="filter-section"><button class="platform-tag platform-selector common-like" data-active="" data-filter=":dataforge-meta:dokkaHtmlPartial/commonMain">common</button><button class="platform-tag platform-selector js-like" data-active="" data-filter=":dataforge-meta:dokkaHtmlPartial/jsMain">js</button><button class="platform-tag platform-selector jvm-like" data-active="" data-filter=":dataforge-meta:dokkaHtmlPartial/jvmMain">jvm</button><button class="platform-tag platform-selector native-like" data-active="" data-filter=":dataforge-meta:dokkaHtmlPartial/nativeMain">native</button></div>
<div id="searchBar"></div>
</div>
</div>
<div class="cover ">
<h1 class="cover"><span><span>Package</span></span> <span>space.</span><wbr><span>kscience.</span><wbr><span>dataforge.</span><wbr><span>misc</span></h1>
</div>
<div class="tabbedcontent">
<div class="tabs-section" tabs-section="tabs-section"><button class="section-tab" data-active="" data-togglable="Types">Types</button><button class="section-tab" data-togglable="Functions">Functions</button><button class="section-tab" data-togglable="Properties">Properties</button></div>
<div class="tabs-section-body">
<h2 class="">Types</h2>
<div class="table" data-togglable="Types"><a data-name="1766293373%2FClasslikes%2F-1789010594" anchor-label="DFBuilder" id="1766293373%2FClasslikes%2F-1789010594" data-filterable-set=":dataforge-meta:dokkaHtmlPartial/commonMain"></a>
<div class="table-row" data-filterable-current=":dataforge-meta:dokkaHtmlPartial/commonMain" data-filterable-set=":dataforge-meta:dokkaHtmlPartial/commonMain">
<div class="main-subrow keyValue ">
<div class=""><span class="inline-flex"><a href="-d-f-builder/index.html"><span><span>DFBuilder</span></span></a><span class="anchor-wrapper"><span class="anchor-icon" pointing-to="1766293373%2FClasslikes%2F-1789010594"></span>
<div class="copy-popup-wrapper "><span class="copy-popup-icon"></span><span>Link copied to clipboard</span></div>
</span></span></div>
<div>
<div class="platform-tags ">
<div class="platform-tag common-like">common</div>
</div>
<div class="title"><div class="divergent-group" data-filterable-current=":dataforge-meta:dokkaHtmlPartial/commonMain" data-filterable-set=":dataforge-meta:dokkaHtmlPartial/commonMain"><div class="with-platform-tags"><span class="pull-right"></span></div>
<div>
<div class="platform-hinted " data-platform-hinted="data-platform-hinted"><div class="content sourceset-depenent-content" data-active="" data-togglable=":dataforge-meta:dokkaHtmlPartial/commonMain"><div class="symbol monospace"><div class="block"><div class="block">@<a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-dsl-marker/index.html">DslMarker</a></div></div>annotation class <a href="-d-f-builder/index.html">DFBuilder</a><span class="top-right-position"><span class="copy-icon"></span><div class="copy-popup-wrapper popup-to-left"><span class="copy-popup-icon"></span><span>Content copied to clipboard</span></div></span></div></div></div>
</div>
<div class="brief "><p class="paragraph">General marker for dataforge builders</p></div></div>
</div>
</div>
</div>
</div>
<a data-name="2103846434%2FClasslikes%2F-1789010594" anchor-label="DFExperimental" id="2103846434%2FClasslikes%2F-1789010594" data-filterable-set=":dataforge-meta:dokkaHtmlPartial/commonMain"></a>
<div class="table-row" data-filterable-current=":dataforge-meta:dokkaHtmlPartial/commonMain" data-filterable-set=":dataforge-meta:dokkaHtmlPartial/commonMain">
<div class="main-subrow keyValue ">
<div class=""><span class="inline-flex"><a href="-d-f-experimental/index.html"><span><span>DFExperimental</span></span></a><span class="anchor-wrapper"><span class="anchor-icon" pointing-to="2103846434%2FClasslikes%2F-1789010594"></span>
<div class="copy-popup-wrapper "><span class="copy-popup-icon"></span><span>Link copied to clipboard</span></div>
</span></span></div>
<div>
<div class="platform-tags ">
<div class="platform-tag common-like">common</div>
</div>
<div class="title"><div class="divergent-group" data-filterable-current=":dataforge-meta:dokkaHtmlPartial/commonMain" data-filterable-set=":dataforge-meta:dokkaHtmlPartial/commonMain"><div class="with-platform-tags"><span class="pull-right"></span></div>
<div>
<div class="platform-hinted " data-platform-hinted="data-platform-hinted"><div class="content sourceset-depenent-content" data-active="" data-togglable=":dataforge-meta:dokkaHtmlPartial/commonMain"><div class="symbol monospace">annotation class <a href="-d-f-experimental/index.html">DFExperimental</a><span class="top-right-position"><span class="copy-icon"></span><div class="copy-popup-wrapper popup-to-left"><span class="copy-popup-icon"></span><span>Content copied to clipboard</span></div></span></div></div></div>
</div>
<div class="brief "><p class="paragraph">The declaration is experimental and could be changed in future</p></div></div>
</div>
</div>
</div>
</div>
<a data-name="840129133%2FClasslikes%2F-1789010594" anchor-label="DFInternal" id="840129133%2FClasslikes%2F-1789010594" data-filterable-set=":dataforge-meta:dokkaHtmlPartial/commonMain"></a>
<div class="table-row" data-filterable-current=":dataforge-meta:dokkaHtmlPartial/commonMain" data-filterable-set=":dataforge-meta:dokkaHtmlPartial/commonMain">
<div class="main-subrow keyValue ">
<div class=""><span class="inline-flex"><a href="-d-f-internal/index.html"><span><span>DFInternal</span></span></a><span class="anchor-wrapper"><span class="anchor-icon" pointing-to="840129133%2FClasslikes%2F-1789010594"></span>
<div class="copy-popup-wrapper "><span class="copy-popup-icon"></span><span>Link copied to clipboard</span></div>
</span></span></div>
<div>
<div class="platform-tags ">
<div class="platform-tag common-like">common</div>
</div>
<div class="title"><div class="divergent-group" data-filterable-current=":dataforge-meta:dokkaHtmlPartial/commonMain" data-filterable-set=":dataforge-meta:dokkaHtmlPartial/commonMain"><div class="with-platform-tags"><span class="pull-right"></span></div>
<div>
<div class="platform-hinted " data-platform-hinted="data-platform-hinted"><div class="content sourceset-depenent-content" data-active="" data-togglable=":dataforge-meta:dokkaHtmlPartial/commonMain"><div class="symbol monospace">annotation class <a href="-d-f-internal/index.html">DFInternal</a><span class="top-right-position"><span class="copy-icon"></span><div class="copy-popup-wrapper popup-to-left"><span class="copy-popup-icon"></span><span>Content copied to clipboard</span></div></span></div></div></div>
</div>
<div class="brief "><p class="paragraph">The declaration is internal to the DataForge and could use unsafe or unstable features.</p></div></div>
</div>
</div>
</div>
</div>
<a data-name="-1369077859%2FClasslikes%2F-1789010594" anchor-label="Named" id="-1369077859%2FClasslikes%2F-1789010594" data-filterable-set=":dataforge-meta:dokkaHtmlPartial/commonMain"></a>
<div class="table-row" data-filterable-current=":dataforge-meta:dokkaHtmlPartial/commonMain" data-filterable-set=":dataforge-meta:dokkaHtmlPartial/commonMain">
<div class="main-subrow keyValue ">
<div class=""><span class="inline-flex"><a href="-named/index.html"><span><span>Named</span></span></a><span class="anchor-wrapper"><span class="anchor-icon" pointing-to="-1369077859%2FClasslikes%2F-1789010594"></span>
<div class="copy-popup-wrapper "><span class="copy-popup-icon"></span><span>Link copied to clipboard</span></div>
</span></span></div>
<div>
<div class="platform-tags ">
<div class="platform-tag common-like">common</div>
</div>
<div class="title"><div class="divergent-group" data-filterable-current=":dataforge-meta:dokkaHtmlPartial/commonMain" data-filterable-set=":dataforge-meta:dokkaHtmlPartial/commonMain"><div class="with-platform-tags"><span class="pull-right"></span></div>
<div>
<div class="platform-hinted " data-platform-hinted="data-platform-hinted"><div class="content sourceset-depenent-content" data-active="" data-togglable=":dataforge-meta:dokkaHtmlPartial/commonMain"><div class="symbol monospace">interface <a href="-named/index.html">Named</a><span class="top-right-position"><span class="copy-icon"></span><div class="copy-popup-wrapper popup-to-left"><span class="copy-popup-icon"></span><span>Content copied to clipboard</span></div></span></div></div></div>
</div>
<div class="brief "><p class="paragraph">Any object that have name</p></div></div>
</div>
</div>
</div>
</div>
<a data-name="1180332306%2FClasslikes%2F-1789010594" anchor-label="Type" id="1180332306%2FClasslikes%2F-1789010594" data-filterable-set=":dataforge-meta:dokkaHtmlPartial/commonMain"></a>
<div class="table-row" data-filterable-current=":dataforge-meta:dokkaHtmlPartial/commonMain" data-filterable-set=":dataforge-meta:dokkaHtmlPartial/commonMain">
<div class="main-subrow keyValue ">
<div class=""><span class="inline-flex"><a href="-type/index.html"><span><span>Type</span></span></a><span class="anchor-wrapper"><span class="anchor-icon" pointing-to="1180332306%2FClasslikes%2F-1789010594"></span>
<div class="copy-popup-wrapper "><span class="copy-popup-icon"></span><span>Link copied to clipboard</span></div>
</span></span></div>
<div>
<div class="platform-tags ">
<div class="platform-tag common-like">common</div>
</div>
<div class="title"><div class="divergent-group" data-filterable-current=":dataforge-meta:dokkaHtmlPartial/commonMain" data-filterable-set=":dataforge-meta:dokkaHtmlPartial/commonMain"><div class="with-platform-tags"><span class="pull-right"></span></div>
<div>
<div class="platform-hinted " data-platform-hinted="data-platform-hinted"><div class="content sourceset-depenent-content" data-active="" data-togglable=":dataforge-meta:dokkaHtmlPartial/commonMain"><div class="symbol monospace"><div class="block"><div class="block">@<a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin.annotation/-target/index.html">Target</a>(<span>allowedTargets = [<span><a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin.annotation/-annotation-target/-c-l-a-s-s/index.html">AnnotationTarget.CLASS</a></span><wbr>]</span><wbr>)</div></div>annotation class <a href="-type/index.html">Type</a>(id: <a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html">String</a>)<span class="top-right-position"><span class="copy-icon"></span><div class="copy-popup-wrapper popup-to-left"><span class="copy-popup-icon"></span><span>Content copied to clipboard</span></div></span></div></div></div>
</div>
<div class="brief "><p class="paragraph">A text label for internal DataForge type classification. Alternative for mime container type.</p></div></div>
</div>
</div>
</div>
</div>
</div>
<h2 class="">Functions</h2>
<div class="table" data-togglable="Functions"><a data-name="1099461742%2FFunctions%2F1576389700" anchor-label="unsafeCast" id="1099461742%2FFunctions%2F1576389700" data-filterable-set=":dataforge-meta:dokkaHtmlPartial/commonMain :dataforge-meta:dokkaHtmlPartial/jsMain :dataforge-meta:dokkaHtmlPartial/jvmMain :dataforge-meta:dokkaHtmlPartial/nativeMain"></a>
<div class="table-row" data-filterable-current=":dataforge-meta:dokkaHtmlPartial/commonMain :dataforge-meta:dokkaHtmlPartial/jsMain :dataforge-meta:dokkaHtmlPartial/jvmMain :dataforge-meta:dokkaHtmlPartial/nativeMain" data-filterable-set=":dataforge-meta:dokkaHtmlPartial/commonMain :dataforge-meta:dokkaHtmlPartial/jsMain :dataforge-meta:dokkaHtmlPartial/jvmMain :dataforge-meta:dokkaHtmlPartial/nativeMain">
<div class="main-subrow keyValue ">
<div class=""><span class="inline-flex"><a href="unsafe-cast.html"><span>unsafe</span><wbr><span><span>Cast</span></span></a><span class="anchor-wrapper"><span class="anchor-icon" pointing-to="1099461742%2FFunctions%2F1576389700"></span>
<div class="copy-popup-wrapper "><span class="copy-popup-icon"></span><span>Link copied to clipboard</span></div>
</span></span></div>
<div>
<div class="title"><div class="divergent-group" data-filterable-current=":dataforge-meta:dokkaHtmlPartial/commonMain :dataforge-meta:dokkaHtmlPartial/jsMain :dataforge-meta:dokkaHtmlPartial/jvmMain :dataforge-meta:dokkaHtmlPartial/nativeMain" data-filterable-set=":dataforge-meta:dokkaHtmlPartial/commonMain :dataforge-meta:dokkaHtmlPartial/jsMain :dataforge-meta:dokkaHtmlPartial/jvmMain :dataforge-meta:dokkaHtmlPartial/nativeMain"><div class="with-platform-tags"><span class="pull-right">
<div class="platform-tags ">
<div class="platform-tag common-like">common</div>
</div>
</span></div>
<div>
<div class="platform-hinted " data-platform-hinted="data-platform-hinted"><div class="content sourceset-depenent-content" data-active="" data-togglable=":dataforge-meta:dokkaHtmlPartial/commonMain"><div class="symbol monospace">inline fun &lt;<a href="unsafe-cast.html">T</a>&gt; <a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-any/index.html">Any</a>?.<a href="unsafe-cast.html">unsafeCast</a>(): <a href="unsafe-cast.html">T</a><span class="top-right-position"><span class="copy-icon"></span><div class="copy-popup-wrapper popup-to-left"><span class="copy-popup-icon"></span><span>Content copied to clipboard</span></div></span></div></div></div>
</div>
</div>
</div>
</div>
</div>
</div>
</div>
<h2 class="">Properties</h2>
<div class="table" data-togglable="Properties"><a data-name="311190893%2FProperties%2F-1789010594" anchor-label="isAnonymous" id="311190893%2FProperties%2F-1789010594" data-filterable-set=":dataforge-meta:dokkaHtmlPartial/commonMain"></a>
<div class="table-row" data-filterable-current=":dataforge-meta:dokkaHtmlPartial/commonMain" data-filterable-set=":dataforge-meta:dokkaHtmlPartial/commonMain">
<div class="main-subrow keyValue ">
<div class=""><span class="inline-flex"><a href="is-anonymous.html">isAnonymous</a><span class="anchor-wrapper"><span class="anchor-icon" pointing-to="311190893%2FProperties%2F-1789010594"></span>
<div class="copy-popup-wrapper "><span class="copy-popup-icon"></span><span>Link copied to clipboard</span></div>
</span></span></div>
<div>
<div class="platform-tags ">
<div class="platform-tag common-like">common</div>
</div>
<div class="title">
<div class="platform-hinted " data-platform-hinted="data-platform-hinted" data-togglable="Properties"><div class="content sourceset-depenent-content" data-active="" data-togglable=":dataforge-meta:dokkaHtmlPartial/commonMain"><a data-name="311190893%2FProperties%2F-1789010594" anchor-label="isAnonymous" id="311190893%2FProperties%2F-1789010594" data-filterable-set=":dataforge-meta:dokkaHtmlPartial/commonMain"></a><div class="symbol monospace">val <a href="-named/index.html">Named</a>.<a href="is-anonymous.html">isAnonymous</a>: <a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html">Boolean</a><span class="top-right-position"><span class="copy-icon"></span><div class="copy-popup-wrapper popup-to-left"><span class="copy-popup-icon"></span><span>Content copied to clipboard</span></div></span></div><div class="brief "><a data-name="311190893%2FProperties%2F-1789010594" anchor-label="isAnonymous" id="311190893%2FProperties%2F-1789010594" data-filterable-set=":dataforge-meta:dokkaHtmlPartial/commonMain"></a><p class="paragraph">Check if this object has an empty name and therefore is anonymous.</p></div></div></div>
</div>
</div>
</div>
</div>
</div>
</div>
</div>
</div>
<div class="footer"><span class="go-to-top-icon"><a href="#content"></a></span><span>© 2021 Copyright</span><span class="pull-right"><span>Generated by </span><a href="https://github.com/Kotlin/dokka"><span>dokka</span><span class="padded-icon"></span></a></span></div>
</div>
</div>
</body></html>