chore: add descriptions for the ControllerInput structs

Add description for the variables inside the ControllerInput structs for all 3 controllers.
einride · Dec 22, 2020 · a2c52d6 · a2c52d6
1 parent 56f8a85
commit a2c52d6
Show file tree

Hide file tree

Showing 3 changed files with 12 additions and 12 deletions.
diff --git 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
@@ -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
@@ -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
 }