## On this page

  

 

 # SourceRayFileBuilder Class Reference

 Last update: 16.07.2025 

Represents the builder for a ray file source. [More...](#details)

Inheritance diagram for SourceRayFileBuilder:

 ![](/sites/default/files/migrate-content/speos_nx_library_2025_r2_1/class_speos_n_x__2412_1_1_source_ray_file_builder.png)



## <a id="pub-static-attribs" name="pub-static-attribs"></a>Static Public Attributes

str [AxisSystem](#af0a012d49a5b59a4f43bb342b8c725c2) = property(fget=\_\_GetAxisSystem) Gets the axis system.   
 str [ExitGeometries](#abcc911cc5f0fad6600039e4e396ff73d) = property(fget=\_\_GetExitGeometries, fset=\_\_SetExitGeometries) Gets or sets exit geometries.   
 str [Flux](#a493e918b625a1c115dbe4962fa41d2f9) = property(fget=\_\_GetFlux, fset=\_\_SetFlux) Gets or sets the flux.   
 str [FluxFromFile](#a986d2ab17e563550abc018a4a98f53ba) = property(fget=\_\_GetFluxFromFile, fset=\_\_SetFluxFromFile) Gets or sets the property to enable fetching the flux from file.   
 str [FluxUnit](#af43355cfe1d66fcc1fe101275c2f23a3) = property(fget=\_\_GetFluxUnit, fset=\_\_SetFluxUnit) Gets or sets the flux unit.   
 str [NumberOfRays](#aaa149f4084199f582574fb95a19750ec) = property(fget=\_\_GetNumberOfRays, fset=\_\_SetNumberOfRays) Gets or sets the number of rays.   
 str [RayFilePath](#a4ba234b7d8a3e9743ef120aaed1943d2) = property(fget=\_\_GetRayFilePath, fset=\_\_SetRayFilePath) Gets or sets the ray file path.   
 str [RayLength](#a24786b401f788b91236f7c5238005822) = property(fget=\_\_GetRayLength, fset=\_\_SetRayLength) Gets or sets the ray length.   
 str [Spectrum](#a16de2f6d720c95018e6e4894a84a1878) = property(fget=\_\_GetSpectrum, fset=\_\_SetSpectrum) Gets or sets the spectrum type.   
 str [SpectrumFilePath](#a92b012ddaebe46fb4504668c118ac6ab) = property(fget=\_\_GetSpectrumFilePath, fset=\_\_SetSpectrumFilePath) Gets or sets the spectrum file path.   
 str [Temperature](#a7339eaf2d641a7dac51923a3dd0b40c9) = property(fget=\_\_GetTemperature, fset=\_\_SetTemperature) Gets or sets the temperature.   
 str [Wavelength](#ae546bb3e1d15eb5e3d84527989f7edae) = property(fget=\_\_GetWavelength, fset=\_\_SetWavelength) Gets or sets the wavelength.   
 ![-](/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.   
 ## <a id="properties" name="properties"></a>Properties

<a id="a50e9fbdd6a13e9e50cfba34656086bb6" name="a50e9fbdd6a13e9e50cfba34656086bb6"></a> **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') ## <a id="inherited" name="inherited"></a>Additional Inherited Members

![-](/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.   
 <a id="details" name="details"></a>## Detailed Description

Represents the builder for a ray file source.

The ray file source builder is used to create and edit ray file source features.

To create a new instance of this class, use <a class="el" href="">FeatureCollection::CreateSourceRayFileBuilder</a>



## Member Data Documentation

<a id="af0a012d49a5b59a4f43bb342b8c725c2" name="af0a012d49a5b59a4f43bb342b8c725c2"></a>## [◆ ](#af0a012d49a5b59a4f43bb342b8c725c2)AxisSystem

 str [AxisSystem](class_speos_n_x__2412_1_1_axis_system.xhtml) = property(fget=\_\_GetAxisSystem)  static 

Gets the axis system.

**Value type**: AxisSystem object.





<a id="abcc911cc5f0fad6600039e4e396ff73d" name="abcc911cc5f0fad6600039e4e396ff73d"></a>## [◆ ](#abcc911cc5f0fad6600039e4e396ff73d)ExitGeometries

 str ExitGeometries = property(fget=\_\_GetExitGeometries, fset=\_\_SetExitGeometries)  static 

Gets or sets exit geometries.

The ExitGeometries property takes a list of feature tag and returns a list of feature tag.

**Value type**: List of integer.

The default value is an empty list.





<a id="a493e918b625a1c115dbe4962fa41d2f9" name="a493e918b625a1c115dbe4962fa41d2f9"></a>## [◆ ](#a493e918b625a1c115dbe4962fa41d2f9)Flux

 str Flux = property(fget=\_\_GetFlux, fset=\_\_SetFlux)  static 

Gets or sets the flux.

**Value type**: Double (in lumen or watt).  
**Range**: The value must be superior to 0.0.

By default the value comes from the ray file, otherwise value is 683. lumen.





<a id="a986d2ab17e563550abc018a4a98f53ba" name="a986d2ab17e563550abc018a4a98f53ba"></a>## [◆ ](#a986d2ab17e563550abc018a4a98f53ba)FluxFromFile

 str FluxFromFile = property(fget=\_\_GetFluxFromFile, fset=\_\_SetFluxFromFile)  static 

Gets or sets the property to enable fetching the flux from file.

True: Enables fetching the flux from file.  
 False: Disables fetching the flux from file.

**Value type**: Boolean.

The default value is True.





<a id="af43355cfe1d66fcc1fe101275c2f23a3" name="af43355cfe1d66fcc1fe101275c2f23a3"></a>## [◆ ](#af43355cfe1d66fcc1fe101275c2f23a3)FluxUnit

 str FluxUnit = property(fget=\_\_GetFluxUnit, fset=\_\_SetFluxUnit)  static 

Gets or sets the flux unit.

The values are:  
 0 - lumen (lm).  
 1 - watt (W).

**Value type**: Integer.

The default value is 0.





<a id="aaa149f4084199f582574fb95a19750ec" name="aaa149f4084199f582574fb95a19750ec"></a>## [◆ ](#aaa149f4084199f582574fb95a19750ec)NumberOfRays

 str NumberOfRays = property(fget=\_\_GetNumberOfRays, fset=\_\_SetNumberOfRays)  static 

Gets or sets the number of rays.

**Value type**: Integer.  
**Range**: The value must be superior or equal to 0.

The default value is 100.





<a id="a4ba234b7d8a3e9743ef120aaed1943d2" name="a4ba234b7d8a3e9743ef120aaed1943d2"></a>## [◆ ](#a4ba234b7d8a3e9743ef120aaed1943d2)RayFilePath

 str RayFilePath = property(fget=\_\_GetRayFilePath, fset=\_\_SetRayFilePath)  static 

Gets or sets the ray file path.

**Value type**: String.

The default value is an empty string.





<a id="a24786b401f788b91236f7c5238005822" name="a24786b401f788b91236f7c5238005822"></a>## [◆ ](#a24786b401f788b91236f7c5238005822)RayLength

 str RayLength = property(fget=\_\_GetRayLength, fset=\_\_SetRayLength)  static 

Gets or sets the ray length.

**Value type**: Double (in millimeter).  
**Range**: The value must be superior to 0.0.

The default value is 75.0 mm.





<a id="a16de2f6d720c95018e6e4894a84a1878" name="a16de2f6d720c95018e6e4894a84a1878"></a>## [◆ ](#a16de2f6d720c95018e6e4894a84a1878)Spectrum

 str Spectrum = property(fget=\_\_GetSpectrum, fset=\_\_SetSpectrum)  static 

Gets or sets the spectrum type.

The values are:  
 0 - Monochromatic, with this value the wavelength property is available.  
 1 - Blackbody, with this value the temperature property is available.  
 2 - Library, with this value the spectrum file property is available.

**Value type**: Integer.

The default value is 0.





<a id="a92b012ddaebe46fb4504668c118ac6ab" name="a92b012ddaebe46fb4504668c118ac6ab"></a>## [◆ ](#a92b012ddaebe46fb4504668c118ac6ab)SpectrumFilePath

 str SpectrumFilePath = property(fget=\_\_GetSpectrumFilePath, fset=\_\_SetSpectrumFilePath)  static 

Gets or sets the spectrum file path.

**Prerequisite**: The SpectrumType must be 1.

**Value type**: String.

The default value is an empty string.





<a id="a7339eaf2d641a7dac51923a3dd0b40c9" name="a7339eaf2d641a7dac51923a3dd0b40c9"></a>## [◆ ](#a7339eaf2d641a7dac51923a3dd0b40c9)Temperature

 str Temperature = property(fget=\_\_GetTemperature, fset=\_\_SetTemperature)  static 

Gets or sets the temperature.

**Prerequisite**: The SpectrumType must be 0.

**Value type**: double (in Kelvin).  
**Range**: The value must be superior to 0.0.

The default value is 2856.0 K.





<a id="ae546bb3e1d15eb5e3d84527989f7edae" name="ae546bb3e1d15eb5e3d84527989f7edae"></a>## [◆ ](#ae546bb3e1d15eb5e3d84527989f7edae)Wavelength

 str Wavelength = property(fget=\_\_GetWavelength, fset=\_\_SetWavelength)  static 

Gets or sets the wavelength.

**Value type**: Double (in nanometer).  
**Range**: The value must be superior to 0.0.

The default value is 555.0 nm.





---

The documentation for this class was generated from the following file:- **SpeosNX\_2412.py**