get

Get design requirement property values

Syntax

propertyValue = get(req)

propertyValue = get(req,propertyName)

Description

propertyValue = get(req) returns the value of all properties of the requirement object.

propertyValue = get(req,propertyName) returns the property values specified by propertyName.

Examples

Obtain Single Property Value

r = sdo.requirements.SignalBound;
boundTimes = get(r,'BoundTimes');

Obtain Multiple Property Values

r = sdo.requirements.SignalBound;
values = get(r,{'BoundTimes','BoundMagnitudes'});
boundTimes = values{1};
boundMagnitudes = values{2};

Input Arguments

req — Design requirement

design requirement object

Design requirement to evaluate, specified as a time-domain, variable, or frequency-domain requirement object.

Time-Domain Requirements

• sdo.requirements.SignalBound

• sdo.requirements.SignalTracking

• sdo.requirements.StepResponseEnvelope

• sdo.requirements.PhasePlaneEllipse

• sdo.requirements.PhasePlaneRegion

Variable Requirements

• sdo.requirements.FunctionMatching

• sdo.requirements.MonotonicVariable

• sdo.requirements.RelationalConstraint

• sdo.requirements.SmoothnessConstraint

Frequency-Domain Requirements

• sdo.requirements.BodeMagnitude

• sdo.requirements.ClosedLoopPeakGain

• sdo.requirements.GainPhaseMargin

• sdo.requirements.OpenLoopGainPhase

• sdo.requirements.PZDampingRatio

• sdo.requirements.PZNaturalFrequency

• sdo.requirements.PZSettlingTime

• sdo.requirements.SingularValue

propertyName — Property name

string | character vector | cell array

Property name, specified as a string or character vector. To obtain multiple property values, specify propertyName as a cell array that contains the corresponding property names.

Output Arguments

propertyValue — Property value

scalar | vector | array | character vector | cell array | structure

Property values, returned as a scalar, vector, array, or character vector, depending on the specified property. For more information, see the corresponding requirement object page.

If you specify multiple property names using a cell array, then propertyValue is returned as a cell array that contains the corresponding property values.

If you use the propertyName = get(req) syntax, then propertyValue is returned as a structure. where the field names match the property names of req and the field values are the property values.

Alternatives

You can access property values using dot notation, for example req.property

Version History

Introduced in R2011b