SourceRayFileBuilder Class Reference
Last update: 17.07.2025Represents the builder for a ray file source. More...
Properties | |
| AxisSystem = property(fget = __GetAxisSystem) | |
| Gets the axis system. | |
| ExitGeometries = property(fget = __GetExitGeometries, fset = __SetExitGeometries) | |
| Gets or sets exit geometries. | |
| Flux = property(fget = __GetFlux, fset = __SetFlux) | |
| Gets or sets the flux. | |
| FluxFromFile = property(fget = __GetFluxFromFile, fset = __SetFluxFromFile) | |
| Gets or sets the property to enable fetching the flux from file. | |
| FluxUnit = property(fget = __GetFluxUnit, fset = __SetFluxUnit) | |
| Gets or sets the flux unit. | |
| NumberOfRays = property(fget = __GetNumberOfRays, fset = __SetNumberOfRays) | |
| Gets or sets the number of rays. | |
| RayFilePath = property(fget = __GetRayFilePath, fset = __SetRayFilePath) | |
| Gets or sets the ray file path. | |
| RayLength = property(fget = __GetRayLength, fset = __SetRayLength) | |
| Gets or sets the ray length. | |
| Spectrum = property(fget = __GetSpectrum, fset = __SetSpectrum) | |
| Gets or sets the spectrum type. | |
| SpectrumFilePath = property(fget = __GetSpectrumFilePath, fset = __SetSpectrumFilePath) | |
| Gets or set the spectrum file path. | |
| Temperature = property(fget = __GetTemperature, fset = __SetTemperature) | |
| Gets or sets the temperature. | |
| Wavelength = property(fget = __GetWavelength, fset = __SetWavelength) | |
| Gets or sets the wavelength. | |
 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 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 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 FeatureCollection::CreateSourceRayFileBuilder
Property Documentation
◆ AxisSystem
|
static |
Gets the axis system.
Value type: AxisSystem object.
◆ ExitGeometries
|
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.
◆ Flux
|
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.
◆ FluxFromFile
|
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.
◆ FluxUnit
|
static |
Gets or sets the flux unit.
The values are:
0 - lumen (lm).
1 - watt (W).
Value type: Integer.
The default value is 0.
◆ NumberOfRays
|
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.
◆ RayFilePath
|
static |
Gets or sets the ray file path.
Value type: String.
The default value is an empty string.
◆ RayLength
|
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.
◆ Spectrum
|
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.
◆ SpectrumFilePath
|
static |
Gets or set the spectrum file path.
Prerequisite: The SpectrumType must be 1.
Value type: String.
The default value is an empty string.
◆ Temperature
|
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.
◆ Wavelength
|
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.py
