DataSet

class pyedb.dotnet.database.Variables.DataSet(app, name, x, y, z=None, v=None, xunit='', yunit='', zunit='', vunit='')

Bases: object

Manages datasets.

Parameters:

app

namestr

Name of the app.

xlist

List of X-axis values for the dataset.

ylist

List of Y-axis values for the dataset.

zlist, optional

List of Z-axis values for a 3D dataset only. The default is None.

vlist, optional

List of V-axis values for a 3D dataset only. The default is None.

xunitstr, optional

Units for the X axis. The default is "".

yunitstr, optional

Units for the Y axis. The default is "".

zunitstr, optional

Units for the Z axis for a 3D dataset only. The default is "".

vunitstr, optional

Units for the V axis for a 3D dataset only. The default is "".

Overview

Methods

create	Create a dataset.
add_point	Add a point to the dataset.
remove_point_from_x	Remove a point from an X-axis value.
remove_point_from_index	Remove a point from an index.
update	Update the dataset.
delete	Delete the dataset.
export	Export the dataset.

Attributes

name
x
y
z
v
xunit
yunit
zunit
vunit

Import detail

from pyedb.dotnet.database.Variables import DataSet

Attribute detail

DataSet.name

DataSet.x

DataSet.y

DataSet.z = None

DataSet.v = None

DataSet.xunit = ''

DataSet.yunit = ''

DataSet.zunit = ''

DataSet.vunit = ''

Method detail

DataSet.create()

Create a dataset.

Returns:

bool

True when successful, False when failed.

References

>>> oProject.AddDataset
>>> oDesign.AddDataset

DataSet.add_point(x, y, z=None, v=None)

Add a point to the dataset.

Parameters:

xfloat

X coordinate of the point.

yfloat

Y coordinate of the point.

zfloat, optional

The default is None.

vfloat, optional

The default is None.

Returns:

bool

True when successful, False when failed.

References

>>> oProject.EditDataset
>>> oDesign.EditDataset

DataSet.remove_point_from_x(x)

Remove a point from an X-axis value.

Parameters:

xfloat

Returns:

bool

True when successful, False when failed.

References

>>> oProject.EditDataset
>>> oDesign.EditDataset

DataSet.remove_point_from_index(id_to_remove)

Remove a point from an index.

Parameters:

id_to_removeint

ID of the index.

Returns:

bool

True when successful, False when failed.

References

>>> oProject.EditDataset
>>> oDesign.EditDataset

DataSet.update()

Update the dataset.

Returns:

bool

True when successful, False when failed.

References

>>> oProject.EditDataset
>>> oDesign.EditDataset

DataSet.delete()

Delete the dataset.

Returns:

bool

True when successful, False when failed.

References

>>> oProject.DeleteDataset
>>> oDesign.DeleteDataset

DataSet.export(dataset_path=None)

Export the dataset.

Parameters:

dataset_pathstr, optional

Path to export the dataset to. The default is None, in which case the dataset is exported to the working_directory path.

Returns:

bool

True when successful, False when failed.

References

>>> oProject.ExportDataset
>>> oDesign.ExportDataset