Skip to content
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

Refactor object3d #142

Merged
merged 44 commits into from
Jun 24, 2021
Merged

Refactor object3d #142

merged 44 commits into from
Jun 24, 2021

Conversation

voss70
Copy link
Contributor

@voss70 voss70 commented Jun 23, 2021

Design.py

  • added DesignCache object to identify new error messages and changes in design - intended for increasing scrutiny of unit-testing

All Application Classes

  • set AlwaysNew=True, release_on_exit=True as default when accessing Desktop from within a Design Object

API Docs

  • Added Object3D classes to the docs

Object3d.py

  • Major refactoring of Object3d class!
    • added setter and getters for all properties, removed som set_ and get_functions
    • docstring work (ongoing)
    • property color - return tuple of int instead of string, add color_string property for consistency
    • added odesign property
    • added rgb codes
    • created unit tests

Modeler.py

  • minor modifications to reflect changes to Object3d class

Primitives.py

  • refactor draw_polyline to create_polyline
  • add properties solids, sheets, lines and object_names.
  • add _refresh_object_types function to update the above properties
  • remove update_object_properties since implemented in Object3d now
  • minor modifications to reflect changes to Object3d class

Primitives3D.py

  • minor modifications to reflect changes to Object3d class

Primitives2D.py

  • minor modifications to reflect changes to Object3d class

Unit Testing

  • Started renaming tests to enforce the order from simple to complex
  • Added test_07_Object3D.py
  • added class BasisTest and wrappers pyaedt_unittest_new_design, pyaedt_unittest_duplicate_design, pyaedt_unittest_same_design
  • refactored test_08_Primitives.py and test_01_Design.py to use the above structures

 - set AlwaysNew=True, release_on_exit=True as default when accessing Desktop from within a Design Object

 API Docs
 - Added Object3D classes to the docs
 - set AlwaysNew=True, release_on_exit=True as default when accessing Desktop from within a Design Object

 API Docs
 - Added Object3D classes to the docs

 Object3d.py
 - Major refactoring of Object3d class!
   - added setter and getters for all properties, removed som set_ and get_functions
   - docstring work (ongoing)
   - property color - return tuple of int instead of string, add color_string property for consistency
   - added odesign property

 Modeler.py
  - minor modifications to reflect changes to Object3d class

 Primitives.py
  - refactor draw_polyline to create_polyline
  - add properties solids, sheets, lines and object_names.
  - add _refresh_object_types function to update the above properties
  - remove update_object_properties since implemented in Object3d now
  - minor modifications to reflect changes to Object3d class

Primitives3D.py
  - minor modifications to reflect changes to Object3d class
# Conflicts:
#	_unittest/test_Primitives.py
#	pyaedt/modeler/Primitives.py
 - set AlwaysNew=True, release_on_exit=True as default when accessing Desktop from within a Design Object

 API Docs
 - Added Object3D classes to the docs

 Object3d.py
 - Major refactoring of Object3d class!
   - added setter and getters for all properties, removed som set_ and get_functions
   - docstring work (ongoing)
   - property color - return tuple of int instead of string, add color_string property for consistency
   - added odesign property

 Modeler.py
  - minor modifications to reflect changes to Object3d class

 Primitives.py
  - refactor draw_polyline to create_polyline
  - add properties solids, sheets, lines and object_names.
  - add _refresh_object_types function to update the above properties
  - remove update_object_properties since implemented in Object3d now
  - minor modifications to reflect changes to Object3d class

Primitives3D.py
  - minor modifications to reflect changes to Object3d class
 - set AlwaysNew=True, release_on_exit=True as default when accessing Desktop from within a Design Object

 API Docs
 - Added Object3D classes to the docs

 Object3d.py
 - Major refactoring of Object3d class!
   - added setter and getters for all properties, removed som set_ and get_functions
   - docstring work (ongoing)
   - property color - return tuple of int instead of string, add color_string property for consistency
   - added odesign property

 Modeler.py
  - minor modifications to reflect changes to Object3d class

 Primitives.py
  - refactor draw_polyline to create_polyline
  - add properties solids, sheets, lines and object_names.
  - add _refresh_object_types function to update the above properties
  - remove update_object_properties since implemented in Object3d now
  - minor modifications to reflect changes to Object3d class

