li.cil.tis3d.common.machine

Class PipeImpl

java.lang.Object

li.cil.tis3d.common.machine.PipeImpl

All Implemented Interfaces:

Pipe

public final class PipeImpl
extends java.lang.Object
implements Pipe

Implementation of Pipes for passing data between Modules.

Constructor Summary

Constructors

Constructor and Description
PipeImpl(PipeHost host, Face receivingFace, Face sendingFace, Port sendingPort)

Method Summary

Modifier and Type	Method and Description
void	beginRead() Begin a reading operation on the pipe.
void	beginWrite(short value) Begin a writing operation on the pipe.
void	cancelRead() Cancel an active read operation.
void	cancelWrite() Cancel an active write operation.
boolean	canTransfer() Whether the pipe can transfer data, i.e.
boolean	isReading() Whether the pipe is currently being read from.
boolean	isWriting() Whether the pipe is currently being written to.
short	read() Finish a read operation by fetching the data that is written by the write operation running at the same time.
void	readFromNBT(net.minecraft.nbt.NBTTagCompound nbt)
void	step() Called from the owning Casing after all Modules have been updated to update the pipe's state in a synchronized manner.
java.lang.String	toString()
void	writeToNBT(net.minecraft.nbt.NBTTagCompound nbt)

Methods inherited from class java.lang.Object

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

Constructor Detail

PipeImpl

public PipeImpl(PipeHost host,
                Face receivingFace,
                Face sendingFace,
                Port sendingPort)

Method Detail

step

public void step()

Called from the owning Casing after all Modules have been updated to update the pipe's state in a synchronized manner.

readFromNBT

public void readFromNBT(net.minecraft.nbt.NBTTagCompound nbt)

writeToNBT

public void writeToNBT(net.minecraft.nbt.NBTTagCompound nbt)

beginWrite

public void beginWrite(short value)

Description copied from interface: Pipe

Begin a writing operation on the pipe.

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

Specified by:

beginWrite in interface Pipe

Parameters:

value - the value to write to the pipe.

cancelWrite

public void cancelWrite()

Description copied from interface: Pipe

Cancel an active write operation.

If the pipe is not currently being written to this does nothing.

Specified by:

cancelWrite in interface Pipe

isWriting

public boolean isWriting()

Description copied from interface: Pipe

Whether the pipe is currently being written to.

This is true as soon as Pipe.beginWrite(short) was called and until Pipe.read() or Pipe.cancelWrite() was called to finish or cancel the operation.

Specified by:

isWriting in interface Pipe

Returns:

whether the pipe is currently being written to.

beginRead

public void beginRead()

Description copied from interface: Pipe

Begin a reading operation on the pipe.

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

Specified by:

beginRead in interface Pipe

cancelRead

public void cancelRead()

Description copied from interface: Pipe

Cancel an active read operation.

If the pipe is not currently being read from this does nothing.

Specified by:

cancelRead in interface Pipe

isReading

public boolean isReading()

Description copied from interface: Pipe

Whether the pipe is currently being read from.

This is true as soon as Pipe.beginRead() was called and until Pipe.read() or Pipe.cancelRead() was called to finish or cancel the operation.

Specified by:

isReading in interface Pipe

Returns:

whether the pipe is currently being read from.

canTransfer

public boolean canTransfer()

Description copied from interface: Pipe

Whether the pipe can transfer data, i.e. Pipe.read() can be called.

Note that this is not equivalent to Pipe.isReading() && Pipe.isWriting(). This is only true in the first update after that has been true and later.

Specified by:

canTransfer in interface Pipe

Returns:

whether the pipe can now transfer data.

read

public short read()

Description copied from interface: Pipe

Finish a read operation by fetching the data that is written by the write operation running at the same time.

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

This will cause Module.onWriteComplete(Port) to be called on the module currently writing to the pipe, then reset the pipe (i.e. call Pipe.cancelRead() and Pipe.cancelWrite()) prior to returning the read value.

Specified by:

read in interface Pipe

Returns:

the value transferred through the pipe.

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object