stateVector.name

Return an identifying name for a stateVector object


Syntax



Description

name = obj.name

Returns an identifying name for a stateVector object (typically used for error messages). If the stateVector does not have a label, the name is “the state vector”. If the stateVector has a label, the name is of form: state vector “<label>”.

name = obj.name(captalize)

Indicate whether to capitalize the first letter of the returned name. Default is to not capitalize (first letter is lowercase).


Input Arguments

capitalize

scalar logical
Whether to capitalize the first letter of the returned name (true), or not (false - default).

Output Arguments

name

char row vector
An identifying name for a stateVector object. If the stateVector does not have a label, the name is “the state vector”. If the stateVector has a label, the name is of form: state vector “<label>”.