A base class for all Simulation Builders. More...

Inheritance diagram for SimulationCommonBuilder:

Public Member Functions
	AddSources (self, sources)
	Adds sources into the simulation.

	RemoveSources (self, sources)
	Deletes sources from the simulation.

	AddGeometries (self, tags)
	Adds geometries into the simulation.

	RemoveGeometries (self, tags)
	Deletes geometries from the simulation.

	AddSensors (self, sensors)
	Adds sensors into the simulation.

	RemoveSensors (self, sensors)
	Deletes sensors from the simulation.

Public Member Functions inherited from FeatureBuilder
	Commit (self)
	Commits any edits that have been applied to the builder.

	ShowResult (self)
	Updates the feature to reflect the result of an edit to the feature for all builders that support showing results.

Properties
	AllPreset = property(fget = __GetAllPreset)
	Gets all Preset.

	AmbientMaterial = property(fget = __GetAmbientMaterial, fset = __SetAmbientMaterial)
	Gets or sets the property to enable ambient material.

	EstimatedRam = property(fget = __GetEstimatedRam)
	Gets the estimated RAM usage.

	FeatureSimulation = property(fget = __GetFeatureSimulation)
	Gets the simulation feature object.

	Geometries = property(fget = __GetGeometries)
	Gets geometries tag.

	LightExpert = property(fget = __GetLightExpert, fset = __SetLightExpert)
	Gets or sets the property to enable Light Expert.

	Preset = property(fget = __GetPreset, fset = __SetPreset)
	Gets or sets the Preset object.

	SelectAmbientMaterial = property(fget = __GetSelectAmbientMaterial, fset = __SetSelectAmbientMaterial)
	Gets or set the ambient material.

	Sensors = property(fget = __GetSensors)
	Gets sensor features.

	Settings = property(fget = __GetSettings, fset = __SetSettings)
	Gets or sets the simulation settings.

	Sources = property(fget = __GetSources)
	Gets source features.

	StandardDeviation = property(fget = __GetStandardDeviation, fset = __SetStandardDeviation)

	UsePresetSettings = property(fget = __GetUsePresetSettings, fset = __SetUsePresetSettings)
	Gets or sets the property to enable preset settings.

Properties inherited from FeatureBuilder
	Feature = property(fget = __GetFeature)
	Returns the feature being edited, or the created feature if the builder is being used in creation mode.

	FullName = property(fget = __GetFullName)
	Gets the full name of the feature being edited.

	Name = property(fget = __GetName, fset = __SetName)
	Gets or sets the name of the feature being edited.

	NameWithContext = property(fget = __GetNameWithContext)
	Gets the name with context of the feature being edited.

	Status = property(fget = __GetStatus)
	Returns the status of the feature being edited.

Detailed Description

A base class for all Simulation Builders.

A Builder is an object that is used to create and edit Features.

This is an abstract class that provides the basic functionality common to all builders. See the Builder subclasses for details of application-specific builders.

This is an abstract class, and cannot be instantiated.

Member Function Documentation

◆ AddGeometries()

AddGeometries	(		self,
			tags )

Adds geometries into the simulation.

The AddGeometries function takes a list of feature tag as parameter.

Parameters

[in] tags : List of integer.

Returns: void.

◆ AddSensors()

AddSensors	(		self,
			sensors )

Adds sensors into the simulation.

Parameters

[in] sensors : List of Feature object.

Returns: void.

◆ AddSources()

AddSources	(		self,
			sources )

Adds sources into the simulation.

Parameters

[in] sources : List of Feature object

Returns: void.

◆ RemoveGeometries()

RemoveGeometries	(		self,
			tags )

Deletes geometries from the simulation.

The DeleteGeometries function takes a list of feature tag as parameter.

Parameters

[in] tags : List of integer.

Returns: void.

◆ RemoveSensors()

RemoveSensors	(		self,
			sensors )

Deletes sensors from the simulation.

Parameters

[in] sensors : List of Feature object.

Returns: void.

◆ RemoveSources()

RemoveSources	(		self,
			sources )

Deletes sources from the simulation.

Parameters

[in] sources : List of Feature object

Returns: void.

Property Documentation

◆ AllPreset

AllPreset = property(fget = __GetAllPreset)

static

Gets all Preset.

Value type: List of Preset object.

◆ AmbientMaterial

AmbientMaterial = property(fget = __GetAmbientMaterial, fset = __SetAmbientMaterial)

static

Gets or sets the property to enable ambient material.

True: Enables Ambient Material.
False: Disables Ambient Material.

Value type: Boolean.

The default value is False.

◆ EstimatedRam

EstimatedRam = property(fget = __GetEstimatedRam)

static

Gets the estimated RAM usage.

Value type: String.

◆ FeatureSimulation

FeatureSimulation = property(fget = __GetFeatureSimulation)

static

Gets the simulation feature object.

Gets the simulation feature in order to launch simulations.

Value type: FeatureSimulation object.

◆ Geometries

Geometries = property(fget = __GetGeometries)

static

Gets geometries tag.

The Geometries property returns a list of feature tag.

Returns: List of integer.

◆ LightExpert

LightExpert = property(fget = __GetLightExpert, fset = __SetLightExpert)

static

Gets or sets the property to enable Light Expert.

True: Enables Light Expert.
False: Disables Light Expert.

Value type: Boolean.

The default value is False.

◆ Preset

Preset = property(fget = __GetPreset, fset = __SetPreset)

static

Gets or sets the Preset object.

A preset is a predefined set of the general simulation settings.

Value type: Preset object.

The default value is None.

◆ SelectAmbientMaterial

SelectAmbientMaterial = property(fget = __GetSelectAmbientMaterial, fset = __SetSelectAmbientMaterial)

static

Gets or set the ambient material.

The SelectedAmbientMaterial property takes a feature tag and returns a feature tag.

Value type: Integer.

The default value is 0.

◆ Sensors

Sensors = property(fget = __GetSensors)

static

Gets sensor features.

Gets the current sensor features that are in the simulation.

Value type: List of Feature object.

◆ Settings

Settings = property(fget = __GetSettings, fset = __SetSettings)

static

Gets or sets the simulation settings.

Value type: SimulationSettings object.

◆ Sources

Sources = property(fget = __GetSources)

static

Gets source features.

Gets the current source features that are in the simulation.

Value type: List of Feature object.

◆ UsePresetSettings

UsePresetSettings = property(fget = __GetUsePresetSettings, fset = __SetUsePresetSettings)

static

Gets or sets the property to enable preset settings.

True: Enable Preset Settings
False: Disable Preset Settings

Value type: Boolean.

The default value is False.

The documentation for this class was generated from the following file:

SpeosNX.py

Speos NX library 2024 R2

SimulationCommonBuilder Class Reference

Public Member Functions

Properties

Detailed Description

Member Function Documentation

◆ AddGeometries()

◆ AddSensors()

◆ AddSources()

◆ RemoveGeometries()

◆ RemoveSensors()

◆ RemoveSources()

Property Documentation

◆ AllPreset

◆ AmbientMaterial

◆ EstimatedRam

◆ FeatureSimulation

◆ Geometries

◆ LightExpert

◆ Preset

◆ SelectAmbientMaterial

◆ Sensors

◆ Settings

◆ Sources

◆ UsePresetSettings

Connect with Ansys