net.cscott.sdr.calls.ast
Enum Prim.Flag

java.lang.Object
  java.lang.Enum<Prim.Flag>
      net.cscott.sdr.calls.ast.Prim.Flag

All Implemented Interfaces:

Serializable, Comparable<Prim.Flag>

Enclosing class:

Prim

public static enum Prim.Flag
extends Enum<Prim.Flag>

The Prim.Flag enumeration represents various properties of the movement described by this Prim.

Enum Constant Summary

FORCE_ARC
The FORCE_ARC flag helps distinguish between (say) "pass thru and quarter in" and "split counter rotate 1/4".

FORCE_ROLL_LEFT
Set the roll direction to the left after this Prim, even if the movement doesn't call for it.

FORCE_ROLL_NONE
Set the roll direction to "none" after this Prim, even if the movement seems to call for a roll.

FORCE_ROLL_RIGHT
Set the roll direction to the right after this Prim, even if the movement doesn't call for it.

NO_HANDS
In a do-sa-do, you don't join hands at the 1/4 and 3/4 marks, even though you are adjacent.

PASS_LEFT
This flag indicates that this motion involves a left shoulder pass (left/mirror concepts, "cross" calls which start with adjacent crossers, etc).

PRESERVE_ROLL
Keep the roll direction from the previous path.

PRESERVE_SWEEP
Keep the sweep direction from the previous path.

SASHAY_FINISH
Finish the movement with a sashay (instead of a forward step).

SASHAY_START
Begin the movement with a sashay (instead of stepping forward).

SKIRT_WORK
Heaven help me, someday I might implement "ladies in, men sashay."

Method Summary

static String	canon(String s) Normalize a Prim.Flag name: convert to uppercase, and convert dashes to underscores.
static boolean	contains(String s) Returns true iff the given string names a valid Prim.Flag.
static Prim.Flag	valueOf(String name) Returns the enum constant of this type with the specified name.
static Prim.Flag[]	values() Returns an array containing the constants of this enum type, in the order they are declared.

Methods inherited from class java.lang.Enum

clone, compareTo, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Detail

PASS_LEFT

public static final Prim.Flag PASS_LEFT

This flag indicates that this motion involves a left shoulder pass (left/mirror concepts, "cross" calls which start with adjacent crossers, etc). Lack of this flag indicates that, like most motions, a right shoulder pass is to be used (for example, for "cross" calls where the crossers start far apart).

FORCE_ARC

public static final Prim.Flag FORCE_ARC

The FORCE_ARC flag helps distinguish between (say) "pass thru and quarter in" and "split counter rotate 1/4". Both of these involve traveling forward and turning, but the latter is an arcing motion (hence FORCE_ARC would be set) while the former is a straight line path (hence FORCE_ARC would not be set).

FORCE_ROLL_RIGHT

public static final Prim.Flag FORCE_ROLL_RIGHT

Set the roll direction to the right after this Prim, even if the movement doesn't call for it. (Useful in circle left definition, left cross chain thru, etc.)

FORCE_ROLL_LEFT

public static final Prim.Flag FORCE_ROLL_LEFT

Set the roll direction to the left after this Prim, even if the movement doesn't call for it. (Useful in circle right definition, cross chain thru, etc.)

FORCE_ROLL_NONE

public static final Prim.Flag FORCE_ROLL_NONE

Set the roll direction to "none" after this Prim, even if the movement seems to call for a roll.

PRESERVE_ROLL

public static final Prim.Flag PRESERVE_ROLL

Keep the roll direction from the previous path.

PRESERVE_SWEEP

public static final Prim.Flag PRESERVE_SWEEP

Keep the sweep direction from the previous path.

SASHAY_START

public static final Prim.Flag SASHAY_START

Begin the movement with a sashay (instead of stepping forward).

SASHAY_FINISH

public static final Prim.Flag SASHAY_FINISH

Finish the movement with a sashay (instead of a forward step).

NO_HANDS

public static final Prim.Flag NO_HANDS

In a do-sa-do, you don't join hands at the 1/4 and 3/4 marks, even though you are adjacent.

SKIRT_WORK

public static final Prim.Flag SKIRT_WORK

Heaven help me, someday I might implement "ladies in, men sashay."

Method Detail

values

public static Prim.Flag[] values()

Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows:

for (Prim.Flag c : Prim.Flag.values())
    System.out.println(c);

Returns:

an array containing the constants of this enum type, in the order they are declared

valueOf

public static Prim.Flag valueOf(String name)

Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)

Parameters:

name - the name of the enum constant to be returned.

Returns:

the enum constant with the specified name

Throws:

IllegalArgumentException - if this enum type has no constant with the specified name

NullPointerException - if the argument is null

contains

public static boolean contains(String s)

Returns true iff the given string names a valid Prim.Flag.

canon

public static String canon(String s)

Normalize a Prim.Flag name: convert to uppercase, and convert dashes to underscores.