Source code: rcs/nml/NMLMessageDictionary.java
1 package rcs.nml;
2
3 /**
4 * The NMLMessageDictionary interface is used to create
5 * custom message sets for NML. It's primary function is
6 * to match an integer type identifier with a particular
7 * message class and update the class.
8 *
9 * <pre>
10 * Related Documentation:
11 * <A HREF="http://isd.cme.nist.gov/proj/rcs_lib">RCS Library</a>, <A HREF="http://isd.cme.nist.gov/proj/rcs_lib/NMLjava.html">NML Programmers Guide (Java Version)</a>
12 *
13 * Source Code:
14 * <A HREF="NMLMessageDictionary.java">NMLMessageDictionary.java</a>
15 *
16 * </pre>
17 *
18 * @author Will Shackleford -- <A HREF="mailto:shackle@cme.nist.gov">shackle@cme.nist.gov</a>
19 *
20 */
21 public interface NMLMessageDictionary
22 {
23 /**
24 * This function should use NMLfc.type to select an
25 * object of the appropriate class, set NMLfc.msg_to_update
26 * to it, and call the objects update(NMLFormatConverter) function.
27 *
28 * @param NMLfc a format converter object which provides methods
29 * for updating all the basic types and is used to update
30 * the message, member-by-member.
31 *
32 * @return The function should return 0 if it is successful, -1
33 * otherwise.
34 */
35 public abstract int formatMsg(rcs.nml.NMLFormatConverter NMLfc);
36
37
38 }
39