# -*- coding: utf-8 -*-
# File generated according to Generator/ClassesRef/Slot/HoleUD.csv
# WARNING! All changes made in this file will be lost!
"""Method code available at https://github.com/Eomys/pyleecan/tree/master/pyleecan/Methods/Slot/HoleUD
"""
from os import linesep
from sys import getsizeof
from logging import getLogger
from ._check import check_var, raise_
from ..Functions.get_logger import get_logger
from ..Functions.save import save
from ..Functions.load import load_init_dict
from ..Functions.Load.import_class import import_class
from copy import deepcopy
from .HoleMag import HoleMag
# Import all class method
# Try/catch to remove unnecessary dependencies in unused method
try:
from ..Methods.Slot.HoleUD.build_geometry import build_geometry
except ImportError as error:
build_geometry = error
try:
from ..Methods.Slot.HoleUD.check import check
except ImportError as error:
check = error
try:
from ..Methods.Slot.HoleUD.comp_surface_magnet_id import comp_surface_magnet_id
except ImportError as error:
comp_surface_magnet_id = error
try:
from ..Methods.Slot.HoleUD.has_magnet import has_magnet
except ImportError as error:
has_magnet = error
try:
from ..Methods.Slot.HoleUD.remove_magnet import remove_magnet
except ImportError as error:
remove_magnet = error
from numpy import isnan
from ._check import InitUnKnowClassError
[docs]class HoleUD(HoleMag):
"""User defined hole from list of surface"""
VERSION = 1
IS_SYMMETRICAL = 1
# Check ImportError to remove unnecessary dependencies in unused method
# cf Methods.Slot.HoleUD.build_geometry
if isinstance(build_geometry, ImportError):
build_geometry = property(
fget=lambda x: raise_(
ImportError(
"Can't use HoleUD method build_geometry: " + str(build_geometry)
)
)
)
else:
build_geometry = build_geometry
# cf Methods.Slot.HoleUD.check
if isinstance(check, ImportError):
check = property(
fget=lambda x: raise_(
ImportError("Can't use HoleUD method check: " + str(check))
)
)
else:
check = check
# cf Methods.Slot.HoleUD.comp_surface_magnet_id
if isinstance(comp_surface_magnet_id, ImportError):
comp_surface_magnet_id = property(
fget=lambda x: raise_(
ImportError(
"Can't use HoleUD method comp_surface_magnet_id: "
+ str(comp_surface_magnet_id)
)
)
)
else:
comp_surface_magnet_id = comp_surface_magnet_id
# cf Methods.Slot.HoleUD.has_magnet
if isinstance(has_magnet, ImportError):
has_magnet = property(
fget=lambda x: raise_(
ImportError("Can't use HoleUD method has_magnet: " + str(has_magnet))
)
)
else:
has_magnet = has_magnet
# cf Methods.Slot.HoleUD.remove_magnet
if isinstance(remove_magnet, ImportError):
remove_magnet = property(
fget=lambda x: raise_(
ImportError(
"Can't use HoleUD method remove_magnet: " + str(remove_magnet)
)
)
)
else:
remove_magnet = remove_magnet
# generic save method is available in all object
save = save
# get_logger method is available in all object
get_logger = get_logger
def __init__(
self,
surf_list=-1,
magnet_dict=-1,
name="",
Zh=36,
mat_void=-1,
magnetization_dict_offset=None,
Alpha0=0,
init_dict=None,
init_str=None,
):
"""Constructor of the class. Can be use in three ways :
- __init__ (arg1 = 1, arg3 = 5) every parameters have name and default values
for pyleecan type, -1 will call the default constructor
- __init__ (init_dict = d) d must be a dictionary with property names as keys
- __init__ (init_str = s) s must be a string
s is the file path to load
ndarray or list can be given for Vector and Matrix
object or dict can be given for pyleecan Object"""
if init_str is not None: # Load from a file
init_dict = load_init_dict(init_str)[1]
if init_dict is not None: # Initialisation by dict
assert type(init_dict) is dict
# Overwrite default value with init_dict content
if "surf_list" in list(init_dict.keys()):
surf_list = init_dict["surf_list"]
if "magnet_dict" in list(init_dict.keys()):
magnet_dict = init_dict["magnet_dict"]
if "name" in list(init_dict.keys()):
name = init_dict["name"]
if "Zh" in list(init_dict.keys()):
Zh = init_dict["Zh"]
if "mat_void" in list(init_dict.keys()):
mat_void = init_dict["mat_void"]
if "magnetization_dict_offset" in list(init_dict.keys()):
magnetization_dict_offset = init_dict["magnetization_dict_offset"]
if "Alpha0" in list(init_dict.keys()):
Alpha0 = init_dict["Alpha0"]
# Set the properties (value check and convertion are done in setter)
self.surf_list = surf_list
self.magnet_dict = magnet_dict
self.name = name
# Call HoleMag init
super(HoleUD, self).__init__(
Zh=Zh,
mat_void=mat_void,
magnetization_dict_offset=magnetization_dict_offset,
Alpha0=Alpha0,
)
# The class is frozen (in HoleMag init), for now it's impossible to
# add new properties
def __str__(self):
"""Convert this object in a readeable string (for print)"""
HoleUD_str = ""
# Get the properties inherited from HoleMag
HoleUD_str += super(HoleUD, self).__str__()
if len(self.surf_list) == 0:
HoleUD_str += "surf_list = []" + linesep
for ii in range(len(self.surf_list)):
tmp = (
self.surf_list[ii].__str__().replace(linesep, linesep + "\t") + linesep
)
HoleUD_str += "surf_list[" + str(ii) + "] =" + tmp + linesep + linesep
if len(self.magnet_dict) == 0:
HoleUD_str += "magnet_dict = dict()" + linesep
for key, obj in self.magnet_dict.items():
tmp = (
self.magnet_dict[key].__str__().replace(linesep, linesep + "\t")
+ linesep
)
HoleUD_str += "magnet_dict[" + key + "] =" + tmp + linesep + linesep
HoleUD_str += 'name = "' + str(self.name) + '"' + linesep
return HoleUD_str
def __eq__(self, other):
"""Compare two objects (skip parent)"""
if type(other) != type(self):
return False
# Check the properties inherited from HoleMag
if not super(HoleUD, self).__eq__(other):
return False
if other.surf_list != self.surf_list:
return False
if other.magnet_dict != self.magnet_dict:
return False
if other.name != self.name:
return False
return True
[docs] def compare(self, other, name="self", ignore_list=None, is_add_value=False):
"""Compare two objects and return list of differences"""
if ignore_list is None:
ignore_list = list()
if type(other) != type(self):
return ["type(" + name + ")"]
diff_list = list()
# Check the properties inherited from HoleMag
diff_list.extend(
super(HoleUD, self).compare(
other, name=name, ignore_list=ignore_list, is_add_value=is_add_value
)
)
if (other.surf_list is None and self.surf_list is not None) or (
other.surf_list is not None and self.surf_list is None
):
diff_list.append(name + ".surf_list None mismatch")
elif self.surf_list is None:
pass
elif len(other.surf_list) != len(self.surf_list):
diff_list.append("len(" + name + ".surf_list)")
else:
for ii in range(len(other.surf_list)):
diff_list.extend(
self.surf_list[ii].compare(
other.surf_list[ii],
name=name + ".surf_list[" + str(ii) + "]",
ignore_list=ignore_list,
is_add_value=is_add_value,
)
)
if (other.magnet_dict is None and self.magnet_dict is not None) or (
other.magnet_dict is not None and self.magnet_dict is None
):
diff_list.append(name + ".magnet_dict None mismatch")
elif self.magnet_dict is None:
pass
elif len(other.magnet_dict) != len(self.magnet_dict):
diff_list.append("len(" + name + "magnet_dict)")
else:
for key in self.magnet_dict:
diff_list.extend(
self.magnet_dict[key].compare(
other.magnet_dict[key],
name=name + ".magnet_dict[" + str(key) + "]",
ignore_list=ignore_list,
is_add_value=is_add_value,
)
)
if other._name != self._name:
if is_add_value:
val_str = (
" (self=" + str(self._name) + ", other=" + str(other._name) + ")"
)
diff_list.append(name + ".name" + val_str)
else:
diff_list.append(name + ".name")
# Filter ignore differences
diff_list = list(filter(lambda x: x not in ignore_list, diff_list))
return diff_list
def __sizeof__(self):
"""Return the size in memory of the object (including all subobject)"""
S = 0 # Full size of the object
# Get size of the properties inherited from HoleMag
S += super(HoleUD, self).__sizeof__()
if self.surf_list is not None:
for value in self.surf_list:
S += getsizeof(value)
if self.magnet_dict is not None:
for key, value in self.magnet_dict.items():
S += getsizeof(value) + getsizeof(key)
S += getsizeof(self.name)
return S
[docs] def as_dict(self, type_handle_ndarray=0, keep_function=False, **kwargs):
"""
Convert this object in a json serializable dict (can be use in __init__).
type_handle_ndarray: int
How to handle ndarray (0: tolist, 1: copy, 2: nothing)
keep_function : bool
True to keep the function object, else return str
Optional keyword input parameter is for internal use only
and may prevent json serializability.
"""
# Get the properties inherited from HoleMag
HoleUD_dict = super(HoleUD, self).as_dict(
type_handle_ndarray=type_handle_ndarray,
keep_function=keep_function,
**kwargs
)
if self.surf_list is None:
HoleUD_dict["surf_list"] = None
else:
HoleUD_dict["surf_list"] = list()
for obj in self.surf_list:
if obj is not None:
HoleUD_dict["surf_list"].append(
obj.as_dict(
type_handle_ndarray=type_handle_ndarray,
keep_function=keep_function,
**kwargs
)
)
else:
HoleUD_dict["surf_list"].append(None)
if self.magnet_dict is None:
HoleUD_dict["magnet_dict"] = None
else:
HoleUD_dict["magnet_dict"] = dict()
for key, obj in self.magnet_dict.items():
if obj is not None:
HoleUD_dict["magnet_dict"][key] = obj.as_dict(
type_handle_ndarray=type_handle_ndarray,
keep_function=keep_function,
**kwargs
)
else:
HoleUD_dict["magnet_dict"][key] = None
HoleUD_dict["name"] = self.name
# The class name is added to the dict for deserialisation purpose
# Overwrite the mother class name
HoleUD_dict["__class__"] = "HoleUD"
return HoleUD_dict
[docs] def copy(self):
"""Creates a deepcopy of the object"""
# Handle deepcopy of all the properties
if self.surf_list is None:
surf_list_val = None
else:
surf_list_val = list()
for obj in self.surf_list:
surf_list_val.append(obj.copy())
if self.magnet_dict is None:
magnet_dict_val = None
else:
magnet_dict_val = dict()
for key, obj in self.magnet_dict.items():
magnet_dict_val[key] = obj.copy()
name_val = self.name
Zh_val = self.Zh
if self.mat_void is None:
mat_void_val = None
else:
mat_void_val = self.mat_void.copy()
if self.magnetization_dict_offset is None:
magnetization_dict_offset_val = None
else:
magnetization_dict_offset_val = self.magnetization_dict_offset.copy()
Alpha0_val = self.Alpha0
# Creates new object of the same type with the copied properties
obj_copy = type(self)(
surf_list=surf_list_val,
magnet_dict=magnet_dict_val,
name=name_val,
Zh=Zh_val,
mat_void=mat_void_val,
magnetization_dict_offset=magnetization_dict_offset_val,
Alpha0=Alpha0_val,
)
return obj_copy
def _set_None(self):
"""Set all the properties to None (except pyleecan object)"""
self.surf_list = None
self.magnet_dict = None
self.name = None
# Set to None the properties inherited from HoleMag
super(HoleUD, self)._set_None()
def _get_surf_list(self):
"""getter of surf_list"""
if self._surf_list is not None:
for obj in self._surf_list:
if obj is not None:
obj.parent = self
return self._surf_list
def _set_surf_list(self, value):
"""setter of surf_list"""
if type(value) is list:
for ii, obj in enumerate(value):
if isinstance(obj, str): # Load from file
try:
obj = load_init_dict(obj)[1]
except Exception as e:
self.get_logger().error(
"Error while loading " + obj + ", setting None instead"
)
obj = None
value[ii] = None
if type(obj) is dict:
class_obj = import_class(
"pyleecan.Classes", obj.get("__class__"), "surf_list"
)
value[ii] = class_obj(init_dict=obj)
if value[ii] is not None:
value[ii].parent = self
if value == -1:
value = list()
check_var("surf_list", value, "[Surface]")
self._surf_list = value
surf_list = property(
fget=_get_surf_list,
fset=_set_surf_list,
doc=u"""List of surface to draw the Hole. Surfaces must be ordered in trigo order, label must contain HoleMagnet for Magnet and Hole for holes
:Type: [Surface]
""",
)
def _get_magnet_dict(self):
"""getter of magnet_dict"""
if self._magnet_dict is not None:
for key, obj in self._magnet_dict.items():
if obj is not None:
obj.parent = self
return self._magnet_dict
def _set_magnet_dict(self, value):
"""setter of magnet_dict"""
if type(value) is dict:
for key, obj in value.items():
if isinstance(obj, str): # Load from file
try:
obj = load_init_dict(obj)[1]
except Exception as e:
self.get_logger().error(
"Error while loading " + obj + ", setting None instead"
)
obj = None
value[key] = None
if type(obj) is dict:
class_obj = import_class(
"pyleecan.Classes", obj.get("__class__"), "magnet_dict"
)
value[key] = class_obj(init_dict=obj)
if type(value) is int and value == -1:
value = dict()
check_var("magnet_dict", value, "{Magnet}")
self._magnet_dict = value
magnet_dict = property(
fget=_get_magnet_dict,
fset=_set_magnet_dict,
doc=u"""dictionary with the magnet for the Hole (None to remove magnet, key should be magnet_X)
:Type: {Magnet}
""",
)
def _get_name(self):
"""getter of name"""
return self._name
def _set_name(self, value):
"""setter of name"""
check_var("name", value, "str")
self._name = value
name = property(
fget=_get_name,
fset=_set_name,
doc=u"""Name of the hole (for save)
:Type: str
""",
)
