Main Content

sdo.requirements.PZSettlingTime class

Package: sdo.requirements

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.

Construction

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

settime_req = sdo.requirements.PZSettlingTime(Name,Value) uses additional options specified by one or more Name,Value pair arguments. Name is a property name and Value is the corresponding value. Name must appear inside single quotes (''). You can specify several name-value pair arguments in any order as Name1,Value1,...,NameN,ValueN.

Input Arguments

Name-Value Arguments

Specify optional pairs of arguments as Name1=Value1,...,NameN=ValueN, where Name is the argument name and Value is 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 enclose Name in quotes.

Use Name,Value arguments to specify properties of the requirement object during object creation. For example, requirement = sdo.requirements.PZSettlingTime('Type','>=') creates an sdo.requirements.PZSettlingTime object and specifies the Type property as a lower bound.

Properties

Description

Requirement description, specified as a character vector. For example, 'Requirement on signal 1'.

Default: ''

Name

Requirement name, specified as a character vector.

Default: ''

SettlingTime

Settling time bound. Must be in seconds and a positive finite scalar.

Default: 2

TimeUnits

Time units of the requirement, specified as one of the following values:

  • 'nanoseconds'

  • 'microseconds'

  • 'milliseconds'

  • 'seconds'

  • 'minutes'

  • 'hours'

  • 'days'

  • 'weeks'

  • 'months'

  • 'years'

Default: 'second'

Type

Settling time bound type, specified as one of the following values:

  • '<=' — Upper bound

  • '>=' — Lower bound

  • '==' — Equality bound

  • 'min' — Minimization objective

Default: '<='

Methods

evalRequirementEvaluate settling time bound on linear system

Copy Semantics

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

Examples

Construct a settling time object and specify the settling time requirement.

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

Alternatively, you can specify the setting time during construction.

r = sdo.requirements.PZSettlingTime('SettlingTime',2.5);

Alternatives

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

See Also

| |

Topics