<html> <head> <title>Interface XSolver</title> <meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> <link rel="stylesheet" type="text/css" href="../../../../idl.css"> </head> <body> <div id="adc-idlref"> <a name="_top_"> </a><table class="navimain" border="0" cellpadding="3"> <tr> <td class="navimain"><a href="../module-ix.html" class="navimain">Overview</a></td> <td class="navimain"><a href="module-ix.html" class="navimain">Module</a></td> <td class="navimain"><a href="XSolver-xref.html" class="navimain">Use</a></td> <td class="navimainnone">Devguide</td> <td class="navimain"><a href="../../../../index-files/index-1.html" class="navimain">Index</a></td> </tr> </table> <table class="navisub" border="0" cellpadding="0"> <tr> <td class="navisub"><a href="#MethodsSummary" class="navisub">Methods' Summary</a></td> <td class="navisub"><a href="#AttributesSummary" class="navisub">Attributes' Summary</a></td> <td class="navisub"><a href="#MethodsDetails" class="navisub">Methods' Details</a></td> <td class="navisub"><a href="#AttributesDetails" class="navisub">Attributes' Details</a></td> </tr> </table> <hr> <table border="0" width="100%" cellpadding="5" cellspacing="3" class="title-table" style="margin-bottom:6pt;"> <tr> <td><p class="namechain"><a href="../../../../module-ix.html" class="namechain">::</a> <a href="../../../module-ix.html" class="namechain">com</a> :: <a href="../../module-ix.html" class="namechain">sun</a> :: <a href="../module-ix.html" class="namechain">star</a> :: <a href="module-ix.html" class="namechain">sheet</a> :: </p> </td> </tr> <tr> <td class="title"><table class="title-table" width="99%"> <tr> <td width="25%" class="title2">unpublished </td> <td width="50%" class="title">interface XSolver</td> <td width="*"/></tr> </table> </td> </tr> <tr> <td/></tr> <tr> <td><dl> <dt><b>Description</b></dt> <dd>allows to call a solver for a model that is defined by spreadsheet cells. </dd> </dl> </td> </tr> </table> <hr> <a name="MethodsSummary"/><table border="1" width="100%" cellpadding="5" cellspacing="0" class="subtitle"> <tr> <td class="subtitle" colspan="2">Methods' Summary</td> </tr> <tr> <td class="imsum_left"><a href="#solve">solve</a></td> <td class="imsum_right">executes the calculation and tries to find a solution. </td> </tr> </table> <a name="AttributesSummary"/><table border="1" width="100%" cellpadding="5" cellspacing="0" class="subtitle"> <tr> <td class="subtitle" colspan="2">Attributes' Summary</td> </tr> <tr> <td class="imsum_left"><a href="#Document">Document</a></td> <td class="imsum_right">The spreadsheet document that contains the cells. </td> </tr> <tr> <td class="imsum_left"><a href="#Objective">Objective</a></td> <td class="imsum_right">The address of the cell that contains the objective value. </td> </tr> <tr> <td class="imsum_left"><a href="#Variables">Variables</a></td> <td class="imsum_right">The addresses of the cells that contain the variables. </td> </tr> <tr> <td class="imsum_left"><a href="#Constraints">Constraints</a></td> <td class="imsum_right">The constraints of the model. </td> </tr> <tr> <td class="imsum_left"><a href="#Maximize">Maximize</a></td> <td class="imsum_right">selects if the objective value is maximized or minimized. </td> </tr> <tr> <td class="imsum_left"><a href="#Success">Success</a></td> <td class="imsum_right">contains <b>true</b> if a solution was found. </td> </tr> <tr> <td class="imsum_left"><a href="#ResultValue">ResultValue</a></td> <td class="imsum_right">contains the objective value for the solution, if a solution was found. </td> </tr> <tr> <td class="imsum_left"><a href="#Solution">Solution</a></td> <td class="imsum_right">contains the solution's value for each of the variables, if a solution was found. </td> </tr> </table> <a name="MethodsDetails"/><table border="1" width="100%" cellpadding="5" cellspacing="0" class="subtitle"> <tr> <td class="subtitle">Methods' Details</td> </tr> <tr> <td class="imdetail"><a name="solve" class="membertitle">solve</a><table border="0" width="96%" cellpadding="5" cellspacing="0" class="table-in-method" bgcolor="#ffffff" align="center"> <tr> <td><table class="table-in-method" border="0"> <tr> <td valign="top" colspan="3">void</td> </tr> <tr> <td valign="top"><b>solve</b>();</td> </tr> </table> <hr> <dl> <dt><b>Description</b></dt> <dd>executes the calculation and tries to find a solution.</dd> </dl> </td> </tr> </table> </td> </tr> </table> <a name="AttributesDetails"/><table border="1" width="100%" cellpadding="5" cellspacing="0" class="subtitle"> <tr> <td class="subtitle">Attributes' Details</td> </tr> <tr> <td class="imdetail"><a name="Document" class="membertitle">Document</a><table border="0" width="96%" cellpadding="5" cellspacing="0" class="table-in-data" bgcolor="#ffffff" align="center"> <tr> <td><a href="XSpreadsheetDocument.html">XSpreadsheetDocument</a> <b>Document</b>;<hr> <dl> <dt><b>Description</b></dt> <dd>The spreadsheet document that contains the cells.</dd> </dl> </td> </tr> </table> </td> </tr> <tr> <td class="imdetail"><a name="Objective" class="membertitle">Objective</a><table border="0" width="96%" cellpadding="5" cellspacing="0" class="table-in-data" bgcolor="#ffffff" align="center"> <tr> <td>::com::sun::star::<a href="../table/module-ix.html">table</a>::<a href="../table/CellAddress.html">CellAddress</a> <b>Objective</b>;<hr> <dl> <dt><b>Description</b></dt> <dd>The address of the cell that contains the objective value.</dd> </dl> </td> </tr> </table> </td> </tr> <tr> <td class="imdetail"><a name="Variables" class="membertitle">Variables</a><table border="0" width="96%" cellpadding="5" cellspacing="0" class="table-in-data" bgcolor="#ffffff" align="center"> <tr> <td>sequence< ::com::sun::star::<a href="../table/module-ix.html">table</a>::<a href="../table/CellAddress.html">CellAddress</a> > <b>Variables</b>;<hr> <dl> <dt><b>Description</b></dt> <dd>The addresses of the cells that contain the variables.</dd> </dl> </td> </tr> </table> </td> </tr> <tr> <td class="imdetail"><a name="Constraints" class="membertitle">Constraints</a><table border="0" width="96%" cellpadding="5" cellspacing="0" class="table-in-data" bgcolor="#ffffff" align="center"> <tr> <td>sequence< <a href="SolverConstraint.html">SolverConstraint</a> > <b>Constraints</b>;<hr> <dl> <dt><b>Description</b></dt> <dd>The constraints of the model.</dd> </dl> </td> </tr> </table> </td> </tr> <tr> <td class="imdetail"><a name="Maximize" class="membertitle">Maximize</a><table border="0" width="96%" cellpadding="5" cellspacing="0" class="table-in-data" bgcolor="#ffffff" align="center"> <tr> <td>boolean <b>Maximize</b>;<hr> <dl> <dt><b>Description</b></dt> <dd>selects if the objective value is maximized or minimized.</dd> </dl> </td> </tr> </table> </td> </tr> <tr> <td class="imdetail"><a name="Success" class="membertitle">Success</a><table border="0" width="96%" cellpadding="5" cellspacing="0" class="table-in-data" bgcolor="#ffffff" align="center"> <tr> <td>[ readonly ] boolean <b>Success</b>;<hr> <dl> <dt><b>Description</b></dt> <dd>contains <b>true</b> if a solution was found.</dd> </dl> </td> </tr> </table> </td> </tr> <tr> <td class="imdetail"><a name="ResultValue" class="membertitle">ResultValue</a><table border="0" width="96%" cellpadding="5" cellspacing="0" class="table-in-data" bgcolor="#ffffff" align="center"> <tr> <td>[ readonly ] double <b>ResultValue</b>;<hr> <dl> <dt><b>Description</b></dt> <dd>contains the objective value for the solution, if a solution was found.</dd> </dl> </td> </tr> </table> </td> </tr> <tr> <td class="imdetail"><a name="Solution" class="membertitle">Solution</a><table border="0" width="96%" cellpadding="5" cellspacing="0" class="table-in-data" bgcolor="#ffffff" align="center"> <tr> <td>[ readonly ] sequence< double > <b>Solution</b>;<hr> <dl> <dt><b>Description</b></dt> <dd>contains the solution's value for each of the variables, if a solution was found. </dd> </dl> </td> </tr> </table> </td> </tr> </table> <a href="#_top_">Top of Page</a><hr size="3"><p class="copyright" align="center">Copyright © 2009 Sun Microsystems, Inc.</p> </div> <!-- id="adc-idlref" --> </body> </html>