java.lang.Objectdiagapplet.CodeGen.DiagNMLMsgDict
public class DiagNMLMsgDict
* NMLMessageDictionaries allow the marshalling and unmarshalling of NML messages. They are generally created using the CodeGenerator and therefore have type information built in at compile-time. The Diag version must discover the type information at runtime.
| Field Summary | |
|---|---|
static boolean |
debug_on
When set to true debug_on enables extra calls to System.out for debugging. |
| Constructor Summary | |
|---|---|
DiagNMLMsgDict()
|
|
| Method Summary | |
|---|---|
void |
bytesNotUsed(int bytes_in_input_stream,
java.lang.String bufName,
boolean warn_given)
Used to log a warning message if the dictionary results do not match the expected input. |
static void |
ErrorPrint(java.lang.String s)
|
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. |
int |
get_failed_count()
Returns the number of errors that have occured related to this dictionary. |
long |
getEstimatedSize(int _type)
|
long |
getMaxEstimatedSize()
|
void |
miscError()
Log Information about this dictionary when generic NML error occurs. |
void |
miscError(java.lang.Exception e)
Log Information about this dictionary when NML error occurs with a related Exception called by NMLFormatConvertErrCallbackInterface |
void |
SetModuleInfoObject(ModuleInfoInterface o)
Used to set a ModuleInfo object, needed for this to function. |
void |
tokensNotUsed(int num_tokens,
java.lang.String input_string,
boolean warn_given)
Used to log a warning message if the dictionary results do not match the expected input. |
java.lang.String |
toString()
|
| Methods inherited from class java.lang.Object |
|---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait |
| Field Detail |
|---|
public static volatile boolean debug_on
| Constructor Detail |
|---|
public DiagNMLMsgDict()
| Method Detail |
|---|
public long getEstimatedSize(int _type)
getEstimatedSize in interface NMLMessageDictionarypublic long getMaxEstimatedSize()
getMaxEstimatedSize in interface NMLMessageDictionary
public void tokensNotUsed(int num_tokens,
java.lang.String input_string,
boolean warn_given)
DiagNMLMsgDictInterface
tokensNotUsed in interface DiagNMLMsgDictInterfacenum_tokens - -- number tokens in input_stringinput_string - -- comma delimited string to be parsedwarn_given - -- if already warned do not warn again.
public void bytesNotUsed(int bytes_in_input_stream,
java.lang.String bufName,
boolean warn_given)
DiagNMLMsgDictInterface
bytesNotUsed in interface DiagNMLMsgDictInterfacebytes_in_input_stream - -- number of bytes readbufName - -- NML buffer namewarn_given - -- if already warned do not warn again.public static void ErrorPrint(java.lang.String s)
public void miscError()
DiagNMLMsgDictInterface
miscError in interface DiagNMLMsgDictInterfacepublic void miscError(java.lang.Exception e)
DiagNMLMsgDictInterface
miscError in interface DiagNMLMsgDictInterfacepublic void SetModuleInfoObject(ModuleInfoInterface o)
DiagNMLMsgDictInterface
SetModuleInfoObject in interface DiagNMLMsgDictInterfacepublic int get_failed_count()
DiagNMLMsgDictInterface
get_failed_count in interface DiagNMLMsgDictInterfacepublic java.lang.String toString()
toString in class java.lang.Objectpublic int formatMsg(NMLFormatConverter NMLfc)
NMLMessageDictionary
formatMsg in interface NMLMessageDictionaryNMLfc - a format converter object which provides methods
for updating all the basic types and is used to update
the message, member-by-member.