ansys-api-systemcoupling 0.1.0__py3-none-any.whl → 0.3.0__py3-none-any.whl

ansys/api/systemcoupling/v0/chart_pb2_grpc.py

@@ -0,0 +1,181 @@
+# Generated by the gRPC Python protocol compiler plugin. DO NOT EDIT!
+"""Client and server classes corresponding to protobuf-defined services."""
+import grpc
+
+from ansys.api.systemcoupling.v0 import chart_pb2 as ansys_dot_api_dot_systemcoupling_dot_v0_dot_chart__pb2
+
+
+class ChartDataStub(object):
+    """Service for querying chart data, both as a "live" stream during a solve
+    and as non-streaming requests for data after a solve has been performed.
+    """
+
+    def __init__(self, channel):
+        """Constructor.
+
+        Args:
+            channel: A grpc.Channel.
+        """
+        self.StreamChartData = channel.unary_stream(
+                '/ansys.api.systemcoupling.v0.ChartData/StreamChartData',
+                request_serializer=ansys_dot_api_dot_systemcoupling_dot_v0_dot_chart__pb2.ChartDataRequest.SerializeToString,
+                response_deserializer=ansys_dot_api_dot_systemcoupling_dot_v0_dot_chart__pb2.ChartDataEvent.FromString,
+                )
+        self.GetChartMetadata = channel.unary_unary(
+                '/ansys.api.systemcoupling.v0.ChartData/GetChartMetadata',
+                request_serializer=ansys_dot_api_dot_systemcoupling_dot_v0_dot_chart__pb2.ChartMetadataRequest.SerializeToString,
+                response_deserializer=ansys_dot_api_dot_systemcoupling_dot_v0_dot_chart__pb2.ChartMetadata.FromString,
+                )
+        self.GetChartSeriesData = channel.unary_unary(
+                '/ansys.api.systemcoupling.v0.ChartData/GetChartSeriesData',
+                request_serializer=ansys_dot_api_dot_systemcoupling_dot_v0_dot_chart__pb2.ChartSeriesDataRequest.SerializeToString,
+                response_deserializer=ansys_dot_api_dot_systemcoupling_dot_v0_dot_chart__pb2.AllSeriesData.FromString,
+                )
+        self.GetChartTimestepData = channel.unary_unary(
+                '/ansys.api.systemcoupling.v0.ChartData/GetChartTimestepData',
+                request_serializer=ansys_dot_api_dot_systemcoupling_dot_v0_dot_chart__pb2.ChartTimestepDataRequest.SerializeToString,
+                response_deserializer=ansys_dot_api_dot_systemcoupling_dot_v0_dot_chart__pb2.TimestepData.FromString,
+                )
+
+
+class ChartDataServicer(object):
+    """Service for querying chart data, both as a "live" stream during a solve
+    and as non-streaming requests for data after a solve has been performed.
+    """
+
+    def StreamChartData(self, request, context):
+        """Streams chart data events starting with interface metadata followed by
+        series data and timestep data as they become available on the server.
+        For transient cases, timestep data will be included in the stream.
+        """
+        context.set_code(grpc.StatusCode.UNIMPLEMENTED)
+        context.set_details('Method not implemented!')
+        raise NotImplementedError('Method not implemented!')
+
+    def GetChartMetadata(self, request, context):
+        """The following RPCs provide non-streaming access to chart data.
+        This should be available as long as a solve has been performed
+        in the current session.
+
+        Retrieves the chart metadata for all available series.
+        """
+        context.set_code(grpc.StatusCode.UNIMPLEMENTED)
+        context.set_details('Method not implemented!')
+        raise NotImplementedError('Method not implemented!')
+
+    def GetChartSeriesData(self, request, context):
+        """Retrieves all data for all chart series.
+        """
+        context.set_code(grpc.StatusCode.UNIMPLEMENTED)
+        context.set_details('Method not implemented!')
+        raise NotImplementedError('Method not implemented!')
+
+    def GetChartTimestepData(self, request, context):
+        """Retrieves all data for all chart timesteps.
+        """
+        context.set_code(grpc.StatusCode.UNIMPLEMENTED)
+        context.set_details('Method not implemented!')
+        raise NotImplementedError('Method not implemented!')
+
+
+def add_ChartDataServicer_to_server(servicer, server):
+    rpc_method_handlers = {
+            'StreamChartData': grpc.unary_stream_rpc_method_handler(
+                    servicer.StreamChartData,
+                    request_deserializer=ansys_dot_api_dot_systemcoupling_dot_v0_dot_chart__pb2.ChartDataRequest.FromString,
+                    response_serializer=ansys_dot_api_dot_systemcoupling_dot_v0_dot_chart__pb2.ChartDataEvent.SerializeToString,
+            ),
+            'GetChartMetadata': grpc.unary_unary_rpc_method_handler(
+                    servicer.GetChartMetadata,
+                    request_deserializer=ansys_dot_api_dot_systemcoupling_dot_v0_dot_chart__pb2.ChartMetadataRequest.FromString,
+                    response_serializer=ansys_dot_api_dot_systemcoupling_dot_v0_dot_chart__pb2.ChartMetadata.SerializeToString,
+            ),
+            'GetChartSeriesData': grpc.unary_unary_rpc_method_handler(
+                    servicer.GetChartSeriesData,
+                    request_deserializer=ansys_dot_api_dot_systemcoupling_dot_v0_dot_chart__pb2.ChartSeriesDataRequest.FromString,
+                    response_serializer=ansys_dot_api_dot_systemcoupling_dot_v0_dot_chart__pb2.AllSeriesData.SerializeToString,
+            ),
+            'GetChartTimestepData': grpc.unary_unary_rpc_method_handler(
+                    servicer.GetChartTimestepData,
+                    request_deserializer=ansys_dot_api_dot_systemcoupling_dot_v0_dot_chart__pb2.ChartTimestepDataRequest.FromString,
+                    response_serializer=ansys_dot_api_dot_systemcoupling_dot_v0_dot_chart__pb2.TimestepData.SerializeToString,
+            ),
+    }
+    generic_handler = grpc.method_handlers_generic_handler(
+            'ansys.api.systemcoupling.v0.ChartData', rpc_method_handlers)
+    server.add_generic_rpc_handlers((generic_handler,))
+
+
+ # This class is part of an EXPERIMENTAL API.
+class ChartData(object):
+    """Service for querying chart data, both as a "live" stream during a solve
+    and as non-streaming requests for data after a solve has been performed.
+    """
+
+    @staticmethod
+    def StreamChartData(request,
+            target,
+            options=(),
+            channel_credentials=None,
+            call_credentials=None,
+            insecure=False,
+            compression=None,
+            wait_for_ready=None,
+            timeout=None,
+            metadata=None):
+        return grpc.experimental.unary_stream(request, target, '/ansys.api.systemcoupling.v0.ChartData/StreamChartData',
+            ansys_dot_api_dot_systemcoupling_dot_v0_dot_chart__pb2.ChartDataRequest.SerializeToString,
+            ansys_dot_api_dot_systemcoupling_dot_v0_dot_chart__pb2.ChartDataEvent.FromString,
+            options, channel_credentials,
+            insecure, call_credentials, compression, wait_for_ready, timeout, metadata)
+
+    @staticmethod
+    def GetChartMetadata(request,
+            target,
+            options=(),
+            channel_credentials=None,
+            call_credentials=None,
+            insecure=False,
+            compression=None,
+            wait_for_ready=None,
+            timeout=None,
+            metadata=None):
+        return grpc.experimental.unary_unary(request, target, '/ansys.api.systemcoupling.v0.ChartData/GetChartMetadata',
+            ansys_dot_api_dot_systemcoupling_dot_v0_dot_chart__pb2.ChartMetadataRequest.SerializeToString,
+            ansys_dot_api_dot_systemcoupling_dot_v0_dot_chart__pb2.ChartMetadata.FromString,
+            options, channel_credentials,
+            insecure, call_credentials, compression, wait_for_ready, timeout, metadata)
+
+    @staticmethod
+    def GetChartSeriesData(request,
+            target,
+            options=(),
+            channel_credentials=None,
+            call_credentials=None,
+            insecure=False,
+            compression=None,
+            wait_for_ready=None,
+            timeout=None,
+            metadata=None):
+        return grpc.experimental.unary_unary(request, target, '/ansys.api.systemcoupling.v0.ChartData/GetChartSeriesData',
+            ansys_dot_api_dot_systemcoupling_dot_v0_dot_chart__pb2.ChartSeriesDataRequest.SerializeToString,
+            ansys_dot_api_dot_systemcoupling_dot_v0_dot_chart__pb2.AllSeriesData.FromString,
+            options, channel_credentials,
+            insecure, call_credentials, compression, wait_for_ready, timeout, metadata)
+
+    @staticmethod
+    def GetChartTimestepData(request,
+            target,
+            options=(),
+            channel_credentials=None,
+            call_credentials=None,
+            insecure=False,
+            compression=None,
+            wait_for_ready=None,
+            timeout=None,
+            metadata=None):
+        return grpc.experimental.unary_unary(request, target, '/ansys.api.systemcoupling.v0.ChartData/GetChartTimestepData',
+            ansys_dot_api_dot_systemcoupling_dot_v0_dot_chart__pb2.ChartTimestepDataRequest.SerializeToString,
+            ansys_dot_api_dot_systemcoupling_dot_v0_dot_chart__pb2.TimestepData.FromString,
+            options, channel_credentials,
+            insecure, call_credentials, compression, wait_for_ready, timeout, metadata)

