rcs.nml

Interface NMLMessageDictionary

All Known Subinterfaces:

DiagNMLMsgDictInterface

All Known Implementing Classes:

DiagNMLMsgDict, errlogMsgDict

public interface NMLMessageDictionary

The NMLMessageDictionary interface is used to create custom message sets for NML. It's primary function is to match an integer type identifier with a particular message class and update the class.

Method Summary

Modifier and Type	Method and Description
int	formatMsg(NMLFormatConverter NMLfc) 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()

Method Detail

formatMsg

int formatMsg(NMLFormatConverter NMLfc)

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.

Parameters:

NMLfc - 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.

getEstimatedSize

long getEstimatedSize(int _type)

getMaxEstimatedSize

long getMaxEstimatedSize()