RCS_STAT

Overview

Package

Class

Use

Deprecated

Index

Home >> All >> rcs >> [ nml overview ]

PREV CLASS NEXT CLASS

SUMMARY:

JAVADOC |

SOURCE |

DOWNLOAD | NESTED | FIELD | CONSTR | METHOD

DETAIL: FIELD | CONSTR | METHOD

rcs.nml
Class RCS_STAT_MSG

java.lang.Object
  rcs.nml.NMLmsg
      rcs.nml.RCS_STAT_MSG

All Implemented Interfaces:: java.lang.Cloneable

public class RCS_STAT_MSG
extends NMLmsg

Base class for NML status messages.

 Related Documentation: 
 RCS Library, NML Programmers Guide (Java Version)

 Source Code:
 RCS_STAT_MSG.java

Field Summary

int command_type
          Subordinates ussually set this to the type of the command they are currently executing or just completed.

int echo_serial_number
          Subordinates ussually set this to the serial_number of the command they are currently executing or just completed.

int line
          Modules that use simple state tables ussually provide the last line matched in the state table here.

static int RCS_DONE
          Value for status if the module has completed the last command it was given.

static int RCS_ERROR
          Value for status if the module has encountered an error.

static int RCS_EXEC
          Value for status if the module is still executing the last command it was given.

byte[] source_file
          Modules that use simple state tables may provide the name of the source file of the state table that is currently being used here.

int source_line
          Modules that use simple state tables ussually provide the last line matched in the state table here.

int state
          Modules that use simple state tables ussually provide the current state here.

int status
          The status of the module is ussually set to either UNINITIALIZED_STATUS, RCS_DONE, RCS_EXEC, or RCS_ERROR, depending on whether the module is currently executing a command or has encountered an error.

static int UNINITIALIZED_STATUS
          Value for status if the module has not yet been initialized.

Fields inherited from class rcs.nml.NMLmsg

size, type

Constructor Summary

RCS_STAT_MSG(int _type)
          Derived classes should use this constructor by placing super(_type) in the first line of thier constructors.

Method Summary

void update(NMLFormatConverter nml_fc)
          update function for the RCS_STAT_MSG members.

Methods inherited from class java.lang.Object

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

Field Detail

command_type

public int command_type

Subordinates ussually set this to the type of the command they are currently executing or just completed. The templates do this automatically.

echo_serial_number

public int echo_serial_number

Subordinates ussually set this to the serial_number of the command they are currently executing or just completed. The templates do this automatically.

UNINITIALIZED_STATUS

public static final int UNINITIALIZED_STATUS

Value for status if the module has not yet been initialized.

See Also:: Constant Field Values

RCS_DONE

public static final int RCS_DONE

Value for status if the module has completed the last command it was given.

See Also:: Constant Field Values

RCS_EXEC

public static final int RCS_EXEC

Value for status if the module is still executing the last command it was given.

See Also:: Constant Field Values

RCS_ERROR

public static final int RCS_ERROR

Value for status if the module has encountered an error.

See Also:: Constant Field Values

status

public int status

The status of the module is ussually set to either UNINITIALIZED_STATUS, RCS_DONE, RCS_EXEC, or RCS_ERROR, depending on whether the module is currently executing a command or has encountered an error. The templates do this automatically.

state

public int state

Modules that use simple state tables ussually provide the current state here. The templates do this automatically.

line

public int line

Modules that use simple state tables ussually provide the last line matched in the state table here. The line here is meant as the number of if(STATE_MATCH(...) encountered before one was true. The templates do this automatically.

source_line

public int source_line

Modules that use simple state tables ussually provide the last line matched in the state table here. The line here is meant as the line number in the source code of the if(STATE_MATCH( . . .) that was true. The templates do this automatically. The diagnostics tool uses this for the "state table" display.

source_file

public byte[] source_file

Modules that use simple state tables may provide the name of the source file of the state table that is currently being used here. The templates do this automatically. The diagnostics tool uses this for the "state table" display.

Constructor Detail

RCS_STAT_MSG

public RCS_STAT_MSG(int _type)

Derived classes should use this constructor by placing super(_type) in the first line of thier constructors.

Method Detail

update

public void update(NMLFormatConverter nml_fc)

update function for the RCS_STAT_MSG members. Derived classes that have data members that should be communicated should override this function and place super.update(nml_fc) in the first line.

Overrides:: update in class NMLmsg