Package com.hexaly.modeler

Enum Class HxmType

java.lang.Object
java.lang.Enum<HxmType>
com.hexaly.modeler.HxmType
All Implemented Interfaces:
Serializable, Comparable<HxmType>, Constable
public enum HxmType extends Enum<HxmType>
Modeler types available in this API.

  • Nested Class Summary

    Nested classes/interfaces inherited from class java.lang.Enum

    Enum.EnumDesc<E extends Enum<E>>

  • Enum Constant Summary

    Enum Constants
    Enum Constant
    Description
    Class
    Classes are used to group together data and functions.
    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

    Modifier and Type
    Method
    Description
    static HxmType
    valueOf(String name)
    Returns the enum constant of this class with the specified name.
    static HxmType[]
    values()
    Returns an array containing the constants of this enum class, in the order they are declared.

    Methods inherited from class java.lang.Enum

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

    Methods inherited from class java.lang.Object

    getClass, notify, notifyAll, wait, wait, wait

  • Enum Constant Details

    • 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.

    • Class

      public static final HxmType Class
      Classes are used to group together data and functions. They are the templates used to create objects. In the modeler, all values that are not integers, doubles or the special value nil are objects. Each object has an associated class (which is itself an object).

    • 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 Details

    • values

      public static HxmType[] values()
      Returns an array containing the constants of this enum class, in the order they are declared.
      Returns:
      an array containing the constants of this enum class, in the order they are declared

    • valueOf

      public static HxmType valueOf(String name)
      Returns the enum constant of this class with the specified name. The string must match exactly an identifier used to declare an enum constant in this class. (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:
      IllegalArgumentException - if this enum class has no constant with the specified name
      NullPointerException - if the argument is null