PatternClockingBuilder Class¶
-
class
NXOpen.GeometricUtilities.
PatternClockingBuilder
¶ Bases:
NXOpen.Builder
enables the ability to apply delta transforms on individual instances of a pattern within the pattern feature
To create a new instance of this class, use
NXOpen.GeometricUtilities.PatternDefinition.CreateClockingBuilder()
Default values.
Property Value Motion.DeltaEnum ReferenceWcsWorkPart Motion.DeltaXc.Value 0.0 Motion.DeltaYc.Value 0.0 Motion.DeltaZc.Value 0.0 New in version NX8.0.0.
Properties¶
Property | Description |
---|---|
AngularDelta | Returns the angular delta for circular clocking |
ClockType | Returns or sets the clocking enum to determine if linear or angular clocking |
Direction1Delta | Returns the x direction delta for linear clocking |
Direction2Delta | Returns the y direction delta for linear clocking |
Motion | Returns the user defined transform motion |
RadialDelta | Returns the radial delta for circular clocking |
Tag | Returns the Tag for this object. |
Methods¶
Method | Description |
---|---|
AddInstance | Adds an instance that will get this clocking |
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. |
RemoveInstance | Removes an instance from this clocking |
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¶
PatternClockingBuilderClockingType Enumeration | type of pattern clocking to transform individual instances |
Property Detail¶
AngularDelta¶
-
PatternClockingBuilder.
AngularDelta
¶ Returns the angular delta for circular clocking
-------------------------------------
Getter Method
Signature
AngularDelta()
Returns: Return type: NXOpen.Expression
New in version NX8.0.0.
License requirements: None.
ClockType¶
-
PatternClockingBuilder.
ClockType
¶ Returns or sets the clocking enum to determine if linear or angular clocking
-------------------------------------
Getter Method
Signature
ClockType()
Returns: Return type: NXOpen.GeometricUtilities.PatternClockingBuilderClockingType
New in version NX8.0.0.
License requirements: None.
-------------------------------------
Setter Method
Signature
ClockType(clockType)
Parameters: clockType ( NXOpen.GeometricUtilities.PatternClockingBuilderClockingType
) – clocking typeNew in version NX8.0.0.
License requirements: None.
Direction1Delta¶
-
PatternClockingBuilder.
Direction1Delta
¶ Returns the x direction delta for linear clocking
-------------------------------------
Getter Method
Signature
Direction1Delta()
Returns: Return type: NXOpen.Expression
New in version NX8.0.0.
License requirements: None.
Direction2Delta¶
-
PatternClockingBuilder.
Direction2Delta
¶ Returns the y direction delta for linear clocking
-------------------------------------
Getter Method
Signature
Direction2Delta()
Returns: Return type: NXOpen.Expression
New in version NX8.0.0.
License requirements: None.
Motion¶
-
PatternClockingBuilder.
Motion
¶ Returns the user defined transform motion
-------------------------------------
Getter Method
Signature
Motion()
Returns: Return type: NXOpen.GeometricUtilities.ModlMotion
New in version NX8.0.0.
License requirements: None.
RadialDelta¶
-
PatternClockingBuilder.
RadialDelta
¶ Returns the radial delta for circular clocking
-------------------------------------
Getter Method
Signature
RadialDelta()
Returns: Return type: NXOpen.Expression
New in version NX8.0.0.
License requirements: None.
Method Detail¶
AddInstance¶
-
PatternClockingBuilder.
AddInstance
¶ Adds an instance that will get this clocking
Signature
AddInstance(index1, index2)
Parameters: - index1 (int) – first index into the instance array to add clocking
- index2 (int) – second index into the instance array to add clocking
New in version NX8.0.0.
License requirements: None.
RemoveInstance¶
-
PatternClockingBuilder.
RemoveInstance
¶ Removes an instance from this clocking
Signature
RemoveInstance(index1, index2)
Parameters: - index1 (int) – first index into the instance array to drop this clocking
- index2 (int) – second index into the instance array to drop this clocking
New in version NX8.0.0.
License requirements: None.
Validate¶
-
PatternClockingBuilder.
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.