Package edu.wpi.first.wpilibj

Enum Class PWM.PeriodMultiplier

java.lang.Object

java.lang.Enum<PWM.PeriodMultiplier>

edu.wpi.first.wpilibj.PWM.PeriodMultiplier

All Implemented Interfaces:

Serializable, Comparable<PWM.PeriodMultiplier>, Constable

Enclosing class:

PWM

public static enum PWM.PeriodMultiplier
extends Enum<PWM.PeriodMultiplier>

Represents the amount to multiply the minimum servo-pulse pwm period by.

Nested Class Summary

Nested classes/interfaces inherited from class java.lang.Enum

Enum.EnumDesc<E extends Enum<E>>

Enum Constant Summary

Enum Constants

Enum Constant	Description
k1X	Period Multiplier: don't skip pulses.
k2X	Period Multiplier: skip every other pulse.
k4X	Period Multiplier: skip three out of four pulses.

Method Summary

Modifier and Type	Method	Description
static PWM.PeriodMultiplier	valueOf(String name)	Returns the enum constant of this class with the specified name.
static PWM.PeriodMultiplier[]	values()	Returns an array containing the constants of this enum class, in the order they are declared.

Methods inherited from class java.lang.Enum

clone, compareTo, describeConstable, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Details

k1X

public static final PWM.PeriodMultiplier k1X

Period Multiplier: don't skip pulses. PWM pulses occur every 5.05 ms

k2X

public static final PWM.PeriodMultiplier k2X

Period Multiplier: skip every other pulse. PWM pulses occur every 10.10 ms

k4X

public static final PWM.PeriodMultiplier k4X

Period Multiplier: skip three out of four pulses. PWM pulses occur every 20.20 ms

Method Details

values

public static PWM.PeriodMultiplier[] values()

Returns an array containing the constants of this enum class, in the order they are declared.

Returns:

an array containing the constants of this enum class, in the order they are declared

valueOf

public static PWM.PeriodMultiplier valueOf(String name)

Returns the enum constant of this class with the specified name. The string must match exactly an identifier used to declare an enum constant in this class. (Extraneous whitespace characters are not permitted.)

Parameters:

name - the name of the enum constant to be returned.

Returns:

the enum constant with the specified name

Throws:

IllegalArgumentException - if this enum class has no constant with the specified name

NullPointerException - if the argument is null