Skip to main content

Speos NX library 2024 R2

RayFileData Class Reference

Last update: 17.07.2025

Represents Ray File Data. More...

Inheritance diagram for RayFileData:
_object

Properties

 FluxInLumen = property(fget = __GetFluxInLumen)
 Returns the flux value in lumen.
 
 FluxInWatt = property(fget = __GetFluxInWatt)
 Returns the flux value in watt.
 
 HasFluxInLumen = property(fget = __GetHasFluxInLumen)
 Returns true if the ray file has flux in lumen, otherwise returns false.
 
 HasFluxInWatt = property(fget = __GetHasFluxInWatt)
 Returns true if the ray file has flux in watt, otherwise returns false.
 
 HasPower = property(fget = __GetHasPower)
 Returns true if the ray file has power, otherwise returns false.
 
 HasSpectrum = property(fget = __GetHasSpectrum)
 Returns true if the ray file has spectrum, otherwise returns false.
 

Detailed Description

Represents Ray File Data.

Ray File Data class provides methods to get data from a ray file.

To obtain an instance of this class, refer to Speos Pattern Builder.

Property Documentation

◆ FluxInLumen

FluxInLumen = property(fget = __GetFluxInLumen)
static

Returns the flux value in lumen.

Value type: Double (in lumen).

The default value is -1.

◆ FluxInWatt

FluxInWatt = property(fget = __GetFluxInWatt)
static

Returns the flux value in watt.

Value type: Double (in watt).

The default value is -1.

◆ HasFluxInLumen

HasFluxInLumen = property(fget = __GetHasFluxInLumen)
static

Returns true if the ray file has flux in lumen, otherwise returns false.

True: The ray file has flux in lumen.
False: The ray file does not have flux in lumen.

Value type: Boolean.

The default value is False.

◆ HasFluxInWatt

HasFluxInWatt = property(fget = __GetHasFluxInWatt)
static

Returns true if the ray file has flux in watt, otherwise returns false.

True: The ray file has flux in watt.
False: The ray file does not have flux in watt.

Value type: Boolean.

The default value is False.

◆ HasPower

HasPower = property(fget = __GetHasPower)
static

Returns true if the ray file has power, otherwise returns false.

True: The ray file has power.
False: The ray file does not have power.

Value type: Boolean.

The default value is False.

◆ HasSpectrum

HasSpectrum = property(fget = __GetHasSpectrum)
static

Returns true if the ray file has spectrum, otherwise returns false.

True: The ray file has spectrum.
False: The ray file does not have spectrum.

Value type: Boolean.

The default value is False.


The documentation for this class was generated from the following file:
  • SpeosNX.py

Connect with Ansys