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

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
@@ -1 +1 @@
1
- 0.2.0
1
+ 0.3.0
@@ -0,0 +1,159 @@
1
+ syntax = "proto3";
2
+
3
+ package ansys.api.systemcoupling.v0;
4
+
5
+ // Enum containing the different types of chart series.
6
+ enum TransferSeriesType {
7
+ SERIES_TYPE_UNKNOWN=0;
8
+ SERIES_TYPE_CONVERGENCE = 1;
9
+ SERIES_TYPE_SUM = 2;
10
+ SERIES_TYPE_WEIGHTED_AVERAGE = 3;
11
+ }
12
+
13
+ // Information about the chart series data associated with a data transfer.
14
+ message TransferSeriesInfo {
15
+ // The type of line series.
16
+ TransferSeriesType series_type = 1;
17
+ // The unique internal name of the data transfer.
18
+ string transfer_name = 2;
19
+ // The unique internal name of the participant. This is required for transfer value series
20
+ // but is empty for CONVERGENCE series. Used in chart labelling.
21
+ string participant_name = 3;
22
+ // The suffix for this component series, if applicable. This is only needed for
23
+ // transfer value series that have multiple components, such as complex or vector
24
+ // values. Suffixes for complex components are "real" and "imag", and suffixes for
25
+ // vector components are "x", "y", and "z". A combination is possible, such as
26
+ // "y real" and "x imag". (Empty for CONVERGENCE series)
27
+ string component_suffix = 4;
28
+ }
29
+
30
+ // Information about the chart series data associated with a single interface.
31
+ message InterfaceInfo {
32
+ // The name of the coupling interface data model object.
33
+ string interface_name = 1;
34
+ // The list of TransferSeriesInfo associated with this interface.
35
+ repeated TransferSeriesInfo transfer_info = 2;
36
+ }
37
+
38
+ // Complete metadata for available chart series.
39
+ message ChartMetadata {
40
+ // Whether the chart is for a transient analysis.
41
+ bool is_transient = 1;
42
+ // The metadata for the series associated with each interface.
43
+ repeated InterfaceInfo interface_info = 2;
44
+ }
45
+
46
+ // The plot data for a single chart line series and information to allow
47
+ // it to be associated with chart metadata.
48
+ // An instance of this type is assumed to be associated with a single interface.
49
+ // This message supports per-iteration incremental data, batched data for a
50
+ // subset of iterations, or complete data for all iterations.
51
+ message SeriesData {
52
+ // The name of the interface this series is associated with.
53
+ string interface_name = 1;
54
+ // Index of the TransferSeriesInfo metadata for this series within the
55
+ // InterfaceInfo for the interface this series is associated with.
56
+ int32 transfer_series_index = 2;
57
+ // The 0-based start index of the data field. This defaults to 0 and
58
+ // only needs to be set to a different value if incremental data, such
59
+ // as might arise during "live" update of plots, has become available.
60
+ // Data indexes correspond to iterations. Iteration N will have an
61
+ // index of N-1.
62
+ int32 start_index = 3;
63
+ // The series data. This is always indexed by iteration. Extract time
64
+ // step-based data by using a time step to iteration mapping.
65
+ repeated double data = 4;
66
+ }
67
+
68
+
69
+ // Message providing notification and details of a new timestep in a transient analysis.
70
+ // This message is intended for use in live updates. See TimestepData for
71
+ // cumulative timestep information.
72
+ message TimestepStart {
73
+ // The timestep count of the new timestep.
74
+ int32 timestep_count = 1;
75
+ // The end time of the current timestep.
76
+ // For the first timestep, this is the timestep size. For subsequent
77
+ // timesteps, the timestep size can be determined by subtracting the previous
78
+ // time value from the current time value.
79
+ double time = 2;
80
+ }
81
+
82
+ // Message providing notification and details of the end of a timestep in a transient analysis.
83
+ // This message is intended for use in live updates. See TimestepData for
84
+ // cumulative timestep information.
85
+ message TimestepEnd {
86
+ // The timestep count of the ended timestep.
87
+ int32 timestep_count = 1;
88
+ // The ending iteration for the timestep. NB: This is a 1-based iteration count.
89
+ int32 iteration_count = 2;
90
+ }
91
+
92
+ // Chart data event that can contain different types of chart data.
93
+ // The first event in a stream will typically contain interface metadata,
94
+ // followed by series data and timestep data as they become available.
95
+ message ChartDataEvent {
96
+ oneof event_data {
97
+ // Metadata containing information about the available series.
98
+ ChartMetadata metadata = 1;
99
+ // Series data for a specific chart line series.
100
+ SeriesData series_data = 2;
101
+ // Timestep start notification for transient analyses.
102
+ TimestepStart timestep_start = 3;
103
+ // Timestep end notification for transient analyses.
104
+ TimestepEnd timestep_end = 4;
105
+ }
106
+ }
107
+
108
+ // Message providing all series data for all interfaces.
109
+ // For use in post-solve, non-streaming retrieval of chart data.
110
+ message AllSeriesData {
111
+ // List of all available series data.
112
+ repeated SeriesData series_data = 1;
113
+ }
114
+
115
+ // Message providing all timestep data for transient analyses.
116
+ // For use in post-solve, non-streaming retrieval of chart data.
117
+ message TimestepData {
118
+ // The mapping of timestep count to iteration count.
119
+ // NB: these are 1-based step and iteration counts.
120
+ repeated int32 timestep_to_iteration = 1;
121
+ // The time values for each timestep.
122
+ repeated double time_values = 2;
123
+ }
124
+
125
+ // Service for querying chart data, both as a "live" stream during a solve
126
+ // and as non-streaming requests for data after a solve has been performed.
127
+ service ChartData {
128
+ // Streams chart data events starting with interface metadata followed by
129
+ // series data and timestep data as they become available on the server.
130
+ // For transient cases, timestep data will be included in the stream.
131
+ rpc StreamChartData(ChartDataRequest) returns (stream ChartDataEvent);
132
+
133
+ // The following RPCs provide non-streaming access to chart data.
134
+ // This should be available as long as a solve has been performed
135
+ // in the current session.
136
+
137
+ // Retrieves the chart metadata for all available series.
138
+ rpc GetChartMetadata(ChartMetadataRequest) returns (ChartMetadata);
139
+ // Retrieves all data for all chart series.
140
+ rpc GetChartSeriesData(ChartSeriesDataRequest) returns (AllSeriesData);
141
+ // Retrieves all data for all chart timesteps.
142
+ rpc GetChartTimestepData(ChartTimestepDataRequest) returns (TimestepData);
143
+ }
144
+
145
+ // Request message for chart data streaming.
146
+ message ChartDataRequest {
147
+ }
148
+
149
+ // Request message for chart metadata retrieval.
150
+ message ChartMetadataRequest {
151
+ }
152
+
153
+ // Request message for all chart series data retrieval.
154
+ message ChartSeriesDataRequest {
155
+ }
156
+
157
+ // Request message for chart timestep data retrieval.
158
+ message ChartTimestepDataRequest {
159
+ }
@@ -0,0 +1,166 @@
1
+ # -*- coding: utf-8 -*-
2
+ # Generated by the protocol buffer compiler. DO NOT EDIT!
3
+ # source: ansys/api/systemcoupling/v0/chart.proto
4
+ """Generated protocol buffer code."""
5
+ from google.protobuf.internal import enum_type_wrapper
6
+ from google.protobuf import descriptor as _descriptor
7
+ from google.protobuf import descriptor_pool as _descriptor_pool
8
+ from google.protobuf import message as _message
9
+ from google.protobuf import reflection as _reflection
10
+ from google.protobuf import symbol_database as _symbol_database
11
+ # @@protoc_insertion_point(imports)
12
+
13
+ _sym_db = _symbol_database.Default()
14
+
15
+
16
+
17
+
18
+ DESCRIPTOR = _descriptor_pool.Default().AddSerializedFile(b'\n\'ansys/api/systemcoupling/v0/chart.proto\x12\x1b\x61nsys.api.systemcoupling.v0\"\xa5\x01\n\x12TransferSeriesInfo\x12\x44\n\x0bseries_type\x18\x01 \x01(\x0e\x32/.ansys.api.systemcoupling.v0.TransferSeriesType\x12\x15\n\rtransfer_name\x18\x02 \x01(\t\x12\x18\n\x10participant_name\x18\x03 \x01(\t\x12\x18\n\x10\x63omponent_suffix\x18\x04 \x01(\t\"o\n\rInterfaceInfo\x12\x16\n\x0einterface_name\x18\x01 \x01(\t\x12\x46\n\rtransfer_info\x18\x02 \x03(\x0b\x32/.ansys.api.systemcoupling.v0.TransferSeriesInfo\"i\n\rChartMetadata\x12\x14\n\x0cis_transient\x18\x01 \x01(\x08\x12\x42\n\x0einterface_info\x18\x02 \x03(\x0b\x32*.ansys.api.systemcoupling.v0.InterfaceInfo\"f\n\nSeriesData\x12\x16\n\x0einterface_name\x18\x01 \x01(\t\x12\x1d\n\x15transfer_series_index\x18\x02 \x01(\x05\x12\x13\n\x0bstart_index\x18\x03 \x01(\x05\x12\x0c\n\x04\x64\x61ta\x18\x04 \x03(\x01\"5\n\rTimestepStart\x12\x16\n\x0etimestep_count\x18\x01 \x01(\x05\x12\x0c\n\x04time\x18\x02 \x01(\x01\">\n\x0bTimestepEnd\x12\x16\n\x0etimestep_count\x18\x01 \x01(\x05\x12\x17\n\x0fiteration_count\x18\x02 \x01(\x05\"\xa6\x02\n\x0e\x43hartDataEvent\x12>\n\x08metadata\x18\x01 \x01(\x0b\x32*.ansys.api.systemcoupling.v0.ChartMetadataH\x00\x12>\n\x0bseries_data\x18\x02 \x01(\x0b\x32\'.ansys.api.systemcoupling.v0.SeriesDataH\x00\x12\x44\n\x0etimestep_start\x18\x03 \x01(\x0b\x32*.ansys.api.systemcoupling.v0.TimestepStartH\x00\x12@\n\x0ctimestep_end\x18\x04 \x01(\x0b\x32(.ansys.api.systemcoupling.v0.TimestepEndH\x00\x42\x0c\n\nevent_data\"M\n\rAllSeriesData\x12<\n\x0bseries_data\x18\x01 \x03(\x0b\x32\'.ansys.api.systemcoupling.v0.SeriesData\"B\n\x0cTimestepData\x12\x1d\n\x15timestep_to_iteration\x18\x01 \x03(\x05\x12\x13\n\x0btime_values\x18\x02 \x03(\x01\"\x12\n\x10\x43hartDataRequest\"\x16\n\x14\x43hartMetadataRequest\"\x18\n\x16\x43hartSeriesDataRequest\"\x1a\n\x18\x43hartTimestepDataRequest*\x81\x01\n\x12TransferSeriesType\x12\x17\n\x13SERIES_TYPE_UNKNOWN\x10\x00\x12\x1b\n\x17SERIES_TYPE_CONVERGENCE\x10\x01\x12\x13\n\x0fSERIES_TYPE_SUM\x10\x02\x12 \n\x1cSERIES_TYPE_WEIGHTED_AVERAGE\x10\x03\x32\xe0\x03\n\tChartData\x12o\n\x0fStreamChartData\x12-.ansys.api.systemcoupling.v0.ChartDataRequest\x1a+.ansys.api.systemcoupling.v0.ChartDataEvent0\x01\x12q\n\x10GetChartMetadata\x12\x31.ansys.api.systemcoupling.v0.ChartMetadataRequest\x1a*.ansys.api.systemcoupling.v0.ChartMetadata\x12u\n\x12GetChartSeriesData\x12\x33.ansys.api.systemcoupling.v0.ChartSeriesDataRequest\x1a*.ansys.api.systemcoupling.v0.AllSeriesData\x12x\n\x14GetChartTimestepData\x12\x35.ansys.api.systemcoupling.v0.ChartTimestepDataRequest\x1a).ansys.api.systemcoupling.v0.TimestepDatab\x06proto3')
19
+
20
+ _TRANSFERSERIESTYPE = DESCRIPTOR.enum_types_by_name['TransferSeriesType']
21
+ TransferSeriesType = enum_type_wrapper.EnumTypeWrapper(_TRANSFERSERIESTYPE)
22
+ SERIES_TYPE_UNKNOWN = 0
23
+ SERIES_TYPE_CONVERGENCE = 1
24
+ SERIES_TYPE_SUM = 2
25
+ SERIES_TYPE_WEIGHTED_AVERAGE = 3
26
+
27
+
28
+ _TRANSFERSERIESINFO = DESCRIPTOR.message_types_by_name['TransferSeriesInfo']
29
+ _INTERFACEINFO = DESCRIPTOR.message_types_by_name['InterfaceInfo']
30
+ _CHARTMETADATA = DESCRIPTOR.message_types_by_name['ChartMetadata']
31
+ _SERIESDATA = DESCRIPTOR.message_types_by_name['SeriesData']
32
+ _TIMESTEPSTART = DESCRIPTOR.message_types_by_name['TimestepStart']
33
+ _TIMESTEPEND = DESCRIPTOR.message_types_by_name['TimestepEnd']
34
+ _CHARTDATAEVENT = DESCRIPTOR.message_types_by_name['ChartDataEvent']
35
+ _ALLSERIESDATA = DESCRIPTOR.message_types_by_name['AllSeriesData']
36
+ _TIMESTEPDATA = DESCRIPTOR.message_types_by_name['TimestepData']
37
+ _CHARTDATAREQUEST = DESCRIPTOR.message_types_by_name['ChartDataRequest']
38
+ _CHARTMETADATAREQUEST = DESCRIPTOR.message_types_by_name['ChartMetadataRequest']
39
+ _CHARTSERIESDATAREQUEST = DESCRIPTOR.message_types_by_name['ChartSeriesDataRequest']
40
+ _CHARTTIMESTEPDATAREQUEST = DESCRIPTOR.message_types_by_name['ChartTimestepDataRequest']
41
+ TransferSeriesInfo = _reflection.GeneratedProtocolMessageType('TransferSeriesInfo', (_message.Message,), {
42
+ 'DESCRIPTOR' : _TRANSFERSERIESINFO,
43
+ '__module__' : 'ansys.api.systemcoupling.v0.chart_pb2'
44
+ # @@protoc_insertion_point(class_scope:ansys.api.systemcoupling.v0.TransferSeriesInfo)
45
+ })
46
+ _sym_db.RegisterMessage(TransferSeriesInfo)
47
+
48
+ InterfaceInfo = _reflection.GeneratedProtocolMessageType('InterfaceInfo', (_message.Message,), {
49
+ 'DESCRIPTOR' : _INTERFACEINFO,
50
+ '__module__' : 'ansys.api.systemcoupling.v0.chart_pb2'
51
+ # @@protoc_insertion_point(class_scope:ansys.api.systemcoupling.v0.InterfaceInfo)
52
+ })
53
+ _sym_db.RegisterMessage(InterfaceInfo)
54
+
55
+ ChartMetadata = _reflection.GeneratedProtocolMessageType('ChartMetadata', (_message.Message,), {
56
+ 'DESCRIPTOR' : _CHARTMETADATA,
57
+ '__module__' : 'ansys.api.systemcoupling.v0.chart_pb2'
58
+ # @@protoc_insertion_point(class_scope:ansys.api.systemcoupling.v0.ChartMetadata)
59
+ })
60
+ _sym_db.RegisterMessage(ChartMetadata)
61
+
62
+ SeriesData = _reflection.GeneratedProtocolMessageType('SeriesData', (_message.Message,), {
63
+ 'DESCRIPTOR' : _SERIESDATA,
64
+ '__module__' : 'ansys.api.systemcoupling.v0.chart_pb2'
65
+ # @@protoc_insertion_point(class_scope:ansys.api.systemcoupling.v0.SeriesData)
66
+ })
67
+ _sym_db.RegisterMessage(SeriesData)
68
+
69
+ TimestepStart = _reflection.GeneratedProtocolMessageType('TimestepStart', (_message.Message,), {
70
+ 'DESCRIPTOR' : _TIMESTEPSTART,
71
+ '__module__' : 'ansys.api.systemcoupling.v0.chart_pb2'
72
+ # @@protoc_insertion_point(class_scope:ansys.api.systemcoupling.v0.TimestepStart)
73
+ })
74
+ _sym_db.RegisterMessage(TimestepStart)
75
+
76
+ TimestepEnd = _reflection.GeneratedProtocolMessageType('TimestepEnd', (_message.Message,), {
77
+ 'DESCRIPTOR' : _TIMESTEPEND,
78
+ '__module__' : 'ansys.api.systemcoupling.v0.chart_pb2'
79
+ # @@protoc_insertion_point(class_scope:ansys.api.systemcoupling.v0.TimestepEnd)
80
+ })
81
+ _sym_db.RegisterMessage(TimestepEnd)
82
+
83
+ ChartDataEvent = _reflection.GeneratedProtocolMessageType('ChartDataEvent', (_message.Message,), {
84
+ 'DESCRIPTOR' : _CHARTDATAEVENT,
85
+ '__module__' : 'ansys.api.systemcoupling.v0.chart_pb2'
86
+ # @@protoc_insertion_point(class_scope:ansys.api.systemcoupling.v0.ChartDataEvent)
87
+ })
88
+ _sym_db.RegisterMessage(ChartDataEvent)
89
+
90
+ AllSeriesData = _reflection.GeneratedProtocolMessageType('AllSeriesData', (_message.Message,), {
91
+ 'DESCRIPTOR' : _ALLSERIESDATA,
92
+ '__module__' : 'ansys.api.systemcoupling.v0.chart_pb2'
93
+ # @@protoc_insertion_point(class_scope:ansys.api.systemcoupling.v0.AllSeriesData)
94
+ })
95
+ _sym_db.RegisterMessage(AllSeriesData)
96
+
97
+ TimestepData = _reflection.GeneratedProtocolMessageType('TimestepData', (_message.Message,), {
98
+ 'DESCRIPTOR' : _TIMESTEPDATA,
99
+ '__module__' : 'ansys.api.systemcoupling.v0.chart_pb2'
100
+ # @@protoc_insertion_point(class_scope:ansys.api.systemcoupling.v0.TimestepData)
101
+ })
102
+ _sym_db.RegisterMessage(TimestepData)
103
+
104
+ ChartDataRequest = _reflection.GeneratedProtocolMessageType('ChartDataRequest', (_message.Message,), {
105
+ 'DESCRIPTOR' : _CHARTDATAREQUEST,
106
+ '__module__' : 'ansys.api.systemcoupling.v0.chart_pb2'
107
+ # @@protoc_insertion_point(class_scope:ansys.api.systemcoupling.v0.ChartDataRequest)
108
+ })
109
+ _sym_db.RegisterMessage(ChartDataRequest)
110
+
111
+ ChartMetadataRequest = _reflection.GeneratedProtocolMessageType('ChartMetadataRequest', (_message.Message,), {
112
+ 'DESCRIPTOR' : _CHARTMETADATAREQUEST,
113
+ '__module__' : 'ansys.api.systemcoupling.v0.chart_pb2'
114
+ # @@protoc_insertion_point(class_scope:ansys.api.systemcoupling.v0.ChartMetadataRequest)
115
+ })
116
+ _sym_db.RegisterMessage(ChartMetadataRequest)
117
+
118
+ ChartSeriesDataRequest = _reflection.GeneratedProtocolMessageType('ChartSeriesDataRequest', (_message.Message,), {
119
+ 'DESCRIPTOR' : _CHARTSERIESDATAREQUEST,
120
+ '__module__' : 'ansys.api.systemcoupling.v0.chart_pb2'
121
+ # @@protoc_insertion_point(class_scope:ansys.api.systemcoupling.v0.ChartSeriesDataRequest)
122
+ })
123
+ _sym_db.RegisterMessage(ChartSeriesDataRequest)
124
+
125
+ ChartTimestepDataRequest = _reflection.GeneratedProtocolMessageType('ChartTimestepDataRequest', (_message.Message,), {
126
+ 'DESCRIPTOR' : _CHARTTIMESTEPDATAREQUEST,
127
+ '__module__' : 'ansys.api.systemcoupling.v0.chart_pb2'
128
+ # @@protoc_insertion_point(class_scope:ansys.api.systemcoupling.v0.ChartTimestepDataRequest)
129
+ })
130
+ _sym_db.RegisterMessage(ChartTimestepDataRequest)
131
+
132
+ _CHARTDATA = DESCRIPTOR.services_by_name['ChartData']
133
+ if _descriptor._USE_C_DESCRIPTORS == False:
134
+
135
+ DESCRIPTOR._options = None
136
+ _TRANSFERSERIESTYPE._serialized_start=1226
137
+ _TRANSFERSERIESTYPE._serialized_end=1355
138
+ _TRANSFERSERIESINFO._serialized_start=73
139
+ _TRANSFERSERIESINFO._serialized_end=238
140
+ _INTERFACEINFO._serialized_start=240
141
+ _INTERFACEINFO._serialized_end=351
142
+ _CHARTMETADATA._serialized_start=353
143
+ _CHARTMETADATA._serialized_end=458
144
+ _SERIESDATA._serialized_start=460
145
+ _SERIESDATA._serialized_end=562
146
+ _TIMESTEPSTART._serialized_start=564
147
+ _TIMESTEPSTART._serialized_end=617
148
+ _TIMESTEPEND._serialized_start=619
149
+ _TIMESTEPEND._serialized_end=681
150
+ _CHARTDATAEVENT._serialized_start=684
151
+ _CHARTDATAEVENT._serialized_end=978
152
+ _ALLSERIESDATA._serialized_start=980
153
+ _ALLSERIESDATA._serialized_end=1057
154
+ _TIMESTEPDATA._serialized_start=1059
155
+ _TIMESTEPDATA._serialized_end=1125
156
+ _CHARTDATAREQUEST._serialized_start=1127
157
+ _CHARTDATAREQUEST._serialized_end=1145
158
+ _CHARTMETADATAREQUEST._serialized_start=1147
159
+ _CHARTMETADATAREQUEST._serialized_end=1169
160
+ _CHARTSERIESDATAREQUEST._serialized_start=1171
161
+ _CHARTSERIESDATAREQUEST._serialized_end=1195
162
+ _CHARTTIMESTEPDATAREQUEST._serialized_start=1197
163
+ _CHARTTIMESTEPDATAREQUEST._serialized_end=1223
164
+ _CHARTDATA._serialized_start=1358
165
+ _CHARTDATA._serialized_end=1838
166
+ # @@protoc_insertion_point(module_scope)
@@ -0,0 +1,309 @@
1
+ """
2
+ @generated by mypy-protobuf. Do not edit manually!
3
+ isort:skip_file
4
+ """
5
+ import builtins
6
+ import google.protobuf.descriptor
7
+ import google.protobuf.internal.containers
8
+ import google.protobuf.internal.enum_type_wrapper
9
+ import google.protobuf.message
10
+ import typing
11
+ import typing_extensions
12
+
13
+ DESCRIPTOR: google.protobuf.descriptor.FileDescriptor = ...
14
+
15
+ class _TransferSeriesType:
16
+ ValueType = typing.NewType('ValueType', builtins.int)
17
+ V: typing_extensions.TypeAlias = ValueType
18
+ class _TransferSeriesTypeEnumTypeWrapper(google.protobuf.internal.enum_type_wrapper._EnumTypeWrapper[_TransferSeriesType.ValueType], builtins.type):
19
+ DESCRIPTOR: google.protobuf.descriptor.EnumDescriptor = ...
20
+ SERIES_TYPE_UNKNOWN: TransferSeriesType.ValueType = ... # 0
21
+ SERIES_TYPE_CONVERGENCE: TransferSeriesType.ValueType = ... # 1
22
+ SERIES_TYPE_SUM: TransferSeriesType.ValueType = ... # 2
23
+ SERIES_TYPE_WEIGHTED_AVERAGE: TransferSeriesType.ValueType = ... # 3
24
+ class TransferSeriesType(_TransferSeriesType, metaclass=_TransferSeriesTypeEnumTypeWrapper):
25
+ """Enum containing the different types of chart series."""
26
+ pass
27
+
28
+ SERIES_TYPE_UNKNOWN: TransferSeriesType.ValueType = ... # 0
29
+ SERIES_TYPE_CONVERGENCE: TransferSeriesType.ValueType = ... # 1
30
+ SERIES_TYPE_SUM: TransferSeriesType.ValueType = ... # 2
31
+ SERIES_TYPE_WEIGHTED_AVERAGE: TransferSeriesType.ValueType = ... # 3
32
+ global___TransferSeriesType = TransferSeriesType
33
+
34
+
35
+ class TransferSeriesInfo(google.protobuf.message.Message):
36
+ """Information about the chart series data associated with a data transfer."""
37
+ DESCRIPTOR: google.protobuf.descriptor.Descriptor = ...
38
+ SERIES_TYPE_FIELD_NUMBER: builtins.int
39
+ TRANSFER_NAME_FIELD_NUMBER: builtins.int
40
+ PARTICIPANT_NAME_FIELD_NUMBER: builtins.int
41
+ COMPONENT_SUFFIX_FIELD_NUMBER: builtins.int
42
+ series_type: global___TransferSeriesType.ValueType = ...
43
+ """The type of line series."""
44
+
45
+ transfer_name: typing.Text = ...
46
+ """The unique internal name of the data transfer."""
47
+
48
+ participant_name: typing.Text = ...
49
+ """The unique internal name of the participant. This is required for transfer value series
50
+ but is empty for CONVERGENCE series. Used in chart labelling.
51
+ """
52
+
53
+ component_suffix: typing.Text = ...
54
+ """The suffix for this component series, if applicable. This is only needed for
55
+ transfer value series that have multiple components, such as complex or vector
56
+ values. Suffixes for complex components are "real" and "imag", and suffixes for
57
+ vector components are "x", "y", and "z". A combination is possible, such as
58
+ "y real" and "x imag". (Empty for CONVERGENCE series)
59
+ """
60
+
61
+ def __init__(self,
62
+ *,
63
+ series_type : global___TransferSeriesType.ValueType = ...,
64
+ transfer_name : typing.Text = ...,
65
+ participant_name : typing.Text = ...,
66
+ component_suffix : typing.Text = ...,
67
+ ) -> None: ...
68
+ def ClearField(self, field_name: typing_extensions.Literal["component_suffix",b"component_suffix","participant_name",b"participant_name","series_type",b"series_type","transfer_name",b"transfer_name"]) -> None: ...
69
+ global___TransferSeriesInfo = TransferSeriesInfo
70
+
71
+ class InterfaceInfo(google.protobuf.message.Message):
72
+ """Information about the chart series data associated with a single interface."""
73
+ DESCRIPTOR: google.protobuf.descriptor.Descriptor = ...
74
+ INTERFACE_NAME_FIELD_NUMBER: builtins.int
75
+ TRANSFER_INFO_FIELD_NUMBER: builtins.int
76
+ interface_name: typing.Text = ...
77
+ """The name of the coupling interface data model object."""
78
+
79
+ @property
80
+ def transfer_info(self) -> google.protobuf.internal.containers.RepeatedCompositeFieldContainer[global___TransferSeriesInfo]:
81
+ """The list of TransferSeriesInfo associated with this interface."""
82
+ pass
83
+ def __init__(self,
84
+ *,
85
+ interface_name : typing.Text = ...,
86
+ transfer_info : typing.Optional[typing.Iterable[global___TransferSeriesInfo]] = ...,
87
+ ) -> None: ...
88
+ def ClearField(self, field_name: typing_extensions.Literal["interface_name",b"interface_name","transfer_info",b"transfer_info"]) -> None: ...
89
+ global___InterfaceInfo = InterfaceInfo
90
+
91
+ class ChartMetadata(google.protobuf.message.Message):
92
+ """Complete metadata for available chart series."""
93
+ DESCRIPTOR: google.protobuf.descriptor.Descriptor = ...
94
+ IS_TRANSIENT_FIELD_NUMBER: builtins.int
95
+ INTERFACE_INFO_FIELD_NUMBER: builtins.int
96
+ is_transient: builtins.bool = ...
97
+ """Whether the chart is for a transient analysis."""
98
+
99
+ @property
100
+ def interface_info(self) -> google.protobuf.internal.containers.RepeatedCompositeFieldContainer[global___InterfaceInfo]:
101
+ """The metadata for the series associated with each interface."""
102
+ pass
103
+ def __init__(self,
104
+ *,
105
+ is_transient : builtins.bool = ...,
106
+ interface_info : typing.Optional[typing.Iterable[global___InterfaceInfo]] = ...,
107
+ ) -> None: ...
108
+ def ClearField(self, field_name: typing_extensions.Literal["interface_info",b"interface_info","is_transient",b"is_transient"]) -> None: ...
109
+ global___ChartMetadata = ChartMetadata
110
+
111
+ class SeriesData(google.protobuf.message.Message):
112
+ """The plot data for a single chart line series and information to allow
113
+ it to be associated with chart metadata.
114
+ An instance of this type is assumed to be associated with a single interface.
115
+ This message supports per-iteration incremental data, batched data for a
116
+ subset of iterations, or complete data for all iterations.
117
+ """
118
+ DESCRIPTOR: google.protobuf.descriptor.Descriptor = ...
119
+ INTERFACE_NAME_FIELD_NUMBER: builtins.int
120
+ TRANSFER_SERIES_INDEX_FIELD_NUMBER: builtins.int
121
+ START_INDEX_FIELD_NUMBER: builtins.int
122
+ DATA_FIELD_NUMBER: builtins.int
123
+ interface_name: typing.Text = ...
124
+ """The name of the interface this series is associated with."""
125
+
126
+ transfer_series_index: builtins.int = ...
127
+ """Index of the TransferSeriesInfo metadata for this series within the
128
+ InterfaceInfo for the interface this series is associated with.
129
+ """
130
+
131
+ start_index: builtins.int = ...
132
+ """The 0-based start index of the data field. This defaults to 0 and
133
+ only needs to be set to a different value if incremental data, such
134
+ as might arise during "live" update of plots, has become available.
135
+ Data indexes correspond to iterations. Iteration N will have an
136
+ index of N-1.
137
+ """
138
+
139
+ @property
140
+ def data(self) -> google.protobuf.internal.containers.RepeatedScalarFieldContainer[builtins.float]:
141
+ """The series data. This is always indexed by iteration. Extract time
142
+ step-based data by using a time step to iteration mapping.
143
+ """
144
+ pass
145
+ def __init__(self,
146
+ *,
147
+ interface_name : typing.Text = ...,
148
+ transfer_series_index : builtins.int = ...,
149
+ start_index : builtins.int = ...,
150
+ data : typing.Optional[typing.Iterable[builtins.float]] = ...,
151
+ ) -> None: ...
152
+ def ClearField(self, field_name: typing_extensions.Literal["data",b"data","interface_name",b"interface_name","start_index",b"start_index","transfer_series_index",b"transfer_series_index"]) -> None: ...
153
+ global___SeriesData = SeriesData
154
+
155
+ class TimestepStart(google.protobuf.message.Message):
156
+ """Message providing notification and details of a new timestep in a transient analysis.
157
+ This message is intended for use in live updates. See TimestepData for
158
+ cumulative timestep information.
159
+ """
160
+ DESCRIPTOR: google.protobuf.descriptor.Descriptor = ...
161
+ TIMESTEP_COUNT_FIELD_NUMBER: builtins.int
162
+ TIME_FIELD_NUMBER: builtins.int
163
+ timestep_count: builtins.int = ...
164
+ """The timestep count of the new timestep."""
165
+
166
+ time: builtins.float = ...
167
+ """The end time of the current timestep.
168
+ For the first timestep, this is the timestep size. For subsequent
169
+ timesteps, the timestep size can be determined by subtracting the previous
170
+ time value from the current time value.
171
+ """
172
+
173
+ def __init__(self,
174
+ *,
175
+ timestep_count : builtins.int = ...,
176
+ time : builtins.float = ...,
177
+ ) -> None: ...
178
+ def ClearField(self, field_name: typing_extensions.Literal["time",b"time","timestep_count",b"timestep_count"]) -> None: ...
179
+ global___TimestepStart = TimestepStart
180
+
181
+ class TimestepEnd(google.protobuf.message.Message):
182
+ """Message providing notification and details of the end of a timestep in a transient analysis.
183
+ This message is intended for use in live updates. See TimestepData for
184
+ cumulative timestep information.
185
+ """
186
+ DESCRIPTOR: google.protobuf.descriptor.Descriptor = ...
187
+ TIMESTEP_COUNT_FIELD_NUMBER: builtins.int
188
+ ITERATION_COUNT_FIELD_NUMBER: builtins.int
189
+ timestep_count: builtins.int = ...
190
+ """The timestep count of the ended timestep."""
191
+
192
+ iteration_count: builtins.int = ...
193
+ """The ending iteration for the timestep. NB: This is a 1-based iteration count."""
194
+
195
+ def __init__(self,
196
+ *,
197
+ timestep_count : builtins.int = ...,
198
+ iteration_count : builtins.int = ...,
199
+ ) -> None: ...
200
+ def ClearField(self, field_name: typing_extensions.Literal["iteration_count",b"iteration_count","timestep_count",b"timestep_count"]) -> None: ...
201
+ global___TimestepEnd = TimestepEnd
202
+
203
+ class ChartDataEvent(google.protobuf.message.Message):
204
+ """Chart data event that can contain different types of chart data.
205
+ The first event in a stream will typically contain interface metadata,
206
+ followed by series data and timestep data as they become available.
207
+ """
208
+ DESCRIPTOR: google.protobuf.descriptor.Descriptor = ...
209
+ METADATA_FIELD_NUMBER: builtins.int
210
+ SERIES_DATA_FIELD_NUMBER: builtins.int
211
+ TIMESTEP_START_FIELD_NUMBER: builtins.int
212
+ TIMESTEP_END_FIELD_NUMBER: builtins.int
213
+ @property
214
+ def metadata(self) -> global___ChartMetadata:
215
+ """Metadata containing information about the available series."""
216
+ pass
217
+ @property
218
+ def series_data(self) -> global___SeriesData:
219
+ """Series data for a specific chart line series."""
220
+ pass
221
+ @property
222
+ def timestep_start(self) -> global___TimestepStart:
223
+ """Timestep start notification for transient analyses."""
224
+ pass
225
+ @property
226
+ def timestep_end(self) -> global___TimestepEnd:
227
+ """Timestep end notification for transient analyses."""
228
+ pass
229
+ def __init__(self,
230
+ *,
231
+ metadata : typing.Optional[global___ChartMetadata] = ...,
232
+ series_data : typing.Optional[global___SeriesData] = ...,
233
+ timestep_start : typing.Optional[global___TimestepStart] = ...,
234
+ timestep_end : typing.Optional[global___TimestepEnd] = ...,
235
+ ) -> None: ...
236
+ def HasField(self, field_name: typing_extensions.Literal["event_data",b"event_data","metadata",b"metadata","series_data",b"series_data","timestep_end",b"timestep_end","timestep_start",b"timestep_start"]) -> builtins.bool: ...
237
+ def ClearField(self, field_name: typing_extensions.Literal["event_data",b"event_data","metadata",b"metadata","series_data",b"series_data","timestep_end",b"timestep_end","timestep_start",b"timestep_start"]) -> None: ...
238
+ def WhichOneof(self, oneof_group: typing_extensions.Literal["event_data",b"event_data"]) -> typing.Optional[typing_extensions.Literal["metadata","series_data","timestep_start","timestep_end"]]: ...
239
+ global___ChartDataEvent = ChartDataEvent
240
+
241
+ class AllSeriesData(google.protobuf.message.Message):
242
+ """Message providing all series data for all interfaces.
243
+ For use in post-solve, non-streaming retrieval of chart data.
244
+ """
245
+ DESCRIPTOR: google.protobuf.descriptor.Descriptor = ...
246
+ SERIES_DATA_FIELD_NUMBER: builtins.int
247
+ @property
248
+ def series_data(self) -> google.protobuf.internal.containers.RepeatedCompositeFieldContainer[global___SeriesData]:
249
+ """List of all available series data."""
250
+ pass
251
+ def __init__(self,
252
+ *,
253
+ series_data : typing.Optional[typing.Iterable[global___SeriesData]] = ...,
254
+ ) -> None: ...
255
+ def ClearField(self, field_name: typing_extensions.Literal["series_data",b"series_data"]) -> None: ...
256
+ global___AllSeriesData = AllSeriesData
257
+
258
+ class TimestepData(google.protobuf.message.Message):
259
+ """Message providing all timestep data for transient analyses.
260
+ For use in post-solve, non-streaming retrieval of chart data.
261
+ """
262
+ DESCRIPTOR: google.protobuf.descriptor.Descriptor = ...
263
+ TIMESTEP_TO_ITERATION_FIELD_NUMBER: builtins.int
264
+ TIME_VALUES_FIELD_NUMBER: builtins.int
265
+ @property
266
+ def timestep_to_iteration(self) -> google.protobuf.internal.containers.RepeatedScalarFieldContainer[builtins.int]:
267
+ """The mapping of timestep count to iteration count.
268
+ NB: these are 1-based step and iteration counts.
269
+ """
270
+ pass
271
+ @property
272
+ def time_values(self) -> google.protobuf.internal.containers.RepeatedScalarFieldContainer[builtins.float]:
273
+ """The time values for each timestep."""
274
+ pass
275
+ def __init__(self,
276
+ *,
277
+ timestep_to_iteration : typing.Optional[typing.Iterable[builtins.int]] = ...,
278
+ time_values : typing.Optional[typing.Iterable[builtins.float]] = ...,
279
+ ) -> None: ...
280
+ def ClearField(self, field_name: typing_extensions.Literal["time_values",b"time_values","timestep_to_iteration",b"timestep_to_iteration"]) -> None: ...
281
+ global___TimestepData = TimestepData
282
+
283
+ class ChartDataRequest(google.protobuf.message.Message):
284
+ """Request message for chart data streaming."""
285
+ DESCRIPTOR: google.protobuf.descriptor.Descriptor = ...
286
+ def __init__(self,
287
+ ) -> None: ...
288
+ global___ChartDataRequest = ChartDataRequest
289
+
290
+ class ChartMetadataRequest(google.protobuf.message.Message):
291
+ """Request message for chart metadata retrieval."""
292
+ DESCRIPTOR: google.protobuf.descriptor.Descriptor = ...
293
+ def __init__(self,
294
+ ) -> None: ...
295
+ global___ChartMetadataRequest = ChartMetadataRequest
296
+
297
+ class ChartSeriesDataRequest(google.protobuf.message.Message):
298
+ """Request message for all chart series data retrieval."""
299
+ DESCRIPTOR: google.protobuf.descriptor.Descriptor = ...
300
+ def __init__(self,
301
+ ) -> None: ...
302
+ global___ChartSeriesDataRequest = ChartSeriesDataRequest
303
+
304
+ class ChartTimestepDataRequest(google.protobuf.message.Message):
305
+ """Request message for chart timestep data retrieval."""
306
+ DESCRIPTOR: google.protobuf.descriptor.Descriptor = ...
307
+ def __init__(self,
308
+ ) -> None: ...
309
+ global___ChartTimestepDataRequest = ChartTimestepDataRequest
@@ -0,0 +1,181 @@
1
+ # Generated by the gRPC Python protocol compiler plugin. DO NOT EDIT!
2
+ """Client and server classes corresponding to protobuf-defined services."""
3
+ import grpc
4
+
5
+ from ansys.api.systemcoupling.v0 import chart_pb2 as ansys_dot_api_dot_systemcoupling_dot_v0_dot_chart__pb2
6
+
7
+
8
+ class ChartDataStub(object):
9
+ """Service for querying chart data, both as a "live" stream during a solve
10
+ and as non-streaming requests for data after a solve has been performed.
11
+ """
12
+
13
+ def __init__(self, channel):
14
+ """Constructor.
15
+
16
+ Args:
17
+ channel: A grpc.Channel.
18
+ """
19
+ self.StreamChartData = channel.unary_stream(
20
+ '/ansys.api.systemcoupling.v0.ChartData/StreamChartData',
21
+ request_serializer=ansys_dot_api_dot_systemcoupling_dot_v0_dot_chart__pb2.ChartDataRequest.SerializeToString,
22
+ response_deserializer=ansys_dot_api_dot_systemcoupling_dot_v0_dot_chart__pb2.ChartDataEvent.FromString,
23
+ )
24
+ self.GetChartMetadata = channel.unary_unary(
25
+ '/ansys.api.systemcoupling.v0.ChartData/GetChartMetadata',
26
+ request_serializer=ansys_dot_api_dot_systemcoupling_dot_v0_dot_chart__pb2.ChartMetadataRequest.SerializeToString,
27
+ response_deserializer=ansys_dot_api_dot_systemcoupling_dot_v0_dot_chart__pb2.ChartMetadata.FromString,
28
+ )
29
+ self.GetChartSeriesData = channel.unary_unary(
30
+ '/ansys.api.systemcoupling.v0.ChartData/GetChartSeriesData',
31
+ request_serializer=ansys_dot_api_dot_systemcoupling_dot_v0_dot_chart__pb2.ChartSeriesDataRequest.SerializeToString,
32
+ response_deserializer=ansys_dot_api_dot_systemcoupling_dot_v0_dot_chart__pb2.AllSeriesData.FromString,
33
+ )
34
+ self.GetChartTimestepData = channel.unary_unary(
35
+ '/ansys.api.systemcoupling.v0.ChartData/GetChartTimestepData',
36
+ request_serializer=ansys_dot_api_dot_systemcoupling_dot_v0_dot_chart__pb2.ChartTimestepDataRequest.SerializeToString,
37
+ response_deserializer=ansys_dot_api_dot_systemcoupling_dot_v0_dot_chart__pb2.TimestepData.FromString,
38
+ )
39
+
40
+
41
+ class ChartDataServicer(object):
42
+ """Service for querying chart data, both as a "live" stream during a solve
43
+ and as non-streaming requests for data after a solve has been performed.
44
+ """
45
+
46
+ def StreamChartData(self, request, context):
47
+ """Streams chart data events starting with interface metadata followed by
48
+ series data and timestep data as they become available on the server.
49
+ For transient cases, timestep data will be included in the stream.
50
+ """
51
+ context.set_code(grpc.StatusCode.UNIMPLEMENTED)
52
+ context.set_details('Method not implemented!')
53
+ raise NotImplementedError('Method not implemented!')
54
+
55
+ def GetChartMetadata(self, request, context):
56
+ """The following RPCs provide non-streaming access to chart data.
57
+ This should be available as long as a solve has been performed
58
+ in the current session.
59
+
60
+ Retrieves the chart metadata for all available series.
61
+ """
62
+ context.set_code(grpc.StatusCode.UNIMPLEMENTED)
63
+ context.set_details('Method not implemented!')
64
+ raise NotImplementedError('Method not implemented!')
65
+
66
+ def GetChartSeriesData(self, request, context):
67
+ """Retrieves all data for all chart series.
68
+ """
69
+ context.set_code(grpc.StatusCode.UNIMPLEMENTED)
70
+ context.set_details('Method not implemented!')
71
+ raise NotImplementedError('Method not implemented!')
72
+
73
+ def GetChartTimestepData(self, request, context):
74
+ """Retrieves all data for all chart timesteps.
75
+ """
76
+ context.set_code(grpc.StatusCode.UNIMPLEMENTED)
77
+ context.set_details('Method not implemented!')
78
+ raise NotImplementedError('Method not implemented!')
79
+
80
+
81
+ def add_ChartDataServicer_to_server(servicer, server):
82
+ rpc_method_handlers = {
83
+ 'StreamChartData': grpc.unary_stream_rpc_method_handler(
84
+ servicer.StreamChartData,
85
+ request_deserializer=ansys_dot_api_dot_systemcoupling_dot_v0_dot_chart__pb2.ChartDataRequest.FromString,
86
+ response_serializer=ansys_dot_api_dot_systemcoupling_dot_v0_dot_chart__pb2.ChartDataEvent.SerializeToString,
87
+ ),
88
+ 'GetChartMetadata': grpc.unary_unary_rpc_method_handler(
89
+ servicer.GetChartMetadata,
90
+ request_deserializer=ansys_dot_api_dot_systemcoupling_dot_v0_dot_chart__pb2.ChartMetadataRequest.FromString,
91
+ response_serializer=ansys_dot_api_dot_systemcoupling_dot_v0_dot_chart__pb2.ChartMetadata.SerializeToString,
92
+ ),
93
+ 'GetChartSeriesData': grpc.unary_unary_rpc_method_handler(
94
+ servicer.GetChartSeriesData,
95
+ request_deserializer=ansys_dot_api_dot_systemcoupling_dot_v0_dot_chart__pb2.ChartSeriesDataRequest.FromString,
96
+ response_serializer=ansys_dot_api_dot_systemcoupling_dot_v0_dot_chart__pb2.AllSeriesData.SerializeToString,
97
+ ),
98
+ 'GetChartTimestepData': grpc.unary_unary_rpc_method_handler(
99
+ servicer.GetChartTimestepData,
100
+ request_deserializer=ansys_dot_api_dot_systemcoupling_dot_v0_dot_chart__pb2.ChartTimestepDataRequest.FromString,
101
+ response_serializer=ansys_dot_api_dot_systemcoupling_dot_v0_dot_chart__pb2.TimestepData.SerializeToString,
102
+ ),
103
+ }
104
+ generic_handler = grpc.method_handlers_generic_handler(
105
+ 'ansys.api.systemcoupling.v0.ChartData', rpc_method_handlers)
106
+ server.add_generic_rpc_handlers((generic_handler,))
107
+
108
+
109
+ # This class is part of an EXPERIMENTAL API.
110
+ class ChartData(object):
111
+ """Service for querying chart data, both as a "live" stream during a solve
112
+ and as non-streaming requests for data after a solve has been performed.
113
+ """
114
+
115
+ @staticmethod
116
+ def StreamChartData(request,
117
+ target,
118
+ options=(),
119
+ channel_credentials=None,
120
+ call_credentials=None,
121
+ insecure=False,
122
+ compression=None,
123
+ wait_for_ready=None,
124
+ timeout=None,
125
+ metadata=None):
126
+ return grpc.experimental.unary_stream(request, target, '/ansys.api.systemcoupling.v0.ChartData/StreamChartData',
127
+ ansys_dot_api_dot_systemcoupling_dot_v0_dot_chart__pb2.ChartDataRequest.SerializeToString,
128
+ ansys_dot_api_dot_systemcoupling_dot_v0_dot_chart__pb2.ChartDataEvent.FromString,
129
+ options, channel_credentials,
130
+ insecure, call_credentials, compression, wait_for_ready, timeout, metadata)
131
+
132
+ @staticmethod
133
+ def GetChartMetadata(request,
134
+ target,
135
+ options=(),
136
+ channel_credentials=None,
137
+ call_credentials=None,
138
+ insecure=False,
139
+ compression=None,
140
+ wait_for_ready=None,
141
+ timeout=None,
142
+ metadata=None):
143
+ return grpc.experimental.unary_unary(request, target, '/ansys.api.systemcoupling.v0.ChartData/GetChartMetadata',
144
+ ansys_dot_api_dot_systemcoupling_dot_v0_dot_chart__pb2.ChartMetadataRequest.SerializeToString,
145
+ ansys_dot_api_dot_systemcoupling_dot_v0_dot_chart__pb2.ChartMetadata.FromString,
146
+ options, channel_credentials,
147
+ insecure, call_credentials, compression, wait_for_ready, timeout, metadata)
148
+
149
+ @staticmethod
150
+ def GetChartSeriesData(request,
151
+ target,
152
+ options=(),
153
+ channel_credentials=None,
154
+ call_credentials=None,
155
+ insecure=False,
156
+ compression=None,
157
+ wait_for_ready=None,
158
+ timeout=None,
159
+ metadata=None):
160
+ return grpc.experimental.unary_unary(request, target, '/ansys.api.systemcoupling.v0.ChartData/GetChartSeriesData',
161
+ ansys_dot_api_dot_systemcoupling_dot_v0_dot_chart__pb2.ChartSeriesDataRequest.SerializeToString,
162
+ ansys_dot_api_dot_systemcoupling_dot_v0_dot_chart__pb2.AllSeriesData.FromString,
163
+ options, channel_credentials,
164
+ insecure, call_credentials, compression, wait_for_ready, timeout, metadata)
165
+
166
+ @staticmethod
167
+ def GetChartTimestepData(request,
168
+ target,
169
+ options=(),
170
+ channel_credentials=None,
171
+ call_credentials=None,
172
+ insecure=False,
173
+ compression=None,
174
+ wait_for_ready=None,
175
+ timeout=None,
176
+ metadata=None):
177
+ return grpc.experimental.unary_unary(request, target, '/ansys.api.systemcoupling.v0.ChartData/GetChartTimestepData',
178
+ ansys_dot_api_dot_systemcoupling_dot_v0_dot_chart__pb2.ChartTimestepDataRequest.SerializeToString,
179
+ ansys_dot_api_dot_systemcoupling_dot_v0_dot_chart__pb2.TimestepData.FromString,
180
+ options, channel_credentials,
181
+ insecure, call_credentials, compression, wait_for_ready, timeout, metadata)
@@ -0,0 +1,89 @@
1
+ """
2
+ @generated by mypy-protobuf. Do not edit manually!
3
+ isort:skip_file
4
+ """
5
+ import abc
6
+ import ansys.api.systemcoupling.v0.chart_pb2
7
+ import grpc
8
+ import typing
9
+
10
+ class ChartDataStub:
11
+ """Service for querying chart data, both as a "live" stream during a solve
12
+ and as non-streaming requests for data after a solve has been performed.
13
+ """
14
+ def __init__(self, channel: grpc.Channel) -> None: ...
15
+ StreamChartData: grpc.UnaryStreamMultiCallable[
16
+ ansys.api.systemcoupling.v0.chart_pb2.ChartDataRequest,
17
+ ansys.api.systemcoupling.v0.chart_pb2.ChartDataEvent] = ...
18
+ """Streams chart data events starting with interface metadata followed by
19
+ series data and timestep data as they become available on the server.
20
+ For transient cases, timestep data will be included in the stream.
21
+ """
22
+
23
+ GetChartMetadata: grpc.UnaryUnaryMultiCallable[
24
+ ansys.api.systemcoupling.v0.chart_pb2.ChartMetadataRequest,
25
+ ansys.api.systemcoupling.v0.chart_pb2.ChartMetadata] = ...
26
+ """The following RPCs provide non-streaming access to chart data.
27
+ This should be available as long as a solve has been performed
28
+ in the current session.
29
+
30
+ Retrieves the chart metadata for all available series.
31
+ """
32
+
33
+ GetChartSeriesData: grpc.UnaryUnaryMultiCallable[
34
+ ansys.api.systemcoupling.v0.chart_pb2.ChartSeriesDataRequest,
35
+ ansys.api.systemcoupling.v0.chart_pb2.AllSeriesData] = ...
36
+ """Retrieves all data for all chart series."""
37
+
38
+ GetChartTimestepData: grpc.UnaryUnaryMultiCallable[
39
+ ansys.api.systemcoupling.v0.chart_pb2.ChartTimestepDataRequest,
40
+ ansys.api.systemcoupling.v0.chart_pb2.TimestepData] = ...
41
+ """Retrieves all data for all chart timesteps."""
42
+
43
+
44
+ class ChartDataServicer(metaclass=abc.ABCMeta):
45
+ """Service for querying chart data, both as a "live" stream during a solve
46
+ and as non-streaming requests for data after a solve has been performed.
47
+ """
48
+ @abc.abstractmethod
49
+ def StreamChartData(self,
50
+ request: ansys.api.systemcoupling.v0.chart_pb2.ChartDataRequest,
51
+ context: grpc.ServicerContext,
52
+ ) -> typing.Iterator[ansys.api.systemcoupling.v0.chart_pb2.ChartDataEvent]:
53
+ """Streams chart data events starting with interface metadata followed by
54
+ series data and timestep data as they become available on the server.
55
+ For transient cases, timestep data will be included in the stream.
56
+ """
57
+ pass
58
+
59
+ @abc.abstractmethod
60
+ def GetChartMetadata(self,
61
+ request: ansys.api.systemcoupling.v0.chart_pb2.ChartMetadataRequest,
62
+ context: grpc.ServicerContext,
63
+ ) -> ansys.api.systemcoupling.v0.chart_pb2.ChartMetadata:
64
+ """The following RPCs provide non-streaming access to chart data.
65
+ This should be available as long as a solve has been performed
66
+ in the current session.
67
+
68
+ Retrieves the chart metadata for all available series.
69
+ """
70
+ pass
71
+
72
+ @abc.abstractmethod
73
+ def GetChartSeriesData(self,
74
+ request: ansys.api.systemcoupling.v0.chart_pb2.ChartSeriesDataRequest,
75
+ context: grpc.ServicerContext,
76
+ ) -> ansys.api.systemcoupling.v0.chart_pb2.AllSeriesData:
77
+ """Retrieves all data for all chart series."""
78
+ pass
79
+
80
+ @abc.abstractmethod
81
+ def GetChartTimestepData(self,
82
+ request: ansys.api.systemcoupling.v0.chart_pb2.ChartTimestepDataRequest,
83
+ context: grpc.ServicerContext,
84
+ ) -> ansys.api.systemcoupling.v0.chart_pb2.TimestepData:
85
+ """Retrieves all data for all chart timesteps."""
86
+ pass
87
+
88
+
89
+ def add_ChartDataServicer_to_server(servicer: ChartDataServicer, server: grpc.Server) -> None: ...
@@ -1,7 +1,7 @@
1
1
  Metadata-Version: 2.1
