Initializing help system before first use

# XPRMValue

- java.lang.Object
- - com.dashoptimization.XPRMValue

- All Implemented Interfaces:
    XPRMTyped
  Direct Known Subclasses:
    XPRMArray, XPRMList, XPRMProblem, XPRMRecord, XPRMReference, XPRMSet, XPRMUnion

      public abstract class XPRMValue
      extends java.lang.Object
      implements XPRMTyped

  A value (of any type) stored in Mosel. Depending on the type, one of the `as*` function is defined and gives access to the corresponding Java object.

- - ### Field Summary

    - ### Fields inherited from interface com.dashoptimization.XPRMTyped

      `GRP_DYN, GRP_GEN, MSK_FIX, MSK_GRP, MSK_STR, MSK_TYP, STR_ARRAY, STR_CONST, STR_CSREF, STR_LIST, STR_MEM, STR_NTYP, STR_PROB, STR_PROC, STR_REC, STR_REF, STR_SET, STR_UNION, STR_UTYP, TYP_BOOL, TYP_EXTN, TYP_INT, TYP_LINCTR, TYP_MPVAR, TYP_NOT, TYP_REAL, TYP_STRING`

  - ### Constructor Summary

    Constructor and Description
    `XPRMValue()`

  - ### Method Summary

    Modifier and Type | Method and Description
    --- | ---
    `XPRMArray` | `asArray()` An array.
    `boolean` | `asBoolean()` A Boolean.
    `XPRMExternal` | `asExternal()` An external type value.
    `int` | `asInteger()` An integer.
    `XPRMLinCtr` | `asLinCtr()` A linear constraint.
    `XPRMList` | `asList()` A list.
    `XPRMMPVar` | `asMPVar()` A decision variable.
    `XPRMProblem` | `asProblem()` A problem.
    `double` | `asReal()` A real.
    `XPRMRecord` | `asRecord()` A record.
    `XPRMSet` | `asSet()` A set.
    `java.lang.String` | `asString()` A string.
    `XPRMUnion` | `asUnion()` A union.
    `XPRMUserTypeRef` | `asUserTypeRef()` A reference to a user type.

    - ### Methods inherited from class java.lang.Object

      `equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait`

    - ### Methods inherited from interface com.dashoptimization.XPRMTyped

      `getStructCode, getStructName, getTypeCode, getTypeName`

- - ### Constructor Detail

    - #### XPRMValue

          public XPRMValue()

  - ### Method Detail

    - #### asInteger

          public int asInteger()

      An integer. This function is defined if the actual object is an integer.
      Returns:
        The integer value

    - #### asReal

          public double asReal()

      A real. This function is defined if the actual object is a real.
      Returns:
        The real value

    - #### asBoolean

          public boolean asBoolean()

      A Boolean. This function is defined if the actual object is a Boolean.
      Returns:
        The Boolean value

    - #### asString

          public java.lang.String asString()

      A string. This function is defined if the actual object is a string.
      Returns:
        The string value

    - #### asMPVar

          public XPRMMPVar asMPVar()

      A decision variable. This function is defined if the actual object is a decision variable.
      Returns:
        The decision variable as a `XPRMMPVar`

    - #### asLinCtr

          public XPRMLinCtr asLinCtr()

      A linear constraint. This function is defined if the actual object is a linear constraint.
      Returns:
        The linear constraint as a `XPRMLinCtr`

    - #### asExternal

          public XPRMExternal asExternal()

      An external type value. This function is defined if the actual object is of an external type.
      Returns:
        The reference as a `XPRMExternal`

    - #### asSet

          public XPRMSet asSet()

      A set. This function is defined if the actual object is a set.
      Returns:
        The set as a `XPRMSet`

    - #### asList

          public XPRMList asList()

      A list. This function is defined if the actual object is a list.
      Returns:
        The list as a `XPRMList`

    - #### asArray

          public XPRMArray asArray()

      An array. This function is defined if the actual object is an array.
      Returns:
        The list as a `XPRMArray`

    - #### asRecord

          public XPRMRecord asRecord()

      A record. This function is defined if the actual object is a record.
      Returns:
        The record as a `XPRMRecord`

    - #### asUnion

          public XPRMUnion asUnion()

      A union. This function is defined if the actual object is a union.
      Returns:
        The union as a `XPRMUnion`

    - #### asProblem

          public XPRMProblem asProblem()

      A problem. This function is defined if the actual object is a problem.
      Returns:
        The problem as a `XPRMProblem`

    - #### asUserTypeRef

          public XPRMUserTypeRef asUserTypeRef()

      A reference to a user type. This function is defined if the actual object is a reference to a user type.
      Returns:
        The reference as a `XPRMUserTypeRef`

Parent Topic Class Summary

© 2001-2026 Fair Isaac Corporation. All rights reserved. This documentation is the property of Fair Isaac Corporation (“FICO”). Receipt or possession of this documentation does not convey rights to disclose, reproduce, make derivative works, use, or allow others to use it except solely for internal evaluation purposes to determine whether to purchase a license to the software described in this documentation, or as otherwise set forth in a written software license agreement between you and FICO (or a FICO affiliate). Use of this documentation and the software described in it must conform strictly to the foregoing permitted uses, and no other use is permitted.