robot-rust 0.2.1

The robot-rust project, bindings for wpilib, ctre, and rev in rust.
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72

/*
 * Copyright (C) Cross The Road Electronics.  All rights reserved.
 * License information can be found in CTRE_LICENSE.txt
 * For support and suggestions contact support@ctr-electronics.com or file
 * an issue tracker at https://github.com/CrossTheRoadElec/Phoenix-Releases
 */
#pragma once

#include "ctre/phoenix/StatusCodes.h"
#include "ctre/phoenix6/signals/SpnEnums.hpp"
#include <units/length.h>
#include <units/voltage.h>

namespace ctre {
namespace phoenix6 {

namespace hardware {
namespace core {
	/* forward proto */
	class CoreCANrange;
}
}

namespace sim {

	/**
	 * \brief Class to control the state of a simulated hardware#CANrange.
	 */
	class CANrangeSimState
	{
	private:
		int _id;

	public:
		/**
		 * \brief Creates an object to control the state of the given hardware#CANrange.
		 *
		 * \details Note the recommended method of accessing simulation features is to
		 *          use hardware#CANrange#GetSimState.
		 *
		 * \param device Device to which this simulation state is attached
		 */
		CANrangeSimState(hardware::core::CoreCANrange const &device);
		/* disallow copy, allow move */
		CANrangeSimState(CANrangeSimState const &) = delete;
		CANrangeSimState(CANrangeSimState &&) = default;
		CANrangeSimState &operator=(CANrangeSimState const &) = delete;
		CANrangeSimState &operator=(CANrangeSimState &&) = default;

		/**
		 * \brief Sets the simulated supply voltage of the CANrange.
		 *
		 * \details The minimum allowed supply voltage is 4 V - values below this
		 * will be promoted to 4 V.
		 *
		 * \param volts The supply voltage in Volts
		 * \returns Status code
		 */
		ctre::phoenix::StatusCode SetSupplyVoltage(units::voltage::volt_t volts);

		/**
		 * \brief Sets the simulated distance of the CANrange.
		 *
		 * \param meters The distance in meters
		 * \returns Status code
		 */
		ctre::phoenix::StatusCode SetDistance(units::length::meter_t meters);
	};
}

}
}