Skip to content
Snippets Groups Projects
Commit 0dc7086c authored by Fredrik Bagge Carlson's avatar Fredrik Bagge Carlson
Browse files

Include documentation

parent 839bfdaa
No related branches found
No related tags found
No related merge requests found
...@@ -3,6 +3,7 @@ module LabProcesses ...@@ -3,6 +3,7 @@ module LabProcesses
using ControlSystems using ControlSystems
include("interface.jl") include("interface.jl")
include("interface_documentation.jl")
include("interface_implementations/ballandbeam.jl") include("interface_implementations/ballandbeam.jl")
include("utilities.jl") include("utilities.jl")
......
...@@ -7,13 +7,13 @@ Base abstract type for all lab processes. This should not be inherited from dire ...@@ -7,13 +7,13 @@ Base abstract type for all lab processes. This should not be inherited from dire
AbstractProcess AbstractProcess
""" """
PhysicalProcess PhysicalProcess <: AbstractProcess
Pysical processes should inherit from this abstract type. Pysical processes should inherit from this abstract type.
""" """
PhysicalProcess PhysicalProcess
""" """
SimulatedProcess SimulatedProcess <: AbstractProcess
Simulated processes should inherit from this abstract type. Simulated processes should inherit from this abstract type.
""" """
SimulatedProcess SimulatedProcess
...@@ -38,7 +38,7 @@ tuples, `length(range) = num_outputs(P), eltype(range) = Tuple(Real, Real)` ...@@ -38,7 +38,7 @@ tuples, `length(range) = num_outputs(P), eltype(range) = Tuple(Real, Real)`
outputrange outputrange
""" """
inputrange(P::AbstractProcess) range = inputrange(P::AbstractProcess)
Return the range of inputs (control signals) of the process. `range` is a vector of Return the range of inputs (control signals) of the process. `range` is a vector of
tuples, `length(range) = num_inputs(P), eltype(range) = Tuple(Real, Real)` tuples, `length(range) = num_inputs(P), eltype(range) = Tuple(Real, Real)`
""" """
......
0% Loading or .
You are about to add 0 people to the discussion. Proceed with caution.
Please register or to comment