Module com.pi4j

Package com.pi4j.io.gpio.analog

Class AnalogOutputBase

java.lang.Object

com.pi4j.common.IdentityBase

com.pi4j.io.IOBase<IO_TYPE,CONFIG_TYPE,PROVIDER_TYPE>

com.pi4j.io.gpio.GpioBase<ANALOG_TYPE,CONFIG_TYPE,PROVIDER_TYPE>

com.pi4j.io.gpio.analog.AnalogBase<AnalogOutput,AnalogOutputConfig,AnalogOutputProvider>

com.pi4j.io.gpio.analog.AnalogOutputBase

All Implemented Interfaces:

Describable, Identity, Lifecycle, Extension, Bindable<AnalogOutput,AnalogBinding>, Analog<AnalogOutput,AnalogOutputConfig,AnalogOutputProvider>, AnalogOutput, com.pi4j.io.gpio.Gpio<AnalogOutput,AnalogOutputConfig,AnalogOutputProvider>, IO<AnalogOutput,AnalogOutputConfig,AnalogOutputProvider>, Output

public abstract class AnalogOutputBase
extends AnalogBase<AnalogOutput,AnalogOutputConfig,AnalogOutputProvider>
implements AnalogOutput

Abstract AnalogOutputBase class.

Version:

$Id: $Id

Author:

Robert Savage (http://www.savagehomeautomation.com)

Field Summary

Fields

Modifier and Type	Field	Description
protected org.slf4j.Logger	logger
protected Integer	value

Fields inherited from class com.pi4j.io.gpio.analog.AnalogBase

bindings, valueChangeEventManager

Fields inherited from class com.pi4j.io.IOBase

config, provider

Fields inherited from class com.pi4j.common.IdentityBase

description, id, metadata, name

Constructor Summary

Constructors

Constructor	Description
AnalogOutputBase(AnalogOutputProvider provider, AnalogOutputConfig config)	Constructor for AnalogOutputBase.

Method Summary

Modifier and Type	Method	Description
AnalogOutput	shutdown(Context context)	shutdown.
AnalogOutput	step(Integer value)	step.
AnalogOutput	stepDown()	stepDown.
AnalogOutput	stepUp()	stepUp.
Integer	value()	value.
AnalogOutput	value(Integer value)	value.

Methods inherited from class com.pi4j.io.gpio.analog.AnalogBase

addListener, bind, dispatch, removeListener, unbind

Methods inherited from class com.pi4j.io.gpio.GpioBase

toString

Methods inherited from class com.pi4j.io.IOBase

config, describe, description, initialize, name, provider

Methods inherited from class com.pi4j.common.IdentityBase

description, id, metadata, name

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.pi4j.io.gpio.analog.Analog

addListener, equals, getValue, removeListener

Methods inherited from interface com.pi4j.io.gpio.analog.AnalogOutput

setValue

Methods inherited from interface com.pi4j.io.binding.Bindable

bind, unbind

Methods inherited from interface com.pi4j.io.gpio.Gpio

address, getAddress

Methods inherited from interface com.pi4j.common.Identity

description, getDescription, getId, getMetadata, getName, id, metadata, name

Methods inherited from interface com.pi4j.io.IO

config, description, name, provider, type

Methods inherited from interface com.pi4j.common.Lifecycle

initialize

Field Details

logger

protected org.slf4j.Logger logger

value

protected Integer value

Constructor Details

AnalogOutputBase

public AnalogOutputBase(AnalogOutputProvider provider,
 AnalogOutputConfig config)

Constructor for AnalogOutputBase.

Parameters:

provider - a AnalogOutputProvider object.

config - a AnalogOutputConfig object.

Method Details

stepUp

public AnalogOutput stepUp()

stepUp.

Specified by:

stepUp in interface AnalogOutput

Returns:

a AnalogOutput object.

stepDown

public AnalogOutput stepDown()

stepDown.

Specified by:

stepDown in interface AnalogOutput

Returns:

a AnalogOutput object.

step

public AnalogOutput step(Integer value)
                  throws IOIllegalValueException,
IOBoundsException

step.

Specified by:

step in interface AnalogOutput

Parameters:

value - a Integer object.

Returns:

a AnalogOutput object.

Throws:

IOIllegalValueException - if any.

IOBoundsException - if any.

value

public AnalogOutput value(Integer value)
                   throws IOIllegalValueException,
IOBoundsException

value.

Specified by:

value in interface AnalogOutput

Parameters:

value - a Integer object.

Returns:

a AnalogOutput object.

Throws:

IOIllegalValueException - if any.

IOBoundsException - if any.

shutdown

public AnalogOutput shutdown(Context context)

shutdown.

Specified by:

shutdown in interface Lifecycle

Overrides:

shutdown in class AnalogBase<AnalogOutput,AnalogOutputConfig,AnalogOutputProvider>

Parameters:

context - a Context object.

Returns:

a T object.

value

public Integer value()

value.

Specified by:

value in interface Analog<AnalogOutput,AnalogOutputConfig,AnalogOutputProvider>

Returns:

a Integer object.