setFileLogDecimation

Sets decimation value on File Log blocks based on block path and input decimation value

Since R2022a

Syntax

setFileLogDecimation(app_object,block_path,decimationValue)

Description

setFileLogDecimation(app_object,block_path,decimationValue) sets the decimation value for the specified File Log block. This function modifies the decimation value of the File Log block in the application object. The subsequent loads of the real-time application MLDATX file run on the Speedgoat^® target computer with the modified decimation value of the File Log block.

Examples

Set Decimation Value for File Log Block

Use the setFileLogDecimation function to set the decimation setting for a File Log block that you specify by using a block paths from a real-time application object.

1. Get the block paths for File Log blocks in the real-time application.

   myApp = slrealtime.Application('slrt_ex_osc');
   myFileLogBlocks = getAllFileLogBlocks(my_App)

   myFileLogBlocks =
   
     2×1 cell array
   
       {["slrt_ex_osc/File Log"]}
       {["slrt_ex_osc/File Log"]}

2. Get the decimation value for a selected File Log block.

   myDecimation = getFileLogDecimation(myApp,"slrt_ex_osc/File Log")

   myDecimation =
   
     int32
   
      1

3. Set the updated decimation value for a selected File Log block.

   setFileLogDecimation(myApp,"slrt_ex_osc/File Log",2)

Input Arguments

app_object — Object that represents real-time application files on the development computer

object

Provides access to methods that manipulate the real-time application files.

block_path — Hierarchical name of the originating block

character vector | string scalar | cell array of character vectors or strings

The block_path values can be:

• Empty character vector ('') or empty string scalar ("") for base or model workspace variables

• Character vector or string scalar for block path to parameters in the top model

• Cell array of character vectors or string scalars for model block arguments and model instance parameters

Example: '', 'Gain1', {'top/model','sub/model'}

decimationValue — Decimation value for File Log block

int32

The decimationValue provides the updated decimation value for the File Log block.

Example: 2

Data Types: int32

Version History

Introduced in R2022a