Initializing help system before first use

XPRMProcedure

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

    public class XPRMProcedure
extends java.lang.Object
    A procedure or function supplied by a module or implemented in a model.

    • Method Detail

      • getNbParameters

        public int getNbParameters()
        Get the number of parameters (arguments) expected by the subroutine.
        Returns:
        Number of parameters

      • getParameterTypes

        public java.lang.String getParameterTypes()
        Get the string of parameter types. This is a text string describing which arguments are expected by the function: it is its signature. This string is composed with the following characters:
        • i an integer;
        • r a real;
        • s a text string;
        • b a Boolean;
        • v a decision variable (type mpvar);
        • c a linear constraint (type linctr);
        • I a range set;
        • a an array (of any kind);
        • e a set (of any type);
        • |xxx| external type named 'xxx';
        • !xxx! the set named 'xxx';
        • Andx.t an array indexed by 'ndx' of the type 't'. 'ndx' is a string describing the type of each indexing set. 'ndx' may be omitted, in which case any array of type 't' is a valid parameter;
        • Et a set of type 't'.
        For instance, the procedure:
        proc(n:integer, tab:array(range, set of real, myset) of string, flag:boolean)
        has the signature 'iAIr!myset!.sb'.
        Returns:
        String describing type of parameters

      • next

        public XPRMProcedure next()
        Get the next overloaded version of the subroutine (model routine only). A subroutine may be defined several times in a model with different sets of arguments. This function gives access to all the defined overloaded versions of a subroutine.
        Returns:
        The next procedure or null if the procedure is not overloaded or comes from a module

      • findLocation

        public XPRMLocation findLocation()
        Find the location of the procedure in the source.
        Returns:
        The location of the procedure or null if no debugging information is available or the procedure comes from a module

      • 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

      • getTypeName

        public final java.lang.String getTypeName()
        Description copied from interface: XPRMTyped
        String representation of type.
        Specified by:
        getTypeName in interface  XPRMTyped
        Returns:
        Type 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