-
Notifications
You must be signed in to change notification settings - Fork 3
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
autodocs
committed
Jan 16, 2019
1 parent
9e75deb
commit f2a5184
Showing
1 changed file
with
3 additions
and
3 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,4 +1,4 @@ | ||
| <!DOCTYPE html> | ||
| <html lang="en"><head><meta charset="UTF-8"/><meta name="viewport" content="width=device-width, initial-scale=1.0"/><title>API · LegendDataTypes</title><link rel="canonical" href="https://legend-exp.github.io/LegendDataTypes.jl/stable/api/index.html"/><link href="https://cdnjs.cloudflare.com/ajax/libs/normalize/4.2.0/normalize.min.css" rel="stylesheet" type="text/css"/><link href="https://fonts.googleapis.com/css?family=Lato|Roboto+Mono" rel="stylesheet" type="text/css"/><link href="https://cdnjs.cloudflare.com/ajax/libs/font-awesome/4.6.3/css/font-awesome.min.css" rel="stylesheet" type="text/css"/><link href="https://cdnjs.cloudflare.com/ajax/libs/highlight.js/9.12.0/styles/default.min.css" rel="stylesheet" type="text/css"/><script>documenterBaseURL=".."</script><script src="https://cdnjs.cloudflare.com/ajax/libs/require.js/2.2.0/require.min.js" data-main="../assets/documenter.js"></script><script src="../siteinfo.js"></script><script src="../../versions.js"></script><link href="../assets/documenter.css" rel="stylesheet" type="text/css"/></head><body><nav class="toc"><h1>LegendDataTypes</h1><select id="version-selector" onChange="window.location.href=this.value" style="visibility: hidden"></select><form class="search" id="search-form" action="../search/"><input id="search-query" name="q" type="text" placeholder="Search docs"/></form><ul><li><a class="toctext" href="../">Home</a></li><li class="current"><a class="toctext" href>API</a><ul class="internal"><li><a class="toctext" href="#Types-1">Types</a></li><li><a class="toctext" href="#Functions-1">Functions</a></li><li class="toplevel"><a class="toctext" href="#Documentation-1">Documentation</a></li></ul></li><li><a class="toctext" href="../LICENSE/">LICENSE</a></li></ul></nav><article id="docs"><header><nav><ul><li><a href>API</a></li></ul><a class="edit-page" href="https://github.com/legend-exp/LegendDataTypes.jl/blob/master/docs/src/api.md"><span class="fa"></span> Edit on GitHub</a></nav><hr/><div id="topbar"><span>API</span><a class="fa fa-bars" href="#"></a></div></header><h1><a class="nav-anchor" id="API-1" href="#API-1">API</a></h1><h2><a class="nav-anchor" id="Types-1" href="#Types-1">Types</a></h2><ul></ul><h2><a class="nav-anchor" id="Functions-1" href="#Functions-1">Functions</a></h2><ul><li><a href="#Base.getindex-Tuple{LegendNullOutput,Any,AbstractString,Vararg{Any,N} where N}"><code>Base.getindex</code></a></li><li><a href="#Base.getindex-Tuple{AbstractLegendInput,AbstractString,Vararg{Any,N} where N}"><code>Base.getindex</code></a></li><li><a href="#LegendDataTypes.getunits"><code>LegendDataTypes.getunits</code></a></li><li><a href="#LegendDataTypes.readdata"><code>LegendDataTypes.readdata</code></a></li><li><a href="#LegendDataTypes.setunits!"><code>LegendDataTypes.setunits!</code></a></li><li><a href="#LegendDataTypes.writedata"><code>LegendDataTypes.writedata</code></a></li></ul><h1><a class="nav-anchor" id="Documentation-1" href="#Documentation-1">Documentation</a></h1><section class="docstring"><div class="docstring-header"><a class="docstring-binding" id="Base.getindex-Tuple{AbstractLegendInput,AbstractString,Vararg{Any,N} where N}" href="#Base.getindex-Tuple{AbstractLegendInput,AbstractString,Vararg{Any,N} where N}"><code>Base.getindex</code></a> — <span class="docstring-category">Method</span>.</div><div><div><pre><code class="language-none">getindex(input::AbstractLegendInput, key::AbstractString) | ||
| getindex(input::AbstractLegendInput, key::AbstractString, idxs::AbstractVector)</code></pre><p>Get object at <code>key</code> from input.</p></div></div><a class="source-link" target="_blank" href="https://github.com/legend-exp/LegendDataTypes.jl/blob/7371e7b6e67a7b9118dd719cd2e2c2faa82c8583/src/abstract_io.jl#L24-L29">source</a></section><section class="docstring"><div class="docstring-header"><a class="docstring-binding" id="Base.getindex-Tuple{LegendNullOutput,Any,AbstractString,Vararg{Any,N} where N}" href="#Base.getindex-Tuple{LegendNullOutput,Any,AbstractString,Vararg{Any,N} where N}"><code>Base.getindex</code></a> — <span class="docstring-category">Method</span>.</div><div><div><pre><code class="language-none">setindex!(output::AbstractLegendOutput, key::AbstractString) | ||
| getindex(output::AbstractLegendOutput, key::AbstractString, idxs::AbstractVector)</code></pre><p>Get object at <code>key</code> from input.</p></div></div><a class="source-link" target="_blank" href="https://github.com/legend-exp/LegendDataTypes.jl/blob/7371e7b6e67a7b9118dd719cd2e2c2faa82c8583/src/abstract_io.jl#L47-L52">source</a></section><section class="docstring"><div class="docstring-header"><a class="docstring-binding" id="LegendDataTypes.getunits" href="#LegendDataTypes.getunits"><code>LegendDataTypes.getunits</code></a> — <span class="docstring-category">Function</span>.</div><div><div><pre><code class="language-none">getunits(x)</code></pre><p>Get the units of x, falls back to <code>Unitful.unit(x)</code> if no specialized method is defined for the type of <code>x</code>.</p><p>LEGEND I/O packages shoud add methods for the I/O-object types they handle.</p></div></div><a class="source-link" target="_blank" href="https://github.com/legend-exp/LegendDataTypes.jl/blob/7371e7b6e67a7b9118dd719cd2e2c2faa82c8583/src/abstract_io.jl#L80-L87">source</a></section><section class="docstring"><div class="docstring-header"><a class="docstring-binding" id="LegendDataTypes.readdata" href="#LegendDataTypes.readdata"><code>LegendDataTypes.readdata</code></a> — <span class="docstring-category">Function</span>.</div><div><div><pre><code class="language-none">readdata(input, SomeDataType::Type)</code></pre><p>Read a value of type <code>SomeDataType</code> from <code>input</code>.</p></div></div><a class="source-link" target="_blank" href="https://github.com/legend-exp/LegendDataTypes.jl/blob/7371e7b6e67a7b9118dd719cd2e2c2faa82c8583/src/abstract_io.jl#L64-L68">source</a></section><section class="docstring"><div class="docstring-header"><a class="docstring-binding" id="LegendDataTypes.setunits!" href="#LegendDataTypes.setunits!"><code>LegendDataTypes.setunits!</code></a> — <span class="docstring-category">Function</span>.</div><div><div><pre><code class="language-none">setunits!(x)</code></pre><p>Set the units of x.</p><p>LEGEND I/O packages will need to add methods for the I/O-object types they handle.</p></div></div><a class="source-link" target="_blank" href="https://github.com/legend-exp/LegendDataTypes.jl/blob/7371e7b6e67a7b9118dd719cd2e2c2faa82c8583/src/abstract_io.jl#L95-L102">source</a></section><section class="docstring"><div class="docstring-header"><a class="docstring-binding" id="LegendDataTypes.writedata" href="#LegendDataTypes.writedata"><code>LegendDataTypes.writedata</code></a> — <span class="docstring-category">Function</span>.</div><div><div><pre><code class="language-none">readdata(input, x::SomeDataType)</code></pre><p>Write a value <code>x</code> to <code>output</code>.</p></div></div><a class="source-link" target="_blank" href="https://github.com/legend-exp/LegendDataTypes.jl/blob/7371e7b6e67a7b9118dd719cd2e2c2faa82c8583/src/abstract_io.jl#L72-L76">source</a></section><footer><hr/><a class="previous" href="../"><span class="direction">Previous</span><span class="title">Home</span></a><a class="next" href="../LICENSE/"><span class="direction">Next</span><span class="title">LICENSE</span></a></footer></article></body></html> | ||
| <html lang="en"><head><meta charset="UTF-8"/><meta name="viewport" content="width=device-width, initial-scale=1.0"/><title>API · LegendDataTypes</title><link rel="canonical" href="https://legend-exp.github.io/LegendDataTypes.jl/stable/api/index.html"/><link href="https://cdnjs.cloudflare.com/ajax/libs/normalize/4.2.0/normalize.min.css" rel="stylesheet" type="text/css"/><link href="https://fonts.googleapis.com/css?family=Lato|Roboto+Mono" rel="stylesheet" type="text/css"/><link href="https://cdnjs.cloudflare.com/ajax/libs/font-awesome/4.6.3/css/font-awesome.min.css" rel="stylesheet" type="text/css"/><link href="https://cdnjs.cloudflare.com/ajax/libs/highlight.js/9.12.0/styles/default.min.css" rel="stylesheet" type="text/css"/><script>documenterBaseURL=".."</script><script src="https://cdnjs.cloudflare.com/ajax/libs/require.js/2.2.0/require.min.js" data-main="../assets/documenter.js"></script><script src="../siteinfo.js"></script><script src="../../versions.js"></script><link href="../assets/documenter.css" rel="stylesheet" type="text/css"/></head><body><nav class="toc"><h1>LegendDataTypes</h1><select id="version-selector" onChange="window.location.href=this.value" style="visibility: hidden"></select><form class="search" id="search-form" action="../search/"><input id="search-query" name="q" type="text" placeholder="Search docs"/></form><ul><li><a class="toctext" href="../">Home</a></li><li class="current"><a class="toctext" href>API</a><ul class="internal"><li><a class="toctext" href="#Types-1">Types</a></li><li><a class="toctext" href="#Functions-1">Functions</a></li><li class="toplevel"><a class="toctext" href="#Documentation-1">Documentation</a></li></ul></li><li><a class="toctext" href="../LICENSE/">LICENSE</a></li></ul></nav><article id="docs"><header><nav><ul><li><a href>API</a></li></ul><a class="edit-page" href="https://github.com/legend-exp/LegendDataTypes.jl/blob/master/docs/src/api.md"><span class="fa"></span> Edit on GitHub</a></nav><hr/><div id="topbar"><span>API</span><a class="fa fa-bars" href="#"></a></div></header><h1><a class="nav-anchor" id="API-1" href="#API-1">API</a></h1><h2><a class="nav-anchor" id="Types-1" href="#Types-1">Types</a></h2><ul></ul><h2><a class="nav-anchor" id="Functions-1" href="#Functions-1">Functions</a></h2><ul><li><a href="#Base.getindex-Tuple{AbstractLegendInput,AbstractString,Vararg{Any,N} where N}"><code>Base.getindex</code></a></li><li><a href="#Base.getindex-Tuple{LegendNullOutput,Any,AbstractString,Vararg{Any,N} where N}"><code>Base.getindex</code></a></li><li><a href="#LegendDataTypes.getunits"><code>LegendDataTypes.getunits</code></a></li><li><a href="#LegendDataTypes.readdata"><code>LegendDataTypes.readdata</code></a></li><li><a href="#LegendDataTypes.setunits!"><code>LegendDataTypes.setunits!</code></a></li><li><a href="#LegendDataTypes.writedata"><code>LegendDataTypes.writedata</code></a></li></ul><h1><a class="nav-anchor" id="Documentation-1" href="#Documentation-1">Documentation</a></h1><section class="docstring"><div class="docstring-header"><a class="docstring-binding" id="Base.getindex-Tuple{AbstractLegendInput,AbstractString,Vararg{Any,N} where N}" href="#Base.getindex-Tuple{AbstractLegendInput,AbstractString,Vararg{Any,N} where N}"><code>Base.getindex</code></a> — <span class="docstring-category">Method</span>.</div><div><div><pre><code class="language-none">getindex(input::AbstractLegendInput, key::AbstractString) | ||
| getindex(input::AbstractLegendInput, key::AbstractString, idxs::AbstractVector)</code></pre><p>Get object at <code>key</code> from input.</p></div></div><a class="source-link" target="_blank" href="https://github.com/legend-exp/LegendDataTypes.jl/blob/88616aadaeb133d158b93e6b09fe834a15faf9cc/src/abstract_io.jl#L24-L29">source</a></section><section class="docstring"><div class="docstring-header"><a class="docstring-binding" id="Base.getindex-Tuple{LegendNullOutput,Any,AbstractString,Vararg{Any,N} where N}" href="#Base.getindex-Tuple{LegendNullOutput,Any,AbstractString,Vararg{Any,N} where N}"><code>Base.getindex</code></a> — <span class="docstring-category">Method</span>.</div><div><div><pre><code class="language-none">setindex!(output::AbstractLegendOutput, key::AbstractString) | ||
| getindex(output::AbstractLegendOutput, key::AbstractString, idxs::AbstractVector)</code></pre><p>Get object at <code>key</code> from input.</p></div></div><a class="source-link" target="_blank" href="https://github.com/legend-exp/LegendDataTypes.jl/blob/88616aadaeb133d158b93e6b09fe834a15faf9cc/src/abstract_io.jl#L47-L52">source</a></section><section class="docstring"><div class="docstring-header"><a class="docstring-binding" id="LegendDataTypes.getunits" href="#LegendDataTypes.getunits"><code>LegendDataTypes.getunits</code></a> — <span class="docstring-category">Function</span>.</div><div><div><pre><code class="language-none">getunits(x)</code></pre><p>Get the units of x, falls back to <code>Unitful.unit(x)</code> if no specialized method is defined for the type of <code>x</code>.</p><p>LEGEND I/O packages shoud add methods for the I/O-object types they handle.</p></div></div><a class="source-link" target="_blank" href="https://github.com/legend-exp/LegendDataTypes.jl/blob/88616aadaeb133d158b93e6b09fe834a15faf9cc/src/abstract_io.jl#L80-L87">source</a></section><section class="docstring"><div class="docstring-header"><a class="docstring-binding" id="LegendDataTypes.readdata" href="#LegendDataTypes.readdata"><code>LegendDataTypes.readdata</code></a> — <span class="docstring-category">Function</span>.</div><div><div><pre><code class="language-none">readdata(input, SomeDataType::Type)</code></pre><p>Read a value of type <code>SomeDataType</code> from <code>input</code>.</p></div></div><a class="source-link" target="_blank" href="https://github.com/legend-exp/LegendDataTypes.jl/blob/88616aadaeb133d158b93e6b09fe834a15faf9cc/src/abstract_io.jl#L64-L68">source</a></section><section class="docstring"><div class="docstring-header"><a class="docstring-binding" id="LegendDataTypes.setunits!" href="#LegendDataTypes.setunits!"><code>LegendDataTypes.setunits!</code></a> — <span class="docstring-category">Function</span>.</div><div><div><pre><code class="language-none">setunits!(x)</code></pre><p>Set the units of x.</p><p>LEGEND I/O packages will need to add methods for the I/O-object types they handle.</p></div></div><a class="source-link" target="_blank" href="https://github.com/legend-exp/LegendDataTypes.jl/blob/88616aadaeb133d158b93e6b09fe834a15faf9cc/src/abstract_io.jl#L95-L102">source</a></section><section class="docstring"><div class="docstring-header"><a class="docstring-binding" id="LegendDataTypes.writedata" href="#LegendDataTypes.writedata"><code>LegendDataTypes.writedata</code></a> — <span class="docstring-category">Function</span>.</div><div><div><pre><code class="language-none">readdata(input, x::SomeDataType)</code></pre><p>Write a value <code>x</code> to <code>output</code>.</p></div></div><a class="source-link" target="_blank" href="https://github.com/legend-exp/LegendDataTypes.jl/blob/88616aadaeb133d158b93e6b09fe834a15faf9cc/src/abstract_io.jl#L72-L76">source</a></section><footer><hr/><a class="previous" href="../"><span class="direction">Previous</span><span class="title">Home</span></a><a class="next" href="../LICENSE/"><span class="direction">Next</span><span class="title">LICENSE</span></a></footer></article></body></html> |