shady.common.op
Class BoundOperation

java.lang.Object
  extended by shady.common.op.Operation
      extended by shady.common.op.BoundOperation
Direct Known Subclasses:
BarrelOperation, ChargeBattery, RechargeBattery, Reset, SetDiscrete, Stop

public abstract class BoundOperation
extends Operation

A Shady Operation bound to a Shady instance.

Copyright (C) 2006 Marsette A. Vona, III

This program is free software; you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation; either version 2 of the License, or (at your option) any later version.

This program is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details.

You should have received a copy of the GNU General Public License along with this program; if not, write to the Free Software Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA.

Author:
Marsette (Marty) A. Vona, III

Field Summary
private static java.lang.String cvsid
          CVS id.
 ShadyCommonAPI shady
          The Shady instance on which to operate.
 
Constructor Summary
BoundOperation(ShadyCommonAPI shady)
          Make a new BoundOperation.
 
Method Summary
abstract  int exec()
          Execute the operation.
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

cvsid

private static final java.lang.String cvsid

CVS id.

See Also:
Constant Field Values

shady

public ShadyCommonAPI shady

The Shady instance on which to operate.

Constructor Detail

BoundOperation

public BoundOperation(ShadyCommonAPI shady)

Make a new BoundOperation.

Parameters:
shady - The Shady instance on which to operate
Method Detail

exec

public abstract int exec()

Execute the operation.

Has no effect if the system is already in the target state of the operation.

Fails fast if the system is currently in fault.

Blocks until the operation is complete.

This impl executes on shady.

Specified by:
exec in class Operation
Returns:
0 if the operation was successful, otherwise the fault that occurred