SimulationCommonBuilder Class Reference
Last update: 17.07.2025A base class for all Simulation Builders. More...
Public Member Functions | |
| 'None' | AddSources (self, sources) |
| Adds sources into the simulation. | |
| 'None' | RemoveSources (self, sources) |
| Deletes sources from the simulation. | |
| 'None' | AddGeometries (self, tags) |
| Adds geometries into the simulation. | |
| 'None' | RemoveGeometries (self, tags) |
| Deletes geometries from the simulation. | |
| 'None' | AddSensors (self, sensors) |
| Adds sensors into the simulation. | |
| 'None' | RemoveSensors (self, sensors) |
| Deletes sensors from the simulation. | |
 Public Member Functions inherited from FeatureBuilder | |
| 'None' | Commit (self) |
| Commits any edits that have been applied to the builder. | |
| 'None' | ShowResult (self) |
| Updates the feature to reflect the result of an edit to the feature for all builders that support showing results. | |
Static Public Attributes | |
| str | AllPreset = property(fget=__GetAllPreset) |
| Gets all Preset. | |
| str | AmbientMaterial = property(fget=__GetAmbientMaterial, fset=__SetAmbientMaterial) |
| Gets or sets the property to enable ambient material. | |
| str | EstimatedRam = property(fget=__GetEstimatedRam) |
| Gets the estimated RAM usage. | |
| str | FeatureSimulation = property(fget=__GetFeatureSimulation) |
| Gets the simulation feature object. | |
| str | Geometries = property(fget=__GetGeometries) |
| Gets geometries tag. | |
| str | LightExpert = property(fget=__GetLightExpert, fset=__SetLightExpert) |
| Gets or sets the property to enable Light Expert. | |
| str | Preset = property(fget=__GetPreset, fset=__SetPreset) |
| Gets or sets the Preset object. | |
| str | SelectAmbientMaterial = property(fget=__GetSelectAmbientMaterial, fset=__SetSelectAmbientMaterial) |
| Gets or set the ambient material. | |
| str | Sensors = property(fget=__GetSensors) |
| Gets sensor features. | |
| str | Settings = property(fget=__GetSettings, fset=__SetSettings) |
| Gets or sets the simulation settings. | |
| str | Sources = property(fget=__GetSources) |
| Gets source features. | |
| str | StandardDeviation = property(fget=__GetStandardDeviation, fset=__SetStandardDeviation) |
| Static Public Attributes inherited from FeatureBuilder | |
| str | Feature = property(fget=__GetFeature) |
| Returns the feature being edited, or the created feature if the builder is being used in creation mode. | |
| str | FullName = property(fget=__GetFullName) |
| Gets the full name of the feature being edited. | |
| str | Name = property(fget=__GetName, fset=__SetName) |
| Gets or sets the name of the feature being edited. | |
| str | NameWithContext = property(fget=__GetNameWithContext) |
| Gets the name with context 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()
| 'None' 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()
| 'None' AddSensors | ( | self, | |
| sensors ) |
Adds sensors into the simulation.
- Parameters
-
[in] sensors : List of Feature object.
- Returns
- void.
◆ AddSources()
| 'None' AddSources | ( | self, | |
| sources ) |
Adds sources into the simulation.
- Parameters
-
[in] sources : List of Feature object
- Returns
- void.
◆ RemoveGeometries()
| 'None' 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()
| 'None' RemoveSensors | ( | self, | |
| sensors ) |
Deletes sensors from the simulation.
- Parameters
-
[in] sensors : List of Feature object.
- Returns
- void.
◆ RemoveSources()
| 'None' RemoveSources | ( | self, | |
| sources ) |
Deletes sources from the simulation.
- Parameters
-
[in] sources : List of Feature object
- Returns
- void.
Member Data Documentation
◆ AllPreset
|
static |
Gets all Preset.
Value type: List of Preset object.
◆ AmbientMaterial
|
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
|
static |
Gets the estimated RAM usage.
Value type: String.
◆ FeatureSimulation
|
static |
Gets the simulation feature object.
Gets the simulation feature in order to launch simulations.
Value type: FeatureSimulation object.
◆ Geometries
|
static |
Gets geometries tag.
The Geometries property returns a list of feature tag.
- Returns
- List of integer.
◆ LightExpert
|
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
|
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
|
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
|
static |
Gets sensor features.
Gets the current sensor features that are in the simulation.
Value type: List of Feature object.
◆ Settings
|
static |
Gets or sets the simulation settings.
Value type: SimulationSettings object.
◆ Sources
|
static |
Gets source features.
Gets the current source features that are in the simulation.
Value type: List of Feature object.
The documentation for this class was generated from the following file:
- SpeosNX.py
