Skip to content

Update an existing user-defined primitive (UDP). #850

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 9 commits into from
Feb 16, 2022
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
25 changes: 25 additions & 0 deletions _unittest/test_28_Maxwell3D.py
Original file line number Diff line number Diff line change
Expand Up @@ -162,9 +162,22 @@ def test_26_create_udp(self):
name=my_udpName,
udptye="Solid",
)

assert udp
assert udp.name == "MyClawPoleCore"
assert "MyClawPoleCore" in udp._primitives.object_names
assert int(udp.bounding_dimension[2]) == 100

# Modify one of the 'MyClawPoleCore' udp properties.
assert self.aedtapp.modeler.update_udp(
object_name="MyClawPoleCore",
operation_name="CreateUserDefinedPart",
udp_parameters_list=[["Length", "110mm"]],
)

assert int(udp.bounding_dimension[0]) == 102
assert int(udp.bounding_dimension[1]) == 102
assert int(udp.bounding_dimension[2]) == 110

# Test udp with default name -None-.
second_udp = self.aedtapp.modeler.create_udp(
Expand All @@ -173,10 +186,22 @@ def test_26_create_udp(self):
upd_library="syslib",
udptye="Solid",
)

assert second_udp
assert second_udp.name == "ClawPoleCore"
assert "ClawPoleCore" in udp._primitives.object_names

# Modify two of the 'MyClawPoleCore' udp properties.
assert self.aedtapp.modeler.update_udp(
object_name="ClawPoleCore",
operation_name="CreateUserDefinedPart",
udp_parameters_list=[["Length", "110mm"], ["DiaGap", "125mm"]],
)

assert int(second_udp.bounding_dimension[0]) == 125
assert int(second_udp.bounding_dimension[1]) == 125
assert int(second_udp.bounding_dimension[2]) == 110

@pytest.mark.skipif(os.name == "posix", reason="Feature not supported in Linux")
def test_27_create_udm(self):
my_udmPairs = []
Expand Down
61 changes: 61 additions & 0 deletions pyaedt/modeler/Primitives.py
Original file line number Diff line number Diff line change
Expand Up @@ -1568,6 +1568,14 @@ def create_udp(self, udp_dll_name, udp_parameters_list, upd_library="syslib", na

>>> oEditor.CreateUserDefinedPart

Examples
--------
>>> my_udp = self.aedtapp.modeler.create_udp(udp_dll_name="RMxprt/ClawPoleCore",
... udp_parameters_list=my_udpPairs,
... upd_library="syslib",
... udptye="Solid")
<class 'pyaedt.modeler.Object3d.Object3d'>

"""
if ".dll" not in udp_dll_name:
vArg1 = [
Expand Down Expand Up @@ -1598,6 +1606,59 @@ def create_udp(self, udp_dll_name, udp_parameters_list, upd_library="syslib", na
obj_name = self._oeditor.CreateUserDefinedPart(vArg1, vArg2)
return self._create_object(obj_name)

@aedt_exception_handler
def update_udp(self, object_name, operation_name, udp_parameters_list):
"""Update an existing geometrical object that was originally created using a user-defined primitive (UDP).

Parameters
----------
object_name : str
Name of the object to update.
operation_name : str
Name of the operation used to create the object.
udp_parameters_list : list
List of the UDP parameters to update and their value.

Returns
-------
bool
``True`` when successful.

References
----------

>>> oEditor.CreateUserDefinedPart

Examples
--------
>>> self.aedtapp.modeler.update_udp(object_name="ClawPoleCore",
... operation_name="CreateUserDefinedPart",
... udp_parameters_list=[["Length","110mm"], ["DiaGap","125mm"]])
True

"""

vArg1 = ["NAME:AllTabs"]

prop_servers = ["NAME:PropServers"]
prop_servers.append("{0}:{1}:1".format(object_name, operation_name))

cmd_tab = ["NAME:Geometry3DCmdTab"]
cmd_tab.append(prop_servers)

changed_props = ["NAME:ChangedProps"]

for pair in udp_parameters_list:
if isinstance(pair, list):
changed_props.append(["NAME:{0}".format(pair[0]), "Value:=", pair[1]])
else:
changed_props.append(["NAME:", pair.Name, "Value:=", pair.Value])

cmd_tab.append(changed_props)
vArg1.append(cmd_tab)
self._oeditor.ChangeProperty(vArg1)
return True

@aedt_exception_handler
def delete(self, objects=None):
"""Delete objects or groups.
Expand Down