Initializing help system before first use

XPRMUserType

  • java.lang.Object
    • com.dashoptimization.XPRMUserType
  • All Implemented Interfaces:
    XPRMIdentifier, XPRMTyped


    public class XPRMUserType
    extends java.lang.Object
    A user type.
    • Method Detail

      • fields

        public XPRMRecordFields fields()
        Get an iterator to enumerate all fields of a record.
        Returns:
        A field iterator if the type is a record, null otherwise
      • components

        public XPRMProblemComps components()
        Get an iterator to enumerate all components of the problem.
        Returns:
        A problem component iterator if the type is a problem, null otherwise
      • isProblem

        public boolean isProblem()
        Check whether the type is a problem.
        Returns:
        true if the type is a problem
      • 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
      • toString

        public java.lang.String toString()
        Overrides:
        toString in class  java.lang.Object
      • 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