Class FMIRealType


  • public class FMIRealType
    extends FMIType
    An Functional Mock-up Interface type that represents a Real.

    A Functional Mock-up Unit file is a .fmu file in zip format that contains a .xml file named "modelDescription.xml". In that file, the ModelVariables element may contain elements such as ScalarVariable that in turn may contain elements like Real. This class represents the Real type.

    FMI documentation may be found at http://www.modelisar.com/fmi.html.

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

      Fields 
      Modifier and Type Field Description
      int indexState
      The state variable index that is set to the value of the "derivative" element.
      java.lang.Double nominal
      The nominal value of this real.
      java.lang.Double start
      The starting value of this real.
    • Constructor Summary

      Constructors 
      Constructor Description
      FMIRealType​(java.lang.String name, java.lang.String description, org.w3c.dom.Element element)
      Construct a Real FMU variable.
    • Method Summary

      All Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      java.lang.String toString()
      Return the string value of the base element.
      • Methods inherited from class java.lang.Object

        clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
    • Field Detail

      • indexState

        public int indexState
        The state variable index that is set to the value of the "derivative" element.
      • start

        public java.lang.Double start
        The starting value of this real.
      • nominal

        public java.lang.Double nominal
        The nominal value of this real.
    • Constructor Detail

      • FMIRealType

        public FMIRealType​(java.lang.String name,
                           java.lang.String description,
                           org.w3c.dom.Element element)
        Construct a Real FMU variable.
        Parameters:
        name - The name of this variable.
        description - A description of this variable.
        element - The XML element whose attributes are used to set the fields of this object.
    • Method Detail

      • toString

        public java.lang.String toString()
        Return the string value of the base element.
        Specified by:
        toString in class FMIType
        Returns:
        The string value. If the element does not have a start element, then the string "NaN" is returned.