Primitives3D.py
  - minor modifications to reflect changes to Object3d class
 - set AlwaysNew=True, release_on_exit=True as default when accessing Desktop from within a Design Object

 API Docs
 - Added Object3D classes to the docs

 Object3d.py
 - Major refactoring of Object3d class!
   - added setter and getters for all properties, removed som set_ and get_functions
   - docstring work (ongoing)
   - property color - return tuple of int instead of string, add color_string property for consistency
   - added odesign property

 Modeler.py
  - minor modifications to reflect changes to Object3d class

 Primitives.py
  - refactor draw_polyline to create_polyline
  - add properties solids, sheets, lines and object_names.
  - add _refresh_object_types function to update the above properties
  - remove update_object_properties since implemented in Object3d now
  - minor modifications to reflect changes to Object3d class

Primitives3D.py
  - minor modifications to reflect changes to Object3d class
 - set AlwaysNew=True, release_on_exit=True as default when accessing Desktop from within a Design Object

 API Docs
 - Added Object3D classes to the docs

 Object3d.py
 - Major refactoring of Object3d class!
   - added setter and getters for all properties, removed som set_ and get_functions
   - docstring work (ongoing)
   - property color - return tuple of int instead of string, add color_string property for consistency
   - added odesign property

 Modeler.py
  - minor modifications to reflect changes to Object3d class

 Primitives.py
  - refactor draw_polyline to create_polyline
  - add properties solids, sheets, lines and object_names.
  - add _refresh_object_types function to update the above properties
  - remove update_object_properties since implemented in Object3d now
  - minor modifications to reflect changes to Object3d class

Primitives3D.py
  - minor modifications to reflect changes to Object3d class
 - set AlwaysNew=True, release_on_exit=True as default when accessing Desktop from within a Design Object

 API Docs
 - Added Object3D classes to the docs

 Object3d.py
 - Major refactoring of Object3d class!
   - added setter and getters for all properties, removed som set_ and get_functions
   - docstring work (ongoing)
   - property color - return tuple of int instead of string, add color_string property for consistency
   - added odesign property
   - added rgb codes

 Modeler.py
  - minor modifications to reflect changes to Object3d class

 Primitives.py
  - refactor draw_polyline to create_polyline
  - add properties solids, sheets, lines and object_names.
  - add _refresh_object_types function to update the above properties
  - remove update_object_properties since implemented in Object3d now
  - minor modifications to reflect changes to Object3d class

Primitives3D.py
  - minor modifications to reflect changes to Object3d class
# Conflicts:
#	_unittest/ignore_test_Icepak.py
#	_unittest/test_08_Primitives.py
 - set AlwaysNew=True, release_on_exit=True as default when accessing Desktop from within a Design Object

 API Docs
 - Added Object3D classes to the docs

 Object3d.py
 - Major refactoring of Object3d class!
   - added setter and getters for all properties, removed som set_ and get_functions
   - docstring work (ongoing)
   - property color - return tuple of int instead of string, add color_string property for consistency
   - added odesign property
   - added rgb codes

 Modeler.py
  - minor modifications to reflect changes to Object3d class

 Primitives.py
  - refactor draw_polyline to create_polyline
  - add properties solids, sheets, lines and object_names.
  - add _refresh_object_types function to update the above properties
  - remove update_object_properties since implemented in Object3d now
  - minor modifications to reflect changes to Object3d class

