rcs.nml

Class errlogMsgDict

java.lang.Object

rcs.nml.errlogMsgDict

All Implemented Interfaces:

NMLMessageDictionary

public class errlogMsgDict
extends java.lang.Object
implements NMLMessageDictionary

Implements an NML message dictionary for a set of messages usually used for logging errors and/or communication with a generic operator interface.

Field Summary

Fields

Modifier and Type	Field and Description
static int	NML_DISPLAY_TYPE
static int	NML_ERROR_TYPE
static int	NML_TEXT_TYPE

Constructor Summary

Constructors

Constructor and Description
errlogMsgDict()

Method Summary

Modifier and Type	Method and Description
int	formatMsg(NMLFormatConverter nml_fc) This function should use NMLfc.type to select an object of the appropriate class, set NMLfc.msg_to_update to it, and call the objects update(NMLFormatConverter) function.
long	getEstimatedSize(int _type)
long	getMaxEstimatedSize()

Methods inherited from class java.lang.Object

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

Field Detail

NML_DISPLAY_TYPE

public static final int NML_DISPLAY_TYPE

See Also:

Constant Field Values

NML_ERROR_TYPE

public static final int NML_ERROR_TYPE

See Also:

Constant Field Values

NML_TEXT_TYPE

public static final int NML_TEXT_TYPE

See Also:

Constant Field Values

Constructor Detail

errlogMsgDict

public errlogMsgDict()

Method Detail

getEstimatedSize

public long getEstimatedSize(int _type)

Specified by:

getEstimatedSize in interface NMLMessageDictionary

getMaxEstimatedSize

public long getMaxEstimatedSize()

Specified by:

getMaxEstimatedSize in interface NMLMessageDictionary

formatMsg

public int formatMsg(NMLFormatConverter nml_fc)

Description copied from interface: NMLMessageDictionary

This function should use NMLfc.type to select an object of the appropriate class, set NMLfc.msg_to_update to it, and call the objects update(NMLFormatConverter) function.

Specified by:

formatMsg in interface NMLMessageDictionary

Parameters:

nml_fc - a format converter object which provides methods for updating all the basic types and is used to update the message, member-by-member.

Returns:

The function should return 0 if it is successful, -1 otherwise.