ExpressionBlockBuilder Class

class NXOpen.Mechatronics.ExpressionBlockBuilder

Bases: NXOpen.Builder

Represents a NXOpen.Mechatronics.ExpressionBlockBuilder builder.

ExpressionBlockBuilder is used to maintain the NXOpen.Mechatronics.ExpressionBlockObject which is used store related expressions that work for same task.

To create a new instance of this class, use NXOpen.Mechatronics.ExpressionBlockCollection.CreateExpressionBlockBuilder()

New in version NX11.0.0.

Properties

Property Description
Name Returns or sets the name.
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.
GetDescription Gets description lines.
GetObject Returns the object currently being edited by this builder.
GetSlots Gets all Slots.
LoadFromXmlFile Load data from xml file.
SaveToXmlFile Save data to xml file.
SetDescription Sets description lines.
SetSlots Sets all Slots.
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.

Enumerations

ExpressionBlockBuilderDataType Enumeration Represents the data type.
ExpressionBlockBuilderSlotType Enumeration Represents the Slot type.

Structs

ExpressionBlockBuilderSlot_Struct Struct
Represents Slot definition structure.

Property Detail

Name

ExpressionBlockBuilder.Name

Returns or sets the name.

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

Getter Method

Signature Name

Returns:
Return type:str

New in version NX11.0.0.

License requirements: None.

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

Setter Method

Signature Name

Parameters:name (str) –

New in version NX11.0.0.

License requirements: nx_mcd_core (“MECHATRONICS CONCEPT DESIGNER”)

Method Detail

GetDescription

ExpressionBlockBuilder.GetDescription

Gets description lines.

Signature GetDescription()

Returns:
Return type:list of str

New in version NX11.0.0.

License requirements: nx_mcd_core (“MECHATRONICS CONCEPT DESIGNER”)

GetSlots

ExpressionBlockBuilder.GetSlots

Gets all Slots.

Signature GetSlots()

Returns:Array of Slots
Return type:list of NXOpen.Mechatronics.ExpressionBlockBuilderSlot_Struct

New in version NX11.0.0.

License requirements: nx_mcd_core (“MECHATRONICS CONCEPT DESIGNER”)

LoadFromXmlFile

ExpressionBlockBuilder.LoadFromXmlFile

Load data from xml file.

Signature LoadFromXmlFile(templateFile)

Parameters:templateFile (str) –

New in version NX11.0.0.

License requirements: nx_mcd_core (“MECHATRONICS CONCEPT DESIGNER”)

SaveToXmlFile

ExpressionBlockBuilder.SaveToXmlFile

Save data to xml file.

Signature SaveToXmlFile(templateFile)

Parameters:templateFile (str) –

New in version NX11.0.0.

License requirements: nx_mcd_core (“MECHATRONICS CONCEPT DESIGNER”)

SetDescription

ExpressionBlockBuilder.SetDescription

Sets description lines.

Signature SetDescription(descLines)

Parameters:descLines (list of str) –

New in version NX11.0.0.

License requirements: nx_mcd_core (“MECHATRONICS CONCEPT DESIGNER”)

SetSlots

ExpressionBlockBuilder.SetSlots

Sets all Slots.

Signature SetSlots(slots)

Parameters:slots (list of NXOpen.Mechatronics.ExpressionBlockBuilderSlot_Struct) – Array of Slots

New in version NX11.0.0.

License requirements: nx_mcd_core (“MECHATRONICS CONCEPT DESIGNER”)

Validate

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