ReadWriteDeviceBuilder Class

class NXOpen.Mechatronics.ReadWriteDeviceBuilder

Bases: NXOpen.Builder

Represents a NXOpen.Mechatronics.ReadWriteDeviceBuilder.

To create a new instance of this class, use NXOpen.Mechatronics.ReadWriteDeviceCollection.CreateReadWriteDeviceBuilder()

New in version NX10.0.0.

Properties

Property	Description
Name	Returns or sets the name.
Sensor	Returns the selected sensor NXOpen.Mechatronics.CollisionSensor 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.
GetDeviceType	Gets device type.
GetExecuteMode	Gets execute mode.
GetForm	Gets the form NXOpen.Mechatronics.TagFormObject object.
GetObject	Returns the object currently being edited by this builder.
GetTable	Gets the table NXOpen.Mechatronics.TagTableObject object.
SetDeviceType	Sets device type.
SetExecuteMode	Sets execute mode.
SetForm	Sets the form NXOpen.Mechatronics.TagFormObject object.
SetTable	Sets the table NXOpen.Mechatronics.TagTableObject object.
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

ReadWriteDeviceBuilderDeviceType Enumeration	the device types.
ReadWriteDeviceBuilderExecuteMode Enumeration	the execute modes.

Property Detail

Name

ReadWriteDeviceBuilder.Name

Returns or sets the name.

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

Getter Method

Signature Name

Returns: Return type:str

New in version NX10.0.0.

License requirements: None.

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

Setter Method

Signature Name

Parameters:name (str) –

New in version NX10.0.0.

License requirements: nx_mcd_core (“MECHATRONICS CONCEPT DESIGNER”)

Sensor

ReadWriteDeviceBuilder.Sensor

Returns the selected sensor NXOpen.Mechatronics.CollisionSensor object.

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

Getter Method

Signature Sensor

Returns: Return type:NXOpen.Mechatronics.SelectCollisionSensor

New in version NX10.0.0.

License requirements: nx_mcd_core (“MECHATRONICS CONCEPT DESIGNER”)

Method Detail

GetDeviceType

ReadWriteDeviceBuilder.GetDeviceType

Gets device type.

Signature GetDeviceType()

Returns: Return type:NXOpen.Mechatronics.ReadWriteDeviceBuilderDeviceType

New in version NX10.0.0.

License requirements: None.

GetExecuteMode

ReadWriteDeviceBuilder.GetExecuteMode

Gets execute mode.

Signature GetExecuteMode()

Returns: Return type:NXOpen.Mechatronics.ReadWriteDeviceBuilderExecuteMode

New in version NX10.0.0.

License requirements: None.

GetForm

ReadWriteDeviceBuilder.GetForm

Gets the form NXOpen.Mechatronics.TagFormObject object.

Signature GetForm()

Returns: Return type:NXOpen.Mechatronics.TagFormObject

New in version NX10.0.0.

License requirements: None.

GetTable

ReadWriteDeviceBuilder.GetTable

Gets the table NXOpen.Mechatronics.TagTableObject object.

Signature GetTable()

Returns: Return type:NXOpen.Mechatronics.TagTableObject

New in version NX10.0.0.

License requirements: None.

SetDeviceType

ReadWriteDeviceBuilder.SetDeviceType

Sets device type.

Signature SetDeviceType(type)

Parameters:type (NXOpen.Mechatronics.ReadWriteDeviceBuilderDeviceType) –

New in version NX10.0.0.

License requirements: nx_mcd_core (“MECHATRONICS CONCEPT DESIGNER”)

SetExecuteMode

ReadWriteDeviceBuilder.SetExecuteMode

Sets execute mode.

Signature SetExecuteMode(mode)

Parameters:mode (NXOpen.Mechatronics.ReadWriteDeviceBuilderExecuteMode) –

New in version NX10.0.0.

License requirements: nx_mcd_core (“MECHATRONICS CONCEPT DESIGNER”)

SetForm

ReadWriteDeviceBuilder.SetForm

Sets the form NXOpen.Mechatronics.TagFormObject object.

Signature SetForm(form)

Parameters:form (NXOpen.Mechatronics.TagFormObject) –

New in version NX10.0.0.

License requirements: nx_mcd_core (“MECHATRONICS CONCEPT DESIGNER”)

SetTable

ReadWriteDeviceBuilder.SetTable

Sets the table NXOpen.Mechatronics.TagTableObject object.

Signature SetTable(table)

Parameters:table (NXOpen.Mechatronics.TagTableObject) –

New in version NX10.0.0.

License requirements: nx_mcd_core (“MECHATRONICS CONCEPT DESIGNER”)

Validate

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