2
2
  Name: ansys-api-systemcoupling
3
- Version: 0.2.0
4
- Summary: Autogenerated python gRPC interface package for ansys-api-systemcoupling, built on 15:37:55 on 09 July 2024
3
+ Version: 0.3.0
4
+ Summary: Autogenerated python gRPC interface package for ansys-api-systemcoupling, built on 09:18:40 on 06 February 2026
5
5
  Home-page: https://github.com/ansys/ansys-api-systemcoupling
6
6
  Author: ANSYS, Inc.
7
7
  Author-email: support@ansys.com
@@ -1,6 +1,11 @@
1
- ansys/api/systemcoupling/VERSION,sha256=kR_AxIywxwYB21d1qb7xt0DcTMn5tGOJufBWP-frlNc,5
1
+ ansys/api/systemcoupling/VERSION,sha256=VQYTU3_EiPOzcq90pAAYefASyEZbgW8bhcbTRGss-0k,5
2
2
  ansys/api/systemcoupling/__init__.py,sha256=i4E-euAg0L4fE_SHeh9Bogb8Jm4-tNSw2y_CPDSmFOk,236
3
3
  ansys/api/systemcoupling/py.typed,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
4
+ ansys/api/systemcoupling/v0/chart.proto,sha256=40LnzSrdWFVIQXBMIBgpCiAsgiVZ_KOLJm7o3UL8c5Q,6317
5
+ ansys/api/systemcoupling/v0/chart_pb2.py,sha256=GxZ5XuDgXq-R1VcKMRhRZMOLKsNHkFKYh9q5NYBX4wc,10118
6
+ ansys/api/systemcoupling/v0/chart_pb2.pyi,sha256=IEUDJB1_3PxA6VV4hQMzBzuNV-R-lyhI3oEbrxI-Vbg,14547
7
+ ansys/api/systemcoupling/v0/chart_pb2_grpc.py,sha256=kyYTnG22HYkqRznedMUPhTAQfL7HFrP8yjhQfdslWpI,9064
8
+ ansys/api/systemcoupling/v0/chart_pb2_grpc.pyi,sha256=CGf106-lWnx1ENuvbWpJVMETrHx-f3r1FKLG1pPnoZQ,3670
4
9
  ansys/api/systemcoupling/v0/command.proto,sha256=CjFLYU9gQ6i6lmm3VfwqsrxQNdkuJ8NQ_zEtmF4EHAw,452
