FeatureTeaching Class¶
-
class
NXOpen.CAM.
FeatureTeaching
¶ Bases:
NXOpen.Builder
Represents a FeatureTeaching Builder
To create a new instance of this class, use
NXOpen.CAM.CAMSetup.CreateFeatureTeaching
New in version NX8.0.0.
Properties¶
Property | Description |
---|---|
RuleMatchOptions | Returns or sets the rule options |
Tag | Returns the Tag for this object. |
Methods¶
Method | Description |
---|---|
AddNewFeatureType | Adds a new feature type |
AddNewRule | Adds a new rule |
Commit | Commits any edits that have been applied to the builder. |
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. |
GetFaces | Gets the selected faces @return |
GetObject | Returns the object currently being edited by this builder. |
GetRulePath | Gets the selected rule path @return |
RemoveFeatureType | Removes a feature type |
RemoveRule | Removes a rule |
RenameFeatureType | Renames a feature type |
RenameRule | Renames a rule |
SetFaces | Sets the selected faces |
SetRulePath | Sets the selected rule path |
ShowResults | Updates the model to reflect the result of an edit to the model for all builders that support showing results. |
Teach | Teaches the new feature |
Test | Tests the new feature @return |
Validate | Validate whether the inputs to the component are sufficient for commit to be called. |
Enumerations¶
FeatureTeachingRuleMatchOptionType Enumeration | Rule Option types |
Property Detail¶
RuleMatchOptions¶
-
FeatureTeaching.
RuleMatchOptions
¶ Returns or sets the rule options
-------------------------------------
Getter Method
Signature
RuleMatchOptions()
Returns: Return type: NXOpen.CAM.FeatureTeachingRuleMatchOptionType
New in version NX8.0.0.
License requirements: fbm_author (“FBM Author”)
-------------------------------------
Setter Method
Signature
RuleMatchOptions(options)
Parameters: options ( NXOpen.CAM.FeatureTeachingRuleMatchOptionType
) –New in version NX8.0.0.
License requirements: fbm_author (“FBM Author”)
Method Detail¶
AddNewFeatureType¶
-
FeatureTeaching.
AddNewFeatureType
¶ Adds a new feature type
Signature
AddNewFeatureType(name, superName)
Parameters: - name (str) –
- superName (str) –
New in version NX8.0.0.
License requirements: fbm_author (“FBM Author”)
AddNewRule¶
-
FeatureTeaching.
AddNewRule
¶ Adds a new rule
Signature
AddNewRule(name, libraryPath, featureTypeName)
Parameters: - name (str) –
- libraryPath (str) –
- featureTypeName (str) –
New in version NX8.0.0.
License requirements: fbm_author (“FBM Author”)
GetFaces¶
-
FeatureTeaching.
GetFaces
¶ Gets the selected faces
Signature
GetFaces()
Returns: Return type: list of NXOpen.DisplayableObject
New in version NX8.0.0.
License requirements: fbm_author (“FBM Author”)
GetRulePath¶
-
FeatureTeaching.
GetRulePath
¶ Gets the selected rule path
Signature
GetRulePath()
Returns: Return type: str New in version NX8.0.0.
License requirements: fbm_author (“FBM Author”)
RemoveFeatureType¶
-
FeatureTeaching.
RemoveFeatureType
¶ Removes a feature type
Signature
RemoveFeatureType(name)
Parameters: name (str) – New in version NX8.0.0.
License requirements: fbm_author (“FBM Author”)
RemoveRule¶
-
FeatureTeaching.
RemoveRule
¶ Removes a rule
Signature
RemoveRule(path)
Parameters: path (str) – New in version NX8.0.0.
License requirements: fbm_author (“FBM Author”)
RenameFeatureType¶
-
FeatureTeaching.
RenameFeatureType
¶ Renames a feature type
Signature
RenameFeatureType(name, newName)
Parameters: - name (str) –
- newName (str) –
New in version NX8.0.0.
License requirements: fbm_author (“FBM Author”)
RenameRule¶
-
FeatureTeaching.
RenameRule
¶ Renames a rule
Signature
RenameRule(path, newName)
Parameters: - path (str) –
- newName (str) –
New in version NX8.0.0.
License requirements: fbm_author (“FBM Author”)
SetFaces¶
-
FeatureTeaching.
SetFaces
¶ Sets the selected faces
Signature
SetFaces(aFaces)
Parameters: aFaces (list of NXOpen.DisplayableObject
) –New in version NX8.0.0.
License requirements: fbm_author (“FBM Author”)
SetRulePath¶
-
FeatureTeaching.
SetRulePath
¶ Sets the selected rule path
Signature
SetRulePath(path)
Parameters: path (str) – New in version NX8.0.0.
License requirements: fbm_author (“FBM Author”)
Teach¶
-
FeatureTeaching.
Teach
¶ Teaches the new feature
Signature
Teach()
New in version NX8.0.0.
License requirements: fbm_author (“FBM Author”)
Test¶
-
FeatureTeaching.
Test
¶ Tests the new feature
Signature
Test()
Returns: Return type: list of NXOpen.CAM.CAMFeature
New in version NX8.0.0.
License requirements: fbm_author (“FBM Author”)
Validate¶
-
FeatureTeaching.
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.