Initializing help system before first use

# XPRMNativeType

- java.lang.Object
- - com.dashoptimization.XPRMNativeType

- All Implemented Interfaces:
    XPRMIdentifier, XPRMTyped

      public class XPRMNativeType
      extends java.lang.Object

  A native type (published by a module).

- - ### 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
    --- | ---
    `int` | `getFlag()` Get the flag property of the type.
    `java.lang.String` | `getName()` Get the identifier name.
    `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` | `hasAppend()` Check whether the 'copy' operator supports 'append'.
    `boolean` | `hasBinary()` Check whether the type can be stored in binary form.
    `boolean` | `hasCompare()` Check whether the type publishes a 'compare' operator.
    `boolean` | `hasConst()` Check whether the type supports constant definition.
    `boolean` | `hasCopy()` Check whether the type publishes a 'copy' operator.
    `boolean` | `hasCreate()` Check whether the type publishes a default constructor.
    `boolean` | `hasDelete()` Check whether the type publishes a destructor.
    `boolean` | `hasFromString()` Check whether the type publishes a 'fromstring' initialiser.
    `boolean` | `hasPRTBL()` Check whether 'tostring' function can be called after execution.
    `boolean` | `hasRefCount()` Check whether the type supports reference counting.
    `boolean` | `hasResetOnly()` Check whether the type only supports 'reset'.
    `boolean` | `hasShare()` Check whether the type can be shared.
    `boolean` | `hasToString()` Check whether the type publishes a 'tostring' converter.
    `boolean` | `isOrdered()` Check whether the type is ordered.
    `boolean` | `isProblem()` Check whether the type is a problem.
    `java.lang.String` | `toString()` Name of the type.

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

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

- - ### Method Detail

    - #### getFlag

          public int getFlag()

      Get the flag property of the type. This flag is the bit encoded version of all the properties of the type. These properties may also be retrieved using `has*` methods of this class.
      Returns:
        Bit encoded version of the type properties

    - #### hasCreate

          public boolean hasCreate()

      Check whether the type publishes a default constructor.
      Returns:
        `true` if the 'create' function is available for this type

    - #### hasDelete

          public boolean hasDelete()

      Check whether the type publishes a destructor.
      Returns:
        `true` if the 'delete' function is available for this type

    - #### hasRefCount

          public boolean hasRefCount()

      Check whether the type supports reference counting.
      Returns:
        `true` if both 'create' and 'delete' functions are available and support reference counting

    - #### hasToString

          public boolean hasToString()

      Check whether the type publishes a 'tostring' converter.
      Returns:
        `true` if the 'tostring' function is available for this type

    - #### hasFromString

          public boolean hasFromString()

      Check whether the type publishes a 'fromstring' initialiser.
      Returns:
        `true` if the 'fromstring' function is available for this type

    - #### hasResetOnly

          public boolean hasResetOnly()

      Check whether the type only supports 'reset'.
      Returns:
        `true` if only the operation 'reset' is supported by the 'copy' operator

    - #### hasCopy

          public boolean hasCopy()

      Check whether the type publishes a 'copy' operator.
      Returns:
        `true` if the 'copy' function is available for this type

    - #### hasAppend

          public boolean hasAppend()

      Check whether the 'copy' operator supports 'append'.
      Returns:
        `true` if the 'copy' function of this type supports 'append'

    - #### hasCompare

          public boolean hasCompare()

      Check whether the type publishes a 'compare' operator.
      Returns:
        `true` if the 'compare' function is available for this type

    - #### hasPRTBL

          public boolean hasPRTBL()

      Check whether 'tostring' function can be called after execution.
      Returns:
        `true` if 'tostring' function can be called after execution

    - #### isProblem

          public boolean isProblem()

      Check whether the type is a problem.
      Returns:
        `true` if the type is a problem

    - #### hasShare

          public boolean hasShare()

      Check whether the type can be shared.
      Returns:
        `true` if the type supports sharing

    - #### hasBinary

          public boolean hasBinary()

      Check whether the type can be stored in binary form.
      Returns:
        `true` if the type supports binary import/export

    - #### isOrdered

          public boolean isOrdered()

      Check whether the type is ordered.
      Returns:
        `true` if the type is ordered

    - #### hasConst

          public boolean hasConst()

      Check whether the type supports constant definition.
      Returns:
        `true` if the type supports constant definition

    - #### toString

          public java.lang.String toString()

      Name of the type.
      Overrides:
        `toString` in class `java.lang.Object`
      Returns:
        Name of the type as a string

    - #### getTypeName

          public java.lang.String getTypeName()

      Description copied from interface: `XPRMTyped`
      String representation of type.
      Specified by:
        `getTypeName` in interface `XPRMTyped`
      Returns:
        Type name

    - #### getStructCode

          public int getStructCode()

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

    - #### getStructName

          public java.lang.String getStructName()

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

    - #### getTypeCode

          public final int getTypeCode()

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

    - #### getName

          public java.lang.String getName()

      Description copied from interface: `XPRMIdentifier`
      Get the identifier name.
      Specified by:
        `getName` in interface `XPRMIdentifier`
      Returns:
        The identifier 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.