ObjectSourceBuilder Class¶
-
class
NXOpen.Mechatronics.
ObjectSourceBuilder
¶ Bases:
NXOpen.Builder
Represents a
NXOpen.Mechatronics.ObjectSource
builder.To create a new instance of this class, use
NXOpen.Mechatronics.ObjectSourceCollection.CreateObjectSourceBuilder
New in version NX7.5.1.
Properties¶
Property | Description |
---|---|
CopyEventTrigger | Returns or sets the event option. |
Name | Returns or sets the name. |
ObjectToCopy | Returns the object select. |
StartOffset | Returns the start offset. |
Tag | Returns the Tag for this object. |
TimeInterval | Returns the time interval. |
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. |
SetObjectsToCopy | Sets the objects to be copied. |
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¶
ObjectSourceBuilderCopyEventTriggerOption Enumeration | Trigger Option in copy event. |
Property Detail¶
CopyEventTrigger¶
-
ObjectSourceBuilder.
CopyEventTrigger
¶ Returns or sets the event option.
-------------------------------------
Getter Method
Signature
CopyEventTrigger()
Returns: Return type: NXOpen.Mechatronics.ObjectSourceBuilderCopyEventTriggerOption
New in version NX7.5.1.
License requirements: nx_mcd_core (“MECHATRONICS CONCEPT DESIGNER”)
-------------------------------------
Setter Method
Signature
CopyEventTrigger(copyEventTrigger)
Parameters: copyEventTrigger ( NXOpen.Mechatronics.ObjectSourceBuilderCopyEventTriggerOption
) –New in version NX7.5.1.
License requirements: nx_mcd_core (“MECHATRONICS CONCEPT DESIGNER”)
Name¶
-
ObjectSourceBuilder.
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(name)
Parameters: name (str) – New in version NX7.5.1.
License requirements: nx_mcd_core (“MECHATRONICS CONCEPT DESIGNER”)
ObjectToCopy¶
-
ObjectSourceBuilder.
ObjectToCopy
¶ Returns the object select.
This can be a
NXOpen.Mechatronics.RigidBody
orNXOpen.Assemblies.ComponentAssembly
.-------------------------------------
Getter Method
Signature
ObjectToCopy()
Returns: Return type: NXOpen.SelectNXObjectList
New in version NX7.5.1.
License requirements: nx_mcd_core (“MECHATRONICS CONCEPT DESIGNER”)
StartOffset¶
-
ObjectSourceBuilder.
StartOffset
¶ Returns the start offset.
-------------------------------------
Getter Method
Signature
StartOffset()
Returns: Return type: NXOpen.Expression
New in version NX7.5.1.
License requirements: nx_mcd_core (“MECHATRONICS CONCEPT DESIGNER”)
TimeInterval¶
-
ObjectSourceBuilder.
TimeInterval
¶ Returns the time interval.
-------------------------------------
Getter Method
Signature
TimeInterval()
Returns: Return type: NXOpen.Expression
New in version NX7.5.1.
License requirements: nx_mcd_core (“MECHATRONICS CONCEPT DESIGNER”)
Method Detail¶
SetObjectsToCopy¶
-
ObjectSourceBuilder.
SetObjectsToCopy
¶ Sets the objects to be copied.
Signature
SetObjectsToCopy(objects)
Parameters: objects (list of NXOpen.NXObject
) – Objects to be copiedNew in version NX7.5.1.
License requirements: nx_mcd_core (“MECHATRONICS CONCEPT DESIGNER”)
Validate¶
-
ObjectSourceBuilder.
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.