## On this page # SimulationDirectBuilder Class Reference Last update: 16.07.2025 Represents an Direct Simulation Builder. [More...](#details) Inheritance diagram for SimulationDirectBuilder: ![](/sites/default/files/migrate-content/speos_nx_library_2025_r2_1/class_speos_n_x__2412_1_1_simulation_direct_builder.png) ## Static Public Attributes str [Duration](#a1da73287097d30314be752eeede32906) = property(fget=\_\_GetDuration, fset=\_\_SetDuration) Gets or sets the duration. str [FamilySelection](#ae406927f206a41ada838eeb5257796d7) = property(fget=\_\_GetFamilySelection, fset=\_\_SetFamilySelection) Gets or sets the family selection list. str [MaximumNumberOfPaths](#a3a9caa2a37ad1c9aa66a09162e1a2b5e) = property(fget=\_\_GetMaximumNumberOfPaths, fset=\_\_SetMaximumNumberOfPaths) Gets or sets the maximum number of paths. str [RayFileFormat](#aa5f160e1b955029d035ea10586086d73) = property(fget=\_\_GetRayFileFormat, fset=\_\_SetRayFileFormat) Gets or sets the ray file format. str [RayNumberMultiplier](#a0e0100909648a8e60cd25de29bd33a13) = property(fget=\_\_GetRayNumberMultiplier, fset=\_\_SetRayNumberMultiplier) Gets or sets the ray number multiplier. str [RaysNumber](#ae7e5ade68c244ee6d62a566d6651eea7) = property(fget=\_\_GetRaysNumber, fset=\_\_SetRaysNumber) Gets or sets the number of rays. str [StopOnDuration](#a456bcb3ea925f2b09b2dd37857be906f) = property(fget=\_\_GetStopOnDuration, fset=\_\_SetStopOnDuration) Gets or sets the property to stop on duration. str [StopOnRaysNumber](#abeec67493ec3215afe500a6a6d59b677) = property(fget=\_\_GetStopOnRaysNumber, fset=\_\_SetStopOnRaysNumber) Gets or sets the property to enable stop on rays number. str [UsePartFamilies](#a6af44536d3f3de18cb0fcb053a477793) = property(fget=\_\_GetUsePartFamilies, fset=\_\_SetUsePartFamilies) Gets or sets the property to use family tables. str [UseRayFile](#a0991311e71d02a2fc520db098afd2e4d) = property(fget=\_\_GetUseRayFile, fset=\_\_SetUseRayFile) Gets or sets the property to enable ray file. ![-](/sites/default/files/migrate-content/speos_nx_library_2025_r2_1/closed.png) Static Public Attributes inherited from [SimulationCommonBuilder](class_speos_n_x__2412_1_1_simulation_common_builder.xhtml)str [AllPreset](class_speos_n_x__2412_1_1_simulation_common_builder.xhtml#a89fef427057d4dc7c4ac43f3211c8f2e) = property(fget=\_\_GetAllPreset) Gets all Preset. str [AmbientMaterial](class_speos_n_x__2412_1_1_simulation_common_builder.xhtml#a704f99fc2b04c38dc6ed09e5943da97d) = property(fget=\_\_GetAmbientMaterial, fset=\_\_SetAmbientMaterial) Gets or sets the ambient material. str [EstimatedRam](class_speos_n_x__2412_1_1_simulation_common_builder.xhtml#ad318175507e61ca7bf3ca4ed1ff4728a) = property(fget=\_\_GetEstimatedRam) Gets the estimated RAM usage. str [FeatureSimulation](class_speos_n_x__2412_1_1_simulation_common_builder.xhtml#ab1e1007fe6aaa65c5c69bfd06d66d8ce) = property(fget=\_\_GetFeatureSimulation) Gets the simulation feature object. str [Geometries](class_speos_n_x__2412_1_1_simulation_common_builder.xhtml#aad591c452737d164b58956acd8acb541) = property(fget=\_\_GetGeometries, fset=\_\_SetGeometries) Gets or sets geometries tag. str [LightExpert](class_speos_n_x__2412_1_1_simulation_common_builder.xhtml#a3280319fc34416f6978a71b821d18ea8) = property(fget=\_\_GetLightExpert, fset=\_\_SetLightExpert) Gets or sets the property to enable Light Expert. str [Preset](class_speos_n_x__2412_1_1_simulation_common_builder.xhtml#a0eedc950d27d340531fe23319f224453) = property(fget=\_\_GetPreset, fset=\_\_SetPreset) Gets or sets the Preset object. str [Sensors](class_speos_n_x__2412_1_1_simulation_common_builder.xhtml#a13ed2a3dc5b127adf10029594165665d) = property(fget=\_\_GetSensors, fset=\_\_SetSensors) Gets or sets sensor features. str [Settings](class_speos_n_x__2412_1_1_simulation_common_builder.xhtml#a825c6a61975c36859ea0ca4566743e9d) = property(fget=\_\_GetSettings, fset=\_\_SetSettings) Gets or sets the simulation settings. str [Sources](class_speos_n_x__2412_1_1_simulation_common_builder.xhtml#ab92ca9039d7a8b5a994638c850715e8a) = property(fget=\_\_GetSources, fset=\_\_SetSources) Gets or sets source features. str [StandardDeviation](class_speos_n_x__2412_1_1_simulation_common_builder.xhtml#a2cefa21dc93348e2d318ff0e8c7bb5d2) = property(fget=\_\_GetStandardDeviation, fset=\_\_SetStandardDeviation) Gets or sets the standard deviation. str [UseAmbientMaterial](class_speos_n_x__2412_1_1_simulation_common_builder.xhtml#afd152eefeaa4120d85eda9b368c5545f) = property(fget=\_\_GetUseAmbientMaterial, fset=\_\_SetUseAmbientMaterial) Gets or sets the property to enable ambient material. str [UsePresetSettings](class_speos_n_x__2412_1_1_simulation_common_builder.xhtml#a46ede59788fd45d0741c220bf8863f28) = property(fget=\_\_GetUsePresetSettings, fset=\_\_SetUsePresetSettings) Gets or sets the property to enable preset settings. ![-](/sites/default/files/migrate-content/speos_nx_library_2025_r2_1/closed.png) Static Public Attributes inherited from [FeatureBuilder](class_speos_n_x__2412_1_1_feature_builder.xhtml)str [Feature](class_speos_n_x__2412_1_1_feature_builder.xhtml#af5dac7005c95ef44c2b66d7270709d0b) = property(fget=\_\_GetFeature) Returns the feature being edited, or the created feature if the builder is being used in creation mode. str [FullName](class_speos_n_x__2412_1_1_feature_builder.xhtml#a6aac8aea55e1f962045d07a12b6569ea) = property(fget=\_\_GetFullName) Gets the full name of the feature being edited. str [Name](class_speos_n_x__2412_1_1_feature_builder.xhtml#a19218d0239b929ca8aecfa629d0185d0) = property(fget=\_\_GetName, fset=\_\_SetName) Gets or sets the name of the feature being edited. str [NameWithContext](class_speos_n_x__2412_1_1_feature_builder.xhtml#a89ee075a30b71ff6e3192d6bd6dd5515) = property(fget=\_\_GetNameWithContext) Gets the name with context of the feature being edited. str [Status](class_speos_n_x__2412_1_1_feature_builder.xhtml#abfd5ba295bea008a0edf2f1a85bc6368) = 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') ![-](/sites/default/files/migrate-content/speos_nx_library_2025_r2_1/closed.png) Properties inherited from [SimulationCommonBuilder](class_speos_n_x__2412_1_1_simulation_common_builder.xhtml) **thisown** = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag') ![-](/sites/default/files/migrate-content/speos_nx_library_2025_r2_1/closed.png) Properties inherited from [FeatureBuilder](class_speos_n_x__2412_1_1_feature_builder.xhtml) **thisown** = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag') ![-](/sites/default/files/migrate-content/speos_nx_library_2025_r2_1/closed.png) Properties inherited from [Builder](class_speos_n_x__2412_1_1_builder.xhtml) **thisown** = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag') ## Additional Inherited Members ![-](/sites/default/files/migrate-content/speos_nx_library_2025_r2_1/closed.png) Public Member Functions inherited from [SimulationCommonBuilder](class_speos_n_x__2412_1_1_simulation_common_builder.xhtml) 'None' [RemoveSources](class_speos_n_x__2412_1_1_simulation_common_builder.xhtml#a22c55e6f209f7acea541afa58c1bc868) (self, sources) Deletes sources from the simulation. 'None' [RemoveGeometries](class_speos_n_x__2412_1_1_simulation_common_builder.xhtml#a72a0f1aff0152618207092c4f7c72121) (self, tags) Deletes geometries from the simulation. 'None' [RemoveSensors](class_speos_n_x__2412_1_1_simulation_common_builder.xhtml#af39872183312cd1cf9335f80b8b066e6) (self, sensors) Deletes sensors from the simulation. ![-](/sites/default/files/migrate-content/speos_nx_library_2025_r2_1/closed.png) Public Member Functions inherited from [FeatureBuilder](class_speos_n_x__2412_1_1_feature_builder.xhtml) 'None' **ShowResult** (self) Updates the feature to reflect the result of an edit to the feature for all builders that support showing results. ![-](/sites/default/files/migrate-content/speos_nx_library_2025_r2_1/closed.png) Public Member Functions inherited from [Builder](class_speos_n_x__2412_1_1_builder.xhtml) 'None' [Commit](class_speos_n_x__2412_1_1_builder.xhtml#a77581800008ea3179049e650e9d1787b) (self) Commits any edits that have been applied to the builder. ## 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 ## Member Data Documentation ## [◆ ](#a1da73287097d30314be752eeede32906)Duration str Duration = property(fget=\_\_GetDuration, fset=\_\_SetDuration) 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. ## [◆ ](#ae406927f206a41ada838eeb5257796d7)FamilySelection str FamilySelection = property(fget=\_\_GetFamilySelection, fset=\_\_SetFamilySelection) 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. ## [◆ ](#a3a9caa2a37ad1c9aa66a09162e1a2b5e)MaximumNumberOfPaths str MaximumNumberOfPaths = property(fget=\_\_GetMaximumNumberOfPaths, fset=\_\_SetMaximumNumberOfPaths) 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. ## [◆ ](#aa5f160e1b955029d035ea10586086d73)RayFileFormat str RayFileFormat = property(fget=\_\_GetRayFileFormat, fset=\_\_SetRayFileFormat) 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. ## [◆ ](#a0e0100909648a8e60cd25de29bd33a13)RayNumberMultiplier str RayNumberMultiplier = property(fget=\_\_GetRayNumberMultiplier, fset=\_\_SetRayNumberMultiplier) 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. ## [◆ ](#ae7e5ade68c244ee6d62a566d6651eea7)RaysNumber str RaysNumber = property(fget=\_\_GetRaysNumber, fset=\_\_SetRaysNumber) static Gets or sets the number of 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. ## [◆ ](#a456bcb3ea925f2b09b2dd37857be906f)StopOnDuration str StopOnDuration = property(fget=\_\_GetStopOnDuration, fset=\_\_SetStopOnDuration) 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. ## [◆ ](#abeec67493ec3215afe500a6a6d59b677)StopOnRaysNumber str StopOnRaysNumber = property(fget=\_\_GetStopOnRaysNumber, fset=\_\_SetStopOnRaysNumber) 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. ## [◆ ](#a6af44536d3f3de18cb0fcb053a477793)UsePartFamilies str UsePartFamilies = property(fget=\_\_GetUsePartFamilies, fset=\_\_SetUsePartFamilies) 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. ## [◆ ](#a0991311e71d02a2fc520db098afd2e4d)UseRayFile str UseRayFile = property(fget=\_\_GetUseRayFile, fset=\_\_SetUseRayFile) 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\_2412.py**