FeatureGeneralPropertiesBuilder Class¶
-
class
NXOpen.
FeatureGeneralPropertiesBuilder
¶ Bases:
NXOpen.Builder
Represents a
NXOpen.FeatureGeneralPropertiesBuilder
to be used for modifying the names of features and general objects.To create a new instance of this class, use
NXOpen.PropertiesManager.CreateFeatureGeneralPropertiesBuilder()
New in version NX8.0.0.
Properties¶
Property | Description |
---|---|
ApplyToWorkPart | Returns or sets the option to apply the name change to the work part. |
FeatureName | Returns or sets the feature name. |
FeatureObject | Returns or sets the feature. |
GeneralName | Returns or sets the general name. |
GeneralObject | Returns or sets the general object. |
NameLocationSpecified | Returns or sets the name location specified. |
SelectedObjects | Returns the selected object(s) list. |
Tag | Returns the Tag for this object. |
Methods¶
Method | Description |
---|---|
Commit | Commits any edits that have been applied to the builder. |
DeleteFeatureName | Delete the name of the feature. |
DeleteGeneralName | Delete the name of the general object. |
Destroy | Deletes the builder, and cleans up any objects created by the builder. |
GetCommittedObjects | For builders that create more than one object, this method returns the objects that are created by commit. |
GetNameLocation | Gets the name location |
GetObject | Returns the object currently being edited by this builder. |
SetNameLocation | Sets the name location. |
ShowResults | Updates the model to reflect the result of an edit to the model for all builders that support showing results. |
Validate | Validate whether the inputs to the component are sufficient for commit to be called. |
Property Detail¶
ApplyToWorkPart¶
-
FeatureGeneralPropertiesBuilder.
ApplyToWorkPart
¶ Returns or sets the option to apply the name change to the work part.
-------------------------------------
Getter Method
Signature
ApplyToWorkPart
Returns: Return type: bool New in version NX8.0.0.
License requirements: None.
-------------------------------------
Setter Method
Signature
ApplyToWorkPart
Parameters: applyToWorkPart (bool) – New in version NX8.0.0.
License requirements: None.
FeatureName¶
-
FeatureGeneralPropertiesBuilder.
FeatureName
¶ Returns or sets the feature name.
This is the new name of the feature.
-------------------------------------
Getter Method
Signature
FeatureName
Returns: Return type: str New in version NX8.0.0.
License requirements: None.
-------------------------------------
Setter Method
Signature
FeatureName
Parameters: featureName (str) – New in version NX8.0.0.
License requirements: None.
FeatureObject¶
-
FeatureGeneralPropertiesBuilder.
FeatureObject
¶ Returns or sets the feature.
This is the feature object to be modified.
-------------------------------------
Getter Method
Signature
FeatureObject
Returns: Return type: NXOpen.NXObject
New in version NX8.0.0.
License requirements: None.
-------------------------------------
Setter Method
Signature
FeatureObject
Parameters: featureObject ( NXOpen.NXObject
) –New in version NX8.0.0.
License requirements: None.
GeneralName¶
-
FeatureGeneralPropertiesBuilder.
GeneralName
¶ Returns or sets the general name.
This is the new name of the general object.
-------------------------------------
Getter Method
Signature
GeneralName
Returns: Return type: str New in version NX8.0.0.
License requirements: None.
-------------------------------------
Setter Method
Signature
GeneralName
Parameters: generalName (str) – New in version NX8.0.0.
License requirements: None.
GeneralObject¶
-
FeatureGeneralPropertiesBuilder.
GeneralObject
¶ Returns or sets the general object.
This is the general object to be modified.
-------------------------------------
Getter Method
Signature
GeneralObject
Returns: Return type: NXOpen.NXObject
New in version NX8.0.0.
License requirements: None.
-------------------------------------
Setter Method
Signature
GeneralObject
Parameters: generalObject ( NXOpen.NXObject
) –New in version NX8.0.0.
License requirements: None.
NameLocationSpecified¶
-
FeatureGeneralPropertiesBuilder.
NameLocationSpecified
¶ Returns or sets the name location specified.
This states whether the name location will be changed.
-------------------------------------
Getter Method
Signature
NameLocationSpecified
Returns: Return type: bool New in version NX8.0.0.
License requirements: None.
-------------------------------------
Setter Method
Signature
NameLocationSpecified
Parameters: nameLocationSpecified (bool) – New in version NX8.0.0.
License requirements: None.
SelectedObjects¶
-
FeatureGeneralPropertiesBuilder.
SelectedObjects
¶ Returns the selected object(s) list.
This list should only contain one object
-------------------------------------
Getter Method
Signature
SelectedObjects
Returns: Return type: NXOpen.SelectNXObjectList
New in version NX8.0.0.
License requirements: None.
Method Detail¶
DeleteFeatureName¶
-
FeatureGeneralPropertiesBuilder.
DeleteFeatureName
¶ Delete the name of the feature.
Signature
DeleteFeatureName()
New in version NX8.0.0.
License requirements: None.
DeleteGeneralName¶
-
FeatureGeneralPropertiesBuilder.
DeleteGeneralName
¶ Delete the name of the general object.
Signature
DeleteGeneralName()
New in version NX8.0.0.
License requirements: None.
GetNameLocation¶
-
FeatureGeneralPropertiesBuilder.
GetNameLocation
¶ Gets the name location
Signature
GetNameLocation()
Returns: Return type: NXOpen.Point3d
New in version NX8.0.0.
License requirements: None.
SetNameLocation¶
-
FeatureGeneralPropertiesBuilder.
SetNameLocation
¶ Sets the name location.
If name location specified is true, this value will be used to change the name location of the general object.
Signature
SetNameLocation(nameLocation)
Parameters: nameLocation ( NXOpen.Point3d
) – the name locationNew in version NX8.0.0.
License requirements: None.
Validate¶
-
FeatureGeneralPropertiesBuilder.
Validate
¶ Validate whether the inputs to the component are sufficient for commit to be called.
If the component is not in a state to commit then an exception is thrown. For example, if the component requires you to set some property, this method will throw an exception if you haven’t set it. This method throws a not-yet-implemented NXException for some components.
Signature
Validate()
Returns: Was self validation successful Return type: bool New in version NX3.0.1.
License requirements: None.