RequirementBuilder Class

class NXOpen.Mechatronics.RequirementBuilder

Bases: NXOpen.Mechatronics.SystemObjectBuilder

Represents a NXOpen.Mechatronics.Requirement builder

To create a new instance of this class, use NXOpen.Mechatronics.RequirementCollection.CreateRequirementBuilder()

New in version NX8.5.0.

Properties

Property Description
InstanceName Returns or sets the name of instance.
ObjectInformation Returns the object information builder, used to specify the information of requirement object.
ParentFunction Returns or sets the parent object.
Tag Returns the Tag for this object.

Methods

Method Description
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.
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

ObjectInformation

RequirementBuilder.ObjectInformation

Returns the object information builder, used to specify the information of requirement object.

-------------------------------------

Getter Method

Signature ObjectInformation

Returns:object information Builder
Return type:NXOpen.Mechatronics.ObjectInformationBuilder

New in version NX8.5.0.

License requirements: None.

ParentFunction

RequirementBuilder.ParentFunction

Returns or sets the parent object.

-------------------------------------

Getter Method

Signature ParentFunction

Returns:Parent function object
Return type:NXOpen.NXObject

New in version NX8.5.0.

License requirements: nx_mcd_core (“MECHATRONICS CONCEPT DESIGNER”)

-------------------------------------

Setter Method

Signature ParentFunction

Parameters:parent (NXOpen.NXObject) – Parent function object

New in version NX8.5.0.

License requirements: nx_mcd_core (“MECHATRONICS CONCEPT DESIGNER”)

Method Detail

Validate

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