Team2890/allwpilib
4
0
Fork 0
mirror of https://github.com/wpilibsuite/allwpilib synced 2026-07-02 02:51:42 +00:00
Code Issues Packages Projects Releases Wiki Activity

Update docs for C++ (fixes artf3761 and artf3953)

Browse Source 
Change-Id: Ic0c4ac8494cadff13461d9bb8b5943cd87619f0a
This commit is contained in:
Kevin O'Connor
2014-12-29 14:09:37 -05:00
parent a6aef54ef4
commit 6d8e782f53
39 changed files with 342 additions and 164 deletions
Download Patch File Download Diff File Expand all files Collapse all files

23
wpilibc/wpilibC++Devices/src/AnalogPotentiometer.cpp
View File

@@ -11,21 +11,42 @@ void AnalogPotentiometer::initPot(AnalogInput *input, double fullRange, double o
m_analog_input = input;
}
/**
* Construct an Analog Potentiometer object from a channel number.
* @param channel The channel number on the roboRIO to represent. 0-3 are on-board 4-7 are on the MXP port.
* @param fullRange The angular value (in desired units) representing the full 0-5V range of the input.
* @param offset The angular value (in desired units) representing the angular output at 0V.
*/
AnalogPotentiometer::AnalogPotentiometer(int channel, double fullRange, double offset) {
m_init_analog_input = true;
initPot(new AnalogInput(channel), fullRange, offset);
}
/**
* Construct an Analog Potentiometer object from an existing Analog Input pointer.
* @param channel The existing Analog Input pointer
* @param fullRange The angular value (in desired units) representing the full 0-5V range of the input.
* @param offset The angular value (in desired units) representing the angular output at 0V.
*/
AnalogPotentiometer::AnalogPotentiometer(AnalogInput *input, double fullRange, double offset) {
m_init_analog_input = false;
initPot(input, fullRange, offset);
}
/**
* Construct an Analog Potentiometer object from an existing Analog Input reference.
* @param channel The existing Analog Input reference
* @param fullRange The angular value (in desired units) representing the full 0-5V range of the input.
* @param offset The angular value (in desired units) representing the angular output at 0V.
*/
AnalogPotentiometer::AnalogPotentiometer(AnalogInput &input, double fullRange, double offset) {
m_init_analog_input = false;
initPot(&input, fullRange, offset);
}
/**
* Destructor. Releases the Analog Input resource if it was allocated by this object
*/
AnalogPotentiometer::~AnalogPotentiometer() {
if(m_init_analog_input){
delete m_analog_input;
@@ -36,7 +57,7 @@ AnalogPotentiometer::~AnalogPotentiometer() {
/**
* Get the current reading of the potentiometer.
*
* @return The current position of the potentiometer.
* @return The current position of the potentiometer (in the units used for fullRaneg and offset).
*/
double AnalogPotentiometer::Get() {
return (m_analog_input->GetVoltage() / ControllerPower::GetVoltage5V()) * m_fullRange + m_offset;