5
10
  ansys/api/systemcoupling/v0/command_pb2.py,sha256=7Ww-D9SXJyepkSdvKoaTB8Bm8VP77wfdL1wTA_-wGrQ,3112
6
11
  ansys/api/systemcoupling/v0/command_pb2.pyi,sha256=Vo6CUilCkHZN-T73l4H4lbsDl62PY5wbGx_UD0R06IQ,2420
@@ -31,9 +36,9 @@ ansys/api/systemcoupling/v0/variant_pb2.py,sha256=f-6AkDzpuya9Wvq62L4ZN_hF499ZSr
31
36
  ansys/api/systemcoupling/v0/variant_pb2.pyi,sha256=D2iHLSHYrd2AhcA42TPYuIoKazBB6bdQO9ODgekhtAs,8093
32
37
  ansys/api/systemcoupling/v0/variant_pb2_grpc.py,sha256=1oboBPFxaTEXt9Aw7EAj8gXHDCNMhZD2VXqocC9l_gk,159
33
38
  ansys/api/systemcoupling/v0/variant_pb2_grpc.pyi,sha256=ff2TSiLVnG6IVQcTGzb2DIH3XRSoAvAo_RMcvbMFyc0,76
34
- ansys_api_systemcoupling-0.2.0.dist-info/LICENSE,sha256=q2LY-0-hseAc1SDA7rBn96IDi2SHenCzygJda8-7AAU,1089
35
- ansys_api_systemcoupling-0.2.0.dist-info/METADATA,sha256=6LJQ2Wqgd2fonxRvDqH2mwXZoD3LfUBsoxoHgUHqUO8,1900
36
- ansys_api_systemcoupling-0.2.0.dist-info/WHEEL,sha256=oiQVh_5PnQM0E3gPdiz09WCNmwiHDMaGer_elqB3coM,92
37
- ansys_api_systemcoupling-0.2.0.dist-info/entry_points.txt,sha256=_GF78i8qp_7OsI5n1jIDwQkIwfq-eg9SfWbdf06iZ1o,101
38
- ansys_api_systemcoupling-0.2.0.dist-info/top_level.txt,sha256=9rw0UJ0mtof2GA3U8RpqYo6EmbpfE8-wo3NoX6SlYtg,6
39
- ansys_api_systemcoupling-0.2.0.dist-info/RECORD,,
39
+ ansys_api_systemcoupling-0.3.0.dist-info/LICENSE,sha256=q2LY-0-hseAc1SDA7rBn96IDi2SHenCzygJda8-7AAU,1089
40
+ ansys_api_systemcoupling-0.3.0.dist-info/METADATA,sha256=QoZ1-t4N6mKx2CeaB5vw3EULavfJlNED1oXxMWSkP1Y,1904
41
+ ansys_api_systemcoupling-0.3.0.dist-info/WHEEL,sha256=oiQVh_5PnQM0E3gPdiz09WCNmwiHDMaGer_elqB3coM,92
42
+ ansys_api_systemcoupling-0.3.0.dist-info/entry_points.txt,sha256=_GF78i8qp_7OsI5n1jIDwQkIwfq-eg9SfWbdf06iZ1o,101
43
+ ansys_api_systemcoupling-0.3.0.dist-info/top_level.txt,sha256=9rw0UJ0mtof2GA3U8RpqYo6EmbpfE8-wo3NoX6SlYtg,6
44
+ ansys_api_systemcoupling-0.3.0.dist-info/RECORD,,