Rename timer `Setup` function to `Schedule`
This patch was motivated by my desire to fix a typo in the function
name. The noun "setup" is 1 word. The verb "set up" is 2 words. All
other member functions are verbs, so this one should be a verb too.
That means that the function should be called `SetUp`. During the
discussion that resulted from the rename, James Kuszmaul pointed out
that "setting up" a timer can be confusing. It implies that you can
only "set up" a timer once. But the intent is to let users set up
timers as many times as they like. So we decided on renaming the
function to `Schedule`. That conveys the purpose and intent better.
I took this opportunity to fix some other typos involving the verb
"set up".
Signed-off-by: Philipp Schrader <philipp.schrader@gmail.com>
Change-Id: I2f557d1f946960af82711f248820d5e2d385a5d3
diff --git a/frc971/control_loops/control_loop_test.h b/frc971/control_loops/control_loop_test.h
index c667568..00062b9 100644
--- a/frc971/control_loops/control_loop_test.h
+++ b/frc971/control_loops/control_loop_test.h
@@ -69,7 +69,7 @@
robot_status_event_loop_->AddTimer([this]() { SendJoystickState(); });
robot_status_event_loop_->OnRun([this]() {
- send_joystick_state_timer_->Setup(
+ send_joystick_state_timer_->Schedule(
robot_status_event_loop_->monotonic_now(), dt_);
});
}
@@ -88,7 +88,7 @@
enabled_ = enabled;
SendJoystickState();
SendRobotState();
- send_joystick_state_timer_->Setup(
+ send_joystick_state_timer_->Schedule(
robot_status_event_loop_->monotonic_now(), dt_);
}
}
diff --git a/frc971/control_loops/drivetrain/localization/puppet_localizer_test.cc b/frc971/control_loops/drivetrain/localization/puppet_localizer_test.cc
index d5f9a31..1a71d5a 100644
--- a/frc971/control_loops/drivetrain/localization/puppet_localizer_test.cc
+++ b/frc971/control_loops/drivetrain/localization/puppet_localizer_test.cc
@@ -100,8 +100,8 @@
output_builder.add_theta(drivetrain_plant_.state()(2));
builder.CheckOk(builder.Send(output_builder.Finish()));
})
- ->Setup(imu_test_event_loop_->monotonic_now(),
- std::chrono::milliseconds(5));
+ ->Schedule(imu_test_event_loop_->monotonic_now(),
+ std::chrono::milliseconds(5));
}
virtual ~LocalizedDrivetrainTest() override {}