ansys/api/systemcoupling/v0/chart_pb2_grpc.pyi

@@ -0,0 +1,89 @@
+"""
+@generated by mypy-protobuf.  Do not edit manually!
+isort:skip_file
+"""
+import abc
+import ansys.api.systemcoupling.v0.chart_pb2
+import grpc
+import typing
+
+class ChartDataStub:
+    """Service for querying chart data, both as a "live" stream during a solve
+    and as non-streaming requests for data after a solve has been performed.
+    """
+    def __init__(self, channel: grpc.Channel) -> None: ...
+    StreamChartData: grpc.UnaryStreamMultiCallable[
+        ansys.api.systemcoupling.v0.chart_pb2.ChartDataRequest,
+        ansys.api.systemcoupling.v0.chart_pb2.ChartDataEvent] = ...
+    """Streams chart data events starting with interface metadata followed by
+    series data and timestep data as they become available on the server.
+    For transient cases, timestep data will be included in the stream.
+    """
+
+    GetChartMetadata: grpc.UnaryUnaryMultiCallable[
+        ansys.api.systemcoupling.v0.chart_pb2.ChartMetadataRequest,
+        ansys.api.systemcoupling.v0.chart_pb2.ChartMetadata] = ...
+    """The following RPCs provide non-streaming access to chart data.
+    This should be available as long as a solve has been performed
+    in the current session.
+
+    Retrieves the chart metadata for all available series.
+    """
+
+    GetChartSeriesData: grpc.UnaryUnaryMultiCallable[
+        ansys.api.systemcoupling.v0.chart_pb2.ChartSeriesDataRequest,
+        ansys.api.systemcoupling.v0.chart_pb2.AllSeriesData] = ...
+    """Retrieves all data for all chart series."""
+
+    GetChartTimestepData: grpc.UnaryUnaryMultiCallable[
+        ansys.api.systemcoupling.v0.chart_pb2.ChartTimestepDataRequest,
+        ansys.api.systemcoupling.v0.chart_pb2.TimestepData] = ...
+    """Retrieves all data for all chart timesteps."""
+
+
+class ChartDataServicer(metaclass=abc.ABCMeta):
+    """Service for querying chart data, both as a "live" stream during a solve
+    and as non-streaming requests for data after a solve has been performed.
+    """
+    @abc.abstractmethod
+    def StreamChartData(self,
+        request: ansys.api.systemcoupling.v0.chart_pb2.ChartDataRequest,
+        context: grpc.ServicerContext,
+    ) -> typing.Iterator[ansys.api.systemcoupling.v0.chart_pb2.ChartDataEvent]:
+        """Streams chart data events starting with interface metadata followed by
+        series data and timestep data as they become available on the server.
+        For transient cases, timestep data will be included in the stream.
+        """
+        pass
+
+    @abc.abstractmethod
+    def GetChartMetadata(self,
+        request: ansys.api.systemcoupling.v0.chart_pb2.ChartMetadataRequest,
+        context: grpc.ServicerContext,
+    ) -> ansys.api.systemcoupling.v0.chart_pb2.ChartMetadata:
+        """The following RPCs provide non-streaming access to chart data.
+        This should be available as long as a solve has been performed
+        in the current session.
+
+        Retrieves the chart metadata for all available series.
+        """
+        pass
+
+    @abc.abstractmethod
+    def GetChartSeriesData(self,
+        request: ansys.api.systemcoupling.v0.chart_pb2.ChartSeriesDataRequest,
+        context: grpc.ServicerContext,
+    ) -> ansys.api.systemcoupling.v0.chart_pb2.AllSeriesData:
+        """Retrieves all data for all chart series."""
+        pass
+
+    @abc.abstractmethod
+    def GetChartTimestepData(self,
+        request: ansys.api.systemcoupling.v0.chart_pb2.ChartTimestepDataRequest,
+        context: grpc.ServicerContext,
+    ) -> ansys.api.systemcoupling.v0.chart_pb2.TimestepData:
+        """Retrieves all data for all chart timesteps."""
+        pass
+
+
+def add_ChartDataServicer_to_server(servicer: ChartDataServicer, server: grpc.Server) -> None: ...

