simscape.instrumentation.isLoggingEnabled

Returns whether logging is enabled for a block

Since R2024a

Syntax

result = simscape.instrumentation.isLoggingEnabled(blockName)

Description

result = simscape.instrumentation.isLoggingEnabled(blockName) returns a logical 0 or 1 depending on whether logging is enabled for the block, blockName.

Examples

collapse all

Check Logging Status for Block

This example shows how to check whether logging is enabled for the Ideal Torque Source block labeled Load Torque in the Permanent Magnet DC Motor example.

To open the model, enter:

openExample('simscape/PermanentMagnetDCMotorExample')

To enable selective logging for the block, enter:

simscape.instrumentation.enableLogging('PermanentMagnetDCMotor/Load Torque')

Because the block did not previously have any variables selected for logging, the function selects all of the variables for the block. Confirm that the logging badge appears on the Ideal Torque Source block.

To confirm that the block has logging enabled, enter:

simscape.instrumentation.isLoggingEnabled('PermanentMagnetDCMotor/Load Torque')

ans =

  logical

   1

Input Arguments

collapse all

`blockName` — Simscape block name
block name | block handle

Simscape block name, specified as a string scalar, character vector, or a handle.

Data Types: double | char | string

Output Arguments

collapse all

`result` — Logging status result
true | false

Logical true or false result when logging is enabled or disabled for the block, respectively. Logical true and false correspond to 0 and 1, respectively.