SensorIrradianceBuilder Class Reference
Last update: 17.07.2025Represents an Irradiance Sensor Builder. More...
Static Public Attributes | |
| str | IntegrationDirection = property(fget=__GetIntegrationDirection, fset=__SetIntegrationDirection) |
| Gets or sets the integration direction. | |
| str | IntegrationDirectionReversed = property(fget=__GetIntegrationDirectionReversed, fset=__SetIntegrationDirectionReversed) |
| Gets or set the reverse direction of integration. | |
| str | IntegrationType = property(fget=__GetIntegrationType, fset=__SetIntegrationType) |
| Gets or set the integration type. | |
| str | OutputFaces = property(fget=__GetOutputFaces, fset=__SetOutputFaces) |
| Gets or sets the output faces. | |
| str | RayFileFormat = property(fget=__GetRayFileFormat, fset=__SetRayFileFormat) |
| Gets or sets the ray file format. | |
 Static Public Attributes inherited from SensorCommonBuilder | |
| str | AxisSystem = property(fget=__GetAxisSystem) |
| Gets the Axis System of the Sensor. | |
| str | DimensionFromFile = property(fget=__GetDimensionFromFile, fset=__SetDimensionFromFile) |
| Gets or sets the property to enable the use of dimensions that come from File. | |
| str | DisplayPropertiesFromFile = property(fget=__GetDisplayPropertiesFromFile, fset=__SetDisplayPropertiesFromFile) |
| Gets or sets the property to enable the use of display properties that come from File. | |
| str | GridOriginX = property(fget=__GetGridOriginX, fset=__SetGridOriginX) |
| Gets or sets the grid X origin. | |
| str | GridOriginY = property(fget=__GetGridOriginY, fset=__SetGridOriginY) |
| Gets or sets the grid Y origin. | |
| str | GridStepX = property(fget=__GetGridStepX, fset=__SetGridStepX) |
| Gets or sets the grid X step. | |
| str | GridStepY = property(fget=__GetGridStepY, fset=__SetGridStepY) |
| Gets or sets the grid Y step. | |
| str | SensorFilter = property(fget=__GetSensorFilter) |
| Gets the sensor filter. | |
| str | ShowGrid = property(fget=__GetShowGrid, fset=__SetShowGrid) |
| Gets or sets the property to enable grid preview. | |
| str | TemplateFilePath = property(fget=__GetTemplateFilePath, fset=__SetTemplateFilePath) |
| Gets or sets the template file's path. | |
| str | TemplateType = property(fget=__GetTemplateType) |
| Gets or sets the template type. | |
| str | Type = property(fget=__GetType, fset=__SetType) |
| Gets or sets the type of the sensor. | |
| str | UseTemplateFile = property(fget=__GetUseTemplateFile, fset=__SetUseTemplateFile) |
| Gets or sets the property to enable the use of template file. | |
| str | WavelengthEnd = property(fget=__GetWavelengthEnd, fset=__SetWavelengthEnd) |
| Gets or sets the wavelength ending border. | |
| str | WavelengthResolution = property(fget=__GetWavelengthResolution, fset=__SetWavelengthResolution) |
| Gets or sets the Wavelength resolution. | |
| str | WavelengthSampling = property(fget=__GetWavelengthSampling, fset=__SetWavelengthSampling) |
| Gets or sets the wavelength sampling. | |
| str | WavelengthStart = property(fget=__GetWavelengthStart, fset=__SetWavelengthStart) |
| Gets or sets the wavelength starting border. | |
| str | XEnd = property(fget=__GetXEnd, fset=__SetXEnd) |
| Gets or sets the Sensor X end dimension value. | |
| str | XMirroredExtent = property(fget=__GetXMirroredExtent, fset=__SetXMirroredExtent) |
| Gets the Sensor X dimension mirrored extent value. | |
| str | XResolution = property(fget=__GetXResolution, fset=__SetXResolution) |
| Gets or sets the Sensor X dimension resolution value. | |
| str | XSampling = property(fget=__GetXSampling, fset=__SetXSampling) |
| Gets or sets the Sensor X dimension sampling value. | |
| str | XStart = property(fget=__GetXStart, fset=__SetXStart) |
| Gets or sets the Sensor X start dimension value. | |
| str | YEnd = property(fget=__GetYEnd, fset=__SetYEnd) |
| Gets or sets the Sensor Y end dimension value. | |
| str | YMirroredExtent = property(fget=__GetYMirroredExtent, fset=__SetYMirroredExtent) |
| Gets the Sensor Y dimension mirrored extent value. | |
| str | YResolution = property(fget=__GetYResolution, fset=__SetYResolution) |
| Gets or sets the Sensor Y dimension resolution value. | |
| str | YSampling = property(fget=__GetYSampling, fset=__SetYSampling) |
| Gets or sets the Sensor Y dimension sampling value. | |
| Static Public Attributes inherited from FeatureBuilder | |
| str | Feature = property(fget=__GetFeature) |
| Returns the feature being edited, or the created feature if the builder is being used in creation mode. | |
| str | FullName = property(fget=__GetFullName) |
| Gets the full name of the feature being edited. | |
| str | Name = property(fget=__GetName, fset=__SetName) |
| Gets or sets the name of the feature being edited. | |
| str | NameWithContext = property(fget=__GetNameWithContext) |
| Gets the name with context of the feature being edited. | |
Additional Inherited Members | |
| Public Member Functions inherited from SensorCommonBuilder | |
| 'bool' | IsTemplateFileValid (self) |
| Checks whether the template file is valid. | |
| Public Member Functions inherited from FeatureBuilder | |
| 'None' | Commit (self) |
| Commits any edits that have been applied to the builder. | |
| 'None' | 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 Irradiance Sensor Builder.
The Irradiance Sensor Builder is used to create and edit Irradiance Sensor features.
To create a new instance of this class, use FeatureCollection::CreateSensorIrradianceBuilder
Member Data Documentation
◆ IntegrationDirection
|
static |
Gets or sets the integration direction.
Prerequisite: The IntegrationType property must be 0, 2 or 4.
The integration direction property takes a feature tag and returns a feature tag.
Value type: Integer.
The default value is 0.
◆ IntegrationDirectionReversed
|
static |
Gets or set the reverse direction of integration.
Prerequisite: The IntegrationType property must be 0, 2 or 4.
True: Reverses the IntegrationDirection property
False: Does not reverse the IntegrationDirection property
Value type: Boolean.
The default value is False.
◆ IntegrationType
|
static |
Gets or set the integration type.
The values are:
0 - Planar.
1 - Radial.
2 - Hemishperical.
3 - Cylindrical.
4 - Semi-cylindrical.
Value type: Integer.
The default value is 0.
◆ OutputFaces
|
static |
Gets or sets the output faces.
The output faces 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.
◆ RayFileFormat
|
static |
Gets or sets the ray file format.
Prerequisite: The EnableRayFile property must be True.
Defines the type of ray file.
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.
The documentation for this class was generated from the following file:
- SpeosNX.py
