io.github.robolib.module

Class PDP

java.lang.Object

io.github.robolib.module.PDP

All Implemented Interfaces:

Sendable, UpdatingSendable

public final class PDP
extends java.lang.Object
implements UpdatingSendable

A class for accessing the Power Distribution Panel.

Author:

noriah

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	PDP.PowerChannel The Enum PowerChannel.

Field Summary

Fields

Modifier and Type	Field and Description
private static java.lang.String[]	m_channelMap The m_update channels.
private static PDP	m_instance The Constant m_instance.
private ITable	m_table The m_table.
static int	MAX_POWER_CHANNELS Number of PDP channels.

Constructor Summary

Constructors

Modifier	Constructor and Description
private	PDP() Instantiates a PDP.

Method Summary

Modifier and Type	Method and Description
static void	claimChannel(PDP.PowerChannel channel, java.lang.String name) Sets the channel name.
private double	getChannelCurrent(int channel) Gets the current.
static java.lang.String	getChannelName(PDP.PowerChannel channel) Gets the channel name.
static double	getCurrent(PDP.PowerChannel channel) Gets the current.
static PDP	getInstance() Gets the single instance of PDP.
java.lang.String	getSmartDashboardType()
ITable	getTable()
static double	getTemperature() Gets the temperature.
static double	getTotalCurrent() Gets the total current.
static double	getTotalEnergy() Gets the total energy.
static double	getTotalPower() Gets the total power.
static double	getVoltage() Gets the voltage.
static void	initialize()
void	initTable(ITable subtable)
static void	resetFaults() Reset faults.
static void	resetTotalEnergy() Reset total energy.
void	updateTable() Update the table for this object with the latest values.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

MAX_POWER_CHANNELS

public static final int MAX_POWER_CHANNELS

Number of PDP channels.

See Also:

Constant Field Values

m_instance

private static PDP m_instance

The Constant m_instance.

m_channelMap

private static final java.lang.String[] m_channelMap

The m_update channels.

m_table

private ITable m_table

The m_table.

Constructor Detail

PDP

private PDP()

Instantiates a PDP.

Method Detail

initialize

public static void initialize()

getInstance

public static PDP getInstance()

Gets the single instance of PDP.

Returns:

single instance of PDP

getChannelName

public static java.lang.String getChannelName(PDP.PowerChannel channel)

Gets the channel name.

Parameters:

channel - the channel

Returns:

the channel name

claimChannel

public static void claimChannel(PDP.PowerChannel channel,
                                java.lang.String name)

Sets the channel name.

Parameters:

channel - the channel

name - the name

getVoltage

public static double getVoltage()

Gets the voltage.

Returns:

the voltage

getTemperature

public static double getTemperature()

Gets the temperature.

Returns:

the temperature

getCurrent

public static double getCurrent(PDP.PowerChannel channel)

Gets the current.

Parameters:

channel - the channel

Returns:

the current

getChannelCurrent

private double getChannelCurrent(int channel)

Gets the current.

Parameters:

channel - the channel

Returns:

the current

getTotalCurrent

public static double getTotalCurrent()

Gets the total current.

Returns:

the total current

getTotalPower

public static double getTotalPower()

Gets the total power.

Returns:

the total power

getTotalEnergy

public static double getTotalEnergy()

Gets the total energy.

Returns:

the total energy

resetTotalEnergy

public static void resetTotalEnergy()

Reset total energy.

resetFaults

public static void resetFaults()

Reset faults.

getSmartDashboardType

public java.lang.String getSmartDashboardType()

Specified by:

getSmartDashboardType in interface Sendable

initTable

public void initTable(ITable subtable)

Specified by:

initTable in interface Sendable

getTable

public ITable getTable()

Specified by:

getTable in interface Sendable

updateTable

public void updateTable()

Update the table for this object with the latest values.

Specified by:

updateTable in interface UpdatingSendable