Coverage for skema/gromet/fn/gromet_wire.py: 83%
76 statements
« prev ^ index » next coverage.py v7.5.0, created at 2024-04-30 17:15 +0000
1# coding: utf-8
3"""
4 Grounded Model Exchange (GroMEt) schema for Function Networks
6 This document defines the GroMEt Function Network data model. Note that Metadata is defined in separate spec. __Using Swagger to Generate Class Structure__ To automatically generate Python or Java models corresponding to this document, you can use [swagger-codegen](https://swagger.io/tools/swagger-codegen/). This can be used to generate the client code based off of this spec, and in the process this will generate the data model class structure. 1. Install via the method described for your operating system [here](https://github.com/swagger-api/swagger-codegen#Prerequisites). Make sure to install a version after 3.0 that will support openapi 3. 2. Run swagger-codegen with the options in the example below. The URL references where the yaml for this documentation is stored on github. Make sure to replace CURRENT_VERSION with the correct version. (The current version is `0.1.7`.) To generate Java classes rather, change the `-l python` to `-l java`. Change the value to the `-o` option to the desired output location. ``` swagger-codegen generate -l python -o ./client -i https://raw.githubusercontent.com/ml4ai/automates-v2/master/docs/source/gromet_FN_v{CURRENT_VERSION}.yaml ``` 3. Once it executes, the client code will be generated at your specified location. For python, the classes will be located in `$OUTPUT_PATH/skema.gromet.fn.`. For java, they will be located in `$OUTPUT_PATH/src/main/java/io/swagger/client/model/` If generating GroMEt schema data model classes in SKEMA (AutoMATES), then after generating the above, follow the instructions here: ``` <automates>/automates/model_assembly/gromet/model/README.md ``` # noqa: E501
8 OpenAPI spec version: 0.1.10
9 Contact: claytonm@arizona.edu
10 Generated by: https://github.com/swagger-api/swagger-codegen.git
11"""
13import pprint
14import re # noqa: F401
16import six
17from skema.gromet.fn.gromet_object import GrometObject # noqa: F401,E501
19class GrometWire(GrometObject):
20 """NOTE: This class is auto generated by the swagger code generator program.
22 Do not edit the class manually.
23 """
24 """
25 Attributes:
26 swagger_types (dict): The key is attribute name
27 and the value is attribute type.
28 attribute_map (dict): The key is attribute name
29 and the value is json key in definition.
30 """
31 swagger_types = {
32 'name': 'str',
33 'src': 'int',
34 'tgt': 'int',
35 'gromet_type': 'str'
36 }
37 if hasattr(GrometObject, "swagger_types"):
38 swagger_types.update(GrometObject.swagger_types)
40 attribute_map = {
41 'name': 'name',
42 'src': 'src',
43 'tgt': 'tgt',
44 'gromet_type': 'gromet_type'
45 }
46 if hasattr(GrometObject, "attribute_map"):
47 attribute_map.update(GrometObject.attribute_map)
49 def __init__(self, name=None, src=None, tgt=None, gromet_type='GrometWire', *args, **kwargs): # noqa: E501
50 """GrometWire - a model defined in Swagger""" # noqa: E501
51 self._name = None
52 self._src = None
53 self._tgt = None
54 self._gromet_type = None
55 self.discriminator = None
56 if name is not None:
57 self.name = name
58 if src is not None:
59 self.src = src
60 if tgt is not None:
61 self.tgt = tgt
62 if gromet_type is not None:
63 self.gromet_type = gromet_type
64 GrometObject.__init__(self, *args, **kwargs)
66 @property
67 def name(self):
68 """Gets the name of this GrometWire. # noqa: E501
71 :return: The name of this GrometWire. # noqa: E501
72 :rtype: str
73 """
74 return self._name
76 @name.setter
77 def name(self, name):
78 """Sets the name of this GrometWire.
81 :param name: The name of this GrometWire. # noqa: E501
82 :type: str
83 """
85 self._name = name
87 @property
88 def src(self):
89 """Gets the src of this GrometWire. # noqa: E501
91 Index to the source Port of the Wire. # noqa: E501
93 :return: The src of this GrometWire. # noqa: E501
94 :rtype: int
95 """
96 return self._src
98 @src.setter
99 def src(self, src):
100 """Sets the src of this GrometWire.
102 Index to the source Port of the Wire. # noqa: E501
104 :param src: The src of this GrometWire. # noqa: E501
105 :type: int
106 """
108 self._src = src
110 @property
111 def tgt(self):
112 """Gets the tgt of this GrometWire. # noqa: E501
114 Index to the target Port of the Wire. # noqa: E501
116 :return: The tgt of this GrometWire. # noqa: E501
117 :rtype: int
118 """
119 return self._tgt
121 @tgt.setter
122 def tgt(self, tgt):
123 """Sets the tgt of this GrometWire.
125 Index to the target Port of the Wire. # noqa: E501
127 :param tgt: The tgt of this GrometWire. # noqa: E501
128 :type: int
129 """
131 self._tgt = tgt
133 @property
134 def gromet_type(self):
135 """Gets the gromet_type of this GrometWire. # noqa: E501
138 :return: The gromet_type of this GrometWire. # noqa: E501
139 :rtype: str
140 """
141 return self._gromet_type
143 @gromet_type.setter
144 def gromet_type(self, gromet_type):
145 """Sets the gromet_type of this GrometWire.
148 :param gromet_type: The gromet_type of this GrometWire. # noqa: E501
149 :type: str
150 """
152 self._gromet_type = gromet_type
154 def to_dict(self):
155 """Returns the model properties as a dict"""
156 result = {}
158 for attr, _ in six.iteritems(self.swagger_types):
159 value = getattr(self, attr)
160 if isinstance(value, list):
161 result[attr] = list(map(
162 lambda x: x.to_dict() if hasattr(x, "to_dict") else x,
163 value
164 ))
165 elif hasattr(value, "to_dict"):
166 result[attr] = value.to_dict()
167 elif isinstance(value, dict):
168 result[attr] = dict(map(
169 lambda item: (item[0], item[1].to_dict())
170 if hasattr(item[1], "to_dict") else item,
171 value.items()
172 ))
173 else:
174 result[attr] = value
175 if issubclass(GrometWire, dict):
176 for key, value in self.items():
177 result[key] = value
179 return result
181 def to_str(self):
182 """Returns the string representation of the model"""
183 return pprint.pformat(self.to_dict())
185 def __repr__(self):
186 """For `print` and `pprint`"""
187 return self.to_str()
189 def __eq__(self, other):
190 """Returns true if both objects are equal"""
191 if not isinstance(other, GrometWire):
192 return False
194 return self.__dict__ == other.__dict__
196 def __ne__(self, other):
197 """Returns true if both objects are not equal"""
198 return not self == other