SimulationInverseBuilder Class Reference
Last update: 17.07.2025Represents an Inverse Simulation Builder. More...
Public Member Functions | |
| AddSourceFaceFilteringReferences (self, tags) | |
| Adds sources faces filtering into the simulation. | |
| DeleteSourceFaceFilteringReferences (self, tags) | |
| Deletes sources faces filtering from the simulation. | |
 Public Member Functions inherited from SimulationCommonBuilder | |
| 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 | |
| Duration = property(fget = __GetDuration, fset = __SetDuration) | |
| toto | |
| FamilySelection = property(fget = __GetFamilySelection, fset = __SetFamilySelection) | |
| Gets or sets the family selection list. | |
| MaximumNumberOfPaths = property(fget = __GetMaximumNumberOfPaths, fset = __SetMaximumNumberOfPaths) | |
| Gets or sets the maximum number of paths. | |
| PassNumber = property(fget = __GetPassNumber, fset = __SetPassNumber) | |
| Gets or sets the pass number. | |
| SourcesFacesFilteringReferences = property(fget = __GetSourcesFacesFilteringReferences) | |
| Gets the sources faces filtering. | |
| StopOnDuration = property(fget = __GetStopOnDuration, fset = __SetStopOnDuration) | |
| Gets or sets the duration. | |
| StopOnPassNumber = property(fget = __GetStopOnPassNumber, fset = __SetStopOnPassNumber) | |
| Gets or sets the property to enable stop on pass number. | |
| UsePartFamilies = property(fget = __GetUsePartFamilies, fset = __SetUsePartFamilies) | |
| Gets or sets the property to use family tables. | |
| Properties inherited from SimulationCommonBuilder | |
| 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
Represents an Inverse Simulation Builder.
The Inverse Simulation Builder is used to create and edit Inverse Simulation features.
To create a new instance of this class, use FeatureCollection::CreateSimulationInverseBuilder
Member Function Documentation
◆ AddSourceFaceFilteringReferences()
| AddSourceFaceFilteringReferences | ( | self, | |
| tags ) |
Adds sources faces filtering into the simulation.
The AddSourceFaceFilteringRefs function takes a list of feature tag as parameter.
- Parameters
-
[in] tags : List of integer.
- Returns
- void.
◆ DeleteSourceFaceFilteringReferences()
| DeleteSourceFaceFilteringReferences | ( | self, | |
| tags ) |
Deletes sources faces filtering from the simulation.
The DeleteSourceFaceFilteringRefs function takes a list of feature tag as parameter.
- Parameters
-
[in] tags : List of integer.
- Returns
- void.
Property Documentation
◆ Duration
|
static |
toto
toto
- Returns
- toto
◆ FamilySelection
|
static |
Gets or sets the family selection list.
Prerequisite: The UseFamilyTables property must be True.
Selects the configurations to run with the simulation.
Value type: List of string.
The default value is an empty list.
◆ MaximumNumberOfPaths
|
static |
Gets or sets the maximum number of paths.
Prerequisite: The EnableLightExpert property must be True.
The Maximum paths corresponds to the maximum number of rays the Light Path Finder file (*.lpf or *.lp3) can contain.
Value type: Integer.
Range: The value must be superior to 0.
The default value is 100,000.
◆ PassNumber
|
static |
Gets or sets the pass number.
Prerequisite: The StopOnPassNumber property must be True.
Value type: Integer.
Range: the value must be superior to 0.
The default value is 5.
◆ SourcesFacesFilteringReferences
|
static |
Gets the sources faces filtering.
The SourcesFacesFilteringRef property returns a list of feature tag.
Value type: List of integer.
◆ StopOnDuration
|
static |
Gets or sets the duration.
Prerequisite: The StopOnDuration property must be True.
Time necessary to reach for the simulation to end.
Value type: Double (in second).
Range: The value must be superior to 0.0.
The default value is 1800.0 s.
◆ StopOnPassNumber
|
static |
Gets or sets the property to enable stop on pass number.
True: Enables stop on PassNumber property
False: Disables stop on PassNumber property
Value type: Boolean.
The default value is True.
◆ UsePartFamilies
|
static |
Gets or sets the property to use family tables.
True: Enables multi-configuration to run in the simulation.
False: Disables multi-configuration to run in the simulation.
Value type: Boolean.
The default value is False.
The documentation for this class was generated from the following file:
- SpeosNX.py
