sdo.requirements.PZSettlingTime

Settling time bound

Description

Specify bounds on the real component of the poles of a linear system. The real component of poles are used to approximate the settling time. You can then optimize the model response to meet these bounds using sdo.optimize.

You must have Simulink^® Control Design™ software to specify settling time requirements.

Creation

Syntax

settime_req = sdo.requirements.PZSettlingTime

settime_req = sdo.requirements.PZSettlingTime(Name=Value)

Description

settime_req = sdo.requirements.PZSettlingTime creates an sdo.requirements.PZSettlingTime object and assigns default values to its properties.

settime_req = sdo.requirements.PZSettlingTime(Name=Value) specifies one or more properties using name-value arguments. For example, settime_req = sdo.requirements.PZSettlingTime(TimeUnits="milliseconds") creates an sdo.requirements.PZSettlingTime object and specifies the TimeUnits property as milliseconds.

Before R2021a, use commas to separate each name and value, and enclose Name in quotes. For example, settime_req = sdo.requirements.PZSettlingTime("TimeUnits","milliseconds") creates an sdo.requirements.PZSettlingTime object and specifies the TimeUnits property as milliseconds.

Properties

Description — Requirement description

'' (default) | character vector

Requirement description, specified as a character vector.

Example: 'Requirement on signal 1'

Name — Requirement name

'' (default) | character vector

Requirement name, specified as a character vector.

SettlingTime — Settling time bound

2 (default) | positive finite scalar

Settling time bound, in seconds, specified as a positive finite scalar.

TimeUnits — Time units

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

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

• "nanoseconds"

• "microseconds"

• "milliseconds"

• "seconds"

• "minutes"

• "hours"

• "days"

• "weeks"

• "months"

• "years"

Type — Settling time bound type

"<=" (default) | ">=" | "==" | "min"

Settling time bound type, specified as one of the following values and stored as a character vector:

• "<=" — Upper bound

• ">=" — Lower bound

• "==" — Equality bound

• "min" — Minimization objective

Object Functions

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

Examples

Create Settling Time Object

Create a settling time object and then specify the settling time requirement.

r = sdo.requirements.PZSettlingTime;
r.SettlingTime = 2.5;

Alternatively, you can specify the setting time when you create the object.

r = sdo.requirements.PZSettlingTime(SettlingTime=2.5)

r = 
  PZSettlingTime with properties:

    SettlingTime: 2.5000
            Type: '<='
            Name: ''
     Description: ''
       TimeUnits: 'seconds'

Alternatives

Use getbounds to get the bounds specified in a Check Pole-Zero Characteristics (Simulink Control Design) block.

Version History

Introduced in R2010b