sdo.requirements.StepResponseEnvelope class

Package:sdo.requirements

Step response bound on signal

Description

Specify a step response envelope requirement on a time-domain signal. Step response characteristics such as rise-time and percentage overshoot define the step response envelope.

Construction

step_req= sdo.requirements.StepResponseEnvelopecreates ansdo.requirements.StepResponseEnvelopeobject and assigns default values to its properties.

step_req= sdo.requirements.StepResponseEnvelope(Name,Value)uses additional options specified by one or moreName,Valuepair arguments.Nameis a property name andValueis the corresponding value.Namemust appear inside single quotes (””). You can specify several name-value pair arguments in any order asName1,Value1,...,NameN,ValueN.

Input Arguments

Name-Value Arguments

Specify optional pairs of arguments asName1=Value1,...,NameN=ValueN, whereNameis the argument name andValueis the corresponding value. Name-value arguments must appear after other arguments, but the order of the pairs does not matter.

Before R2021a, use commas to separate each name and value, and encloseNamein quotes.

UseName,Valuearguments to specifypropertiesof the requirement object during object creation. For example,requirement = sdo.requirements.StepResponseEnvelope('PercentOvershoot',20)creates ansdo.requirements.StepResponseEnvelopeobject and specifies thePercentOvershootproperty as 20.

Properties

`Description`	Requirement description, specified as a character vector. For example,`”Requirement on signal 1'`. Default:`””`
`FinalValue`	Final value of the step response. Must be a finite real scalar not equal to the`InitialValue`property. Default:`1`
`InitialValue`	Value of the signal level before the step response starts. Must be a finite real scalar not equal to the`FinalValue`. property. Default:`0`
`Name`	Requirement name, specified as a character vector. Default:`””`
`PercentOvershoot`	The percentage amount by which the signal can exceed the final value before settling. Must be a real finite scalar between`[0 100]`and greater than`PercentSettling`. Use`set`to set this and the`PercentSettling`properties simultaneously. Default:`10`
`PercentRise`	The percentage of final value used with the`RiseTime`property to define the overall rise time characteristics. Must be a real finite scalar between`[0 100]`and less than (100–`PercentSettling`). Use`set`to set this and the`PercentSettling`properties simultaneously. Default:`80`
`PercentSettling`	The percentage of the final value that defines the settling range of settling time characteristic specified in the`SettlingTime`property. Must be a real positive finite scalar between`[0 100]`and less than (100 –`PercentRise`) and less than`PercentOvershoot`. Use`set`to set this and the`PercentOvershoot`and`PercentRise`properties simultaneously. Default:`1`
`PercentUndershoot`	The percentage amount by which the signal can undershoot the initial value. Must be a positive finite scalar between`[0 100]`. Default:`1`
`RiseTime`	Time taken, in seconds, for the signal to reach a percentage of the final value specified in`PercentRise`. Must be a finite positive real scalar and less than the`SettlingTime`. Time is relative to the`StepTime`. Use`set`to set this and the`StepTime`and`SettlingTime`properties simultaneously. Default:`5`
`SettlingTime`	Time taken, in seconds, for the signal to settle within a specified range around the final value. This settling range is defined as the final value plus or minus the percentage of the final value, specified in`PercentSettling`. Must be a finite positive real scalar, greater than`RiseTime`. Time is relative to the`StepTime`. Use`set`to set this and the`RiseTime`properties simultaneously. Default:`7`
`StepTime`	Time, in seconds, when the step response starts. Must be a finite real nonnegative scalar, less than the`RiseTime`property. Use`set`to set this and the`RiseTime`properties simultaneously. Default:`0`
`TimeUnits`	Time units of the requirement, specified as one of the following values: `”nanoseconds'` `”microseconds'` `”milliseconds'` `“秒”` `”minutes'` `”hours'` `”days'` `”weeks'` `”months'` `”years'` Default:`”second'`
`Type`	Step response bound type. This property is read-only and set to`”<='`.

Methods

evalRequirement

Evaluate satisfaction of step response requirement

Copy Semantics

Handle. To learn how handle classes affect copy operations, seeCopying Objects.

Examples

Construct a step response bound object and specify percent overshoot.

r = sdo.requirements.StepResponseEnvelope; r.PercentOvershoot = 20;

Alternatively, you can specify the percent overshoot during construction:

r = sdo.requirements.StepResponseEnvelope('PercentOvershoot',20);

Alternatives

Usegetboundsto get the bounds specified in aCheck Step Response Characteristicsblock.