moves
Class Begin

java.lang.Object
  |
  +--moves.EuMove
        |
        +--moves.bracketFamily
              |
              +--moves.Begin

public class Begin

extends moves.bracketFamily

Implements the LEA command Begin

Field Summary

protected fundamentals.EuArguments

commandArguments

Fields inherited from class moves.EuMove

allowedSegments, in, out

Constructor Summary

Begin(interagents.finalWrapper in, interagents.finalWrapper out, fundamentals.EuArguments args, int beacon)
This constructor checks syntax and sets up the variables in, out, in.mode, out.mode

Method Summary

protected int	postprocess(interagents.EuLab lab, librarian.ppProcessor ppp) Performs various postprocessing of the move, updating the ppProcessor and changing segment.
protected void	preMain(librarian.ppProcessor ppp)
protected boolean	specialSegmentOK(int segment) Determines whether a call to this move is legal in the passed special segment.
java.lang.String	toString() Document the move

Methods inherited from class moves.EuMove

checkSegment, ex, executeMacro, executeMain, executeSegmentOnly, exMacro, exMain, getFirstOutIndex, initArguments, initBeacon, iobUsageChecks, issueBeacon, name, operationName, passExceptionDetails, passHintDetails, passSelection, postMacro, postMain, preMacro, preprocess

Methods inherited from class java.lang.Object

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

Field Detail

commandArguments

protected fundamentals.EuArguments commandArguments

Constructor Detail

Begin

public Begin(interagents.finalWrapper in,
             interagents.finalWrapper out,
             fundamentals.EuArguments args,
             int beacon)
      throws DesignException

This constructor checks syntax and sets up the variables in, out, in.mode, out.mode

Parameters:

in - the input @see finalWrapper

out - the output @see finalWrapper

args - arguments

beacon - a beacon, or 0 if no such was requested

Method Detail

specialSegmentOK

protected boolean specialSegmentOK(int segment)

Determines whether a call to this move is legal in the passed special segment. This instance always true.

Overrides:

specialSegmentOK in class EuMove

Parameters:

segment - the current segment

Returns:

true if a call to this move is legal in the passed special segment

postprocess

protected int postprocess(interagents.EuLab lab,
                          librarian.ppProcessor ppp)
                   throws LeaException

Performs various postprocessing of the move, updating the ppProcessor and changing segment.

Overrides:

postprocess in class EuMove

Parameters:

ppp - the ppProcessor to be updated

Returns:

the new segment, BEFORE_PREMISE

LeaException

preMain

protected void preMain(librarian.ppProcessor ppp)
                throws LeaException

Overrides:

preMain in class EuMove

LeaException

toString

public java.lang.String toString()

Description copied from class: EuMove

Document the move

Overrides:

toString in class EuMove

Returns:

a string in the format exemplified by (R2, P4)>>>ConstructCircle>>(C6!)