isLocked

Locked status of online parameter estimation System object

Syntax

L = isLocked(obj)

Description

L = isLocked(obj) returns the locked status of online parameter estimation System object™, obj.

Examples

Check Locked Status of Online Estimation System Object

Create a System object™ for online estimation of an ARMAX model with default properties.

obj = recursiveARMAX;

Check the locked status of the object.

L = isLocked(obj)

L = logical
   0

Estimate model parameters online using step and input-output data.

[A,B,C,EstimatedOutput] = step(obj,1,1);

Check the locked status of the object again.

L = isLocked(obj)

L = logical
   1

step puts the object in a locked state.

Input Arguments

obj — System object for online parameter estimation

recursiveAR object | recursiveARMA object | recursiveARX object | recursiveARMAX object | recursiveOE object | recursiveBJ object | recursiveLS object

System object for online parameter estimation, created using one of the following commands:

• recursiveAR

• recursiveARMA

• recursiveARX

• recursiveARMAX

• recursiveOE

• recursiveBJ

• recursiveLS

Output Arguments

L — Locked status of online estimation System object

logical

Locked status of online estimation System object, returned as a logical value. L is true if obj is locked.