com.yobotics.simulationconstructionset.whiteBoard
Class YoWhiteBoard

java.lang.Object
  extended by com.yobotics.simulationconstructionset.whiteBoard.YoWhiteBoard
Direct Known Subclasses:
DataStreamYoWhiteBoard, LocalYoWhiteBoard

public abstract class YoWhiteBoard
extends java.lang.Object


Constructor Summary
YoWhiteBoard(java.lang.String name, YoVariableRegistry registry)
           
 
Method Summary
 void attachYoWhiteBoardListener(YoWhiteBoardListener yoWhiteBoardListener)
           
 void close()
           
 void connect()
           
 void getAllVariablesToRead(java.util.ArrayList<YoVariable> allVariablesToRead)
           
 void getAllVariablesToWrite(java.util.ArrayList<YoVariable> allVariablesToWrite)
           
 int getNumberOfBooleansToRead()
           
 int getNumberOfDoublesToRead()
           
 int getNumberOfEnumsToRead()
           
 int getNumberOfIntsToRead()
           
 int getNumberOfNewDataSinceLastRead()
           
 int getReadIndex()
           
 int getWriteIndex()
           
 boolean haveVariablesToReadAndWriteBeenSet()
           
 boolean isConnected()
           
 boolean isNewDataAvailable()
           
 void readData()
           
 void setVariablesToRead(java.util.ArrayList<YoVariable> variablesToRead)
           
 void setVariablesToWrite(java.util.ArrayList<YoVariable> variablesToWrite)
           
abstract  void whiteBoardSpecificClose()
           
abstract  void whiteBoardSpecificConnect()
           
abstract  void whiteBoardSpecificWriteData(double[] doubleVariablesToWriteBuffer, int[] intVariablesToWriteBuffer, boolean[] booleanVariablesToWriteBuffer, int[] enumVariablesToWriteBuffer, int writeIndex)
           
 void writeData()
           
 
Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

YoWhiteBoard

public YoWhiteBoard(java.lang.String name,
                    YoVariableRegistry registry)
Method Detail

whiteBoardSpecificConnect

public abstract void whiteBoardSpecificConnect()
                                        throws java.io.IOException
Throws:
java.io.IOException

whiteBoardSpecificClose

public abstract void whiteBoardSpecificClose()
                                      throws java.io.IOException
Throws:
java.io.IOException

whiteBoardSpecificWriteData

public abstract void whiteBoardSpecificWriteData(double[] doubleVariablesToWriteBuffer,
                                                 int[] intVariablesToWriteBuffer,
                                                 boolean[] booleanVariablesToWriteBuffer,
                                                 int[] enumVariablesToWriteBuffer,
                                                 int writeIndex)
                                          throws java.io.IOException
Throws:
java.io.IOException

isConnected

public final boolean isConnected()

getNumberOfDoublesToRead

public int getNumberOfDoublesToRead()

getNumberOfIntsToRead

public int getNumberOfIntsToRead()

getNumberOfBooleansToRead

public int getNumberOfBooleansToRead()

getNumberOfEnumsToRead

public int getNumberOfEnumsToRead()

isNewDataAvailable

public boolean isNewDataAvailable()

getNumberOfNewDataSinceLastRead

public int getNumberOfNewDataSinceLastRead()

haveVariablesToReadAndWriteBeenSet

public boolean haveVariablesToReadAndWriteBeenSet()

connect

public void connect()
             throws java.io.IOException
Throws:
java.io.IOException

close

public void close()
           throws java.io.IOException
Throws:
java.io.IOException

writeData

public void writeData()
               throws java.io.IOException
Throws:
java.io.IOException

readData

public void readData()

attachYoWhiteBoardListener

public void attachYoWhiteBoardListener(YoWhiteBoardListener yoWhiteBoardListener)

getAllVariablesToWrite

public void getAllVariablesToWrite(java.util.ArrayList<YoVariable> allVariablesToWrite)

getAllVariablesToRead

public void getAllVariablesToRead(java.util.ArrayList<YoVariable> allVariablesToRead)

setVariablesToWrite

public void setVariablesToWrite(java.util.ArrayList<YoVariable> variablesToWrite)

setVariablesToRead

public void setVariablesToRead(java.util.ArrayList<YoVariable> variablesToRead)

getWriteIndex

public int getWriteIndex()

getReadIndex

public int getReadIndex()