sdo.requirements.StepResponseEnvelope

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.

Creation

Syntax

step_req = sdo.requirements.StepResponseEnvelope

step_req = sdo.requirements.StepResponseEnvelope(Name=Value)

Description

step_req = sdo.requirements.StepResponseEnvelope creates an sdo.requirements.StepResponseEnvelope object and assigns default values to its properties.

step_req = sdo.requirements.StepResponseEnvelope(Name=Value) specifies one or more properties using name-value arguments. For example, step_req = sdo.requirements.StepResponseEnvelope(PercentOvershoot=20) creates an sdo.requirements.StepResponseEnvelope object and specifies the overshoot as 20%.

Before R2021a, use commas to separate each name and value, and enclose Name in quotes. For example, step_req = sdo.requirements.StepResponseEnvelope("PercentOvershoot",20) creates an sdo.requirements.StepResponseEnvelope object and specifies the overshoot as 20%.

Properties

Description — Requirement description

'' (default) | character vector

Requirement description, specified as a character vector.

Example: 'Requirement on signal 1'

FinalValue — Final value of the step response

1 (default) | finite real scalar

Final value of the step response, specified as a finite real scalar not equal to the InitialValue property.

InitialValue — Value of signal before step response starts

0 (default) | finite real scalar

Value of the signal level before the step response starts, specified as a finite real scalar not equal to the FinalValue property.

Name — Requirement name

'' (default) | character vector

Requirement name, specified as a character vector.

PercentOvershoot — Amount by which the signal can exceed the final value

10 (default) | scalar in the range [0 100]

Amount by which the signal can exceed the final value before settling defined as a percentage of the step range and specified as a scalar in the range [0 100] and greater than PercentSettling.

Use set to set the PercentSettling, PercentOvershoot, and PercentRise properties simultaneously.

PercentRise — Rise time range

80 (default) | scalar in the range [0 100]

Rise time range, defined as a percentage of the step range and specified as a scalar in the range [0 100]. The value must be less than (100–PercentSettling). Use this value along with RiseTime to define the overall rise time characteristics.

Use set to set the PercentSettling, PercentOvershoot, and PercentRise properties simultaneously.

PercentSettling — Settling range

1 (default) | scalar in the range [0 100]

Settling range, defined as a percentage of the step range and specified as a scalar in the range [0 100]. The value must be less than (100 – PercentRise) and less than PercentOvershoot.

Use set to set the PercentSettling, PercentOvershoot, and PercentRise properties simultaneously.

PercentUndershoot — Amount by which the signal can undershoot the initial value

1 (default) | scalar in the range [0 100]

Amount by which the signal can undershoot the initial value, defined as a percentage of the step range and specified as a scalar in the range [0 100].

RiseTime — Time taken for signal to reach the rise time range

5 (default) | positive real scalar

Time taken, in seconds, for the signal to reach the percentage of the step range value specified in PercentRise, specified as a positive real scalar less than SettlingTime.

Use set to set the RiseTime, StepTime, and SettlingTime properties simultaneously.

SettlingTime — Time taken for signal to settle within specified range around final value

7 (default) | positive real scalar

Time taken, in seconds, for the signal to settle within a specified range around the final value, specified as a positive real scalar greater than RiseTime. This settling range is defined as the final value plus or minus the settling range, specified in PercentSettling.

Use set to set the RiseTime, StepTime, and SettlingTime properties simultaneously.

StepTime — Time when step response starts

0 (default) | nonnegative real scalar

Time, in seconds, when the step response starts, specified as a nonnegative real scalar less than RiseTime

Use set to set the RiseTime, StepTime, and SettlingTime properties simultaneously.

TimeUnits — Time units

"second" (default) | string scalar | character vector

Time units of the requirement, specified as one of the following values. The sdo.requirements.StepResponseEnvelope object stores the value as a character vector.

• "nanoseconds"

• "microseconds"

• "milliseconds"

• "seconds"

• "minutes"

• "hours"

• "days"

• "weeks"

• "months"

• "years"

Type — Step response bound type

Read-only: '<=' (default)

This property is read-only.

Step response bound type, returned as '<='.

Object Functions

copy	Copy design requirement
get	Get design requirement property values
set	Set design requirement property values
evalRequirement	Evaluate design requirement

Examples

Create Step Response Envelope Requirements Object

Create a step response envelope requirements object and specify percent overshoot.

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

Alternatively, you can specify the percent overshoot when you create the object.

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

Alternatives

Use getbounds to get the bounds specified in a Check Step Response Characteristics block.

Version History

Introduced in R2010b