SunSPOT API V3.0


com.sun.spot.sensorboard.io
Class PinDescriptor

java.lang.Object
  extended by com.sun.spot.sensorboard.io.PinDescriptor

public class PinDescriptor
extends Object

Describe the operating parameters of a particular hardware pin.

Author:
arshan

Field Summary
static int COMPOSITE
           
static int INPUT
           
static int OUTPUT
           
static int SCALAR
           
 
Constructor Summary
PinDescriptor(int idx, String name, int[] hints, int flags)
          Creates a new instance of PinDescriptor.
 
Method Summary
 int[] getHints()
           
 boolean isComposite()
           
 boolean isInput()
           
 boolean isOutput()
           
 boolean isScalar()
           
 void setHints(int[] hints)
           
 int toInteger()
          mimic the behaviour of an enum
 String toString()
          Returns a string representation of the object.
 
Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, wait, wait, wait
 

Field Detail

INPUT

public static final int INPUT
See Also:
Constant Field Values

OUTPUT

public static final int OUTPUT
See Also:
Constant Field Values

SCALAR

public static final int SCALAR
See Also:
Constant Field Values

COMPOSITE

public static final int COMPOSITE
See Also:
Constant Field Values
Constructor Detail

PinDescriptor

public PinDescriptor(int idx,
                     String name,
                     int[] hints,
                     int flags)
Creates a new instance of PinDescriptor.

Parameters:
idx - enum value for pin
name - human readable name for pin
hints - array of hints to be used by the controller
flags - flags that define the possible uses of this pin
Method Detail

isInput

public boolean isInput()
Returns:
true if pin can be used as an input

isOutput

public boolean isOutput()
Returns:
true if pin can be used as an output

isScalar

public boolean isScalar()
Returns:
true if pin can be used as an scalar

isComposite

public boolean isComposite()
Returns:
true if the pin is a composite of many real pins

toInteger

public int toInteger()
mimic the behaviour of an enum

Returns:
value of this pin as an integer

toString

public String toString()
Description copied from class: Object
Returns a string representation of the object. In general, the toString method returns a string that "textually represents" this object. The result should be a concise but informative representation that is easy for a person to read. It is recommended that all subclasses override this method.

The toString method for class Object returns a string consisting of the name of the class of which the object is an instance, the at-sign character `@', and the unsigned hexadecimal representation of the hash code of the object. In other words, this method returns a string equal to the value of:

 getClass().getName() + '@' + Integer.toHexString(hashCode())
 

Overrides:
toString in class Object
Returns:
name of pin

getHints

public int[] getHints()
Returns:
hints array

setHints

public void setHints(int[] hints)
Parameters:
hints - array

SunSPOT API V3.0


Copyright © 2006, 2007 Sun Microsystems, Inc. All Rights Reserved.