Primitives3D.py
  - minor modifications to reflect changes to Object3d class
 - set AlwaysNew=True, release_on_exit=True as default when accessing Desktop from within a Design Object

 API Docs
 - Added Object3D classes to the docs

 Object3d.py
 - Major refactoring of Object3d class!
   - added setter and getters for all properties, removed som set_ and get_functions
   - docstring work (ongoing)
   - property color - return tuple of int instead of string, add color_string property for consistency
   - added odesign property
   - added rgb codes

 Modeler.py
  - minor modifications to reflect changes to Object3d class

 Primitives.py
  - refactor draw_polyline to create_polyline
  - add properties solids, sheets, lines and object_names.
  - add _refresh_object_types function to update the above properties
  - remove update_object_properties since implemented in Object3d now
  - minor modifications to reflect changes to Object3d class

Primitives3D.py
  - minor modifications to reflect changes to Object3d class
# Conflicts:
#	pyaedt/hfss.py
- experimental refactor to propose to help with testing

Design.py
- added DesignCache object to identify new error messages and changes in design - intended for increasing scrutiny of unit-testing

All Application Classes
 - set AlwaysNew=True, release_on_exit=True as default when accessing Desktop from within a Design Object

 API Docs
 - Added Object3D classes to the docs

 Object3d.py
 - Major refactoring of Object3d class!
   - added setter and getters for all properties, removed som set_ and get_functions
   - docstring work (ongoing)
   - property color - return tuple of int instead of string, add color_string property for consistency
   - added odesign property
   - added rgb codes
   - created unit tests

 Modeler.py
  - minor modifications to reflect changes to Object3d class

 Primitives.py
  - refactor draw_polyline to create_polyline
  - add properties solids, sheets, lines and object_names.
  - add _refresh_object_types function to update the above properties
  - remove update_object_properties since implemented in Object3d now
  - minor modifications to reflect changes to Object3d class

Primitives3D.py
  - minor modifications to reflect changes to Object3d class

Primitives2D.py
  - minor modifications to reflect changes to Object3d class

 Unit Testing
 - Started renaming tests to enforce the order frim simple to complex
 - Added test_07_Object3D.py
 - added class BasisTest and wrappers pyaedt_unittest_same_design, pyaedt_unittest_same_design, pyaedt_unittest_same_design
 - refactored test_08_Primitives.py and test_01_Design.py to use the above structures
- experimental refactor to propose to help with testing

Design.py
- added DesignCache object to identify new error messages and changes in design - intended for increasing scrutiny of unit-testing

All Application Classes
 - set AlwaysNew=True, release_on_exit=True as default when accessing Desktop from within a Design Object

 API Docs
 - Added Object3D classes to the docs

 Object3d.py
 - Major refactoring of Object3d class!
   - added setter and getters for all properties, removed som set_ and get_functions
   - docstring work (ongoing)
   - property color - return tuple of int instead of string, add color_string property for consistency
   - added odesign property
   - added rgb codes
   - created unit tests

 Modeler.py
  - minor modifications to reflect changes to Object3d class

 Primitives.py
  - refactor draw_polyline to create_polyline
  - add properties solids, sheets, lines and object_names.
  - add _refresh_object_types function to update the above properties
  - remove update_object_properties since implemented in Object3d now
  - minor modifications to reflect changes to Object3d class

Primitives3D.py
  - minor modifications to reflect changes to Object3d class

Primitives2D.py
  - minor modifications to reflect changes to Object3d class

 Unit Testing
 - Started renaming tests to enforce the order frim simple to complex
 - Added test_07_Object3D.py
 - added class BasisTest and wrappers pyaedt_unittest_same_design, pyaedt_unittest_same_design, pyaedt_unittest_same_design
 - refactored test_08_Primitives.py and test_01_Design.py to use the above structures
@voss70 voss70 requested a review from maxcapodi78 June 23, 2021 10:09
vossleon and others added 6 commits June 23, 2021 12:11
- experimental refactor to propose to help with testing

Design.py
- added DesignCache object to identify new error messages and changes in design - intended for increasing scrutiny of unit-testing

