stateVector.editVariables

Edit the design parameters of state vector variables


Syntax



Description

obj = obj.editVariables(vars, d, method, inputs, task)

Applies the specified method to the given variables using indicated inputs. Throws informative error message if the method fails.

*Note* In general, the purpose of this method is to provide a common error-handling framework for methods that edit variable design parameters.


Input Arguments

vars

vector, linear indices [nVars]
The indices of the variables being edited

d

matrix, dimension indices [nVars x nDims]
The indices of the dimensions being edited for each variable.

method

string scalar
The name of the method to apply to the variables

inputs

cell vector
Inputs to the method after the dimension indices

task

string scalar
The name of attempted task to use in thrown error messages

Output Arguments

obj

scalar stateVector object
The state vector with updated variables