Package com.hexaly.modeler

Enum HxmType

  • All Implemented Interfaces:
    java.io.Serializable, java.lang.Comparable<HxmType>
    public enum HxmType
extends java.lang.Enum<HxmType>
    Modeler types available in this API.

    • Enum Constant Summary

      Enum Constants 
      Enum Constant Description
      Double
      Double precision floating point numbers (stored on 64 bits) in IEEE 754 binary floating point representation.
      Expression
      HxExpressions are the variables and the expressions of the mathematical model defined by the modeling program or directly in the Hexaly Optimizer API.
      Function
      Function of the modeler.
      Int
      Integers are positive and negative integral numbers stored on 64 bits.
      Map
      Maps are data structure matching some values to some keys.
      Module
      A module is a collection of global variables.
      Nil
      Nil is the equivalent of null in Java.
      Other
      Any other value used in the modeler but not exposed in this API (dates, files or streams for example).
      String
      A string is an immutable sequence of unicode characters.

    • Method Summary

      All Methods Static Methods Concrete Methods 
      Modifier and Type Method Description
      static HxmType valueOf​(java.lang.String name)
      Returns the enum constant of this type with the specified name.
      static HxmType[] values()
      Returns an array containing the constants of this enum type, in the order they are declared.

      • Methods inherited from class java.lang.Enum

        compareTo, equals, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

      • Methods inherited from class java.lang.Object

        getClass, notify, notifyAll, wait, wait, wait

    • Enum Constant Detail

      • Nil

        public static final HxmType Nil
        Nil is the equivalent of null in Java. The single value of this type is accessed through the keyword nil in Hexaly Modeler. It is used to signify the absence of a value. Nil is the default returned value for functions that don’t explicitly return anything. It’s also the default value assigned by the modeler to every global and local variable.

      • Int

        public static final HxmType Int
        Integers are positive and negative integral numbers stored on 64 bits. They are created by integer literals or returned as results of arithmetic operations.

      • Double

        public static final HxmType Double
        Double precision floating point numbers (stored on 64 bits) in IEEE 754 binary floating point representation. They are created by floating point literals or returned as results of arithmetic operations.

      • String

        public static final HxmType String
        A string is an immutable sequence of unicode characters.

      • Expression

        public static final HxmType Expression
        HxExpressions are the variables and the expressions of the mathematical model defined by the modeling program or directly in the Hexaly Optimizer API.

      • Function

        public static final HxmType Function

        Function of the modeler. The modeler treats functions as first-class citizens. In other words, a function is a value with a particular type. Thus, functions can be passed as arguments to other functions, can be assigned to variables or returned by other functions.

        A function can be written using the Hexaly modeling language (user-defined function) or can be a function written in Java and exposed to the modeler.

      • Map

        public static final HxmType Map
        Maps are data structure matching some values to some keys. This is the main data structure in the modeler that can also be used as an array-like structure.

      • Module

        public static final HxmType Module
        A module is a collection of global variables. Modules are used to group functions together and import them dynamically at runtime. The I/O library is an example of a module. Each HXM file is a module.

      • Other

        public static final HxmType Other
        Any other value used in the modeler but not exposed in this API (dates, files or streams for example).

    • Method Detail

      • values

        public static HxmType[] values()
        Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows: 
        for (HxmType c : HxmType.values())
    System.out.println(c);
        Returns:
        an array containing the constants of this enum type, in the order they are declared

      • valueOf

        public static HxmType valueOf​(java.lang.String name)
        Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)
        Parameters:
        name - the name of the enum constant to be returned.
        Returns:
        the enum constant with the specified name
        Throws:
        java.lang.IllegalArgumentException - if this enum type has no constant with the specified name
        java.lang.NullPointerException - if the argument is null