Skip to main content

Speos NX library 2025 R1

FeatureBuilder Class Reference

Last update: 17.07.2025

A base class for all Builders. More...

Inheritance diagram for FeatureBuilder:
_objectComponentLightBoxExportBuilderComponentLightBoxImportBuilderFolderBuilderOpticalPropertiesBuilderSensor3DEnergyDensityBuilderSensor3DIrradianceBuilderSensorCameraBuilderSensorCommonBuilderSensorHumanEyeBuilderSensorLightFieldBuilderSensorObserverBuilderSensorPhysicalCameraBuilderSensorVRImmersiveBuilderSimulationCommonBuilderSourceAmbientCommonBuilderSourceAmbientEnvironmentBuilderSourceDisplayBuilderSourceGroupBuilderSourceLightFieldBuilderSourceLuminaireBuilderSourceRayFileBuilderSourceSurfaceBuilderSourceSurfaceThermicBuilderSpeosPatternBuilder

Public Member Functions

'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.
 

Static Public Attributes

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.
 

Detailed Description

A base class for all Builders.

A Builder is an object that is used to create and edit Features.

This is an abstract class that provides the basic functionality common to all builders. See the Builder subclasses for details of application-specific builders.

This is an abstract class, and cannot be instantiated.

Member Function Documentation

◆ Commit()

'None' Commit ( self)

Commits any edits that have been applied to the builder.

Commits any edits that have been applied to the feature being edited, or a new feature if the builder is being used in creation mode.

Member Data Documentation

◆ Feature

str Feature = property(fget=__GetFeature)
static

Returns the feature being edited, or the created feature if the builder is being used in creation mode.

Returns the feature currently being edited by this builder.
If a new feature is being created, and the builder has not yet been commited, returns Null.

Returns
The feature being edited, or the created one or Null.

◆ FullName

str FullName = property(fget=__GetFullName)
static

Gets the full name of the feature being edited.

Value type: String.

The default value is the current feature full name.

◆ Name

str Name = property(fget=__GetName, fset=__SetName)
static

Gets or sets the name of the feature being edited.

Value type: String.

The default value is the current feature name.

◆ NameWithContext

str NameWithContext = property(fget=__GetNameWithContext)
static

Gets the name with context of the feature being edited.

Value type: String.


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

Connect with Ansys