Source code for py_dss_interface.models.XYCurves.XYCurves

# -*- encoding: utf-8 -*-
"""
 Created by eniocc at 11/10/2020
"""

from py_dss_interface.models.XYCurves.XYCurvesF import XYCurvesF
from py_dss_interface.models.XYCurves.XYCurvesI import XYCurvesI
from py_dss_interface.models.XYCurves.XYCurvesS import XYCurvesS
from py_dss_interface.models.XYCurves.XYCurvesV import XYCurvesV
from typing import List


[docs]class XYCurves(XYCurvesS, XYCurvesI, XYCurvesF, XYCurvesV): """ This interface implements the XYCurves (IXYCurves) interface of OpenDSS by declaring 4 procedures for accessing the different properties included in this interface: XYCurvesS, XYCurvesI, XYCurvesF, XYCurvesV. """ def __init__(self, dss_obj): super().__init__(dss_obj) @property def x(self) -> float: """Gets the interpolated value after setting X. Sets the X value.""" return XYCurvesF._x_read(self) @x.setter def x(self, value: int): XYCurvesF._x_write(self, value) @property def y(self) -> float: """Gets the interpolated value after setting Y. Sets the Y value.""" return XYCurvesF._y_read(self) @y.setter def y(self, value: int): XYCurvesF._y_write(self, value) @property def x_shift(self) -> float: """Gets the amount to shift X value from original curve. Sets the amount to shift X value from original curve.""" return XYCurvesF._x_shift_read(self) @x_shift.setter def x_shift(self, value: int): XYCurvesF._x_shift_write(self, value) @property def y_shift(self) -> float: """Gets the amount to shift Y value from original curve. Sets the amount to shift Y value from original curve.""" return XYCurvesF._y_shift_read(self) @y_shift.setter def y_shift(self, value: int): XYCurvesF._y_shift_write(self, value) @property def x_scale(self) -> float: """Gets the factor to scale X values from original curve. Sets the factor to scale X values from original curve.""" return XYCurvesF._x_scale_read(self) @x_scale.setter def x_scale(self, value: int): XYCurvesF._x_scale_write(self, value) @property def y_scale(self) -> float: """Gets the factor to scale Y values from original curve. Sets the factor to scale Y values from original curve.""" return XYCurvesF._y_scale_read(self) @y_scale.setter def y_scale(self, value: int): XYCurvesF._y_scale_write(self, value) @property def count(self) -> int: """Gets number of XYCurves in active circuit.""" return XYCurvesI._count(self)
[docs] def first(self) -> int: """Sets first XYCurves object active; returns 0 if none.""" return XYCurvesI._first(self)
[docs] def next(self) -> int: """Sets next XYCurves object active; returns 0 if none.""" return XYCurvesI._next(self)
@property def npts(self) -> int: return XYCurvesI._npts_read(self) @npts.setter def npts(self, argument: int): """Gets the number of points in X-Y curve. Sets the number of points in X-Y curve.""" XYCurvesI._npts_write(self, argument) @property def name(self) -> str: """Gets the name of the active XYCurve Object. Sets the name of the active XYCurve Object.""" return XYCurvesS._name_read(self) @name.setter def name(self, argument: str): XYCurvesS._name_write(self, argument) @property def x_array(self) -> List[float]: """Gets the X values as a variant array of doubles. Set Npts to max number expected if setting. Sets the X values as a variant array of doubles specified in Argument. Set Npts to max number expected if setting.""" return XYCurvesV._x_array_read(self) @x_array.setter def x_array(self, argument: List[float]): XYCurvesV._x_array_write(self, argument) @property def y_array(self) -> List[float]: """Gets the Y values as a variant array of doubles. Set Npts to max number expected if setting.. Sets the Y values as a variant array of doubles specified in Argument. Set Npts to max number expected if setting.""" return XYCurvesV._y_array_read(self) @y_array.setter def y_array(self, argument: List[float]): XYCurvesV._y_array_write(self, argument)