Home > matlab > acado > functions > acadoSet.m

acadoSet

PURPOSE ^

Set ACADO main settings

SYNOPSIS ^

function acadoSet( property, value )

DESCRIPTION ^

Set ACADO main settings

  Usage:
    >> acadoSet(property, value);

  Possible settings:
    'problemname',         a valid variable name, default 'myAcadoProblem'
       Set the output name of your problem. This value will be used to name
       all files related to your problem

    'results_to_file',     [LOGICAL], default false
       The result of your problem is written to an output struct which you
       can store by running your problem as "out = myAcadoProblem_RUN();".
       Optionaly ACADO can also write your results to a matrix in a file.


  Example:
    >> acadoSet('problemname', 'my_demo');
    >> acadoSet('results_to_file', true);

  Licence:
    This file is part of ACADO Toolkit  - (http://www.acadotoolkit.org/)

    ACADO Toolkit -- A Toolkit for Automatic Control and Dynamic Optimization.
    Copyright (C) 2008-2009 by Boris Houska and Hans Joachim Ferreau, K.U.Leuven.
    Developed within the Optimization in Engineering Center (OPTEC) under
    supervision of Moritz Diehl. All rights reserved.

    ACADO Toolkit is free software; you can redistribute it and/or
    modify it under the terms of the GNU Lesser General Public
    License as published by the Free Software Foundation; either
    version 3 of the License, or (at your option) any later version.

    ACADO Toolkit is distributed in the hope that it will be useful,
    but WITHOUT ANY WARRANTY; without even the implied warranty of
    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
    Lesser General Public License for more details.

    You should have received a copy of the GNU Lesser General Public
    License along with ACADO Toolkit; if not, write to the Free Software
    Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301  USA

    Author: David Ariens
    Date: 2010

CROSS-REFERENCE INFORMATION ^

This function calls: This function is called by:

SOURCE CODE ^

0001 %Set ACADO main settings
0002 %
0003 %  Usage:
0004 %    >> acadoSet(property, value);
0005 %
0006 %  Possible settings:
0007 %    'problemname',         a valid variable name, default 'myAcadoProblem'
0008 %       Set the output name of your problem. This value will be used to name
0009 %       all files related to your problem
0010 %
0011 %    'results_to_file',     [LOGICAL], default false
0012 %       The result of your problem is written to an output struct which you
0013 %       can store by running your problem as "out = myAcadoProblem_RUN();".
0014 %       Optionaly ACADO can also write your results to a matrix in a file.
0015 %
0016 %
0017 %  Example:
0018 %    >> acadoSet('problemname', 'my_demo');
0019 %    >> acadoSet('results_to_file', true);
0020 %
0021 %  Licence:
0022 %    This file is part of ACADO Toolkit  - (http://www.acadotoolkit.org/)
0023 %
0024 %    ACADO Toolkit -- A Toolkit for Automatic Control and Dynamic Optimization.
0025 %    Copyright (C) 2008-2009 by Boris Houska and Hans Joachim Ferreau, K.U.Leuven.
0026 %    Developed within the Optimization in Engineering Center (OPTEC) under
0027 %    supervision of Moritz Diehl. All rights reserved.
0028 %
0029 %    ACADO Toolkit is free software; you can redistribute it and/or
0030 %    modify it under the terms of the GNU Lesser General Public
0031 %    License as published by the Free Software Foundation; either
0032 %    version 3 of the License, or (at your option) any later version.
0033 %
0034 %    ACADO Toolkit is distributed in the hope that it will be useful,
0035 %    but WITHOUT ANY WARRANTY; without even the implied warranty of
0036 %    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
0037 %    Lesser General Public License for more details.
0038 %
0039 %    You should have received a copy of the GNU Lesser General Public
0040 %    License along with ACADO Toolkit; if not, write to the Free Software
0041 %    Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301  USA
0042 %
0043 %    Author: David Ariens
0044 %    Date: 2010
0045 %
0046 function acadoSet( property, value )
0047     
0048     global ACADO_;
0049     
0050     checkActiveModel;
0051     
0052     if (strcmp(property, 'problemname') && isvarname(value))
0053         
0054         ACADO_.problemname = value;
0055     
0056     elseif (strcmp(property, 'results_to_file') && isa(value, 'logical'))
0057         
0058         ACADO_.results_to_file = value;
0059         
0060     else
0061         
0062         error('ERROR: Invalid setting. <a href="matlab: help acadoSet">help acadoSet</a>'); 
0063         
0064     end
0065     
0066 end

www.acadotoolkit.org/matlab
Generated on Tue 01-Jun-2010 20:14:12 by m2html © 2005