Phidgets
Class PhidgetEncoder

java.lang.Object
  |
  +--java.lang.Thread
        |
        +--Phidgets.Phidget
              |
              +--Phidgets.PhidgetEncoder
All Implemented Interfaces:
java.lang.Runnable

public class PhidgetEncoder
extends Phidget

Author:
Patrick McNeil

The class PhidgetEncoder represents a Phidget Encoder. All methods to read encoder data from an encoder are implemented in this class.


Fields inherited from class java.lang.Thread
MAX_PRIORITY, MIN_PRIORITY, NORM_PRIORITY
 
Constructor Summary
PhidgetEncoder()
           
 
Method Summary
 void add_IPhidgetEncoderEventsListener(_IPhidgetEncoderEvents l)
          Sets up the event handlers
 long GetEncoderPosition(int Index)
          Gets the position of a specific encoder
 boolean GetInputState(int Index)
          Gets the state of digital inputs
 int GetNumEncoders()
          Gets number of encoders
 int GetNumInputs()
          Gets number of digital inputs
 int OpenRemote(int serverSerial, int port, int serialNumber, java.lang.String pass)
          Open the device when it is on the local network.
 int OpenRemoteIP(java.lang.String ip, int port, int serialNumber, java.lang.String pass)
          Open the device when it is on a remote network.
 void remove_IPhidgetEncoderEventsListener()
          Removes the events handlers
 
Methods inherited from class Phidgets.Phidget
Close, equals, GetDeviceType, GetDeviceVersion, GetIsAttached, GetSerialNumber, GetServerAddress, GetServerID, GetServerPort, run, setDeviceType, setDeviceVersion, setSerialNumber
 
Methods inherited from class java.lang.Thread
activeCount, checkAccess, countStackFrames, currentThread, destroy, dumpStack, enumerate, getContextClassLoader, getName, getPriority, getThreadGroup, interrupt, interrupted, isAlive, isDaemon, isInterrupted, join, join, join, resume, setContextClassLoader, setDaemon, setName, setPriority, sleep, sleep, start, stop, stop, suspend, toString, yield
 
Methods inherited from class java.lang.Object
getClass, hashCode, notify, notifyAll, wait, wait, wait
 

Constructor Detail

PhidgetEncoder

public PhidgetEncoder()
Method Detail

OpenRemote

public int OpenRemote(int serverSerial,
                      int port,
                      int serialNumber,
                      java.lang.String pass)
Open the device when it is on the local network. This uses a UDB broadcast to find the server with a specified serial number, so you don't need to know it's IP address, but only works on internal networks where broadcasting is allowed
Parameters:
serverSerial - Serial number of the server, or -1 for any serial
port - Server port
serialNumber - Serial number of the device or -1 for any serial
pass - Server password
Returns:
0 on success

OpenRemoteIP

public int OpenRemoteIP(java.lang.String ip,
                        int port,
                        int serialNumber,
                        java.lang.String pass)
Open the device when it is on a remote network. Use this when OpenRemote fails, such as opening Phidgets over the internet. You need to know the IP address here.
Parameters:
ip - IP address or hostname of the server
port - Server port
serialNumber - Serial number of the device or -1 for any serial
pass - Server password
Returns:
0 on success

GetNumInputs

public int GetNumInputs()
Gets number of digital inputs
Returns:
Inputs

GetNumEncoders

public int GetNumEncoders()
Gets number of encoders
Returns:
Encoders

GetEncoderPosition

public long GetEncoderPosition(int Index)
Gets the position of a specific encoder
Parameters:
Index - Encoder
Returns:
position

GetInputState

public boolean GetInputState(int Index)
Gets the state of digital inputs
Parameters:
Index - Input
Returns:
State

add_IPhidgetEncoderEventsListener

public void add_IPhidgetEncoderEventsListener(_IPhidgetEncoderEvents l)
Sets up the event handlers
Parameters:
l - An object implementing the __IPhidgetEncoderEvents interface

remove_IPhidgetEncoderEventsListener

public void remove_IPhidgetEncoderEventsListener()
Removes the events handlers