ObjectSinkBuilder Class — NXOpen Python API Reference 12.0.0 documentation

# ObjectSinkBuilder Class

class `NXOpen.Mechatronics.``ObjectSinkBuilder`

  Bases: `NXOpen.Builder`

  Represents a `NXOpen.Mechatronics.ObjectSink` builder.

  To create a new instance of this class, use `NXOpen.Mechatronics.ObjectSinkCollection.CreateObjectSinkBuilder()`

  New in version NX7.5.1.

# Properties

Property | Description
--- | ---
CollisionSensor | Returns the object select.
DeleteSource | Returns or sets the option to delete source.
Name | Returns or sets the name.
Source | Returns the source select.
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.
SetCollisionSensor | Sets the collision sensor object.
SetSource | Sets the source.
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

ObjectSinkBuilderDeleteSourceType Enumeration | the delete option.

# Property Detail

## CollisionSensor

`ObjectSinkBuilder.``CollisionSensor`

  Returns the object select.

  This can be a `NXOpen.Mechatronics.CollisionSensor`.

  `-------------------------------------`

  Getter Method

  Signature `CollisionSensor`

  Returns: |
  Return type: | `NXOpen.Mechatronics.SelectCollisionSensorList`

  New in version NX7.5.1.

  License requirements: nx_mcd_core (“MECHATRONICS CONCEPT DESIGNER”)

## DeleteSource

`ObjectSinkBuilder.``DeleteSource`

  Returns or sets the option to delete source.

  `-------------------------------------`

  Getter Method

  Signature `DeleteSource`

  Returns: |
  Return type: | `NXOpen.Mechatronics.ObjectSinkBuilderDeleteSourceType`

  New in version NX7.5.1.

  License requirements: nx_mcd_core (“MECHATRONICS CONCEPT DESIGNER”)

  `-------------------------------------`

  Setter Method

  Signature `DeleteSource`

  Parameters: | deleteSource (`NXOpen.Mechatronics.ObjectSinkBuilderDeleteSourceType`) –

  New in version NX7.5.1.

  License requirements: nx_mcd_core (“MECHATRONICS CONCEPT DESIGNER”)

## Name

`ObjectSinkBuilder.``Name`

  Returns or sets the name.

  `-------------------------------------`

  Getter Method

  Signature `Name`

  Returns: |
  Return type: | str

  New in version NX7.5.1.

  License requirements: nx_mcd_core (“MECHATRONICS CONCEPT DESIGNER”)

  `-------------------------------------`

  Setter Method

  Signature `Name`

  Parameters: | name (str) –

  New in version NX7.5.1.

  License requirements: nx_mcd_core (“MECHATRONICS CONCEPT DESIGNER”)

## Source

`ObjectSinkBuilder.``Source`

  Returns the source select.

  `-------------------------------------`

  Getter Method

  Signature `Source`

  Returns: |
  Return type: | `NXOpen.SelectNXObjectList`

  New in version NX7.5.1.

  License requirements: nx_mcd_core (“MECHATRONICS CONCEPT DESIGNER”)

# Method Detail

## SetCollisionSensor

`ObjectSinkBuilder.``SetCollisionSensor`

  Sets the collision sensor object.

  Signature `SetCollisionSensor(objects)`

  Parameters: | objects (list of `NXOpen.Mechatronics.CollisionSensor`) – Collision Sensor objects

  New in version NX7.5.1.

  License requirements: nx_mcd_core (“MECHATRONICS CONCEPT DESIGNER”)

## SetSource

`ObjectSinkBuilder.``SetSource`

  Sets the source.

  Signature `SetSource(objects)`

  Parameters: | objects (list of `NXOpen.NXObject`) – Source objects

  New in version NX7.5.1.

  License requirements: nx_mcd_core (“MECHATRONICS CONCEPT DESIGNER”)

## Validate

`ObjectSinkBuilder.``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.