Initializing help system before first use

# XPRMProblem

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

- All Implemented Interfaces:
    XPRMTyped

      public class XPRMProblem
      extends XPRMValue

  A problem object in Mosel.

- - ### 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`

  - ### Method Summary

    Modifier and Type | Method and Description
    --- | ---
    `XPRMProblem` | `asProblem()` A problem.
    `XPRMProblemComps` | `components()` Get an iterator to enumerate all components of the problem.
    `int` | `getStructCode()` Structure code.
    `java.lang.String` | `getStructName()` String representation of structure.
    `int` | `getTypeCode()` Type code.
    `java.lang.String` | `getTypeName()` String representation of type.
    `boolean` | `isInitialised()` Check whether the problem has been initialised.

    - ### Methods inherited from class com.dashoptimization.XPRMValue

      `asArray, asBoolean, asExternal, asInteger, asLinCtr, asList, asMPVar, asReal, asRecord, asSet, asString, asUnion, asUserTypeRef`

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

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

- - ### Method Detail

    - #### asProblem

          public final XPRMProblem asProblem()

      Description copied from class: `XPRMValue`
      A problem. This function is defined if the actual object is a problem.
      Overrides:
        `asProblem` in class `XPRMValue`
      Returns:
        The problem as a `XPRMProblem`

    - #### isInitialised

          public final boolean isInitialised()

      Check whether the problem has been initialised. Objects are initialised during model execution. Trying to access a Mosel object that has not been created will result on an exception.
      Returns:
        `true` if the problem has been created

    - #### components

          public XPRMProblemComps components()

      Get an iterator to enumerate all components of the problem.
      Returns:
        A problem component iterator

    - #### getTypeCode

          public final int getTypeCode()

      Description copied from interface: `XPRMTyped`
      Type code. The code is one of the `TYP_*` values.
      Returns:
        Encoded type

    - #### getTypeName

          public final java.lang.String getTypeName()

      Description copied from interface: `XPRMTyped`
      String representation of type.
      Returns:
        Type name

    - #### getStructCode

          public final int getStructCode()

      Description copied from interface: `XPRMTyped`
      Structure code. The code is one of the `STR_*` values.
      Returns:
        Encoded structure

    - #### getStructName

          public final java.lang.String getStructName()

      Description copied from interface: `XPRMTyped`
      String representation of structure.
      Returns:
        Structure name

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.