mirror of
https://github.com/wpilibsuite/allwpilib
synced 2026-06-21 01:01:43 +00:00
1d9ed8f458
C++ PDP was missing module check, and channel check called module. Java docs said 1 based instead of 0 based.
118 lines
3.2 KiB
C++
118 lines
3.2 KiB
C++
/*----------------------------------------------------------------------------*/
|
|
/* Copyright (c) 2008-2018 FIRST. All Rights Reserved. */
|
|
/* Open Source Software - may be modified and shared by FRC teams. The code */
|
|
/* must be accompanied by the FIRST BSD license file in the root directory of */
|
|
/* the project. */
|
|
/*----------------------------------------------------------------------------*/
|
|
|
|
#pragma once
|
|
|
|
namespace frc {
|
|
|
|
/**
|
|
* Stores most recent status information as well as containing utility functions
|
|
* for checking channels and error processing.
|
|
*/
|
|
class SensorUtil final {
|
|
public:
|
|
/**
|
|
* Get the number of the default solenoid module.
|
|
*
|
|
* @return The number of the default solenoid module.
|
|
*/
|
|
static int GetDefaultSolenoidModule();
|
|
|
|
/**
|
|
* Check that the solenoid module number is valid. module numbers are 0-based
|
|
*
|
|
* @return Solenoid module is valid and present
|
|
*/
|
|
static bool CheckSolenoidModule(int moduleNumber);
|
|
|
|
/**
|
|
* Check that the digital channel number is valid.
|
|
*
|
|
* Verify that the channel number is one of the legal channel numbers. Channel
|
|
* numbers are 0-based.
|
|
*
|
|
* @return Digital channel is valid
|
|
*/
|
|
static bool CheckDigitalChannel(int channel);
|
|
|
|
/**
|
|
* Check that the relay channel number is valid.
|
|
*
|
|
* Verify that the channel number is one of the legal channel numbers. Channel
|
|
* numbers are 0-based.
|
|
*
|
|
* @return Relay channel is valid
|
|
*/
|
|
static bool CheckRelayChannel(int channel);
|
|
|
|
/**
|
|
* Check that the digital channel number is valid.
|
|
*
|
|
* Verify that the channel number is one of the legal channel numbers. Channel
|
|
* numbers are 0-based.
|
|
*
|
|
* @return PWM channel is valid
|
|
*/
|
|
static bool CheckPWMChannel(int channel);
|
|
|
|
/**
|
|
* Check that the analog input number is value.
|
|
*
|
|
* Verify that the analog input number is one of the legal channel numbers.
|
|
* Channel numbers are 0-based.
|
|
*
|
|
* @return Analog channel is valid
|
|
*/
|
|
static bool CheckAnalogInputChannel(int channel);
|
|
|
|
/**
|
|
* Check that the analog output number is valid.
|
|
*
|
|
* Verify that the analog output number is one of the legal channel numbers.
|
|
* Channel numbers are 0-based.
|
|
*
|
|
* @return Analog channel is valid
|
|
*/
|
|
static bool CheckAnalogOutputChannel(int channel);
|
|
|
|
/**
|
|
* Verify that the solenoid channel number is within limits.
|
|
*
|
|
* @return Solenoid channel is valid
|
|
*/
|
|
static bool CheckSolenoidChannel(int channel);
|
|
|
|
/**
|
|
* Verify that the power distribution channel number is within limits.
|
|
*
|
|
* @return PDP channel is valid
|
|
*/
|
|
static bool CheckPDPChannel(int channel);
|
|
|
|
/**
|
|
* Verify that the PDP module number is within limits. module numbers are
|
|
* 0-based
|
|
*
|
|
* @return PDP module is valid
|
|
*/
|
|
static bool CheckPDPModule(int module);
|
|
|
|
static const int kDigitalChannels;
|
|
static const int kAnalogInputs;
|
|
static const int kAnalogOutputs;
|
|
static const int kSolenoidChannels;
|
|
static const int kSolenoidModules;
|
|
static const int kPwmChannels;
|
|
static const int kRelayChannels;
|
|
static const int kPDPChannels;
|
|
|
|
private:
|
|
SensorUtil() = default;
|
|
};
|
|
|
|
} // namespace frc
|