Represents a Result Light Expert builder. More...

Inheritance diagram for ResultLXPBuilder:

Public Member Functions
'None'	CreateAreaRectangle (self, sensorIndex, xCenter, yCenter, width, height)
	Create a rectangle area.

'None'	CreateAreaEllipse (self, sensorIndex, xCenter, yCenter, xRadius, yRadius)
	Create an ellipse area.

'None'	CreateAreaPolygon (self, sensorIndex, xPts, yPts)
	Create an polygon area.

'float'	RetrieveMeasureValue (self, sensorIndex, measureType)
	Retrieve measure value.

Public Member Functions inherited from FeatureBuilder
'None'	ShowResult (self)
	Updates the feature to reflect the result of an edit to the feature for all builders that support showing results.

Public Member Functions inherited from Builder
'None'	Commit (self)
	Commits any edits that have been applied to the builder.

Static Public Attributes
str	DrawingOptions = property(fget=__GetDrawingOptions, fset=__SetDrawingOptions)
	Gets or sets the drawing options.

str	InfiniteRayLength = property(fget=__GetInfiniteRayLength, fset=__SetInfiniteRayLength)
	Gets or sets the infinite ray length.

str	NumberOfRays = property(fget=__GetNumberOfRays, fset=__SetNumberOfRays)
	Gets or sets the number of rays.

str	RejectedFaces = property(fget=__GetRejectedFaces, fset=__SetRejectedFaces)
	Gets or sets rejected faces tag.

str	RequiredFaces = property(fget=__GetRequiredFaces, fset=__SetRequiredFaces)
	Gets or sets requiered faces tag.

str	RequiredFacesMode = property(fget=__GetRequiredFacesMode, fset=__SetRequiredFacesMode)
	Gets or sets the required faces mode.

str	SelectedRaysMode = property(fget=__GetSelectedRaysMode, fset=__SetSelectedRaysMode)
	Gets or sets the selected rays mode.

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.

str	Status = 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')

Properties inherited from FeatureBuilder
	thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')

Properties inherited from Builder
	thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')

Detailed Description

Represents a Result Light Expert builder.

The ResultLXPBuilder is used to create and edit Result Light Expert features.

To create a new instance of this class, use FeatureCollection::CreateResultLXPBuilder

Member Function Documentation

◆ CreateAreaEllipse()

'None' CreateAreaEllipse	(	self,
		sensorIndex,
		xCenter,
		yCenter,
		xRadius,
		yRadius )

Create an ellipse area.

Parameters

[in]	viewerId	index of XMP in the sensor group (must be 0 for non group sensor) : Unsigned integer.
[in]	xCenter	Center position X of the ellipse area : double.
[in]	yCenter	Center position Y of the ellipse area : double.
[in]	xRadius	Radius X of the ellipse area : double.
[in]	yRadius	Radius Y of the ellipse area : double.

The default value is no reactangle area.

◆ CreateAreaPolygon()

'None' CreateAreaPolygon	(	self,
		sensorIndex,
		xPts,
		yPts )

Create an polygon area.

Parameters

[in]	viewerId	index of XMP in the sensor group (must be 0 for non group sensor) : Unsigned integer.
[in]	xPts	List of X position of the polygon area : List of double.
[in]	yPts	List of X position of the polygon area : List of double.

The default value is no reactangle area.

◆ CreateAreaRectangle()

'None' CreateAreaRectangle	(	self,
		sensorIndex,
		xCenter,
		yCenter,
		width,
		height )

Create a rectangle area.

Parameters

[in]	viewerId	index of XMP in the sensor group (must be 0 for non group sensor) : Unsigned integer.
[in]	xCenter	Center position X of the rectangle area : double.
[in]	yCenter	Center position Y of the rectangle area : double.
[in]	width	Width of the rectangle area : double.
[in]	height	Height of the rectangle area : double.

The default value is no reactangle area.

◆ RetrieveMeasureValue()

'float' RetrieveMeasureValue	(	self,
		sensorIndex,
		measureType )

Retrieve measure value.

RetrieveMeasureValue return measure value by Type.

Parameters

[in]	viewerId	index of XMP in the sensor group (must be 0 for non group sensor) : Unsigned integer.
[in]	measureType	the type of value to retrieve : Unsigned integer. The values are: 1 - Maximum 2 - Maximum position X 3 - Maximum position Y 4 - Minimum 5 - Minimum position X 6 - Minimum position Y 7 - Average 8 - Flux 9 - Barycentre position X 10 - Barycentre position Y 11 - Sigma 12 - Sigma position X 13 - Sigma position Y 14 - Contrast 15 - RMS Contrast 16 - Eye Irradiance 17 - Range 19 - Range position X 2O - Range position Y 21 - Area 22 - UGR117 28 - Deviation Min 29 - Deviation Max 30 - Deviation Average

Returns: the result measure.

Member Data Documentation

◆ DrawingOptions

str DrawingOptions = property(fget=__GetDrawingOptions, fset=__SetDrawingOptions)

static

Gets or sets the drawing options.

The values are:
1 - Rays.
2 - Impact.
3 - Rays and Impacts.

Value type: Integer.

The default value is 0.

◆ InfiniteRayLength

str InfiniteRayLength = property(fget=__GetInfiniteRayLength, fset=__SetInfiniteRayLength)

static

Gets or sets the infinite ray length.

Length used to draw infinite rays.

Value type: Double (in mm).
Range: The value must be superior or equal to 0.0.

The default value is calculated based on the system bounding box.

◆ NumberOfRays

str NumberOfRays = property(fget=__GetNumberOfRays, fset=__SetNumberOfRays)

static

Gets or sets the number of rays.

Number of rays calculate.

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

The default value is 200.

◆ RejectedFaces

str RejectedFaces = property(fget=__GetRejectedFaces, fset=__SetRejectedFaces)

static

Gets or sets rejected faces tag.

The RejectedFaces property returns a list of feature tag.

Returns: List of integer.

◆ RequiredFaces

str RequiredFaces = property(fget=__GetRequiredFaces, fset=__SetRequiredFaces)

static

Gets or sets requiered faces tag.

The RequiredFaces property returns a list of feature tag.

Returns: List of integer.

◆ RequiredFacesMode

str RequiredFacesMode = property(fget=__GetRequiredFacesMode, fset=__SetRequiredFacesMode)

static

Gets or sets the required faces mode.

The values are:
0 - AND.
1 - OR.

Value type: Integer.

The default value is 0.

◆ SelectedRaysMode

str SelectedRaysMode = property(fget=__GetSelectedRaysMode, fset=__SetSelectedRaysMode)

static

Gets or sets the selected rays mode.

The values are:
0 - IN.
1 - OUT.

Value type: Integer.

The default value is 0.

The documentation for this class was generated from the following file:

SpeosNX_2412.py

Speos NX library 2025 R2

ResultLXPBuilder Class Reference

Public Member Functions

Static Public Attributes

Properties

Detailed Description

Member Function Documentation

◆ CreateAreaEllipse()

◆ CreateAreaPolygon()

◆ CreateAreaRectangle()

◆ RetrieveMeasureValue()

Member Data Documentation

◆ DrawingOptions

◆ InfiniteRayLength

◆ NumberOfRays

◆ RejectedFaces

◆ RequiredFaces

◆ RequiredFacesMode

◆ SelectedRaysMode

Connect with Ansys