ansys/api/systemcoupling/v0/command.proto

@@ -1,23 +1,23 @@
-// Copyright (C) 2023 ANSYS, Inc. and/or its affiliates.
-syntax = "proto3";
-
-package ansys.api.systemcoupling.v0;
-
-import "ansys/api/systemcoupling/v0/variant.proto";
-
-service Command {
-  rpc InvokeCommand (CommandRequest) returns (CommandResponse) {}
-}
-
-message CommandRequest {
-  message Argument {
-    string name = 1;
-    Variant val = 2;
-  }
-  string command = 1;
-  repeated Argument args = 2;
-}
-
-message CommandResponse {
-  Variant result = 1;
-}
+// Copyright (C) 2023 ANSYS, Inc. and/or its affiliates.
+syntax = "proto3";
+
+package ansys.api.systemcoupling.v0;
+
+import "ansys/api/systemcoupling/v0/variant.proto";
+
+service Command {
+  rpc InvokeCommand (CommandRequest) returns (CommandResponse) {}
+}
+
+message CommandRequest {
+  message Argument {
+    string name = 1;
+    Variant val = 2;
+  }
+  string command = 1;
+  repeated Argument args = 2;
+}
+
+message CommandResponse {
+  Variant result = 1;
+}

ansys/api/systemcoupling/v0/error.proto

