Package com.digi.android.pwm

Class PWMException

java.lang.Object

java.lang.Throwable

java.lang.Exception

com.digi.android.pwm.PWMException

public class PWMException
extends java.lang.Exception

This exception indicates that an operation related to PWM access or configuration has failed.

The exception stores information of which PWM channel caused it and the type of exception thrown.

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field	Description
static int	CHANGE_PERIOD_WHILE_ENABLED	Period cannot be changed while PWM is enabled.
protected int	channelIndex
protected PWMChip	chip
protected int	exceptionType
static int	INVALID_PERIOD	Period is invalid.
static int	OPERATION_NOT_SUPPORTED	The requested action is not supported.
static int	PERIOD_ZERO	Period cannot be 0.
static int	PWM_CHANNEL_NOT_AVAILABLE	The provided PWM channel index is not available.
static int	PWM_CHIP_NOT_AVAILABLE	The provided PWM chip index is not available.
static int	READING_ERROR	Error reading from PWM channel files.
static long	serialVersionUID
static int	UNSPECIFIED_EXCEPTION	Any exception that does not specify a specific issue.
static int	WRITING_ERROR	Error writing to PWM channel files.

Method Summary

Modifier and Type	Method	Description
int	getPWMChannelIndex()	Retrieves the PWM channel index associated to this exception.
PWMChip	getPWMChip()	Retrieves the PWM chip associated to this exception.
int	getType()	Retrieves the exception type.

Methods inherited from class java.lang.Object

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

Methods inherited from class java.lang.Throwable

addSuppressed, fillInStackTrace, getCause, getLocalizedMessage, getMessage, getStackTrace, getSuppressed, initCause, printStackTrace, printStackTrace, printStackTrace, setStackTrace, toString

Field Detail

serialVersionUID

public static final long serialVersionUID

See Also:

Constant Field Values

UNSPECIFIED_EXCEPTION

public static final int UNSPECIFIED_EXCEPTION

Any exception that does not specify a specific issue.

See Also:

Constant Field Values

PWM_CHIP_NOT_AVAILABLE

public static final int PWM_CHIP_NOT_AVAILABLE

The provided PWM chip index is not available.

See Also:

Constant Field Values

PWM_CHANNEL_NOT_AVAILABLE

public static final int PWM_CHANNEL_NOT_AVAILABLE

The provided PWM channel index is not available.

See Also:

Constant Field Values

READING_ERROR

public static final int READING_ERROR

Error reading from PWM channel files.

See Also:

Constant Field Values

WRITING_ERROR

public static final int WRITING_ERROR

Error writing to PWM channel files.

See Also:

Constant Field Values

OPERATION_NOT_SUPPORTED

public static final int OPERATION_NOT_SUPPORTED

The requested action is not supported.

See Also:

Constant Field Values

PERIOD_ZERO

public static final int PERIOD_ZERO

Period cannot be 0.

See Also:

Constant Field Values

INVALID_PERIOD

public static final int INVALID_PERIOD

Period is invalid.

See Also:

Constant Field Values

CHANGE_PERIOD_WHILE_ENABLED

public static final int CHANGE_PERIOD_WHILE_ENABLED

Period cannot be changed while PWM is enabled.

See Also:

Constant Field Values

exceptionType

protected int exceptionType

channelIndex

protected int channelIndex

chip

protected PWMChip chip

Method Detail

getPWMChip

public PWMChip getPWMChip()

Retrieves the PWM chip associated to this exception.

Returns:

PWM chip associated with this exception.

getPWMChannelIndex

public int getPWMChannelIndex()

Retrieves the PWM channel index associated to this exception.

Returns:

PWM channel index associated with this exception.

getType

public int getType()

Retrieves the exception type. Will be UNSPECIFIED_EXCEPTION if not explicitly set.

Returns:

Returns the exception type.

See Also:

PWM_CHIP_NOT_AVAILABLE, PWM_CHANNEL_NOT_AVAILABLE, READING_ERROR, UNSPECIFIED_EXCEPTION, WRITING_ERROR