Class FMULog


  • public class FMULog
    extends java.lang.Object
    A Functional Mock-up Interface (FMI) log method implementation.

    This Java method is called via a callback from the FMI C-side. The FMI log method optionally takes a variable number of arguments and handles #TypevalueReference#, specially where Type is one of r, i, b or s. To print a #, use ##.

    Since:
    Ptolemy II 10.0
    Version:
    $Id$
    Author:
    Christopher Brooks
    Pt.AcceptedRating:
    Red (cxh)
    Pt.ProposedRating:
    Red (cxh)
    • Constructor Summary

      Constructors 
      Constructor Description
      FMULog()  
    • Method Summary

      All Methods Static Methods Concrete Methods 
      Modifier and Type Method Description
      static void log​(FMIModelDescription modelDescription, com.sun.jna.Pointer fmiComponentOrEnvironment, java.lang.String instanceName, int status, java.lang.String category, java.lang.String message)
      Log a message.
      • Methods inherited from class java.lang.Object

        clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
    • Constructor Detail

      • FMULog

        public FMULog()
    • Method Detail

      • log

        public static void log​(FMIModelDescription modelDescription,
                               com.sun.jna.Pointer fmiComponentOrEnvironment,
                               java.lang.String instanceName,
                               int status,
                               java.lang.String category,
                               java.lang.String message)
        Log a message. Note that arguments after the message are currently ignored.
        Parameters:
        modelDescription - The model description that contains the names of the variables. In FMI-1.0, the FMI specification states that the variable names might not be stored in the C-functions, which is why we can't just use the second argument, which is a fmiComponent. In FMI-2.0, the second argumet is a fmiComponentEnvironment.
        fmiComponentOrEnvironment - The component that was instantiated or its environment.
        instanceName - The name of the instance of the FMU.
        status - The fmiStatus, see FMILibrary.FMIStatus
        category - The category of the message, defined by the tool that created the fmu. Typical values are "log" or "error".
        message - The message in printf format