All Application Classes
 - set AlwaysNew=True, release_on_exit=True as default when accessing Desktop from within a Design Object

 API Docs
 - Added Object3D classes to the docs

 Object3d.py
 - Major refactoring of Object3d class!
   - added setter and getters for all properties, removed som set_ and get_functions
   - docstring work (ongoing)
   - property color - return tuple of int instead of string, add color_string property for consistency
   - added odesign property
   - added rgb codes
   - created unit tests

 Modeler.py
  - minor modifications to reflect changes to Object3d class

 Primitives.py
  - refactor draw_polyline to create_polyline
  - add properties solids, sheets, lines and object_names.
  - add _refresh_object_types function to update the above properties
  - remove update_object_properties since implemented in Object3d now
  - minor modifications to reflect changes to Object3d class

Primitives3D.py
  - minor modifications to reflect changes to Object3d class

Primitives2D.py
  - minor modifications to reflect changes to Object3d class

 Unit Testing
 - Started renaming tests to enforce the order frim simple to complex
 - Added test_07_Object3D.py
 - added class BasisTest and wrappers pyaedt_unittest_same_design, pyaedt_unittest_same_design, pyaedt_unittest_same_design
 - refactored test_08_Primitives.py and test_01_Design.py to use the above structures
- experimental refactor to propose to help with testing

Design.py
- added DesignCache object to identify new error messages and changes in design - intended for increasing scrutiny of unit-testing

All Application Classes
 - set AlwaysNew=True, release_on_exit=True as default when accessing Desktop from within a Design Object

 API Docs
 - Added Object3D classes to the docs

 Object3d.py
 - Major refactoring of Object3d class!
   - added setter and getters for all properties, removed som set_ and get_functions
   - docstring work (ongoing)
   - property color - return tuple of int instead of string, add color_string property for consistency
   - added odesign property
   - added rgb codes
   - created unit tests

 Modeler.py
  - minor modifications to reflect changes to Object3d class

 Primitives.py
  - refactor draw_polyline to create_polyline
  - add properties solids, sheets, lines and object_names.
  - add _refresh_object_types function to update the above properties
  - remove update_object_properties since implemented in Object3d now
  - minor modifications to reflect changes to Object3d class

Primitives3D.py
  - minor modifications to reflect changes to Object3d class

Primitives2D.py
  - minor modifications to reflect changes to Object3d class

 Unit Testing
 - Started renaming tests to enforce the order frim simple to complex
 - Added test_07_Object3D.py
 - added class BasisTest and wrappers pyaedt_unittest_same_design, pyaedt_unittest_same_design, pyaedt_unittest_same_design
 - refactored test_08_Primitives.py and test_01_Design.py to use the above structures
- experimental refactor to propose to help with testing

Design.py
- added DesignCache object to identify new error messages and changes in design - intended for increasing scrutiny of unit-testing

All Application Classes
 - set AlwaysNew=True, release_on_exit=True as default when accessing Desktop from within a Design Object

 API Docs
 - Added Object3D classes to the docs

 Object3d.py
 - Major refactoring of Object3d class!
   - added setter and getters for all properties, removed som set_ and get_functions
   - docstring work (ongoing)
   - property color - return tuple of int instead of string, add color_string property for consistency
   - added odesign property
   - added rgb codes
   - created unit tests

 Modeler.py
  - minor modifications to reflect changes to Object3d class

 Primitives.py
  - refactor draw_polyline to create_polyline
  - add properties solids, sheets, lines and object_names.
  - add _refresh_object_types function to update the above properties
  - remove update_object_properties since implemented in Object3d now
  - minor modifications to reflect changes to Object3d class

Primitives3D.py
  - minor modifications to reflect changes to Object3d class

Primitives2D.py
  - minor modifications to reflect changes to Object3d class

 Unit Testing
 - Started renaming tests to enforce the order frim simple to complex
 - Added test_07_Object3D.py
 - added class BasisTest and wrappers pyaedt_unittest_same_design, pyaedt_unittest_same_design, pyaedt_unittest_same_design
 - refactored test_08_Primitives.py and test_01_Design.py to use the above structures
- experimental refactor to propose to help with testing

