SimulationInverseBuilder Class Reference
Last update: 16.07.2025Represents an Inverse Simulation Builder. More...
Public Member Functions | |
| 'None' | AddSourceFaceFilteringReferences (self, tags) |
| Adds sources faces filtering into the simulation. | |
| 'None' | DeleteSourceFaceFilteringReferences (self, tags) |
| Deletes sources faces filtering from the simulation. | |
 Public Member Functions inherited from SimulationCommonBuilder | |
| 'None' | RemoveSources (self, sources) |
| Deletes sources from the simulation. | |
| 'None' | RemoveGeometries (self, tags) |
| Deletes geometries from the simulation. | |
| 'None' | RemoveSensors (self, sensors) |
| Deletes sensors from the simulation. | |
| Public Member Functions inherited from FeatureBuilder | |
| 'None' | ShowResult (self) |
| Updates the feature to reflect the result of an edit to the feature for all builders that support showing results. | |
| Public Member Functions inherited from Builder | |
| 'None' | Commit (self) |
| Commits any edits that have been applied to the builder. | |
Static Public Attributes | |
| str | Duration = property(fget=__GetDuration, fset=__SetDuration) |
| toto | |
| str | FamilySelection = property(fget=__GetFamilySelection, fset=__SetFamilySelection) |
| Gets or sets the family selection list. | |
| str | MaximumNumberOfPaths = property(fget=__GetMaximumNumberOfPaths, fset=__SetMaximumNumberOfPaths) |
| Gets or sets the maximum number of paths. | |
| str | PassNumber = property(fget=__GetPassNumber, fset=__SetPassNumber) |
| Gets or sets the pass number. | |
| str | SourcesFacesFilteringReferences = property(fget=__GetSourcesFacesFilteringReferences) |
| Gets the sources faces filtering. | |
| str | StopOnDuration = property(fget=__GetStopOnDuration, fset=__SetStopOnDuration) |
| Gets or sets the duration. | |
| str | StopOnPassNumber = property(fget=__GetStopOnPassNumber, fset=__SetStopOnPassNumber) |
| Gets or sets the property to enable stop on pass number. | |
| str | UsePartFamilies = property(fget=__GetUsePartFamilies, fset=__SetUsePartFamilies) |
| Gets or sets the property to use family tables. | |
| Static Public Attributes inherited from SimulationCommonBuilder | |
| str | AllPreset = property(fget=__GetAllPreset) |
| Gets all Preset. | |
| str | AmbientMaterial = property(fget=__GetAmbientMaterial, fset=__SetAmbientMaterial) |
| Gets or sets the 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, fset=__SetGeometries) |
| Gets or sets 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 | Sensors = property(fget=__GetSensors, fset=__SetSensors) |
| Gets or sets sensor features. | |
| str | Settings = property(fget=__GetSettings, fset=__SetSettings) |
| Gets or sets the simulation settings. | |
| str | Sources = property(fget=__GetSources, fset=__SetSources) |
| Gets or sets source features. | |
| str | StandardDeviation = property(fget=__GetStandardDeviation, fset=__SetStandardDeviation) |
| Gets or sets the standard deviation. | |
| str | UseAmbientMaterial = property(fget=__GetUseAmbientMaterial, fset=__SetUseAmbientMaterial) |
| Gets or sets the property to enable ambient material. | |
| str | UsePresetSettings = property(fget=__GetUsePresetSettings, fset=__SetUsePresetSettings) |
| Gets or sets the property to enable preset settings. | |
| 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. | |
| str | Status = property(fget=__GetStatus) |
| Returns the status of the feature being edited. | |
Properties | |
| thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag') | |
| Properties inherited from SimulationCommonBuilder | |
| thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag') | |
| Properties inherited from FeatureBuilder | |
| thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag') | |
| Properties inherited from Builder | |
| thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag') | |
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()
| 'None' 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()
| 'None' 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.
Member Data 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_2412.py
