io.github.robolib.module.sensor

Class LimitSwitch

java.lang.Object

io.github.robolib.module.iface.Interface

io.github.robolib.module.iface.InterruptBase

io.github.robolib.module.iface.DigitalIO

io.github.robolib.module.iface.DigitalInput

io.github.robolib.module.sensor.LimitSwitch

All Implemented Interfaces:

BooleanSource, Trigger, Module, SensorModule

public class LimitSwitch
extends DigitalInput
implements SensorModule

Limit Switch Class.

Author:

noriah

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	LimitSwitch.SwitchType The type of switch this is Normally open is a switch that is normally false when not pushed Normally closed is a switch that is normally true when not pushed

Nested classes/interfaces inherited from class io.github.robolib.module.iface.DigitalIO

DigitalIO.DigitalChannel, DigitalIO.Direction

Nested classes/interfaces inherited from class io.github.robolib.module.iface.Interface

Interface.InterfaceType

Nested classes/interfaces inherited from interface io.github.robolib.identifier.Trigger

Trigger.ButtonScheduler

Field Summary

Fields

Modifier and Type	Field and Description
private LimitSwitch.SwitchType	m_type The m_type.

Fields inherited from class io.github.robolib.module.iface.DigitalIO

m_channel, m_direction, m_port

Fields inherited from class io.github.robolib.module.iface.InterruptBase

m_interrupt, m_interruptIndex, m_isSyncInterrupt

Fields inherited from class io.github.robolib.module.iface.Interface

m_ifaceType, MAX_ANALOG_IN_CHANNELS, MAX_ANALOG_OUT_CHANNELS, MAX_DIGITAL_CHANNELS, MAX_PWM_CHANNELS, MAX_RELAY_CHANNELS

Constructor Summary

Constructors

Constructor and Description
LimitSwitch(DigitalIO.DigitalChannel channel)
LimitSwitch(DigitalIO.DigitalChannel channel, LimitSwitch.SwitchType type) Instantiates a new limit switch.

Method Summary

Modifier and Type	Method and Description
void	disableModule() Disable the module
void	enableModule() Enable the module
boolean	getModuleEnabled()
boolean	getState() Get the value of this boolean source
LimitSwitch.SwitchType	getType() Gets the type.

Methods inherited from class io.github.robolib.module.iface.DigitalIO

free, getChannel, getChannelName, getChannelNumber, getModuleNumber, isAnalogTrigger

Methods inherited from class io.github.robolib.module.iface.InterruptBase

allocateInterrupt, cancelInterrupt, disableInterrupts, enableInterrupts, readFallingTimestamp, readRisingTimestamp, requestInterrupt, requestInterrupt, setUpSourceEdge, validateInterrupt, waitForInterrupt, waitForInterrupt

Methods inherited from class io.github.robolib.module.iface.Interface

allocateMXPPin, checkAnalogInputChannel, checkAnalogOutputChannel, checkDigitalChannel, checkPWMChannel, checkRelayChannel, freeMXPPin, getInterfaceType

Methods inherited from class java.lang.Object

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

Methods inherited from interface io.github.robolib.identifier.Trigger

cancelWhenActive, runWhenActive, runWhenInactive, runWhileActive, runWhileInactive, toggleWhenActive

Field Detail

m_type

private LimitSwitch.SwitchType m_type

The m_type.

Constructor Detail

LimitSwitch

public LimitSwitch(DigitalIO.DigitalChannel channel)

LimitSwitch

public LimitSwitch(DigitalIO.DigitalChannel channel,
                   LimitSwitch.SwitchType type)

Instantiates a new limit switch.

Parameters:

channel - the channel

type - the type

Method Detail

getState

public boolean getState()

Get the value of this boolean source

Specified by:

getState in interface BooleanSource

Overrides:

getState in class DigitalInput

Returns:

value of the source

getType

public LimitSwitch.SwitchType getType()

Gets the type.

Returns:

the type

enableModule

public void enableModule()

Enable the module

Specified by:

enableModule in interface Module

disableModule

public void disableModule()

Disable the module

Specified by:

disableModule in interface Module

getModuleEnabled

public boolean getModuleEnabled()

Specified by:

getModuleEnabled in interface Module