Skip to content

Commit

Permalink
build based on 49c3528
Browse files Browse the repository at this point in the history
  • Loading branch information
autodocs committed Jun 19, 2019
1 parent f2a5184 commit 46158d4
Show file tree
Hide file tree
Showing 2 changed files with 27 additions and 3 deletions.
6 changes: 3 additions & 3 deletions dev/api/index.html
View file
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{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>
<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><li><a href="#LegendDataTypes.RadwareSigcompress"><code>LegendDataTypes.RadwareSigcompress</code></a></li></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.read_from_properties"><code>LegendDataTypes.read_from_properties</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.to_properties"><code>LegendDataTypes.to_properties</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="LegendDataTypes.RadwareSigcompress" href="#LegendDataTypes.RadwareSigcompress"><code>LegendDataTypes.RadwareSigcompress</code></a> — <span class="docstring-category">Type</span>.</div><div><div><pre><code class="language-none">RadwareSigcompress &lt;: AbstractArrayCodec</code></pre></div></div><a class="source-link" target="_blank" href="https://github.com/legend-exp/LegendDataTypes.jl/blob/49c35286d1302a9d591a74734ae8d19517c8e3b6/src/radware_sigcompress.jl#L228-L230">source</a></section><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/49c35286d1302a9d591a74734ae8d19517c8e3b6/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/49c35286d1302a9d591a74734ae8d19517c8e3b6/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/49c35286d1302a9d591a74734ae8d19517c8e3b6/src/abstract_io.jl#L80-L87">source</a></section><section class="docstring"><div class="docstring-header"><a class="docstring-binding" id="LegendDataTypes.read_from_properties" href="#LegendDataTypes.read_from_properties"><code>LegendDataTypes.read_from_properties</code></a> — <span class="docstring-category">Function</span>.</div><div><div><pre><code class="language-none">read_from_properties(read_property::Function, src::Any, ::Type{T}) where {T&lt;:AbstractArrayCodec}</code></pre><p>Create a array codec of type <code>T</code> from properties of <code>src</code>, using the <code>src</code>-specific function <code>read_property(src, name::Symbol, default_value)</code> to read each property required.</p><p>Returns an value of type <code>T</code>.</p></div></div><a class="source-link" target="_blank" href="https://github.com/legend-exp/LegendDataTypes.jl/blob/49c35286d1302a9d591a74734ae8d19517c8e3b6/src/array_codecs.jl#L4-L12">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/49c35286d1302a9d591a74734ae8d19517c8e3b6/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/49c35286d1302a9d591a74734ae8d19517c8e3b6/src/abstract_io.jl#L95-L102">source</a></section><section class="docstring"><div class="docstring-header"><a class="docstring-binding" id="LegendDataTypes.to_properties" href="#LegendDataTypes.to_properties"><code>LegendDataTypes.to_properties</code></a> — <span class="docstring-category">Function</span>.</div><div><div><pre><code class="language-none">write_to_properties!(write_property!::Function, dest::Any, codec::AbstractArrayCodec)</code></pre><p>Write all information required to re-create <code>codec</code> to <code>dest</code> using thes <code>dest</code>-specific function <code>write_property!(dest, name::Symbol, x)</code>.</p><p>Typically returns <code>nothing</code>.</p></div></div><a class="source-link" target="_blank" href="https://github.com/legend-exp/LegendDataTypes.jl/blob/49c35286d1302a9d591a74734ae8d19517c8e3b6/src/array_codecs.jl#L16-L23">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/49c35286d1302a9d591a74734ae8d19517c8e3b6/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>
24 changes: 24 additions & 0 deletions dev/search_index.js
View file
Original file line number Diff line number Diff line change
Expand Up @@ -48,6 +48,14 @@ var documenterSearchIndex = {"docs": [
"text": "Order = [:function]"
},

{
"location": "api/#LegendDataTypes.RadwareSigcompress",
"page": "API",
"title": "LegendDataTypes.RadwareSigcompress",
"category": "type",
"text": "RadwareSigcompress <: AbstractArrayCodec\n\n\n\n\n\n"
},

{
"location": "api/#Base.getindex-Tuple{AbstractLegendInput,AbstractString,Vararg{Any,N} where N}",
"page": "API",
Expand All @@ -72,6 +80,14 @@ var documenterSearchIndex = {"docs": [
"text": "getunits(x)\n\nGet the units of x, falls back to Unitful.unit(x) if no specialized method is defined for the type of x.\n\nLEGEND I/O packages shoud add methods for the I/O-object types they handle.\n\n\n\n\n\n"
},

{
"location": "api/#LegendDataTypes.read_from_properties",
"page": "API",
"title": "LegendDataTypes.read_from_properties",
"category": "function",
"text": "read_from_properties(read_property::Function, src::Any, ::Type{T}) where {T<:AbstractArrayCodec}\n\nCreate a array codec of type T from properties of src, using the src-specific function read_property(src, name::Symbol, default_value) to read each property required.\n\nReturns an value of type T.\n\n\n\n\n\n"
},

{
"location": "api/#LegendDataTypes.readdata",
"page": "API",
Expand All @@ -88,6 +104,14 @@ var documenterSearchIndex = {"docs": [
"text": "setunits!(x)\n\nSet the units of x.\n\nLEGEND I/O packages will need to add methods for the I/O-object types they handle.\n\n\n\n\n\n"
},

{
"location": "api/#LegendDataTypes.to_properties",
"page": "API",
"title": "LegendDataTypes.to_properties",
"category": "function",
"text": "write_to_properties!(write_property!::Function, dest::Any, codec::AbstractArrayCodec)\n\nWrite all information required to re-create codec to dest using thes dest-specific function write_property!(dest, name::Symbol, x).\n\nTypically returns nothing.\n\n\n\n\n\n"
},

{
"location": "api/#LegendDataTypes.writedata",
"page": "API",
Expand Down

0 comments on commit 46158d4

Please sign in to comment.