GraphBuilder Class¶
-
class
NXOpen.Motion.
GraphBuilder
¶ Bases:
NXOpen.Builder
Represents a
NXOpen.Motion.GraphBuilder
, only creation is supportedTo create a new instance of this class, use
NXOpen.Motion.GraphManager.CreateGraphBuilder()
New in version NX5.0.0.
Deprecated since version NX11.0.0: Use
Motion.GraphObjectBuilder
instead.
Properties¶
Property | Description |
---|---|
AfuFile | Returns or sets the afu file name |
Component | Returns or sets the component |
CoordinateSystemType | Returns or sets the csystype |
GraphTitle | Returns or sets the graph title |
Mode | Returns or sets the mode id |
ModeRequest | Returns or sets the mode request |
Object | Returns or sets the object selected from motion objects |
PlotEnable | Returns or sets the plot enable flag |
PlotStyle | Returns or sets the plot style choice |
Request | Returns or sets the request |
StoreEnable | Returns or sets the store enable flag |
Tag | Returns the Tag for this object. |
XAxisType | Returns or sets the x axis type |
XCurve | Returns the x curve |
Methods¶
Method | Description |
---|---|
AddYCurves | Add curves to the end of y curve list |
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. |
GetMotionObjects | Get the motion objects |
GetYCurves | Get the defined y curves |
MoveDownYCurves | Move down the curves in the y curve list by one step |
MoveUpYCurves | Move up the curves in the y curve list by one step |
RemoveYCurve | Remove the curve from the y curve list |
SetMotionObjects | Set the motion objects |
SetXCurve | Set x curve |
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¶
GraphBuilderComponentChoices Enumeration | Component attribute of the curve data. |
GraphBuilderCsysChoices Enumeration | Csys attribute of the curve data. |
GraphBuilderPlotStyleChoices Enumeration | Plot output type |
GraphBuilderRequestChoices Enumeration | Request attribute of the curve data. |
GraphBuilderXAxisTypeChoices Enumeration | X axis type choice. |
Structs¶
GraphBuilderCurveData_Struct Struct | Contains the structure of curve associated with curve data. |
Property Detail¶
AfuFile¶
-
GraphBuilder.
AfuFile
¶ Returns or sets the afu file name
-------------------------------------
Getter Method
Signature
AfuFile
Returns: Return type: str New in version NX5.0.0.
License requirements: mechanisms (“MECHANISMS”)
-------------------------------------
Setter Method
Signature
AfuFile
Parameters: fileName (str) – New in version NX5.0.0.
License requirements: mechanisms (“MECHANISMS”)
Component¶
-
GraphBuilder.
Component
¶ Returns or sets the component
-------------------------------------
Getter Method
Signature
Component
Returns: Return type: NXOpen.Motion.GraphBuilderComponentChoices
New in version NX5.0.0.
License requirements: mechanisms (“MECHANISMS”)
-------------------------------------
Setter Method
Signature
Component
Parameters: component ( NXOpen.Motion.GraphBuilderComponentChoices
) –New in version NX5.0.0.
License requirements: mechanisms (“MECHANISMS”)
CoordinateSystemType¶
-
GraphBuilder.
CoordinateSystemType
¶ Returns or sets the csystype
-------------------------------------
Getter Method
Signature
CoordinateSystemType
Returns: Return type: NXOpen.Motion.GraphBuilderCsysChoices
New in version NX5.0.0.
License requirements: mechanisms (“MECHANISMS”)
-------------------------------------
Setter Method
Signature
CoordinateSystemType
Parameters: coordinateSystemType ( NXOpen.Motion.GraphBuilderCsysChoices
) –New in version NX5.0.0.
License requirements: mechanisms (“MECHANISMS”)
GraphTitle¶
-
GraphBuilder.
GraphTitle
¶ Returns or sets the graph title
-------------------------------------
Getter Method
Signature
GraphTitle
Returns: Return type: str New in version NX5.0.0.
License requirements: mechanisms (“MECHANISMS”)
-------------------------------------
Setter Method
Signature
GraphTitle
Parameters: graphTitle (str) – New in version NX5.0.0.
License requirements: mechanisms (“MECHANISMS”)
Mode¶
-
GraphBuilder.
Mode
¶ Returns or sets the mode id
-------------------------------------
Getter Method
Signature
Mode
Returns: Return type: int New in version NX8.0.0.
License requirements: mechanisms (“MECHANISMS”)
-------------------------------------
Setter Method
Signature
Mode
Parameters: modeID (int) – New in version NX8.0.0.
License requirements: mechanisms (“MECHANISMS”)
ModeRequest¶
-
GraphBuilder.
ModeRequest
¶ Returns or sets the mode request
-------------------------------------
Getter Method
Signature
ModeRequest
Returns: Return type: NXOpen.Motion.GraphBuilderRequestChoices
New in version NX8.0.0.
License requirements: mechanisms (“MECHANISMS”)
-------------------------------------
Setter Method
Signature
ModeRequest
Parameters: modeRequest ( NXOpen.Motion.GraphBuilderRequestChoices
) –New in version NX8.0.0.
License requirements: mechanisms (“MECHANISMS”)
Object¶
-
GraphBuilder.
Object
¶ Returns or sets the object selected from motion objects
-------------------------------------
Getter Method
Signature
Object
Returns: Return type: NXOpen.NXObject
New in version NX5.0.0.
License requirements: mechanisms (“MECHANISMS”)
-------------------------------------
Setter Method
Signature
Object
Parameters: object ( NXOpen.NXObject
) –New in version NX5.0.0.
License requirements: mechanisms (“MECHANISMS”)
PlotEnable¶
-
GraphBuilder.
PlotEnable
¶ Returns or sets the plot enable flag
-------------------------------------
Getter Method
Signature
PlotEnable
Returns: Return type: bool New in version NX5.0.0.
License requirements: mechanisms (“MECHANISMS”)
-------------------------------------
Setter Method
Signature
PlotEnable
Parameters: plotEnable (bool) – New in version NX5.0.0.
License requirements: mechanisms (“MECHANISMS”)
PlotStyle¶
-
GraphBuilder.
PlotStyle
¶ Returns or sets the plot style choice
-------------------------------------
Getter Method
Signature
PlotStyle
Returns: Return type: NXOpen.Motion.GraphBuilderPlotStyleChoices
New in version NX5.0.0.
License requirements: mechanisms (“MECHANISMS”)
-------------------------------------
Setter Method
Signature
PlotStyle
Parameters: plotStyle ( NXOpen.Motion.GraphBuilderPlotStyleChoices
) –New in version NX5.0.0.
License requirements: mechanisms (“MECHANISMS”)
Request¶
-
GraphBuilder.
Request
¶ Returns or sets the request
-------------------------------------
Getter Method
Signature
Request
Returns: Return type: NXOpen.Motion.GraphBuilderRequestChoices
New in version NX5.0.0.
License requirements: mechanisms (“MECHANISMS”)
-------------------------------------
Setter Method
Signature
Request
Parameters: request ( NXOpen.Motion.GraphBuilderRequestChoices
) –New in version NX5.0.0.
License requirements: mechanisms (“MECHANISMS”)
StoreEnable¶
-
GraphBuilder.
StoreEnable
¶ Returns or sets the store enable flag
-------------------------------------
Getter Method
Signature
StoreEnable
Returns: Return type: bool New in version NX5.0.0.
License requirements: mechanisms (“MECHANISMS”)
-------------------------------------
Setter Method
Signature
StoreEnable
Parameters: storeEnable (bool) – New in version NX5.0.0.
License requirements: mechanisms (“MECHANISMS”)
XAxisType¶
-
GraphBuilder.
XAxisType
¶ Returns or sets the x axis type
-------------------------------------
Getter Method
Signature
XAxisType
Returns: Return type: NXOpen.Motion.GraphBuilderXAxisTypeChoices
New in version NX5.0.0.
License requirements: mechanisms (“MECHANISMS”)
-------------------------------------
Setter Method
Signature
XAxisType
Parameters: xAxisType ( NXOpen.Motion.GraphBuilderXAxisTypeChoices
) –New in version NX5.0.0.
License requirements: mechanisms (“MECHANISMS”)
XCurve¶
-
GraphBuilder.
XCurve
¶ Returns the x curve
-------------------------------------
Getter Method
Signature
XCurve
Returns: Return type: NXOpen.Motion.GraphBuilderCurveData_Struct
New in version NX5.0.0.
License requirements: mechanisms (“MECHANISMS”)
Method Detail¶
AddYCurves¶
-
GraphBuilder.
AddYCurves
¶ Add curves to the end of y curve list
Signature
AddYCurves(curves)
Parameters: curves (list of NXOpen.Motion.GraphBuilderCurveData_Struct
) –New in version NX5.0.0.
License requirements: mechanisms (“MECHANISMS”)
GetMotionObjects¶
-
GraphBuilder.
GetMotionObjects
¶ Get the motion objects
Signature
GetMotionObjects()
Returns: Return type: list of NXOpen.NXObject
New in version NX5.0.0.
License requirements: mechanisms (“MECHANISMS”)
GetYCurves¶
-
GraphBuilder.
GetYCurves
¶ Get the defined y curves
Signature
GetYCurves()
Returns: Return type: list of NXOpen.Motion.GraphBuilderCurveData_Struct
New in version NX5.0.0.
License requirements: mechanisms (“MECHANISMS”)
MoveDownYCurves¶
-
GraphBuilder.
MoveDownYCurves
¶ Move down the curves in the y curve list by one step
Signature
MoveDownYCurves(selectedIndices)
Parameters: selectedIndices (list of int) – a list of y curve indeces New in version NX5.0.0.
License requirements: mechanisms (“MECHANISMS”)
MoveUpYCurves¶
-
GraphBuilder.
MoveUpYCurves
¶ Move up the curves in the y curve list by one step
Signature
MoveUpYCurves(selectedIndices)
Parameters: selectedIndices (list of int) – a list of y curve indeces New in version NX5.0.0.
License requirements: mechanisms (“MECHANISMS”)
RemoveYCurve¶
-
GraphBuilder.
RemoveYCurve
¶ Remove the curve from the y curve list
Signature
RemoveYCurve(yCurve)
Parameters: yCurve ( NXOpen.Motion.GraphBuilderCurveData_Struct
) –New in version NX5.0.0.
License requirements: mechanisms (“MECHANISMS”)
SetMotionObjects¶
-
GraphBuilder.
SetMotionObjects
¶ Set the motion objects
Signature
SetMotionObjects(motionObjects)
Parameters: motionObjects (list of NXOpen.NXObject
) –New in version NX5.0.0.
License requirements: mechanisms (“MECHANISMS”)
SetXCurve¶
-
GraphBuilder.
SetXCurve
¶ Set x curve
Signature
SetXCurve(newCurve)
Parameters: newCurve ( NXOpen.Motion.GraphBuilderCurveData_Struct
) –New in version NX5.0.0.
License requirements: mechanisms (“MECHANISMS”)
Validate¶
-
GraphBuilder.
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.