agentland.output
Class X10Agent

java.lang.Object
  |
  +--java.rmi.server.RemoteObject
        |
        +--java.rmi.server.RemoteServer
              |
              +--java.rmi.server.UnicastRemoteObject
                    |
                    +--metaglue.AgentAgent
                          |
                          +--agentland.util.GoodAgent
                                |
                                +--agentland.resource.ManagedAgent
                                      |
                                      +--agentland.device.DeviceAgent
                                            |
                                            +--agentland.output.X10Agent
Direct Known Subclasses:
LynX10Agent, TwoWayX10Agent

public abstract class X10Agent
extends DeviceAgent
implements X10

See Also:
Serialized Form

Inner classes inherited from class metaglue.AgentAgent
AgentAgent.Attribute
 
Fields inherited from class agentland.device.DeviceAgent
defaultState, fName, names, states
 
Fields inherited from class agentland.resource.ManagedAgent
rm, society
 
Fields inherited from class agentland.util.GoodAgent
alert, notifier
 
Fields inherited from class java.rmi.server.RemoteObject
ref
 
Fields inherited from interface metaglue.Agent
ALIVE, DIED, NO_METAGLUE, NOT_RUNNING, STARTING
 
Fields inherited from interface metaglue.Agent
ALIVE, DIED, NO_METAGLUE, NOT_RUNNING, STARTING
 
Constructor Summary
X10Agent()
           
 
Method Summary
 boolean brightenBy(String housecode, int module, int delta)
           
 boolean brightenBy(Vector devs, int delta)
           
 boolean brightenBy(X10Data dev, int delta)
           
 boolean brightenTo(String housecode, int module, int level)
           
 boolean brightenTo(Vector devs, int level)
           
 boolean brightenTo(X10Data dev, int level)
           
protected  DeviceState defaultX10DimLevelState(String devName)
          Creates a new "dimLevel" state with default value
protected  DeviceState defaultX10OnState(String devName)
          Creates a new "On" state with default value
 boolean dimBy(String housecode, int module, int delta)
           
 boolean dimBy(Vector devs, int delta)
           
 boolean dimBy(X10Data dev, int delta)
           
 boolean dimTo(String housecode, int module, int level)
           
 boolean dimTo(Vector devs, int level)
           
 boolean dimTo(X10Data dev, int level)
           
 boolean fadeOff(String housecode, int module)
           
 boolean fadeOff(Vector devs)
           
 boolean fadeOff(X10Data dev)
           
 DeviceState getDimState(String housecode, int module)
           
 DeviceState getOnState(String housecode, int module)
           
 DeviceState getState(String name)
          Overrides getState in DeviceAgent.
 boolean turnOff(String housecode, int module)
           
 boolean turnOff(Vector devs)
           
 boolean turnOff(X10Data dev)
           
 boolean turnOn(String housecode, int module)
           
 boolean turnOn(Vector devs)
           
 boolean turnOn(X10Data dev)
           
 
Methods inherited from class agentland.device.DeviceAgent
addName, createStateChangeNotification, ensureState, getDefaultNames, getDefaultStateName, getName, getNames, getState, getStateNames, hasName, quietException, resetAllStates, resetName, resetState, resetState, setDefaultStateName, setName, setState, throwException, updateState, updateState, updateState, updateState, updateState, updateState, updateState, updateState
 
Methods inherited from class agentland.resource.ManagedAgent
connect, getAlert, getNeed, reliesOn, reliesOn, replace, request, request, request, requestAgent, requestAgent, resources, resourcesByAgentID, setNeed, yank, yank, yank
 
Methods inherited from class agentland.util.GoodAgent
addSpy, addSpy, alert, alertString, beep, error, getHistory, getHistoryElement, getPersistentMap, log, notify, removeSpy, removeSpy, resetHistory, safeRely, safeRely, safeRely, setNiceLogName, tell
 
Methods inherited from class metaglue.AgentAgent
addMonitor, alive, defrost, defrostAll, defrostBoolean, defrostInt, defrostString, fixAttribute, fixAttribute, freeze, freeze, freeze, freezeAll, freezeVar, getAgentID, getAttribute, getCatalog, getCatalogID, getDesignation, getFrozenVariables, getLogLevel, getMetaglueAgent, getMetaglueAgentID, getOccupation, getProperties, getSociety, log, log, obtainMetaglueAgent, obtainMetaglueAgent, obtainMetaglueAgentByName, reliesOn, reliesOnSynch, removeFrozen, replaceExceptionHandler, setFreezeName, setLogLevel, setLogName, shutdown, startAgent, startAgentOn, startAgentOn, startup, status, tiedTo, tiedTo, tiedTo, tiedTo, tieToDesignation, whereAreYou
 
