edu.wpi.first.wpilibj

Class SendableBase

java.lang.Object

edu.wpi.first.wpilibj.SendableBase

All Implemented Interfaces:

Sendable

Direct Known Subclasses:

AnalogOutput, Command, Compressor, DigitalOutput, NidecBrushless, PIDController, PWM, Relay, RobotDriveBase, Scheduler, SendableChooser, SensorBase, SolenoidBase, SpeedControllerGroup, Subsystem, Trigger

public abstract class SendableBase
extends java.lang.Object
implements Sendable

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

Constructor Summary

Constructors

Constructor and Description
SendableBase() Creates an instance of the sensor base.
SendableBase(boolean addLiveWindow) Creates an instance of the sensor base.

Method Summary

Modifier and Type	Method and Description
protected void	addChild(java.lang.Object child) Add a child component.
void	free() Free the resources used by this object.
java.lang.String	getName() Gets the name of this Sendable object.
java.lang.String	getSubsystem() Gets the subsystem name of this Sendable object.
void	setName(java.lang.String name) Sets the name of this Sendable object.
protected void	setName(java.lang.String moduleType, int channel) Sets the name of the sensor with a channel number.
protected void	setName(java.lang.String moduleType, int moduleNumber, int channel) Sets the name of the sensor with a module and channel number.
void	setSubsystem(java.lang.String subsystem) Sets the subsystem name of this Sendable object.

Methods inherited from class java.lang.Object

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

Methods inherited from interface edu.wpi.first.wpilibj.Sendable

initSendable, setName

Constructor Detail

SendableBase

public SendableBase()

Creates an instance of the sensor base.

SendableBase

public SendableBase(boolean addLiveWindow)

Creates an instance of the sensor base.

Parameters:

addLiveWindow - if true, add this Sendable to LiveWindow

Method Detail

free

public void free()

Free the resources used by this object.

getName

public final java.lang.String getName()

Description copied from interface: Sendable

Gets the name of this Sendable object.

Specified by:

getName in interface Sendable

Returns:

Name

setName

public final void setName(java.lang.String name)

Description copied from interface: Sendable

Sets the name of this Sendable object.

Specified by:

setName in interface Sendable

Parameters:

name - name

setName

protected final void setName(java.lang.String moduleType,
                             int channel)

Sets the name of the sensor with a channel number.

Parameters:

moduleType - A string that defines the module name in the label for the value

channel - The channel number the device is plugged into

setName

protected final void setName(java.lang.String moduleType,
                             int moduleNumber,
                             int channel)

Sets the name of the sensor with a module and channel number.

Parameters:

moduleType - A string that defines the module name in the label for the value

moduleNumber - The number of the particular module type

channel - The channel number the device is plugged into (usually PWM)

getSubsystem

public final java.lang.String getSubsystem()

Description copied from interface: Sendable

Gets the subsystem name of this Sendable object.

Specified by:

getSubsystem in interface Sendable

Returns:

Subsystem name

setSubsystem

public final void setSubsystem(java.lang.String subsystem)

Description copied from interface: Sendable

Sets the subsystem name of this Sendable object.

Specified by:

setSubsystem in interface Sendable

Parameters:

subsystem - subsystem name

addChild

protected final void addChild(java.lang.Object child)

Add a child component.

Parameters:

child - child component