update generated code

Author: PProfizi

doc/source/_static/dpf_operators.html

@@ -283,6 +283,7 @@
 from .reaction_force_Z import reaction_force_Z
 from .read_cms_rbd_file import read_cms_rbd_file
 from .recombine_harmonic_indeces_cyclic import recombine_harmonic_indeces_cyclic
+from .record_reader import record_reader
 from .remove_rigid_body_motion import remove_rigid_body_motion
 from .remove_rigid_body_motion_fc import remove_rigid_body_motion_fc
 from .result_provider import result_provider

src/ansys/dpf/core/operators/result/__init__.py

@@ -0,0 +1,313 @@
+"""
+record_reader
+
+Autogenerated DPF operator classes.
+"""
+
+from __future__ import annotations
+from typing import TYPE_CHECKING
+
+from warnings import warn
+from ansys.dpf.core.dpf_operator import Operator
+from ansys.dpf.core.inputs import Input, _Inputs
+from ansys.dpf.core.outputs import Output, _Outputs
+from ansys.dpf.core.outputs import _modify_output_spec_with_one_type
+from ansys.dpf.core.operators.specification import PinSpecification, Specification
+from ansys.dpf.core.config import Config
+from ansys.dpf.core.server_types import AnyServerType
+
+if TYPE_CHECKING:
+    from ansys.dpf.core.data_sources import DataSources
+    from ansys.dpf.core.streams_container import StreamsContainer
+
+
+class record_reader(Operator):
+    r"""Extracts a record from a file.
+
+
+    Inputs
+    ------
+    streams: StreamsContainer, optional
+    data_sources: DataSources
+    record_name:
+        Name of the record that must be extracted from the file.
+
+        For example to read the nodal solution of the 4th set, input should be **RST::DSI::SET4::NSL**
+
+        The MAPDL records tree can be found in the following links:
+
+        - [Ansys Help - Retrieving Data from the Results File](https://ansyshelp.ansys.com/public/account/secured?returnurl=//////Views/Secured/corp/v252/en/ans_prog/datafromRST.html)
+
+        - [Ansys Help - Description of the Results File](https://ansyshelp.ansys.com/public/account/secured?returnurl=/Views/Secured/corp/v252/en/ans_prog/Hlp_P_INT1_2.html)
+
+    Outputs
+    -------
+    field: PropertyField or Field
+        Output is of type property_field for integer records and of type field for double records.
+
+    Examples
+    --------
+    >>> from ansys.dpf import core as dpf
+
+    >>> # Instantiate operator
+    >>> op = dpf.operators.result.record_reader()
+
+    >>> # Make input connections
+    >>> my_streams = dpf.StreamsContainer()
+    >>> op.inputs.streams.connect(my_streams)
+    >>> my_data_sources = dpf.DataSources()
+    >>> op.inputs.data_sources.connect(my_data_sources)
+    >>> my_record_name = dpf.()
+    >>> op.inputs.record_name.connect(my_record_name)
+
+    >>> # Instantiate operator and connect inputs in one line
+    >>> op = dpf.operators.result.record_reader(
+    ...     streams=my_streams,
+    ...     data_sources=my_data_sources,
+    ...     record_name=my_record_name,
+    ... )
+
+    >>> # Get output data
+    >>> result_field = op.outputs.field()
+    """
+
+    def __init__(
+        self,
+        streams=None,
+        data_sources=None,
+        record_name=None,
+        config=None,
+        server=None,
+    ):
+        super().__init__(
+            name="record_reader",
+            config=config,
+            server=server,
+            inputs_type=InputsRecordReader,
+            outputs_type=OutputsRecordReader,
+        )
+        if streams is not None:
+            self.inputs.streams.connect(streams)
+        if data_sources is not None:
+            self.inputs.data_sources.connect(data_sources)
+        if record_name is not None:
+            self.inputs.record_name.connect(record_name)
+
+    @staticmethod
+    def _spec() -> Specification:
+        description = r"""Extracts a record from a file.
+"""
+        spec = Specification(
+            description=description,
+            map_input_pin_spec={
+                3: PinSpecification(
+                    name="streams",
+                    type_names=["streams_container"],
+                    optional=True,
+                    document=r"""""",
+                ),
+                4: PinSpecification(
+                    name="data_sources",
+                    type_names=["data_sources"],
+                    optional=False,
+                    document=r"""""",
+                ),
+                60: PinSpecification(
+                    name="record_name",
+                    type_names=["any"],
+                    optional=False,
+                    document=r"""Name of the record that must be extracted from the file. 
+
+For example to read the nodal solution of the 4th set, input should be **RST::DSI::SET4::NSL**
+
+The MAPDL records tree can be found in the following links:
+
+- [Ansys Help - Retrieving Data from the Results File](https://ansyshelp.ansys.com/public/account/secured?returnurl=//////Views/Secured/corp/v252/en/ans_prog/datafromRST.html)
+
+- [Ansys Help - Description of the Results File](https://ansyshelp.ansys.com/public/account/secured?returnurl=/Views/Secured/corp/v252/en/ans_prog/Hlp_P_INT1_2.html)""",
+                ),
+            },
+            map_output_pin_spec={
+                0: PinSpecification(
+                    name="field",
+                    type_names=["property_field", "field"],
+                    optional=False,
+                    document=r"""Output is of type property_field for integer records and of type field for double records.""",
+                ),
+            },
+        )
+        return spec
+
+    @staticmethod
+    def default_config(server: AnyServerType = None) -> Config:
+        """Returns the default config of the operator.
+
+        This config can then be changed to the user needs and be used to
+        instantiate the operator. The Configuration allows to customize
+        how the operation will be processed by the operator.
+
+        Parameters
+        ----------
+        server:
+            Server with channel connected to the remote or local instance. When
+            ``None``, attempts to use the global server.
+
+        Returns
+        -------
+        config:
+            A new Config instance equivalent to the default config for this operator.
+        """
+        return Operator.default_config(name="record_reader", server=server)
+
+    @property
+    def inputs(self) -> InputsRecordReader:
+        """Enables to connect inputs to the operator
+
+        Returns
+        --------
+        inputs:
+            An instance of InputsRecordReader.
+        """
+        return self._inputs
+
+    @property
+    def outputs(self) -> OutputsRecordReader:
+        """Enables to get outputs of the operator by evaluating it
+
+        Returns
+        --------
+        outputs:
+            An instance of OutputsRecordReader.
+        """
+        return self._outputs
+
+
+class InputsRecordReader(_Inputs):
+    """Intermediate class used to connect user inputs to
+    record_reader operator.
+
+    Examples
+    --------
+    >>> from ansys.dpf import core as dpf
+    >>> op = dpf.operators.result.record_reader()
+    >>> my_streams = dpf.StreamsContainer()
+    >>> op.inputs.streams.connect(my_streams)
+    >>> my_data_sources = dpf.DataSources()
+    >>> op.inputs.data_sources.connect(my_data_sources)
+    >>> my_record_name = dpf.()
+    >>> op.inputs.record_name.connect(my_record_name)
+    """
+
+    def __init__(self, op: Operator):
+        super().__init__(record_reader._spec().inputs, op)
+        self._streams: Input[StreamsContainer] = Input(
+            record_reader._spec().input_pin(3), 3, op, -1
+        )
+        self._inputs.append(self._streams)
+        self._data_sources: Input[DataSources] = Input(
+            record_reader._spec().input_pin(4), 4, op, -1
+        )
+        self._inputs.append(self._data_sources)
+        self._record_name: Input = Input(
+            record_reader._spec().input_pin(60), 60, op, -1
+        )
+        self._inputs.append(self._record_name)
+
+    @property
+    def streams(self) -> Input[StreamsContainer]:
+        r"""Allows to connect streams input to the operator.
+
+        Returns
+        -------
+        input:
+            An Input instance for this pin.
+
+        Examples
+        --------
+        >>> from ansys.dpf import core as dpf
+        >>> op = dpf.operators.result.record_reader()
+        >>> op.inputs.streams.connect(my_streams)
+        >>> # or
+        >>> op.inputs.streams(my_streams)
+        """
+        return self._streams
+
+    @property
+    def data_sources(self) -> Input[DataSources]:
+        r"""Allows to connect data_sources input to the operator.
+
+        Returns
+        -------
+        input:
+            An Input instance for this pin.
+
+        Examples
+        --------
+        >>> from ansys.dpf import core as dpf
+        >>> op = dpf.operators.result.record_reader()
+        >>> op.inputs.data_sources.connect(my_data_sources)
+        >>> # or
+        >>> op.inputs.data_sources(my_data_sources)
+        """
+        return self._data_sources
+
+    @property
+    def record_name(self) -> Input:
+        r"""Allows to connect record_name input to the operator.
+
+        Name of the record that must be extracted from the file.
+
+        For example to read the nodal solution of the 4th set, input should be **RST::DSI::SET4::NSL**
+
+        The MAPDL records tree can be found in the following links:
+
+        - [Ansys Help - Retrieving Data from the Results File](https://ansyshelp.ansys.com/public/account/secured?returnurl=//////Views/Secured/corp/v252/en/ans_prog/datafromRST.html)
+
+        - [Ansys Help - Description of the Results File](https://ansyshelp.ansys.com/public/account/secured?returnurl=/Views/Secured/corp/v252/en/ans_prog/Hlp_P_INT1_2.html)
+
+        Returns
+        -------
+        input:
+            An Input instance for this pin.
+
+        Examples
+        --------
+        >>> from ansys.dpf import core as dpf
+        >>> op = dpf.operators.result.record_reader()
+        >>> op.inputs.record_name.connect(my_record_name)
+        >>> # or
+        >>> op.inputs.record_name(my_record_name)
+        """
+        return self._record_name
+
+
+class OutputsRecordReader(_Outputs):
+    """Intermediate class used to get outputs from
+    record_reader operator.
+
+    Examples
+    --------
+    >>> from ansys.dpf import core as dpf
+    >>> op = dpf.operators.result.record_reader()
+    >>> # Connect inputs : op.inputs. ...
+    >>> result_field = op.outputs.field()
+    """
+
+    def __init__(self, op: Operator):
+        super().__init__(record_reader._spec().outputs, op)
+        self.field_as_property_field = Output(
+            _modify_output_spec_with_one_type(
+                record_reader._spec().output_pin(0), "property_field"
+            ),
+            0,
+            op,
+        )
+        self._outputs.append(self.field_as_property_field)
+        self.field_as_field = Output(
+            _modify_output_spec_with_one_type(
+                record_reader._spec().output_pin(0), "field"
+            ),
+            0,
+            op,
+        )
+        self._outputs.append(self.field_as_field)

src/ansys/dpf/core/operators/result/record_reader.py

@@ -21,7 +21,8 @@
 
 
 class field_to_csv(Operator):
-    r"""Exports a field or a fields container into a csv file
+    r"""Exports a field or a fields container into a csv file. Currently only
+    homogenous Fields Definition of Fields Container are supported.
 
 
     Inputs
@@ -83,7 +84,8 @@ def __init__(
 
     @staticmethod
     def _spec() -> Specification:
-        description = r"""Exports a field or a fields container into a csv file
+        description = r"""Exports a field or a fields container into a csv file. Currently only
+homogenous Fields Definition of Fields Container are supported.
 """
         spec = Specification(
             description=description,