li.cil.tis3d.common.module.execution.target

Class TargetInterfaceSide

java.lang.Object

li.cil.tis3d.common.module.execution.target.TargetInterfaceSide

All Implemented Interfaces:

TargetInterface

public final class TargetInterfaceSide
extends java.lang.Object

Interface for the Target.LEFT, Target.RIGHT, Target.UP and Target.DOWN targets.

Provides read and write on the pipe of the respective port.

Constructor Summary

Constructors

Constructor and Description
TargetInterfaceSide(Machine machine, ModuleExecution module, Face face, Port port)

Method Summary

Modifier and Type	Method and Description
void	beginRead() Begin a reading operation on the target.
protected void	beginRead(Port port)
protected void	beginWrite(Port port, short value)
boolean	beginWrite(short value) Begin a writing operation on the target.
protected void	cancelRead(Port port)
protected void	cancelWrite(Port port)
boolean	canTransfer() Whether the target can transfer data, i.e.
protected boolean	canTransfer(Port port)
protected Machine	getMachine()
protected MachineState	getState()
boolean	isReading() Whether the target is currently being read from.
protected boolean	isReading(Port port)
boolean	isWriting() Whether the target is currently being written to.
protected boolean	isWriting(Port port)
short	read() Finish a read operation by fetching the data made available from the represented target.
protected short	read(Port port)
java.lang.String	toString()

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface li.cil.tis3d.common.module.execution.target.TargetInterface

onWriteComplete

Constructor Detail

TargetInterfaceSide

public TargetInterfaceSide(Machine machine,
                           ModuleExecution module,
                           Face face,
                           Port port)

Method Detail

beginWrite

public boolean beginWrite(short value)

Description copied from interface: TargetInterface

Begin a writing operation on the target.

Make sure not to call this if the target is already being written to, or an exception will be thrown. Use TargetInterface.isWriting() to check for this.

Parameters:

value - the value to write to the target.

Returns:

true if the operation finished synchronously, false otherwise.

isWriting

public boolean isWriting()

Description copied from interface: TargetInterface

Whether the target is currently being written to.

This is true as soon as TargetInterface.beginWrite(short) was called and until TargetInterface.read() was called to finish or cancel the operation, unless the operation was completed synchronously, in which case TargetInterface.beginWrite(short) returned true.

Returns:

whether the target is currently being written to.

beginRead

public void beginRead()

Description copied from interface: TargetInterface

Begin a reading operation on the target.

Make sure not to call this if the target is already being read from, or an exception will be thrown. Use TargetInterface.isReading() to check for this.

isReading

public boolean isReading()

Description copied from interface: TargetInterface

Whether the target is currently being read from.

This is true as soon as TargetInterface.beginRead() was called and until TargetInterface.read() was called to finish the operation.

Returns:

whether the target is currently being read from.

canTransfer

public boolean canTransfer()

Description copied from interface: TargetInterface

Whether the target can transfer data, i.e. TargetInterface.read() can be called.

Note that this is not equivalent to TargetInterface.isReading() && TargetInterface.isWriting(). Depending on the target type, this may be only true in the first update after that has been true and later, but it may also be true right away or always.

Returns:

whether the target can now transfer data.

read

public short read()

Description copied from interface: TargetInterface

Finish a read operation by fetching the data made available from the represented target.

Make sure not to call this if the target is not in the correct state, or an exception will be thrown. use TargetInterface.canTransfer() to check for this.

Returns:

the value transferred through the target.

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object

beginWrite

protected final void beginWrite(Port port,
                                short value)

cancelWrite

protected final void cancelWrite(Port port)

isWriting

protected final boolean isWriting(Port port)

beginRead

protected final void beginRead(Port port)

cancelRead

protected final void cancelRead(Port port)

isReading

protected final boolean isReading(Port port)

canTransfer

protected final boolean canTransfer(Port port)

read

protected final short read(Port port)

getMachine

protected Machine getMachine()

getState

protected MachineState getState()