# -*- coding: utf-8 -*-
# File generated according to Generator/ClassesRef/Import/ImportGenVectLin.csv
# WARNING! All changes made in this file will be lost!
"""Method code available at https://github.com/Eomys/pyleecan/tree/master/pyleecan/Methods/Import/ImportGenVectLin
"""
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 .ImportMatrix import ImportMatrix
# Import all class method
# Try/catch to remove unnecessary dependencies in unused method
try:
from ..Methods.Import.ImportGenVectLin.check import check
except ImportError as error:
check = error
try:
from ..Methods.Import.ImportGenVectLin.comp_step import comp_step
except ImportError as error:
comp_step = error
try:
from ..Methods.Import.ImportGenVectLin.get_data import get_data
except ImportError as error:
get_data = error
from numpy import isnan
from ._check import InitUnKnowClassError
[docs]class ImportGenVectLin(ImportMatrix):
"""To generate a Linspace vector"""
VERSION = 1
# Check ImportError to remove unnecessary dependencies in unused method
# cf Methods.Import.ImportGenVectLin.check
if isinstance(check, ImportError):
check = property(
fget=lambda x: raise_(
ImportError("Can't use ImportGenVectLin method check: " + str(check))
)
)
else:
check = check
# cf Methods.Import.ImportGenVectLin.comp_step
if isinstance(comp_step, ImportError):
comp_step = property(
fget=lambda x: raise_(
ImportError(
"Can't use ImportGenVectLin method comp_step: " + str(comp_step)
)
)
)
else:
comp_step = comp_step
# cf Methods.Import.ImportGenVectLin.get_data
if isinstance(get_data, ImportError):
get_data = property(
fget=lambda x: raise_(
ImportError(
"Can't use ImportGenVectLin method get_data: " + str(get_data)
)
)
)
else:
get_data = get_data
# 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,
start=0,
stop=1,
num=100,
endpoint=True,
is_transpose=False,
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 "start" in list(init_dict.keys()):
start = init_dict["start"]
if "stop" in list(init_dict.keys()):
stop = init_dict["stop"]
if "num" in list(init_dict.keys()):
num = init_dict["num"]
if "endpoint" in list(init_dict.keys()):
endpoint = init_dict["endpoint"]
if "is_transpose" in list(init_dict.keys()):
is_transpose = init_dict["is_transpose"]
# Set the properties (value check and convertion are done in setter)
self.start = start
self.stop = stop
self.num = num
self.endpoint = endpoint
# Call ImportMatrix init
super(ImportGenVectLin, self).__init__(is_transpose=is_transpose)
# The class is frozen (in ImportMatrix init), for now it's impossible to
# add new properties
def __str__(self):
"""Convert this object in a readeable string (for print)"""
ImportGenVectLin_str = ""
# Get the properties inherited from ImportMatrix
ImportGenVectLin_str += super(ImportGenVectLin, self).__str__()
ImportGenVectLin_str += "start = " + str(self.start) + linesep
ImportGenVectLin_str += "stop = " + str(self.stop) + linesep
ImportGenVectLin_str += "num = " + str(self.num) + linesep
ImportGenVectLin_str += "endpoint = " + str(self.endpoint) + linesep
return ImportGenVectLin_str
def __eq__(self, other):
"""Compare two objects (skip parent)"""
if type(other) != type(self):
return False
# Check the properties inherited from ImportMatrix
if not super(ImportGenVectLin, self).__eq__(other):
return False
if other.start != self.start:
return False
if other.stop != self.stop:
return False
if other.num != self.num:
return False
if other.endpoint != self.endpoint:
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 ImportMatrix
diff_list.extend(
super(ImportGenVectLin, self).compare(
other, name=name, ignore_list=ignore_list, is_add_value=is_add_value
)
)
if (
other._start is not None
and self._start is not None
and isnan(other._start)
and isnan(self._start)
):
pass
elif other._start != self._start:
if is_add_value:
val_str = (
" (self=" + str(self._start) + ", other=" + str(other._start) + ")"
)
diff_list.append(name + ".start" + val_str)
else:
diff_list.append(name + ".start")
if (
other._stop is not None
and self._stop is not None
and isnan(other._stop)
and isnan(self._stop)
):
pass
elif other._stop != self._stop:
if is_add_value:
val_str = (
" (self=" + str(self._stop) + ", other=" + str(other._stop) + ")"
)
diff_list.append(name + ".stop" + val_str)
else:
diff_list.append(name + ".stop")
if (
other._num is not None
and self._num is not None
and isnan(other._num)
and isnan(self._num)
):
pass
elif other._num != self._num:
if is_add_value:
val_str = (
" (self=" + str(self._num) + ", other=" + str(other._num) + ")"
)
diff_list.append(name + ".num" + val_str)
else:
diff_list.append(name + ".num")
if other._endpoint != self._endpoint:
if is_add_value:
val_str = (
" (self="
+ str(self._endpoint)
+ ", other="
+ str(other._endpoint)
+ ")"
)
diff_list.append(name + ".endpoint" + val_str)
else:
diff_list.append(name + ".endpoint")
# 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 ImportMatrix
S += super(ImportGenVectLin, self).__sizeof__()
S += getsizeof(self.start)
S += getsizeof(self.stop)
S += getsizeof(self.num)
S += getsizeof(self.endpoint)
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 ImportMatrix
ImportGenVectLin_dict = super(ImportGenVectLin, self).as_dict(
type_handle_ndarray=type_handle_ndarray,
keep_function=keep_function,
**kwargs
)
ImportGenVectLin_dict["start"] = self.start
ImportGenVectLin_dict["stop"] = self.stop
ImportGenVectLin_dict["num"] = self.num
ImportGenVectLin_dict["endpoint"] = self.endpoint
# The class name is added to the dict for deserialisation purpose
# Overwrite the mother class name
ImportGenVectLin_dict["__class__"] = "ImportGenVectLin"
return ImportGenVectLin_dict
[docs] def copy(self):
"""Creates a deepcopy of the object"""
# Handle deepcopy of all the properties
start_val = self.start
stop_val = self.stop
num_val = self.num
endpoint_val = self.endpoint
is_transpose_val = self.is_transpose
# Creates new object of the same type with the copied properties
obj_copy = type(self)(
start=start_val,
stop=stop_val,
num=num_val,
endpoint=endpoint_val,
is_transpose=is_transpose_val,
)
return obj_copy
def _set_None(self):
"""Set all the properties to None (except pyleecan object)"""
self.start = None
self.stop = None
self.num = None
self.endpoint = None
# Set to None the properties inherited from ImportMatrix
super(ImportGenVectLin, self)._set_None()
def _get_start(self):
"""getter of start"""
return self._start
def _set_start(self, value):
"""setter of start"""
check_var("start", value, "float")
self._start = value
start = property(
fget=_get_start,
fset=_set_start,
doc=u"""Begin point of the linspace
:Type: float
""",
)
def _get_stop(self):
"""getter of stop"""
return self._stop
def _set_stop(self, value):
"""setter of stop"""
check_var("stop", value, "float")
self._stop = value
stop = property(
fget=_get_stop,
fset=_set_stop,
doc=u"""End point of the linspace
:Type: float
""",
)
def _get_num(self):
"""getter of num"""
return self._num
def _set_num(self, value):
"""setter of num"""
check_var("num", value, "float")
self._num = value
num = property(
fget=_get_num,
fset=_set_num,
doc=u"""Number of value in the linspace
:Type: float
""",
)
def _get_endpoint(self):
"""getter of endpoint"""
return self._endpoint
def _set_endpoint(self, value):
"""setter of endpoint"""
check_var("endpoint", value, "bool")
self._endpoint = value
endpoint = property(
fget=_get_endpoint,
fset=_set_endpoint,
doc=u"""If True, stop is the last sample. Otherwise, it is not included
:Type: bool
""",
)