Design.py
- added DesignCache object to identify new error messages and changes in design - intended for increasing scrutiny of unit-testing

All Application Classes
 - set AlwaysNew=True, release_on_exit=True as default when accessing Desktop from within a Design Object

 API Docs
 - Added Object3D classes to the docs

 Object3d.py
 - Major refactoring of Object3d class!
   - added setter and getters for all properties, removed som set_ and get_functions
   - docstring work (ongoing)
   - property color - return tuple of int instead of string, add color_string property for consistency
   - added odesign property
   - added rgb codes
   - created unit tests

 Modeler.py
  - minor modifications to reflect changes to Object3d class

 Primitives.py
  - refactor draw_polyline to create_polyline
  - add properties solids, sheets, lines and object_names.
  - add _refresh_object_types function to update the above properties
  - remove update_object_properties since implemented in Object3d now
  - minor modifications to reflect changes to Object3d class

Primitives3D.py
  - minor modifications to reflect changes to Object3d class

Primitives2D.py
  - minor modifications to reflect changes to Object3d class

 Unit Testing
 - Started renaming tests to enforce the order frim simple to complex
 - Added test_07_Object3D.py
 - added class BasisTest and wrappers pyaedt_unittest_same_design, pyaedt_unittest_same_design, pyaedt_unittest_same_design
 - refactored test_08_Primitives.py and test_01_Design.py to use the above structures
- experimental refactor to propose to help with testing

Design.py
- added DesignCache object to identify new error messages and changes in design - intended for increasing scrutiny of unit-testing

All Application Classes
 - set AlwaysNew=True, release_on_exit=True as default when accessing Desktop from within a Design Object

 API Docs
 - Added Object3D classes to the docs

 Object3d.py
 - Major refactoring of Object3d class!
   - added setter and getters for all properties, removed som set_ and get_functions
   - docstring work (ongoing)
   - property color - return tuple of int instead of string, add color_string property for consistency
   - added odesign property
   - added rgb codes
   - created unit tests

 Modeler.py
  - minor modifications to reflect changes to Object3d class

 Primitives.py
  - refactor draw_polyline to create_polyline
  - add properties solids, sheets, lines and object_names.
  - add _refresh_object_types function to update the above properties
  - remove update_object_properties since implemented in Object3d now
  - minor modifications to reflect changes to Object3d class

Primitives3D.py
  - minor modifications to reflect changes to Object3d class

Primitives2D.py
  - minor modifications to reflect changes to Object3d class

 Unit Testing
 - Started renaming tests to enforce the order frim simple to complex
 - Added test_07_Object3D.py
 - added class BasisTest and wrappers pyaedt_unittest_same_design, pyaedt_unittest_same_design, pyaedt_unittest_same_design
 - refactored test_08_Primitives.py and test_01_Design.py to use the above structures
pyaedt/hfss.py Outdated
Comment on lines 252 to 253
:class: BoundaryObject
Boundary object
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Please revert to original review docstrings. This way is not working with PyCharm

pyaedt/hfss.py Outdated Show resolved Hide resolved
pyaedt/hfss.py Outdated Show resolved Hide resolved
pyaedt/hfss.py Outdated Show resolved Hide resolved
pyaedt/hfss.py Outdated Show resolved Hide resolved
pyaedt/hfss.py Outdated Show resolved Hide resolved
pyaedt/hfss.py Outdated Show resolved Hide resolved
pyaedt/hfss.py Outdated Show resolved Hide resolved
pyaedt/hfss.py Outdated Show resolved Hide resolved
Returns
-------

"""
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

why did you deleted the docstrings for this method?

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I refactored this function to a protected _refresh_all_ids_from_aedt_file and thus do not need the docstring anymore

@maxcapodi78 maxcapodi78 self-requested a review June 24, 2021 08:18
@voss70 voss70 merged commit ef24acb into main Jun 24, 2021
@voss70 voss70 deleted the Refactor_Object3d branch June 24, 2021 08:34
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants