From 46158d4a6d2a3bbf69d8c9a46442bbaadeba1478 Mon Sep 17 00:00:00 2001 From: autodocs Date: Wed, 19 Jun 2019 22:20:44 +0000 Subject: [PATCH] build based on 49c3528 --- dev/api/index.html | 6 +++--- dev/search_index.js | 24 ++++++++++++++++++++++++ 2 files changed, 27 insertions(+), 3 deletions(-) diff --git a/dev/api/index.html b/dev/api/index.html index b0ffb06..79042df 100644 --- a/dev/api/index.html +++ b/dev/api/index.html @@ -1,4 +1,4 @@ -API · LegendDataTypes
API

API

Types

Functions

Documentation

Base.getindex — Method.
getindex(input::AbstractLegendInput, key::AbstractString)
-getindex(input::AbstractLegendInput, key::AbstractString, idxs::AbstractVector)

Get object at key from input.

source
Base.getindex — Method.
setindex!(output::AbstractLegendOutput, key::AbstractString)
-getindex(output::AbstractLegendOutput, key::AbstractString, idxs::AbstractVector)

Get object at key from input.

source
LegendDataTypes.getunits — Function.
getunits(x)

Get the units of x, falls back to Unitful.unit(x) if no specialized method is defined for the type of x.

LEGEND I/O packages shoud add methods for the I/O-object types they handle.

source
LegendDataTypes.readdata — Function.
readdata(input, SomeDataType::Type)

Read a value of type SomeDataType from input.

source
LegendDataTypes.setunits! — Function.
setunits!(x)

Set the units of x.

LEGEND I/O packages will need to add methods for the I/O-object types they handle.

source
LegendDataTypes.writedata — Function.
readdata(input, x::SomeDataType)

Write a value x to output.

source
+API · LegendDataTypes
API

API

Types

Functions

Documentation

LegendDataTypes.RadwareSigcompress — Type.
RadwareSigcompress <: AbstractArrayCodec
source
Base.getindex — Method.
getindex(input::AbstractLegendInput, key::AbstractString)
+getindex(input::AbstractLegendInput, key::AbstractString, idxs::AbstractVector)

Get object at key from input.

source
Base.getindex — Method.
setindex!(output::AbstractLegendOutput, key::AbstractString)
+getindex(output::AbstractLegendOutput, key::AbstractString, idxs::AbstractVector)

Get object at key from input.

source
LegendDataTypes.getunits — Function.
getunits(x)

Get the units of x, falls back to Unitful.unit(x) if no specialized method is defined for the type of x.

LEGEND I/O packages shoud add methods for the I/O-object types they handle.

source
LegendDataTypes.read_from_properties — Function.
read_from_properties(read_property::Function, src::Any, ::Type{T}) where {T<:AbstractArrayCodec}

Create 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.

Returns an value of type T.

source
LegendDataTypes.readdata — Function.
readdata(input, SomeDataType::Type)

Read a value of type SomeDataType from input.

source
LegendDataTypes.setunits! — Function.
setunits!(x)

Set the units of x.

LEGEND I/O packages will need to add methods for the I/O-object types they handle.

source
LegendDataTypes.to_properties — Function.
write_to_properties!(write_property!::Function, dest::Any, codec::AbstractArrayCodec)

Write all information required to re-create codec to dest using thes dest-specific function write_property!(dest, name::Symbol, x).

Typically returns nothing.

source
LegendDataTypes.writedata — Function.
readdata(input, x::SomeDataType)

Write a value x to output.

source
diff --git a/dev/search_index.js b/dev/search_index.js index b01c186..0c290f6 100644 --- a/dev/search_index.js +++ b/dev/search_index.js @@ -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", @@ -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", @@ -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",