rcs.nml

Class NMLmsg

java.lang.Object

rcs.nml.NMLmsg

All Implemented Interfaces:

java.lang.Cloneable

Direct Known Subclasses:

NML_DISPLAY, NML_ERROR, NML_TEXT, RCS_CMD_MSG, RCS_STAT_MSG

public abstract class NMLmsg
extends java.lang.Object
implements java.lang.Cloneable

This is the abstract base class of all messages sent or recieved via NML.

Field Summary

Fields

Modifier and Type	Field and Description
protected long	size not used in Java
int	type Unique Identifier for the type of message

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	NMLmsg()
	NMLmsg(int _type) This constructor is to be used by derived types.

Method Summary

Modifier and Type	Method and Description
NMLmsg	clone()
void	update(NMLFormatConverter nml_fc) This function should be overloaded to provide a function that will convert this message to a nuetral format that can be used, by many different types of hosts.

Methods inherited from class java.lang.Object

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

Field Detail

type

public int type

Unique Identifier for the type of message

size

protected long size

not used in Java

Constructor Detail

NMLmsg

protected NMLmsg()

NMLmsg

public NMLmsg(int _type)

This constructor is to be used by derived types. Example:

 class MY_MSG extends NMLmsg
 {
       int i;
       double d;

       public MY_MSG()
       {
               super(1001);
       }
 }
 

Parameters:

_type - Unique Identifier for the type of message

Method Detail

update

public void update(NMLFormatConverter nml_fc)

This function should be overloaded to provide a function that will convert this message to a nuetral format that can be used, by many different types of hosts.

Parameters:

nml_fc - NMLFormatConverter that provides functions for updating all of the basic data types.

clone

public NMLmsg clone()
             throws java.lang.CloneNotSupportedException

Overrides:

clone in class java.lang.Object

Throws:

java.lang.CloneNotSupportedException