Skip to main content

metadata:time freq support get attribute

Version: 0.0.0

Description

Uses the TimeFreqSupport APIs to return a given attribute of the scoping in input.

Inputs

InputNameExpected type(s)Description
Pin 0
Required
time_freq_supporttime_freq_support
Pin 1
Required
property_namestringSupported property names are: "time_freqs", "imaginary_freqs", "frequency_tolerance", "set_id", "cummulative_index", "sets_freqs", "step_id_from_harmonic_index".
Pin 2property_identifierint32, scopingAdditional pin for properties "set_id" and "cummulative_index": the step id, for "sets_freqs": the sets scoping, for "step_id_from_harmonic_index" : the harmonic index.
Pin 3property_identifier_2int32Additional pin for properties "set_id" and "cummulative_index": the substep id (if none, last substep is considered).

Outputs

OutputNameExpected type(s)Description
Pin 0propertydouble, field, scopingReturns a double for property: "frequency_tolerance", a single-value Scoping for properties for "set_id" and "cummulative_index", an int for "step_id_from_harmonic_index" and a Field otherwise.

Configurations

NameExpected type(s)Default valueDescription
mutexboolfalseIf this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads.

Scripting

Category: metadata

Plugin: core

Scripting name: time_freq_support_get_attribute

Full name: metadata.time_freq_support_get_attribute

Internal name: timefreqsupport::get_attribute

License: None

Changelog

  • Version 0.0.0: Initial release.