From a2c52d69fa4bfb35cb1c9488c03d8dd872588dc7 Mon Sep 17 00:00:00 2001 From: Camille Chasset Date: Mon, 21 Dec 2020 13:23:46 +0100 Subject: [PATCH] chore: add descriptions for the ControllerInput structs Add description for the variables inside the ControllerInput structs for all 3 controllers. --- antiwindupcontroller.go | 8 ++++---- controller.go | 6 +++--- trackingcontroller.go | 10 +++++----- 3 files changed, 12 insertions(+), 12 deletions(-) diff --git a/antiwindupcontroller.go b/antiwindupcontroller.go index 11712aa..8db0e05 100644 --- a/antiwindupcontroller.go +++ b/antiwindupcontroller.go @@ -54,13 +54,13 @@ type AntiWindupControllerState struct { // AntiWindupControllerInput holds the input parameters to an AntiWindupController. type AntiWindupControllerInput struct { - // TODO: Document me. + // ReferenceSignal is the reference value for the signal to control. ReferenceSignal float64 - // TODO: Document me. + // ActualSignal is the actual value of the signal to control. ActualSignal float64 - // TODO: Document me. + // FeedForwardSignal is the contribution of the feed-forward control loop in the controller output. FeedForwardSignal float64 - // TODO: Document me. + // SamplingInterval is the time interval elapsed since the previous call of the controller Update method. SamplingInterval time.Duration } diff --git a/controller.go b/controller.go index 4ee58a3..cb73d56 100644 --- a/controller.go +++ b/controller.go @@ -34,11 +34,11 @@ type ControllerState struct { // ControllerInput holds the input parameters to a Controller. type ControllerInput struct { - // TODO: Document me. + // ReferenceSignal is the reference value for the signal to control. ReferenceSignal float64 - // TODO: Document me. + // ActualSignal is the actual value of the signal to control. ActualSignal float64 - // TODO: Document me. + // SamplingInterval is the time interval elapsed since the previous call of the controller Update method. SamplingInterval time.Duration } diff --git a/trackingcontroller.go b/trackingcontroller.go index e49f3f3..4058df9 100644 --- a/trackingcontroller.go +++ b/trackingcontroller.go @@ -58,15 +58,15 @@ type TrackingControllerState struct { // TrackingControllerInput holds the input parameters to a TrackingController. type TrackingControllerInput struct { - // TODO: Document me. + // ReferenceSignal is the reference value for the signal to control. ReferenceSignal float64 - // TODO: Document me. + // ActualSignal is the actual value of the signal to control. ActualSignal float64 - // TODO: Document me. + // FeedForwardSignal is the contribution of the feed-forward control loop in the controller output. FeedForwardSignal float64 - // TODO: Document me. + // AppliedControlSignal is the actual control command applied by the actuator. AppliedControlSignal float64 - // TODO: Document me. + // SamplingInterval is the time interval elapsed since the previous call of the controller Update method. SamplingInterval time.Duration }