|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectrcs.nml.NMLmsg
rcs.nml.RCS_STAT_MSG
public class RCS_STAT_MSG
Base class for NML status messages.
Related Documentation: RCS Library, NML Programmers Guide (Java Version)
Field Summary | |
---|---|
long |
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 NML_ENUM_INFO |
nml_enum_info_for_RCS_STATUS
|
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 | |
---|---|
protected |
RCS_STAT_MSG()
|
|
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 rcs.nml.NMLmsg |
---|
clone |
Methods inherited from class java.lang.Object |
---|
equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Field Detail |
---|
public static NML_ENUM_INFO nml_enum_info_for_RCS_STATUS
public long command_type
public int echo_serial_number
public static final int UNINITIALIZED_STATUS
public static final int RCS_DONE
public static final int RCS_EXEC
public static final int RCS_ERROR
public int status
public int state
public int line
public int source_line
public byte[] source_file
Constructor Detail |
---|
protected RCS_STAT_MSG()
public RCS_STAT_MSG(int _type)
_type
- the integer identifier of the derived classMethod Detail |
---|
public void update(NMLFormatConverter nml_fc)
update
in class NMLmsg
nml_fc
- the NMLFormatConverter used to convert basic
data types to neutral formats and back.
|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |