rcs.utils
Class rcs_states

java.lang.Object
  extended by rcs.utils.rcs_states

public class rcs_states
extends java.lang.Object


Field Summary
static int ADMIN_INITIALIZED
           
static int ADMIN_SHUT_DOWN
           
static int ADMIN_UNINITIALIZED
           
static int NEW_COMMAND
           
static int NOP_STATE
           
static int RCS_ADMIN_ZERO
           
static int S0
           
static int S1
           
static int S10
           
static int S11
           
static int S12
           
static int S13
           
static int S14
           
static int S15
           
static int S16
           
static int S17
           
static int S18
           
static int S2
           
static int S3
           
static int S4
           
static int S5
           
static int S6
           
static int S7
           
static int S8
           
static int S9
           
static int SE0
           
static int SE1
           
static int SE2
           
static int SE3
           
static int SE4
           
static int SE5
           
static int SE6
           
static int SE7
           
static int SE8
           
static int SE9
           
static int UNINITIALIZED_STATE
           
 
Constructor Summary
rcs_states()
           
 
Method Summary
static java.lang.String printWhereAmI()
          Get a formatted stack trace.
static void state_default(RCS_STAT_MSG stat)
          Sets the stat.source_line and stat.source_file, called when all state_match()'s fail.
static boolean state_match(RCS_STAT_MSG stat, int stateIn)
          Checks stat.state == stateIn and sets the source_file and source line so that one can check which line of the state table matched.
static void state_new(RCS_STAT_MSG stat)
          Sets the source file and source line.
static void state_next(RCS_STAT_MSG stat, int next)
          Sets stat.state to the next state.
static void status_next(RCS_STAT_MSG stat, int next)
          Sets stat.status to the next status
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

RCS_ADMIN_ZERO

public static final int RCS_ADMIN_ZERO
See Also:
Constant Field Values

ADMIN_UNINITIALIZED

public static final int ADMIN_UNINITIALIZED
See Also:
Constant Field Values

ADMIN_INITIALIZED

public static final int ADMIN_INITIALIZED
See Also:
Constant Field Values

ADMIN_SHUT_DOWN

public static final int ADMIN_SHUT_DOWN
See Also:
Constant Field Values

UNINITIALIZED_STATE

public static final int UNINITIALIZED_STATE
See Also:
Constant Field Values

NEW_COMMAND

public static final int NEW_COMMAND
See Also:
Constant Field Values

NOP_STATE

public static final int NOP_STATE
See Also:
Constant Field Values

SE0

public static final int SE0
See Also:
Constant Field Values

SE1

public static final int SE1
See Also:
Constant Field Values

SE2

public static final int SE2
See Also:
Constant Field Values

SE3

public static final int SE3
See Also:
Constant Field Values

SE4

public static final int SE4
See Also:
Constant Field Values

SE5

public static final int SE5
See Also:
Constant Field Values

SE6

public static final int SE6
See Also:
Constant Field Values

SE7

public static final int SE7
See Also:
Constant Field Values

SE8

public static final int SE8
See Also:
Constant Field Values

SE9

public static final int SE9
See Also:
Constant Field Values

S0

public static final int S0
See Also:
Constant Field Values

S1

public static final int S1
See Also:
Constant Field Values

S2

public static final int S2
See Also:
Constant Field Values

S3

public static final int S3
See Also:
Constant Field Values

S4

public static final int S4
See Also:
Constant Field Values

S5

public static final int S5
See Also:
Constant Field Values

S6

public static final int S6
See Also:
Constant Field Values

S7

public static final int S7
See Also:
Constant Field Values

S8

public static final int S8
See Also:
Constant Field Values

S9

public static final int S9
See Also:
Constant Field Values

S10

public static final int S10
See Also:
Constant Field Values

S11

public static final int S11
See Also:
Constant Field Values

S12

public static final int S12
See Also:
Constant Field Values

S13

public static final int S13
See Also:
Constant Field Values

S14

public static final int S14
See Also:
Constant Field Values

S15

public static final int S15
See Also:
Constant Field Values

S16

public static final int S16
See Also:
Constant Field Values

S17

public static final int S17
See Also:
Constant Field Values

S18

public static final int S18
See Also:
Constant Field Values
Constructor Detail

rcs_states

public rcs_states()
Method Detail

printWhereAmI

public static java.lang.String printWhereAmI()
Get a formatted stack trace.

Returns:
String with formatted stack trace.

state_match

public static boolean state_match(RCS_STAT_MSG stat,
                                  int stateIn)
Checks stat.state == stateIn and sets the source_file and source line so that one can check which line of the state table matched.

Parameters:
stat - The status message to be written out via NML.
stateIn - state to check, (NEW_COMMAND, or one of the S? values defined above.)
Returns:
stat.state == stateIn

state_new

public static void state_new(RCS_STAT_MSG stat)
Sets the source file and source line. (seems a little redundant especially if you just called state_match())

Parameters:
stat -

state_next

public static void state_next(RCS_STAT_MSG stat,
                              int next)
Sets stat.state to the next state.

Parameters:
stat -
next - (NEW_COMMAND, or one of the S* constants in this class.)

status_next

public static void status_next(RCS_STAT_MSG stat,
                               int next)
Sets stat.status to the next status

Parameters:
stat -
next -

state_default

public static void state_default(RCS_STAT_MSG stat)
Sets the stat.source_line and stat.source_file, called when all state_match()'s fail.

Parameters:
stat -