org.lsst.ccs.drivers.dataforth

Class Maq20DiscretePWM

java.lang.Object

org.lsst.ccs.drivers.dataforth.Maq20Discrete

org.lsst.ccs.drivers.dataforth.Maq20DiscreteFunc

org.lsst.ccs.drivers.dataforth.Maq20DiscretePWM

public class Maq20DiscretePWM
extends Maq20DiscreteFunc

Control a Dataforth MAQ20 discrete I/O module PWM generator.

Author:

Owen Saxton

Field Summary

Fields inherited from class org.lsst.ccs.drivers.dataforth.Maq20DiscreteFunc

TIMEBASE_MSECS, TIMEBASE_SECS, TIMEBASE_USECS

Constructor Summary

Constructors

Constructor and Description
Maq20DiscretePWM(Maq20 maq, int modId) Constructor.

Method Summary

Modifier and Type	Method and Description
void	enable(int chan) Enables the PWM generator.
void	enableOutput2(int chan, boolean enable) Sets the output 2 enabled state.
int	getLowTime1(int chan) Gets the low time for output 1.
int	getLowTime2(int chan) Gets the low time for output 2.
int	getPeriod(int chan) Gets the period.
int	getTimebase(int chan) Gets the timebase.
boolean	isEnabled(int chan) Gets whether the PWM generator is enabled.
boolean	isOutput2Enabled(int chan) Gets the output 2 enabled state.
void	setLowTime1(int chan, int time) Sets the low time for output 1.
void	setLowTime2(int chan, int time) Sets the low time for output 2.
void	setPeriod(int chan, int period) Sets the period.
void	setTimebase(int chan, int base) Sets the timebase.

Methods inherited from class org.lsst.ccs.drivers.dataforth.Maq20DiscreteFunc

armFunction, disarmFunction, isFunctionArmed, saveConfig

Methods inherited from class org.lsst.ccs.drivers.dataforth.Maq20Discrete

getDiscDefault, getDiscDefault, getDiscDefault, readDiscIn, readDiscIn, readDiscIn, readDiscOut, readDiscOut, readDiscOut, saveParameters, setDiscDefault, setDiscDefault, setDiscDefault, writeDisc, writeDisc, writeDisc

Methods inherited from class java.lang.Object

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

Constructor Detail

Maq20DiscretePWM

public Maq20DiscretePWM(Maq20 maq,
                        int modId)
                 throws org.lsst.ccs.drivers.commons.DriverException

Constructor.

Parameters:

maq - The underlying Maq20 object

modId - The module registration ID

Throws:

org.lsst.ccs.drivers.commons.DriverException

Method Detail

enable

public void enable(int chan)
            throws org.lsst.ccs.drivers.commons.DriverException

Enables the PWM generator.

Parameters:

chan - The function channel (0 or 1)

Throws:

org.lsst.ccs.drivers.commons.DriverException

isEnabled

public boolean isEnabled(int chan)
                  throws org.lsst.ccs.drivers.commons.DriverException

Gets whether the PWM generator is enabled.

Parameters:

chan - The function channel (0 or 1)

Returns:

Whether anabled

Throws:

org.lsst.ccs.drivers.commons.DriverException

setTimebase

public void setTimebase(int chan,
                        int base)
                 throws org.lsst.ccs.drivers.commons.DriverException

Sets the timebase.

Parameters:

chan - The function channel (0 or 1)

base - The encoded timebase value

Throws:

org.lsst.ccs.drivers.commons.DriverException

getTimebase

public int getTimebase(int chan)
                throws org.lsst.ccs.drivers.commons.DriverException

Gets the timebase.

Parameters:

chan - The function channel (0 or 1)

Returns:

The encoded timebase

Throws:

org.lsst.ccs.drivers.commons.DriverException

enableOutput2

public void enableOutput2(int chan,
                          boolean enable)
                   throws org.lsst.ccs.drivers.commons.DriverException

Sets the output 2 enabled state.

Parameters:

chan - The function channel (0 or 1)

enable - Whether to enable output 2

Throws:

org.lsst.ccs.drivers.commons.DriverException

isOutput2Enabled

public boolean isOutput2Enabled(int chan)
                         throws org.lsst.ccs.drivers.commons.DriverException

Gets the output 2 enabled state.

Parameters:

chan - The function channel (0 or 1)

Returns:

Whether output 2 is enabled

Throws:

org.lsst.ccs.drivers.commons.DriverException

setPeriod

public void setPeriod(int chan,
                      int period)
               throws org.lsst.ccs.drivers.commons.DriverException

Sets the period.

Parameters:

chan - The function channel (0 or 1)

period - The period

Throws:

org.lsst.ccs.drivers.commons.DriverException

getPeriod

public int getPeriod(int chan)
              throws org.lsst.ccs.drivers.commons.DriverException

Gets the period.

Parameters:

chan - The function channel (0 or 1)

Returns:

The period

Throws:

org.lsst.ccs.drivers.commons.DriverException

setLowTime1

public void setLowTime1(int chan,
                        int time)
                 throws org.lsst.ccs.drivers.commons.DriverException

Sets the low time for output 1.

Parameters:

chan - The function channel (0 or 1)

time - The low time

Throws:

org.lsst.ccs.drivers.commons.DriverException

getLowTime1

public int getLowTime1(int chan)
                throws org.lsst.ccs.drivers.commons.DriverException

Gets the low time for output 1.

Parameters:

chan - The function channel (0 or 1)

Returns:

The low time

Throws:

org.lsst.ccs.drivers.commons.DriverException

setLowTime2

public void setLowTime2(int chan,
                        int time)
                 throws org.lsst.ccs.drivers.commons.DriverException

Sets the low time for output 2.

Parameters:

chan - The function channel (0 or 1)

time - The low time

Throws:

org.lsst.ccs.drivers.commons.DriverException

getLowTime2

public int getLowTime2(int chan)
                throws org.lsst.ccs.drivers.commons.DriverException

Gets the low time for output 2.

Parameters:

chan - The function channel (0 or 1)

Returns:

The low time

Throws:

org.lsst.ccs.drivers.commons.DriverException