`BaseSource`#

class ansys.speos.core.source.BaseSource(project, name, description='', metadata=None, source_instance=None)#

Super Class for all sources.

Parameters:

projectansys.speos.core.project.Project: Project in which source shall be created.
namestr: Name of the source.
descriptionstr: Description of the source. By default, "".
metadataOptional[Mapping[str, str]]: Metadata of the feature. By default, {}.
source_instanceansys.api.speos.scene.v2.scene_pb2.Scene.SourceInstance, optional: Source instance to provide if the feature does not have to be created from scratch By default, None, means that the feature is created from scratch by default.

Parameters:

project (BaseSource.__init__.project)
name (str)
description (str)
metadata (Optional[Mapping[str, str]])
source_instance (Optional[ansys.speos.core.kernel.scene.ProtoScene.SourceInstance])

Notes

This is a Super class, Do not instantiate this class yourself

Overview#

Methods

`get`	Get dictionary corresponding to the project - read only.
`commit`	Save feature: send the local data to the speos server database.
`reset`	Reset feature: override local data by the one from the speos server database.
`delete`	Delete feature: delete data from the speos server database.

Attributes

Link object for the source template in database.

Special methods

Return the string representation of the source.

from ansys.speos.core.source import BaseSource

BaseSource.source_template_link = None#: Link object for the source template in database.

BaseSource.get(key='')#

Get dictionary corresponding to the project - read only.

Parameters:

Returns:

BaseSource.commit()#

Save feature: send the local data to the speos server database.

Returns:

BaseSource.reset()#

Reset feature: override local data by the one from the speos server database.

Returns:

BaseSource.delete()#

Delete feature: delete data from the speos server database.

The local data are still available

Returns: