WPILibC++  unspecified
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 ()
 
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 Public Attributes

static const int kDigitalChannels = HAL_GetNumDigitalChannels()
 
static const int kAnalogInputs = HAL_GetNumAnalogInputs()
 
static const int kAnalogOutputs
 
static const int kSolenoidChannels = HAL_GetNumSolenoidChannels()
 
static const int kSolenoidModules = HAL_GetNumPCMModules()
 
static const int kPwmChannels = HAL_GetNumPWMChannels()
 
static const int kRelayChannels = HAL_GetNumRelayHeaders()
 
static const int kPDPChannels = HAL_GetNumPDPChannels()
 

Detailed Description

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

Member Function Documentation

bool 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
bool 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
bool 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 1-based.

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

Verify that the power distribution channel number is within limits.

Returns
PDP channel is valid
bool 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 1-based.

Returns
PWM channel is valid
bool 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
bool SensorUtil::CheckSolenoidChannel ( int  channel)
static

Verify that the solenoid channel number is within limits.

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

Check that the solenoid module number is valid.

Returns
Solenoid module is valid and present

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