WPILibC++  2019.3.1
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Modules Pages
frc::SensorUtil Class Referencefinal

Stores most recent status information as well as containing utility functions for checking channels and error processing. More...

#include <SensorUtil.h>

Static Public Member Functions

static int GetDefaultSolenoidModule ()
 Get the number of the default solenoid module. More...
 
static bool CheckSolenoidModule (int moduleNumber)
 Check that the solenoid module number is valid. More...
 
static bool CheckDigitalChannel (int channel)
 Check that the digital channel number is valid. More...
 
static bool CheckRelayChannel (int channel)
 Check that the relay channel number is valid. More...
 
static bool CheckPWMChannel (int channel)
 Check that the digital channel number is valid. More...
 
static bool CheckAnalogInputChannel (int channel)
 Check that the analog input number is value. More...
 
static bool CheckAnalogOutputChannel (int channel)
 Check that the analog output number is valid. More...
 
static bool CheckSolenoidChannel (int channel)
 Verify that the solenoid channel number is within limits. More...
 
static bool CheckPDPChannel (int channel)
 Verify that the power distribution channel number is within limits. More...
 
static bool CheckPDPModule (int module)
 Verify that the PDP module number is within limits. More...
 

Static Public Attributes

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
 

Detailed Description

Stores most recent status information as well as containing utility functions for checking channels and error processing.

Member Function Documentation

static bool frc::SensorUtil::CheckAnalogInputChannel ( int  channel)
static

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.

Returns
Analog channel is valid
static bool frc::SensorUtil::CheckAnalogOutputChannel ( int  channel)
static

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.

Returns
Analog channel is valid
static bool frc::SensorUtil::CheckDigitalChannel ( int  channel)
static

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.

Returns
Digital channel is valid
static bool frc::SensorUtil::CheckPDPChannel ( int  channel)
static

Verify that the power distribution channel number is within limits.

Returns
PDP channel is valid
static bool frc::SensorUtil::CheckPDPModule ( int  module)
static

Verify that the PDP module number is within limits.

module numbers are 0-based

Returns
PDP module is valid
static bool frc::SensorUtil::CheckPWMChannel ( int  channel)
static

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.

Returns
PWM channel is valid
static bool frc::SensorUtil::CheckRelayChannel ( int  channel)
static

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.

Returns
Relay channel is valid
static bool frc::SensorUtil::CheckSolenoidChannel ( int  channel)
static

Verify that the solenoid channel number is within limits.

Returns
Solenoid channel is valid
static bool frc::SensorUtil::CheckSolenoidModule ( int  moduleNumber)
static

Check that the solenoid module number is valid.

module numbers are 0-based

Returns
Solenoid module is valid and present
static int frc::SensorUtil::GetDefaultSolenoidModule ( )
static

Get the number of the default solenoid module.

Returns
The number of the default solenoid module.

The documentation for this class was generated from the following file: