TransferFileDataBuilder Class

class NXOpen.AME.TransferFileDataBuilder

Bases: NXOpen.Builder

Imports a new one or updates the existing configuration in AD Upstream Data Navigator from the external file.

To create a new instance of this class, use NXOpen.AME.AMEManager.CreateTransferFileDataBuilder()

New in version NX11.0.0.

Properties

Property	Description
FileToImport	Returns or sets the excel file which is being imported
NodeToUpdate	Returns the node which needs to update during import operation
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.
ValidateAndPopulateExcelData	Validate and populate excel import data.

Property Detail

FileToImport

TransferFileDataBuilder.FileToImport

Returns or sets the excel file which is being imported

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

Getter Method

Signature FileToImport

Returns: Return type:str

New in version NX11.0.0.

License requirements: ad_automation_design (“FULL AUTOMATION DESIGNER”)

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

Setter Method

Signature FileToImport

Parameters:fileToImport (str) –

New in version NX11.0.0.

License requirements: ad_automation_design (“FULL AUTOMATION DESIGNER”)

NodeToUpdate

TransferFileDataBuilder.NodeToUpdate

Returns the node which needs to update during import operation

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

Getter Method

Signature NodeToUpdate

Returns: Return type:NXOpen.SelectNXObject

New in version NX11.0.0.

License requirements: ad_automation_design (“FULL AUTOMATION DESIGNER”)

Method Detail

Validate

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

ValidateAndPopulateExcelData

TransferFileDataBuilder.ValidateAndPopulateExcelData

Validate and populate excel import data.

This should be called prior to commit.

Signature ValidateAndPopulateExcelData()

New in version NX11.0.0.

License requirements: ad_automation_design (“FULL AUTOMATION DESIGNER”)