packages/xdc/rta/IEventMetaData.java

package xdc.rta;

import org.w3c.dom.Node;

/*
 *  ======== IEventMetaData ========
 *  This interface is used by a HostEvent to retrieve what it needs to decode
 *  itself. 
 *  An interface has been defined here to allow for multiple implementations.
 *  In RTA, the interface is implemented by the xdc.rta.MetaData class which
 *  wraps the RTA XML file.
 *  In ROV, the interface is implemented by xdc.runtime.Log APIs which 
 *  reference the ROV recap file.
 */
public interface IEventMetaData {
    
    /*
     *  ======== getOFReader ========
     */
    public IOFReader getOFReader();
	
    /*
     *  ======== lookupEventMessage ========
     *  Returns the format string for the message with the given name.
     */
    public String lookupEventMessage(int eventId);

    /*
     *  ======== getTargetArgSize ========
     *  Returns the target size of a record argument in bytes (not MAUs).
     */
    public int getTargetArgSize();
		
    /*
     *  ======== lookupEventName ========
     */
    public String lookupEventName(int eventId);

    /*
     *  ======== lookupModuleName ========
     */
    public String lookupModuleName(int modId);

    /*
     *  ======== getTargetEventRecSize ========
     *  Returns the record size in bytes (not MAUs).
     */
    public int getTargetEventRecSize();
	
    /*
     *  ======== getLoggerMetaArgs ========
     *  Returns the meta data associated with the specified logger instance.
     */
    public Node getLoggerMetaArgs(int loggerId);
}