Initializing help system before first use

XPRSnamelist

  • All Implemented Interfaces:
    java.lang.AutoCloseable 

    public class XPRSnamelist
extends XPRSobject
    Class allowing access to a name list

    • Constructor Detail

      • XPRSnamelist

        public XPRSnamelist()
             throws XPRSexception
        Creates a new name list managed by the optimizer. XPRS.Init must have been called first.
        Throws:
        XPRSexception

    • Method Detail

      • getNames

        public void getNames(int padlen,
                     java.lang.String[] buf,
                     int firstIndex,
                     int lastIndex)
              throws XPRSexception
        Throws:
        XPRSexception

      • getNames

        public void getNames(java.lang.String[] buf,
                     int firstIndex,
                     int lastIndex)
              throws XPRSexception
        Throws:
        XPRSexception

      • addNames

        public void addNames(java.lang.String[] buf,
                     int firstIndex,
                     int lastIndex)
              throws XPRSexception
        Throws:
        XPRSexception

      • close

        public void close()
        Description copied from class: XPRSobject
        Deallocates resources associated with an XPRSobject.
        Specified by:
        close in interface  java.lang.AutoCloseable
        Specified by:
        close in class  XPRSobject

      • removeNames

        public void removeNames(int first,
                        int last)
                 throws XPRSexception
        The XPRS_nml_* functions provide a simple, generic interface to lists of names, which may be names of rows/columns on a problem or may be a list of arbitrary names provided by the user. nml_RemoveNames will remove the specified names from the name list. Any subsequent names will be moved down to replace the removed names.
        Parameters:
        first - The index of the first name to remove. Note that indices for names in a name list always start from 0.
        last - The index of the last name to remove.
        Throws:
        XPRSexception

      • findName

        public void findName(java.lang.String name,
                     IntHolder p_index)
              throws XPRSexception
        The XPRS_nml_* functions provide a simple, generic interface to lists of names, which may be names of rows/columns on a problem or may be a list of arbitrary names provided by the user. nml_FindName returns the index of the given name in the given name list.
        Parameters:
        name - Null-terminated string containing the name for which to search.
        p_index - Pointer to variable in which the index of the name is returned, or in which is returned -1 if the name is not found in the namelist.
        Throws:
        XPRSexception

      • copyNames

        public void copyNames(XPRSnamelist src)
               throws XPRSexception
        The XPRS_nml_* functions provide a simple, generic interface to lists of names, which may be names of rows/columns on a problem or may be a list of arbitrary names provided by the user. nml_CopyNames allows you to copy all the names from one name list to another. As name lists representing row/column names cannot be modified, nml_CopyNames will be most often used to copy such names to a namelist where they can be modified, for some later use.
        Parameters:
        src - The namelist object from which all the names should be copied.
        Throws:
        XPRSexception

      • addMsgHandlerListener

        public void addMsgHandlerListener(XPRSmsgHandlerListener listener)
                           throws XPRSexception
        Add a listener for the MsgHandler callback. Note that an object can have multiple MsgHandler listeners.
        Specified by:
        addMsgHandlerListener in class  XPRSobject
        Parameters:
        listener - The listener to which the event will be dispatched. (If null, all MsgHandler listeners will be removed.)
        Throws:
        XPRSexception

      • addMsgHandlerListener

        public void addMsgHandlerListener(XPRSmsgHandlerListener listener,
                                  java.lang.Object data)
                           throws XPRSexception
        Add a listener for the MsgHandler callback. Note that an object can have multiple MsgHandler listeners.
        Specified by:
        addMsgHandlerListener in class  XPRSobject
        Parameters:
        listener - The listener to which the event will be dispatched. (If null, all MsgHandler listeners will be removed.)
        data - An additional object which will be passed down to the callback function
        Throws:
        XPRSexception

      • addMsgHandlerListener

        public void addMsgHandlerListener(XPRSmsgHandlerListener listener,
                                  int priority)
                           throws XPRSexception
        Add a listener for the MsgHandler callback. Note that an object can have multiple MsgHandler listeners.
        Parameters:
        listener - The listener to which the event will be dispatched. (If null, all MsgHandler listeners will be removed.)
        priority - Listeners with higher priorities are called first
        Throws:
        XPRSexception

      • addMsgHandlerListener

        public void addMsgHandlerListener(XPRSmsgHandlerListener listener,
                                  java.lang.Object data,
                                  int priority)
                           throws XPRSexception
        Add a listener for the MsgHandler callback. Note that an object can have multiple MsgHandler listeners.
        Parameters:
        listener - The listener to which the event will be dispatched. (If null, all MsgHandler listeners will be removed.)
        data - An additional object which will be passed down to the callback function
        priority - Listeners with higher priorities are called first
        Throws:
        XPRSexception

      • removeMsgHandlerListener

        public void removeMsgHandlerListener(XPRSmsgHandlerListener listener,
                                     java.lang.Object data)
                              throws XPRSexception
        Removes the given MsgHandler listener with the given data value from the object.
        Throws:
        XPRSexception

      • removeMsgHandlerListeners

        public void removeMsgHandlerListeners()
                               throws XPRSexception
        Remove all listeners for the MsgHandler callback
        Throws:
        XPRSexception
Parent Topic Class Summary

© 2001-2021 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.