Home > matlab > acado > packages > +acado > @IntermediateState > IntermediateState.m

IntermediateState

PURPOSE ^

Intermediate State

SYNOPSIS ^

This is a script file.

DESCRIPTION ^

Intermediate State

  Usage:
    >> IntermediateState(name);
    >> IntermediateState name;                          SHORTHAND
    >> IntermediateState name1 name2 name3 ....         SHORTHAND

  Parameters:
    name        A valid matlab variable name [STRING]

  Example:
    >> IntermediateState i;
    >> i.equals(x+u)
 
  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:

SUBFUNCTIONS ^

SOURCE CODE ^

0001 %Intermediate State
0002 %
0003 %  Usage:
0004 %    >> IntermediateState(name);
0005 %    >> IntermediateState name;                          SHORTHAND
0006 %    >> IntermediateState name1 name2 name3 ....         SHORTHAND
0007 %
0008 %  Parameters:
0009 %    name        A valid matlab variable name [STRING]
0010 %
0011 %  Example:
0012 %    >> IntermediateState i;
0013 %    >> i.equals(x+u)
0014 %
0015 %  Licence:
0016 %    This file is part of ACADO Toolkit  - (http://www.acadotoolkit.org/)
0017 %
0018 %    ACADO Toolkit -- A Toolkit for Automatic Control and Dynamic Optimization.
0019 %    Copyright (C) 2008-2009 by Boris Houska and Hans Joachim Ferreau, K.U.Leuven.
0020 %    Developed within the Optimization in Engineering Center (OPTEC) under
0021 %    supervision of Moritz Diehl. All rights reserved.
0022 %
0023 %    ACADO Toolkit is free software; you can redistribute it and/or
0024 %    modify it under the terms of the GNU Lesser General Public
0025 %    License as published by the Free Software Foundation; either
0026 %    version 3 of the License, or (at your option) any later version.
0027 %
0028 %    ACADO Toolkit is distributed in the hope that it will be useful,
0029 %    but WITHOUT ANY WARRANTY; without even the implied warranty of
0030 %    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
0031 %    Lesser General Public License for more details.
0032 %
0033 %    You should have received a copy of the GNU Lesser General Public
0034 %    License along with ACADO Toolkit; if not, write to the Free Software
0035 %    Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301  USA
0036 %
0037 %    Author: David Ariens
0038 %    Date: 2010
0039 %
0040 classdef IntermediateState < acado.Expression    
0041     properties(SetAccess='private')
0042         value;
0043     end
0044     
0045     methods
0046         function obj = IntermediateState(name)
0047             if (isvarname(name) ~= 1)
0048                 error( 'ERROR: The variable name you have set is not a valid matlab variable name. A valid variable name is a character string of letters, digits, and underscores, totaling not more than namelengthmax characters and beginning with a letter.' );
0049             end
0050 
0051             obj.name = name;
0052 
0053             
0054         end
0055                 
0056                 
0057         equals(obj, varargin);
0058         getInstructions(obj, cppobj, get)
0059         
0060     end
0061     
0062 end

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