@@ -1,9 +1,9 @@
-// Copyright (C) 2023 ANSYS, Inc. and/or its affiliates.
-syntax = "proto3";
-
-package ansys.api.systemcoupling.v0;
-
-message ErrorDetails {
-  string exception_classname = 1;
-  string stack_trace = 2;
+// Copyright (C) 2023 ANSYS, Inc. and/or its affiliates.
+syntax = "proto3";
+
+package ansys.api.systemcoupling.v0;
+
+message ErrorDetails {
+  string exception_classname = 1;
+  string stack_trace = 2;
 }

ansys/api/systemcoupling/v0/output_stream.proto

@@ -1,15 +1,15 @@
-// Copyright (C) 2023 ANSYS, Inc. and/or its affiliates.
-syntax = "proto3";
-
-package ansys.api.systemcoupling.v0;
-
-service OutputStream {
-  rpc BeginStdStreaming(StdStreamRequest) returns (stream StdStreamResponse) {}
-}
-
-message StdStreamRequest {
-}
-
-message StdStreamResponse {
-  string text = 1;
-}
+// Copyright (C) 2023 ANSYS, Inc. and/or its affiliates.
+syntax = "proto3";
+
+package ansys.api.systemcoupling.v0;
+
+service OutputStream {
+  rpc BeginStdStreaming(StdStreamRequest) returns (stream StdStreamResponse) {}
+}
+
+message StdStreamRequest {
+}
+
+message StdStreamResponse {
+  string text = 1;
+}

ansys/api/systemcoupling/v0/process.proto

@@ -1,15 +1,15 @@
-// Copyright (C) 2023 ANSYS, Inc. and/or its affiliates.
-syntax = "proto3";
-
-package ansys.api.systemcoupling.v0;
-
-service Process {
-  rpc Ping (PingRequest) returns (PingResponse) {}
-  rpc Quit (QuitRequest) returns (QuitResponse) {}
-}
-
-message PingRequest {}
-message PingResponse {}
-
-message QuitRequest {}
-message QuitResponse {}
+// Copyright (C) 2023 ANSYS, Inc. and/or its affiliates.
+syntax = "proto3";
+
+package ansys.api.systemcoupling.v0;
+
+service Process {
+  rpc Ping (PingRequest) returns (PingResponse) {}
+  rpc Quit (QuitRequest) returns (QuitResponse) {}
+}
+
+message PingRequest {}
+message PingResponse {}
+
+message QuitRequest {}
+message QuitResponse {}

ansys/api/systemcoupling/v0/solution.proto

@@ -1,30 +1,30 @@
-// Copyright (C) 2023 ANSYS, Inc. and/or its affiliates.
-syntax = "proto3";
-
-package ansys.api.systemcoupling.v0;
-
-service Solution {
-  rpc Solve (SolveRequest) returns (SolveResponse) {}
-  rpc Interrupt (InterruptRequest) returns (InterruptResponse) {}
-  rpc Abort (AbortRequest) returns (AbortResponse) {}
-}
-
-// Note that all responses are currently empty messages
-// In particular no status info for solve is returned -
-// failure or early termination of solve will be
-// communicated by an exception as for commands
-// via the Command service.
-
-message SolveRequest {}
-message SolveResponse {}
-
-message InterruptRequest {
-  string reason = 1;
-}
-message InterruptResponse {}
-
-message AbortRequest {
-  string reason = 1;
-}
-message AbortResponse {}
-
+// Copyright (C) 2023 ANSYS, Inc. and/or its affiliates.
+syntax = "proto3";
+
+package ansys.api.systemcoupling.v0;
+
+service Solution {
+  rpc Solve (SolveRequest) returns (SolveResponse) {}
+  rpc Interrupt (InterruptRequest) returns (InterruptResponse) {}
+  rpc Abort (AbortRequest) returns (AbortResponse) {}
+}
+
+// Note that all responses are currently empty messages
+// In particular no status info for solve is returned -
+// failure or early termination of solve will be
+// communicated by an exception as for commands
+// via the Command service.
+
+message SolveRequest {}
+message SolveResponse {}
+
+message InterruptRequest {
+  string reason = 1;
+}
+message InterruptResponse {}
+
+message AbortRequest {
+  string reason = 1;
+}
+message AbortResponse {}
+

ansys/api/systemcoupling/v0/variant.proto

@@ -1,51 +1,51 @@
-// Copyright (C) 2023 ANSYS, Inc. and/or its affiliates.
-syntax = "proto3";
-
-package ansys.api.systemcoupling.v0;
-
-enum NoneValue {
-  NONE_VALUE=0;
-}
-
-message StringVector {
-  repeated string item = 1;
-}
-
-message DoubleVector {
-  repeated double item = 1;
-}
-
-message BoolVector {
-  repeated bool item = 1;
-}
-
-message Int64Vector {
-  repeated sint64 item = 1;
-}
-
-message VariantMap {
-  map<string, Variant> item = 1;
-}
-
-message VariantVector {
-  repeated Variant item = 1;
-}
-
-message Variant {
-  oneof as {
-      NoneValue none_state = 1;
-
-      bool bool_state = 2;
-      sint64 int64_state = 3;
-      double double_state = 5;
-      string string_state = 6;
-
-      BoolVector bool_vector_state = 7;
-      Int64Vector int64_vector_state = 8;
-      DoubleVector double_vector_state = 9;
-      StringVector string_vector_state = 10;
-      VariantVector variant_vector_state = 11;
-      VariantMap variant_map_state = 12;
-  }
-}
-
+// Copyright (C) 2023 ANSYS, Inc. and/or its affiliates.
+syntax = "proto3";
+
+package ansys.api.systemcoupling.v0;
+
+enum NoneValue {
+  NONE_VALUE=0;
+}
+
+message StringVector {
+  repeated string item = 1;
+}
+
+message DoubleVector {
+  repeated double item = 1;
+}
+
+message BoolVector {
+  repeated bool item = 1;
+}
+
+message Int64Vector {
+  repeated sint64 item = 1;
+}
+
+message VariantMap {
+  map<string, Variant> item = 1;
+}
+
+message VariantVector {
+  repeated Variant item = 1;
+}
+
+message Variant {
+  oneof as {
+      NoneValue none_state = 1;
+
+      bool bool_state = 2;
+      sint64 int64_state = 3;
+      double double_state = 5;
+      string string_state = 6;
+
+      BoolVector bool_vector_state = 7;
+      Int64Vector int64_vector_state = 8;
+      DoubleVector double_vector_state = 9;
+      StringVector string_vector_state = 10;
+      VariantVector variant_vector_state = 11;
+      VariantMap variant_map_state = 12;
+  }
+}
+

{ansys_api_systemcoupling-0.1.0.dist-info → ansys_api_systemcoupling-0.3.0.dist-info}/LICENSE

@@ -1,21 +1,21 @@
-MIT License
-
-Copyright (c) 2022 ANSYS, Inc. All rights reserved.
-
-Permission is hereby granted, free of charge, to any person obtaining a copy
-of this software and associated documentation files (the "Software"), to deal
-in the Software without restriction, including without limitation the rights
-to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
-copies of the Software, and to permit persons to whom the Software is
-furnished to do so, subject to the following conditions:
-
-The above copyright notice and this permission notice shall be included in all
-copies or substantial portions of the Software.
-
-THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
-IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
-FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
-AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
-LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
-OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
-SOFTWARE.
+MIT License
+
+Copyright (c) 2022 ANSYS, Inc. All rights reserved.
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.