Commit 85308492 authored by Éric Thiébaut's avatar Éric Thiébaut
Browse files

Provide union ServerName and fix doc.

parent 0394ff76
......@@ -12,55 +12,44 @@
#
"""
Tao.start(xpa)
Tao.start(apt)
starts image acquisition by remote camera owned by a server whose XPA
access-point is `xpa`.
starts image acquisition by remote camera server with XPA access-point `apt`.
"""
start(apt::Union{AccessPoint,XPA.AccessPoint}) =
XPA.set(start(XPA.address(apt)), "start")
start(apt::ServerName) = XPA.set(start(XPA.address(apt)), "start")
"""
Tao.stop(cam)
Tao.stop(apt)
stops image acquisition by camera `cam`. Argument can be a shared camera, a
remote camera or the accesspoint of the XPA server owning the camera.
stops image acquisition by remote camera server with XPA access-point `apt`.
"""
stop(apt::Union{AccessPoint,XPA.AccessPoint}) =
XPA.set(start(XPA.address(apt)), "stop")
stop(apt::ServerName) = XPA.set(start(XPA.address(apt)), "stop")
"""
Tao.abort(cam)
Tao.abort(apt)
aborts image acquisition by camera `cam`. Argument `cam` can be a shared
camera, a remote camera or the accesspoint of the XPA server owning the camera.
aborts image acquisition by remote camera server with XPA access-point `apt`.
"""
abort(apt::Union{AccessPoint,XPA.AccessPoint}) =
XPA.set(start(XPA.address(apt)), "abort")
abort(apt::ServerName) = XPA.set(start(XPA.address(apt)), "abort")
"""
Tao.suspend(arg)
suspends image acquisition by camera `cam`. Argument `cam` can be a shared
camera, a remote camera or the accesspoint of the XPA server owning the camera.
suspends image acquisition by remote camera server with XPA access-point `apt`.
"""
suspend(apt::Union{AccessPoint,XPA.AccessPoint}) =
XPA.set(suspend(XPA.address(apt)), "suspend")
suspend(apt::ServerName) = XPA.set(suspend(XPA.address(apt)), "suspend")
"""
Tao.resume(cam)
resumes image acquisition for the remote camera `cam`. Argument `cam` can be a
shared camera, a remote camera or the accesspoint of the XPA server owning the
camera.
resumes image acquisition by remote camera server with XPA access-point `apt`.
"""
resume(apt::Union{AccessPoint,XPA.AccessPoint}) =
XPA.set(resume(XPA.address(apt)), "resume")
resume(apt::ServerName) = XPA.set(resume(XPA.address(apt)), "resume")
"""
mean([T=Float64,], cam::AbstractCamera, nimgs; skip=0, timeout=0.5) -> arr
......
......@@ -46,6 +46,15 @@ macro xpa_str(str)
:(AccessPoint($str))
end
"""
`Tao.ServerName` is the union of types that are suitable to represent the
accesspoint of an XPA server, that is to say a string or an instance of
[`Tao.AccessPoint`](@ref).
"""
const ServerName = Union{AbstractString,XPA.AccessPoint}
"""
WeightedArray(wgt, dat, verify=false)
......
Supports Markdown
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment