sdo.requirements.ClosedLoopPeakGain

Closed loop peak gain bound

Description

Specify lower or equality bounds on the closed loop peak gain of a linear system. The closed loop can be formed using negative, positive or no feedback. You can then optimize the model response to meet these bounds using sdo.optimize.

You must have Simulink^® Control Design™ software to specify closed-loop peak gain bounds.

Creation

Syntax

pkgainReq = sdo.requirements.ClosedLoopPeakGain

pkgainReq = sdo.requirements.ClosedLoopPeakGain(Name,Value)

Description

pkgainReq = sdo.requirements.ClosedLoopPeakGain creates a sdo.requirements.ClosedLoopPeakGain object and assigns default values to its properties.

pkgainReq = sdo.requirements.ClosedLoopPeakGain(Name,Value) specifies one or more properties using name-value arguments. Name is a property name and Value is the corresponding value. Name must appear inside quotes. You can specify several name-value arguments in any order as Name1,Value1,...,NameN,ValueN.

Properties

Description — Requirement description

'' (default) | character vector

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

FeedbackSign — Feedback loop sign to determine the peak gain of the linear system

-1 (default) | 1

Feedback loop sign to determine the peak gain of the linear system, specified as either –1 or 1. Use –1 if the loop has negative feedback and 1 if the loop has positive feedback.

MagnitudeUnits — Magnitude units of the requirement

'db' (default) | 'abs'

Magnitude units of the requirement, specified as either 'db' (decibels) or 'abs' (absolute units).

Name — Requirement name

'' (default) | character vector

Requirement name, specified as a character vector.

PeakGain — Peak gain bound

2 (default) | nonnegative scalar

Peak gain bound, specified as a nonnegative scalar.

Type — Peak gain requirement type

'<=' (default) | '==' | 'min'

Peak gain requirement type, specified as one of the following:

• '<=' — Upper bound

• '==' — Equality bound

• 'min' — Minimization objective

Object Functions

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

Examples

Construct Closed-Loop Peak Gain Object

Construct a closed loop peak gain object and specify peak gain requirement.

r = sdo.requirements.ClosedLoopPeakGain;
r.PeakGain = 2;

Alternatively, you can specify the peak gain during construction:

r = sdo.requirements.ClosedLoopPeakGain('PeakGain',2);

Alternatives

Use getbounds to get the bounds specified in Check Nichols Characteristics (Simulink Control Design) block.

Version History

Introduced in R2010b