Skip to content

Commit 83ad459

Browse files
author
4rmuuser
committed
DPF doc update for 261 (2025.10.16)
1 parent a79c0e9 commit 83ad459

File tree

4 files changed

+58
-4
lines changed

4 files changed

+58
-4
lines changed

2026R1/dpf-framework-26-r1/operator-specifications/metadata/time_freq_support_get_attribute.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -17,15 +17,15 @@ Uses the TimeFreqSupport APIs to return a given attribute of the scoping in inpu
1717
| Input | Name | Expected type(s) | Description |
1818
|-------|-------|------------------|-------------|
1919
| <strong>Pin 0</strong> <br><span style="background-color:#d93025; color:white; padding:2px 6px; border-radius:3px; font-size:0.75em;">Required</span>| time_freq_support |[`time_freq_support`](../../core-concepts/dpf-types.md#time-freq-support) | |
20-
| <strong>Pin 1</strong> <br><span style="background-color:#d93025; color:white; padding:2px 6px; border-radius:3px; font-size:0.75em;">Required</span>| property_name |[`string`](../../core-concepts/dpf-types.md#standard-types) | Supported property names are: "time_freqs", "imaginary_freqs", "frequency_tolerance", "set_id", "cummulative_index", "sets_freqs". |
21-
| <strong>Pin 2</strong>| property_identifier |[`int32`](../../core-concepts/dpf-types.md#standard-types) | Additional pin for properties "set_id" and "cummulative_index": the step id, for "sets_freqs": the sets scoping. |
20+
| <strong>Pin 1</strong> <br><span style="background-color:#d93025; color:white; padding:2px 6px; border-radius:3px; font-size:0.75em;">Required</span>| property_name |[`string`](../../core-concepts/dpf-types.md#standard-types) | Supported property names are: "time_freqs", "imaginary_freqs", "frequency_tolerance", "set_id", "cummulative_index", "sets_freqs", "step_id_from_harmonic_index". |
21+
| <strong>Pin 2</strong>| property_identifier |[`int32`](../../core-concepts/dpf-types.md#standard-types), [`scoping`](../../core-concepts/dpf-types.md#scoping) | Additional 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. |
2222
| <strong>Pin 3</strong>| property_identifier_2 |[`int32`](../../core-concepts/dpf-types.md#standard-types) | Additional pin for properties "set_id" and "cummulative_index": the substep id (if none, last substep is considered). |
2323

2424
## Outputs
2525

2626
| Output | Name | Expected type(s) | Description |
2727
|-------|------|------------------|-------------|
28-
| **Pin 0**| property |[`double`](../../core-concepts/dpf-types.md#standard-types), [`field`](../../core-concepts/dpf-types.md#field), [`scoping`](../../core-concepts/dpf-types.md#scoping) | Returns a double for property: "frequency_tolerance", a single-value Scoping for properties for "set_id" and "cummulative_index", and a Field otherwise. |
28+
| **Pin 0**| property |[`double`](../../core-concepts/dpf-types.md#standard-types), [`field`](../../core-concepts/dpf-types.md#field), [`scoping`](../../core-concepts/dpf-types.md#scoping) | Returns 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. |
2929

3030
## Configurations
3131

Lines changed: 51 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,51 @@
1+
---
2+
category: utility
3+
plugin: core
4+
license: None
5+
---
6+
7+
# utility:cyclic support get attribute
8+
9+
**Version: 0.0.0**
10+
11+
## Description
12+
13+
A CyclicSupport in pin 0 and a property name (string) in pin 1 are expected in input.
14+
15+
## Inputs
16+
17+
| Input | Name | Expected type(s) | Description |
18+
|-------|-------|------------------|-------------|
19+
| <strong>Pin 0</strong> <br><span style="background-color:#d93025; color:white; padding:2px 6px; border-radius:3px; font-size:0.75em;">Required</span>| cyclic_support |[`cyclic_support`](../../core-concepts/dpf-types.md#cyclic-support) | |
20+
| <strong>Pin 1</strong> <br><span style="background-color:#d93025; color:white; padding:2px 6px; border-radius:3px; font-size:0.75em;">Required</span>| property_name |[`string`](../../core-concepts/dpf-types.md#standard-types) | Accepted inputs are: 'element_duplicate_offset' and 'node_duplicate_offset' (returns int). |
21+
22+
## Outputs
23+
24+
| Output | Name | Expected type(s) | Description |
25+
|-------|------|------------------|-------------|
26+
| **Pin 0**| property |[`string`](../../core-concepts/dpf-types.md#standard-types), [`int32`](../../core-concepts/dpf-types.md#standard-types) | Property value. |
27+
28+
## Configurations
29+
30+
| Name| Expected type(s) | Default value | Description |
31+
|-----|------|----------|-------------|
32+
| **mutex** |[`bool`](../../core-concepts/dpf-types.md#standard-types) | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. |
33+
34+
## Scripting
35+
36+
**Category**: utility
37+
38+
**Plugin**: core
39+
40+
**Scripting name**: cyclic_support_get_attribute
41+
42+
**Full name**: utility.cyclic_support_get_attribute
43+
44+
**Internal name**: cyclic_support::get_attribute
45+
46+
**License**: None
47+
48+
49+
## Changelog
50+
51+
- Version 0.0.0: Initial release.

2026R1/dpf-framework-26-r1/operator-specifications/utility/ints_to_scoping.md

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -16,8 +16,9 @@ take a int or a vector of int and transform it in a one entity field of location
1616

1717
| Input | Name | Expected type(s) | Description |
1818
|-------|-------|------------------|-------------|
19-
| <strong>Pin 0</strong> <br><span style="background-color:#d93025; color:white; padding:2px 6px; border-radius:3px; font-size:0.75em;">Required</span>| int_or_vector_int |[`int32`](../../core-concepts/dpf-types.md#standard-types), [`vector<int32>`](../../core-concepts/dpf-types.md#standard-types) | int or vector of int |
19+
| <strong>Pin 0</strong> <br><span style="background-color:#d93025; color:white; padding:2px 6px; border-radius:3px; font-size:0.75em;">Required</span>| int_or_vector_int |[`int32`](../../core-concepts/dpf-types.md#standard-types), [`vector<int32>`](../../core-concepts/dpf-types.md#standard-types), [`scoping`](../../core-concepts/dpf-types.md#scoping) | int or single value scoping or vector of int |
2020
| <strong>Pin 1</strong>| location |[`string`](../../core-concepts/dpf-types.md#standard-types) | |
21+
| <strong>Pin 2</strong>| upper_bound |[`int32`](../../core-concepts/dpf-types.md#standard-types), [`scoping`](../../core-concepts/dpf-types.md#scoping) | Define the upper bound to create a scoping that will contain a range from the single value input in pin 0 to the upper bound defined in this pin. |
2122

2223
## Outputs
2324

2026R1/dpf-framework-26-r1/toc.yml

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1752,6 +1752,8 @@
17521752
href: operator-specifications/utility/compute_time_scoping.md
17531753
- name: customtypefield get attribute
17541754
href: operator-specifications/utility/customtypefield_get_attribute.md
1755+
- name: cyclic support get attribute
1756+
href: operator-specifications/utility/cyclic_support_get_attribute.md
17551757
- name: default value
17561758
href: operator-specifications/utility/default_value.md
17571759
- name: delegate to operator

0 commit comments

Comments
 (0)