SimulationDirectBuilder Class Reference
Last update: 17.07.2025Represents an Direct Simulation Builder. More...
Properties | |
| Duration = property(fget = __GetDuration, fset = __SetDuration) | |
| Gets or sets the duration. | |
| 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. | |
| RayFileFormat = property(fget = __GetRayFileFormat, fset = __SetRayFileFormat) | |
| Gets or sets the ray file format. | |
| RayNumberMultiplier = property(fget = __GetRayNumberMultiplier, fset = __SetRayNumberMultiplier) | |
| Gets or sets the ray number multiplier. | |
| RaysNumber = property(fget = __GetRaysNumber, fset = __SetRaysNumber) | |
| Gets or sets the number or rays. | |
| StopOnDuration = property(fget = __GetStopOnDuration, fset = __SetStopOnDuration) | |
| Gets or sets the property to stop on duration. | |
| StopOnRaysNumber = property(fget = __GetStopOnRaysNumber, fset = __SetStopOnRaysNumber) | |
| Gets or sets the property to enable stop on rays number. | |
| UsePartFamilies = property(fget = __GetUsePartFamilies, fset = __SetUsePartFamilies) | |
| Gets or sets the property to use family tables. | |
| UseRayFile = property(fget = __GetUseRayFile, fset = __SetUseRayFile) | |
| Gets or sets the property to enable ray file. | |
 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. | |
Additional Inherited Members | |
| 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. | |
Detailed Description
Represents an Direct Simulation Builder.
The Direct Simulation Builder is used to create and edit Direct Simulation features.
To create a new instance of this class, use FeatureCollection::CreateSimulationDirectBuilder
Property Documentation
◆ Duration
|
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.
◆ 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.
◆ RayFileFormat
|
static |
Gets or sets the ray file format.
Prerequisite: The EnableRayFile property must be True.
Type of ray file that the simulation creates at the end.
The values are:
0 - Speos without Polarization.
1 - Speos with Polarization.
2 - IES TM-25 without Polarization.
3 - IES TM-25 with Polarization.
Value type: Integer.
The default value is 0.
◆ RayNumberMultiplier
|
static |
Gets or sets the ray number multiplier.
Prerequisite: The StopOnRaysNumber property must be True.
The values are:
0 - Rays.
1 - Kilo-Rays.
2 - Mega-Rays.
3 - Giga-Rays.
Value type: Integer.
The default value is 1.
◆ RaysNumber
|
static |
Gets or sets the number or rays.
Prerequisite: The StopOnRaysNumber property must be True.
Number of rays necessary to reach for the simulation to end.
Value type: Integer.
Range: The value must be superior to 0.
The default value is 200.
◆ StopOnDuration
|
static |
Gets or sets the property to stop on duration.
True: Enables stop on Duration property
False: Disables stop on Duration property
Value type: Boolean.
The default value is False.
◆ StopOnRaysNumber
|
static |
Gets or sets the property to enable stop on rays number.
True: Enables stop on RaysNumber property.
False: Disables stop on RaysNumber 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.
◆ UseRayFile
|
static |
Gets or sets the property to enable ray file.
True: Enables Ray file.
False: Disables Ray file.
Value type: Boolean.
The default value is False.
The documentation for this class was generated from the following file:
- SpeosNX.py
