ExitanceVariable#

class ansys.speos.core.source.SourceSurface.ExitanceVariable(exitance_variable, exitance_variable_props, default_values=True, stable_ctr=False)#

Type of surface source existence : existence variable.

Parameters:
exitance_variableansys.api.speos.source.v1.source_pb2.SourceTemplate.Surface.
ExitanceVariable

Existence variable to complete.

exitance_variable_propsansys.api.speos.scene.v2.scene_pb2.Scene.SourceInstance.
SurfaceProperties.ExitanceVariableProperties

Existence variable properties to complete.

default_valuesbool

Uses default values when True.

stable_ctrbool

Variable to indicate if usage is inside class scope

Parameters:

  • default_values (bool)

  • stable_ctr (bool)

Notes

Do not instantiate this class yourself, use set_exitance_variable method available in Source classes.

Overview#

set_xmp_file_uri

Set existence xmp file.

set_axis_plane

Set position of the existence map.

Import detail#

from ansys.speos.core.source.SourceSurface import ExitanceVariable

Method detail#

ExitanceVariable.set_xmp_file_uri(uri)#

Set existence xmp file.

Parameters:
uristr

XMP file describing existence.

Returns:
ansys.speos.core.source.SourceSurface.ExitanceVariable

ExitanceVariable of surface source.

ExitanceVariable.set_axis_plane(axis_plane=None)#

Set position of the existence map.

Parameters:
axis_planeOptional[List[float]]

Position of the existence map [Ox Oy Oz Xx Xy Xz Yx Yy Yz]. By default, [0, 0, 0, 1, 0, 0, 0, 1, 0].

Returns:
ansys.speos.core.source.SourceSurface.ExitanceVariable

ExitanceVariable of surface Source.