Teaching Class

class NXOpen.CAM.Teaching

Bases: NXOpen.Builder

Represents a Teaching Builder

Abstract

New in version NX10.0.3.

Properties

Property Description
Tag Returns the Tag for this object.

Methods

Method Description
AddNewClass Adds a new class
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.
GetObject Returns the object currently being edited by this builder.
GetRuleCondition Gets the rule conditions
GetRuleLibraryPath Gets the selected rule library path
GetRulePath Gets the selected rule path
GetRulePriority Gets the selected rule priority
RemoveClass Removes a class
RemoveRule Removes a rule
RenameClass Renames a class
RenameRule Renames a rule
SetRuleCondition Sets the rule conditions
SetRuleLibraryPath Sets the selected rule library path
SetRulePath Sets the selected rule path
SetRulePriority Sets the selected rule priority
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.

Method Detail

AddNewClass

Teaching.AddNewClass

Adds a new class

Signature AddNewClass(name, packageName, superName)

Parameters:
  • name (str) –
  • packageName (str) –
  • superName (str) –

New in version NX10.0.3.

License requirements: fbm_author (“FBM Author”)

AddNewRule

Teaching.AddNewRule

Adds a new rule

Signature AddNewRule(name)

Parameters:name (str) –

New in version NX10.0.3.

License requirements: fbm_author (“FBM Author”)

GetRuleCondition

Teaching.GetRuleCondition

Gets the rule conditions

Signature GetRuleCondition()

Returns:
Return type:str

New in version NX10.0.3.

License requirements: fbm_author (“FBM Author”)

GetRuleLibraryPath

Teaching.GetRuleLibraryPath

Gets the selected rule library path

Signature GetRuleLibraryPath()

Returns:
Return type:str

New in version NX10.0.3.

License requirements: fbm_author (“FBM Author”)

GetRulePath

Teaching.GetRulePath

Gets the selected rule path

Signature GetRulePath()

Returns:
Return type:str

New in version NX10.0.3.

License requirements: fbm_author (“FBM Author”)

GetRulePriority

Teaching.GetRulePriority

Gets the selected rule priority

Signature GetRulePriority()

Returns:
Return type:float

New in version NX10.0.3.

License requirements: fbm_author (“FBM Author”)

RemoveClass

Teaching.RemoveClass

Removes a class

Signature RemoveClass(name, packageName)

Parameters:
  • name (str) –
  • packageName (str) –

New in version NX10.0.3.

License requirements: fbm_author (“FBM Author”)

RemoveRule

Teaching.RemoveRule

Removes a rule

Signature RemoveRule()

New in version NX10.0.3.

License requirements: fbm_author (“FBM Author”)

RenameClass

Teaching.RenameClass

Renames a class

Signature RenameClass(name, packageName, newName)

Parameters:
  • name (str) –
  • packageName (str) –
  • newName (str) –

New in version NX10.0.3.

License requirements: fbm_author (“FBM Author”)

RenameRule

Teaching.RenameRule

Renames a rule

Signature RenameRule(newName)

Parameters:newName (str) –

New in version NX10.0.3.

License requirements: fbm_author (“FBM Author”)

SetRuleCondition

Teaching.SetRuleCondition

Sets the rule conditions

Signature SetRuleCondition(condition)

Parameters:condition (str) –

New in version NX10.0.3.

License requirements: fbm_author (“FBM Author”)

SetRuleLibraryPath

Teaching.SetRuleLibraryPath

Sets the selected rule library path

Signature SetRuleLibraryPath(path)

Parameters:path (str) –

New in version NX10.0.3.

License requirements: fbm_author (“FBM Author”)

SetRulePath

Teaching.SetRulePath

Sets the selected rule path

Signature SetRulePath(path)

Parameters:path (str) –

New in version NX10.0.3.

License requirements: fbm_author (“FBM Author”)

SetRulePriority

Teaching.SetRulePriority

Sets the selected rule priority

Signature SetRulePriority(priority)

Parameters:priority (float) –

New in version NX10.0.3.

License requirements: fbm_author (“FBM Author”)

Validate

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