Methods inherited from class java.rmi.server.UnicastRemoteObject
clone, exportObject, exportObject, exportObject, unexportObject
 
Methods inherited from class java.rmi.server.RemoteServer
getClientHost, getLog, setLog
 
Methods inherited from class java.rmi.server.RemoteObject
equals, getRef, hashCode, toString, toStub
 
Methods inherited from class java.lang.Object
finalize, getClass, notify, notifyAll, wait, wait, wait
 

Constructor Detail

X10Agent

public X10Agent()
         throws RemoteException
Method Detail

turnOn

public boolean turnOn(String housecode,
                      int module)
               throws RemoteException
Specified by:
turnOn in interface X10

turnOn

public boolean turnOn(X10Data dev)
               throws RemoteException
Specified by:
turnOn in interface X10

turnOn

public boolean turnOn(Vector devs)
               throws RemoteException
Specified by:
turnOn in interface X10

turnOff

public boolean turnOff(String housecode,
                       int module)
                throws RemoteException
Specified by:
turnOff in interface X10

turnOff

public boolean turnOff(X10Data dev)
                throws RemoteException
Specified by:
turnOff in interface X10

turnOff

public boolean turnOff(Vector devs)
                throws RemoteException
Specified by:
turnOff in interface X10

fadeOff

public boolean fadeOff(String housecode,
                       int module)
                throws RemoteException
Specified by:
fadeOff in interface X10

fadeOff

public boolean fadeOff(X10Data dev)
                throws RemoteException
Specified by:
fadeOff in interface X10

fadeOff

public boolean fadeOff(Vector devs)
                throws RemoteException
Specified by:
fadeOff in interface X10

dimBy

public boolean dimBy(String housecode,
                     int module,
                     int delta)
              throws RemoteException
Specified by:
dimBy in interface X10

dimBy

public boolean dimBy(X10Data dev,
                     int delta)
              throws RemoteException
Specified by:
dimBy in interface X10

dimBy

public boolean dimBy(Vector devs,
                     int delta)
              throws RemoteException
Specified by:
dimBy in interface X10

dimTo

public boolean dimTo(String housecode,
                     int module,
                     int level)
              throws RemoteException
Specified by:
dimTo in interface X10

dimTo

public boolean dimTo(X10Data dev,
                     int level)
              throws RemoteException
Specified by:
dimTo in interface X10

dimTo

public boolean dimTo(Vector devs,
                     int level)
              throws RemoteException
Specified by:
dimTo in interface X10

brightenBy

public boolean brightenBy(String housecode,
                          int module,
                          int delta)
                   throws RemoteException
Specified by:
brightenBy in interface X10

brightenBy

public boolean brightenBy(X10Data dev,
                          int delta)
                   throws RemoteException
Specified by:
brightenBy in interface X10

brightenBy

public boolean brightenBy(Vector devs,
                          int delta)
                   throws RemoteException
Specified by:
brightenBy in interface X10

brightenTo

public boolean brightenTo(String housecode,
                          int module,
                          int level)
                   throws RemoteException
Specified by:
brightenTo in interface X10

brightenTo

public boolean brightenTo(X10Data dev,
                          int level)
                   throws RemoteException
Specified by:
brightenTo in interface X10

brightenTo

public boolean brightenTo(Vector devs,
                          int level)
                   throws RemoteException
Specified by:
brightenTo in interface X10

getState

public DeviceState getState(String name)
                     throws RemoteException
Overrides getState in DeviceAgent. If a given state does not exist, it creates a default value for it (unless some unknown state name was requested -- then it returns null)
Overrides:
getState in class DeviceAgent
Parameters:
name - state name

defaultX10OnState

protected DeviceState defaultX10OnState(String devName)
Creates a new "On" state with default value
Parameters:
name - device name (e.g. A1, B12)

defaultX10DimLevelState

protected DeviceState defaultX10DimLevelState(String devName)
Creates a new "dimLevel" state with default value
Parameters:
name - device name (e.g. A1, B12)

getOnState

public DeviceState getOnState(String housecode,
                              int module)
                       throws RemoteException
Specified by:
getOnState in interface X10

getDimState

public DeviceState getDimState(String housecode,
                               int module)
                        throws RemoteException
Specified by:
getDimState in interface X10