GraphObjectBuilder Class¶
-
class
NXOpen.Motion.
GraphObjectBuilder
¶ Bases:
NXOpen.Motion.MotionBuilder
Represents a
NXOpen.Motion.GraphObjectBuilder
, only creation is supportedTo create a new instance of this class, use
NXOpen.Motion.GraphManager.CreateGraphObjectBuilder()
New in version NX11.0.0.
Properties¶
Property | Description |
---|---|
AdvancedSolutionObject | Returns or sets the advanced solution object who owns the graph object |
DisplayScale | Returns or sets the icon display scale |
GroupName | Returns or sets the group name |
GroupType | Returns or sets the group type |
ReferenceObject | Returns or sets the reference object of graph object |
SolutionObject | Returns or sets the solution object who owns the graph 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. |
FindEquivalent | Find an existing graph object that is equivalent to the request in 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. |
GetQuantityTypes | Returns the graph object quantity types and its values |
SetQuantityType | Sets a pair of quantity type and its value of graph 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. |
Property Detail¶
AdvancedSolutionObject¶
-
GraphObjectBuilder.
AdvancedSolutionObject
¶ Returns or sets the advanced solution object who owns the graph object
-------------------------------------
Getter Method
Signature
AdvancedSolutionObject
Returns: Return type: NXOpen.Motion.AdvancedSolution
New in version NX12.0.0.
License requirements: None.
-------------------------------------
Setter Method
Signature
AdvancedSolutionObject
Parameters: solutionObject ( NXOpen.Motion.AdvancedSolution
) –New in version NX12.0.0.
License requirements: mechanisms (“MECHANISMS”)
ReferenceObject¶
-
GraphObjectBuilder.
ReferenceObject
¶ Returns or sets the reference object of graph object
-------------------------------------
Getter Method
Signature
ReferenceObject
Returns: Return type: NXOpen.Motion.IGraphSource
New in version NX11.0.0.
License requirements: None.
-------------------------------------
Setter Method
Signature
ReferenceObject
Parameters: referObject ( NXOpen.Motion.IGraphSource
) –New in version NX11.0.0.
License requirements: mechanisms (“MECHANISMS”)
SolutionObject¶
-
GraphObjectBuilder.
SolutionObject
¶ Returns or sets the solution object who owns the graph object
-------------------------------------
Getter Method
Signature
SolutionObject
Returns: Return type: NXOpen.Motion.MotionSolution
New in version NX11.0.0.
License requirements: None.
-------------------------------------
Setter Method
Signature
SolutionObject
Parameters: solutionObject ( NXOpen.Motion.MotionSolution
) –New in version NX11.0.0.
License requirements: mechanisms (“MECHANISMS”)
Method Detail¶
FindEquivalent¶
-
GraphObjectBuilder.
FindEquivalent
¶ Find an existing graph object that is equivalent to the request in builder
Signature
FindEquivalent()
Returns: Return type: NXOpen.Motion.Graph
New in version NX11.0.0.
License requirements: mechanisms (“MECHANISMS”)
GetQuantityTypes¶
-
GraphObjectBuilder.
GetQuantityTypes
¶ Returns the graph object quantity types and its values
Signature
GetQuantityTypes()
Returns: a tuple Return type: A tuple consisting of (typeStrings, valueStrings) typeStrings is a list of str. valueStrings is a list of str. New in version NX11.0.0.
License requirements: None.
SetQuantityType¶
-
GraphObjectBuilder.
SetQuantityType
¶ Sets a pair of quantity type and its value of graph object
Signature
SetQuantityType(typeString, valueString)
Parameters: - typeString (str) –
- valueString (str) –
New in version NX11.0.0.
License requirements: mechanisms (“MECHANISMS”)
Validate¶
-
GraphObjectBuilder.
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.