Module (2013 FRC Java API)

Class

Use

Tree

Index

Help

"
2013 FRC Java API
"

PREV CLASS NEXT CLASS

FRAMES NO FRAMES

SUMMARY: NESTED | FIELD | CONSTR | METHOD

DETAIL: FIELD | CONSTR | METHOD

edu.wpi.first.wpilibj
Class Module

java.lang.Object
  edu.wpi.first.wpilibj.SensorBase
      edu.wpi.first.wpilibj.Module

Base class for AnalogModule and DigitalModule.

Field Summary
`protected int`	`m_moduleNumber` The module number of the module
`protected static Module[]`	`m_modules` An array holding the object representing each module
`protected ModulePresence.ModuleType`	`m_moduleType`

Fields inherited from class edu.wpi.first.wpilibj.SensorBase
`kAnalogChannels, kAnalogModules, kDigitalChannels, kPwmChannels, kRelayChannels, kSolenoidChannels, kSolenoidModules, kSystemClockTicksPerMicrosecond`

Constructor Summary
`protected`	`Module(ModulePresence.ModuleType moduleType, int moduleNumber)` Constructor.

Method Summary
`static Module`	`getModule(ModulePresence.ModuleType moduleType, int moduleNumber)` Static module singleton factory.
`int`	`getModuleNumber()` Gets the module number associated with a module.
`ModulePresence.ModuleType`	`getModuleType()` Gets the module type associated with a module.

Methods inherited from class edu.wpi.first.wpilibj.SensorBase
`checkAnalogChannel, checkAnalogModule, checkDigitalChannel, checkDigitalModule, checkPWMChannel, checkPWMModule, checkRelayChannel, checkRelayModule, checkSolenoidChannel, checkSolenoidModule, free, getDefaultAnalogModule, getDefaultDigitalModule, getDefaultSolenoidModule, setDefaultAnalogModule, setDefaultDigitalModule, setDefaultSolenoidModule`

Methods inherited from class java.lang.Object
`equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait`

Field Detail

protected static Module[] m_modules

An array holding the object representing each module

protected int m_moduleNumber

The module number of the module

protected ModulePresence.ModuleType m_moduleType

Constructor Detail

protected Module(ModulePresence.ModuleType moduleType,
                 int moduleNumber)

Constructor.

Method Detail

public int getModuleNumber()

Gets the module number associated with a module.

public ModulePresence.ModuleType getModuleType()

Gets the module type associated with a module.

public static Module getModule(ModulePresence.ModuleType moduleType,
                               int moduleNumber)

Static module singleton factory.

Parameters:: moduleType - The type of the module represented.; moduleNumber - The module index within the module type.
Returns:: the module