getFileLogDecimation

Returns decimation value of File Log block based on block path

Since R2022a

Syntax

fileLogDecimation = getFileLogDecimation(app_object,block_path)

Description

fileLogDecimation = getFileLogDecimation(app_object,block_path) returns the value of decimation for the specified File Log block. You can use this function to get the decimation setting of a particular File Log block or to verify the changed decimation after using the setFileLogDecimation function.

Examples

Get Decimation Value for File Log Block

Use the getFileLogDecimation function to get 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

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'}

Output Arguments

fileLogDecimation — Decimation setting of File Log block

int32

The returned fileLogDecimation is the decimation value of the selected File Log block.

Version History

Introduced in R2022a