io.github.robolib.module.iface

Class Interface

java.lang.Object

io.github.robolib.module.iface.Interface

Direct Known Subclasses:

AnalogIO, I2C, InterruptBase, PWM, Relay, Serial, SPI

public abstract class Interface
extends java.lang.Object

The Class Interface.

Author:

noriah

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
protected static class	Interface.InterfaceType Enum representation of interfaces.

Field Summary

Fields

Modifier and Type	Field and Description
protected Interface.InterfaceType	m_ifaceType The InterfaceType for this Interface.
private static Interface.InterfaceType[]	m_mxpArr Keep a mapping of MXP pins to InterfaceTypes.
static int	MAX_ANALOG_IN_CHANNELS The maximum number of analog input channels.
static int	MAX_ANALOG_OUT_CHANNELS The maximum number of analog output channels.
static int	MAX_DIGITAL_CHANNELS The maximum number of digital channels.
static int	MAX_PWM_CHANNELS The maximum number of pwm channels.
static int	MAX_RELAY_CHANNELS The maximum number of relay channels.

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	Interface(Interface.InterfaceType iType) Instantiates a new interface.

Method Summary

Modifier and Type	Method and Description
protected void	allocateMXPPin(int pin) Allocate an MXP pin
protected static void	checkAnalogInputChannel(int channel) Check the given analog input channel for validity
protected static void	checkAnalogOutputChannel(int channel) Check the given analog output channel for validity
protected static void	checkDigitalChannel(int channel) Check the given digital channel for validity
protected static void	checkPWMChannel(int channel) Check the given pwm channel for validity
protected static void	checkRelayChannel(int channel) Check the given relay channel for validity
protected void	freeMXPPin(int pin) Free an MXP pin
Interface.InterfaceType	getInterfaceType() Gets the interface type.

Methods inherited from class java.lang.Object

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

Field Detail

MAX_DIGITAL_CHANNELS

public static final int MAX_DIGITAL_CHANNELS

The maximum number of digital channels.

See Also:

Constant Field Values

MAX_ANALOG_IN_CHANNELS

public static final int MAX_ANALOG_IN_CHANNELS

The maximum number of analog input channels.

See Also:

Constant Field Values

MAX_ANALOG_OUT_CHANNELS

public static final int MAX_ANALOG_OUT_CHANNELS

The maximum number of analog output channels.

See Also:

Constant Field Values

MAX_PWM_CHANNELS

public static final int MAX_PWM_CHANNELS

The maximum number of pwm channels.

See Also:

Constant Field Values

MAX_RELAY_CHANNELS

public static final int MAX_RELAY_CHANNELS

The maximum number of relay channels.

See Also:

Constant Field Values

m_ifaceType

protected final Interface.InterfaceType m_ifaceType

The InterfaceType for this Interface.

m_mxpArr

private static final Interface.InterfaceType[] m_mxpArr

Keep a mapping of MXP pins to InterfaceTypes.

Constructor Detail

Interface

protected Interface(Interface.InterfaceType iType)

Instantiates a new interface.

Parameters:

iType - the InterfaceType for this Interface

Method Detail

checkDigitalChannel

protected static final void checkDigitalChannel(int channel)

Check the given digital channel for validity

Parameters:

channel - the channel to check

checkAnalogInputChannel

protected static final void checkAnalogInputChannel(int channel)

Check the given analog input channel for validity

Parameters:

channel - the channel to check

checkAnalogOutputChannel

protected static final void checkAnalogOutputChannel(int channel)

Check the given analog output channel for validity

Parameters:

channel - the channel to check

checkPWMChannel

protected static final void checkPWMChannel(int channel)

Check the given pwm channel for validity

Parameters:

channel - the channel to check

checkRelayChannel

protected static final void checkRelayChannel(int channel)

Check the given relay channel for validity

Parameters:

channel - the channel to check

allocateMXPPin

protected final void allocateMXPPin(int pin)

Allocate an MXP pin

Parameters:

pin - the pin we are allocating.

freeMXPPin

protected final void freeMXPPin(int pin)

Free an MXP pin

Parameters:

pin - the pin we are allocating.

getInterfaceType

public final Interface.InterfaceType getInterfaceType()

Gets the interface type.

Returns:

the interface type for this interface