LoadTransferBuilder Class¶
-
class
NXOpen.Motion.
LoadTransferBuilder
¶ Bases:
NXOpen.Motion.MotionBuilder
Represents a
NXOpen.Motion.LoadTransferBuilder
To create a new instance of this class, use
NXOpen.Motion.LoadTransferCollection.CreateLoadTransferBuilder()
Default values.
Property Value VectorScale 1.0 New in version NX9.0.0.
Properties¶
Property | Description |
---|---|
DisplayScale | Returns or sets the icon display scale |
GroupName | Returns or sets the group name |
GroupType | Returns or sets the group type |
Link | Returns the link |
Tag | Returns the Tag for this object. |
VectorScale | Returns or sets the vector scale |
Methods¶
Method | Description |
---|---|
Commit | Commits any edits that have been applied to the builder. |
CreateGraphObjects | Creates graph objects |
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. |
GetRecordedSteps | Returns recorded steps |
SetRecordedSteps | Sets recorded steps |
ShowResults | Updates the model to reflect the result of an edit to the model for all builders that support showing results. |
StoreGraphInAfu | Stores graph objects in afu file |
Validate | Validate whether the inputs to the component are sufficient for commit to be called. |
Property Detail¶
Link¶
-
LoadTransferBuilder.
Link
¶ Returns the link
-------------------------------------
Getter Method
Signature
Link
Returns: NXOpen.SelectObjectList
contains link or link geometriesReturn type: NXOpen.SelectNXObjectList
New in version NX9.0.0.
License requirements: mechanisms (“MECHANISMS”)
VectorScale¶
-
LoadTransferBuilder.
VectorScale
¶ Returns or sets the vector scale
-------------------------------------
Getter Method
Signature
VectorScale
Returns: Return type: float New in version NX9.0.0.
License requirements: mechanisms (“MECHANISMS”)
-------------------------------------
Setter Method
Signature
VectorScale
Parameters: vectorScale (float) – New in version NX9.0.0.
License requirements: mechanisms (“MECHANISMS”)
Method Detail¶
CreateGraphObjects¶
-
LoadTransferBuilder.
CreateGraphObjects
¶ Creates graph objects
Signature
CreateGraphObjects()
Returns: The NXOpen.Motion.Graph
object arrayReturn type: list of NXOpen.Motion.Graph
New in version NX9.0.0.
License requirements: mechanisms (“MECHANISMS”)
GetRecordedSteps¶
-
LoadTransferBuilder.
GetRecordedSteps
¶ Returns recorded steps
Signature
GetRecordedSteps()
Returns: Return type: list of int New in version NX9.0.0.
License requirements: mechanisms (“MECHANISMS”)
SetRecordedSteps¶
-
LoadTransferBuilder.
SetRecordedSteps
¶ Sets recorded steps
Signature
SetRecordedSteps(steps)
Parameters: steps (list of int) – New in version NX9.0.0.
License requirements: mechanisms (“MECHANISMS”)
StoreGraphInAfu¶
-
LoadTransferBuilder.
StoreGraphInAfu
¶ Stores graph objects in afu file
Signature
StoreGraphInAfu(afu)
Parameters: afu (str) – The name of the AFU file to store the graph results New in version NX9.0.0.
License requirements: mechanisms (“MECHANISMS”)
Validate¶
-
LoadTransferBuilder.
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.