AlongPathPattern Class¶
-
class
NXOpen.GeometricUtilities.
AlongPathPattern
¶ Bases:
NXOpen.TaggedObject
,NXOpen.GeometricUtilities.IComponentBuilder
the AlongPath pattern definition.
Allows specification along two section pathes. .. versionadded:: NX7.5.0
Properties¶
Property | Description |
---|---|
Tag | Returns the Tag for this object. |
UseYDirectionToggle | Returns or sets the UseYDirection toggle attribute. |
XOnPathSpacing | Returns the on path instance spacing along the x path |
XPath | Returns or sets the x path |
XPathOption | Returns or sets the x path options |
YDirection | Returns or sets the y axis, which can be any vector not parallel to the x axis |
YDirectionOption | Returns or sets the y direction options |
YOnPathSpacing | Returns the on path instance spacing along the y path |
YPath | Returns or sets the y path, which can be any continuous section |
YPathOption | Returns or sets the y path options |
YSpacing | Returns the instance spacing along the y axis |
Methods¶
Method | Description |
---|---|
Validate | Validate whether the inputs to the component are sufficient for commit to be called. |
Enumerations¶
AlongPathPatternPathOptions Enumeration | This defines path options |
AlongPathPatternYDirectionOptions Enumeration | This defines y direction Types |
Property Detail¶
UseYDirectionToggle¶
-
AlongPathPattern.
UseYDirectionToggle
¶ Returns or sets the UseYDirection toggle attribute.
This function gets the UseYDirection toggle value
-------------------------------------
Getter Method
Signature
UseYDirectionToggle()
Returns: Return type: bool New in version NX7.5.0.
License requirements: None.
-------------------------------------
Setter Method
Signature
UseYDirectionToggle(toggle)
Parameters: toggle (bool) – New in version NX7.5.0.
License requirements: None.
XOnPathSpacing¶
-
AlongPathPattern.
XOnPathSpacing
¶ Returns the on path instance spacing along the x path
-------------------------------------
Getter Method
Signature
XOnPathSpacing()
Returns: Return type: NXOpen.GeometricUtilities.OnPathDistancePatternSpacing
New in version NX7.5.0.
License requirements: None.
XPath¶
-
AlongPathPattern.
XPath
¶ Returns or sets the x path
-------------------------------------
Getter Method
Signature
XPath()
Returns: Return type: NXOpen.Section
New in version NX7.5.0.
License requirements: None.
-------------------------------------
Setter Method
Signature
XPath(xPath)
Parameters: xPath ( NXOpen.Section
) –New in version NX7.5.0.
License requirements: None.
XPathOption¶
-
AlongPathPattern.
XPathOption
¶ Returns or sets the x path options
-------------------------------------
Getter Method
Signature
XPathOption()
Returns: Return type: NXOpen.GeometricUtilities.AlongPathPatternPathOptions
New in version NX8.0.0.
License requirements: None.
-------------------------------------
Setter Method
Signature
XPathOption(xPathOption)
Parameters: xPathOption ( NXOpen.GeometricUtilities.AlongPathPatternPathOptions
) –New in version NX8.0.0.
License requirements: None.
YDirection¶
-
AlongPathPattern.
YDirection
¶ Returns or sets the y axis, which can be any vector not parallel to the x axis
-------------------------------------
Getter Method
Signature
YDirection()
Returns: Return type: NXOpen.Direction
New in version NX7.5.0.
License requirements: None.
-------------------------------------
Setter Method
Signature
YDirection(yDirection)
Parameters: yDirection ( NXOpen.Direction
) –New in version NX7.5.0.
License requirements: None.
YDirectionOption¶
-
AlongPathPattern.
YDirectionOption
¶ Returns or sets the y direction options
-------------------------------------
Getter Method
Signature
YDirectionOption()
Returns: Return type: NXOpen.GeometricUtilities.AlongPathPatternYDirectionOptions
New in version NX7.5.0.
License requirements: None.
-------------------------------------
Setter Method
Signature
YDirectionOption(yDirectionOption)
Parameters: yDirectionOption ( NXOpen.GeometricUtilities.AlongPathPatternYDirectionOptions
) –New in version NX7.5.0.
License requirements: None.
YOnPathSpacing¶
-
AlongPathPattern.
YOnPathSpacing
¶ Returns the on path instance spacing along the y path
-------------------------------------
Getter Method
Signature
YOnPathSpacing()
Returns: Return type: NXOpen.GeometricUtilities.OnPathDistancePatternSpacing
New in version NX7.5.0.
License requirements: None.
YPath¶
-
AlongPathPattern.
YPath
¶ Returns or sets the y path, which can be any continuous section
-------------------------------------
Getter Method
Signature
YPath()
Returns: Return type: NXOpen.Section
New in version NX7.5.0.
License requirements: None.
-------------------------------------
Setter Method
Signature
YPath(yPath)
Parameters: yPath ( NXOpen.Section
) –New in version NX7.5.0.
License requirements: None.
YPathOption¶
-
AlongPathPattern.
YPathOption
¶ Returns or sets the y path options
-------------------------------------
Getter Method
Signature
YPathOption()
Returns: Return type: NXOpen.GeometricUtilities.AlongPathPatternPathOptions
New in version NX8.0.0.
License requirements: None.
-------------------------------------
Setter Method
Signature
YPathOption(yPathOption)
Parameters: yPathOption ( NXOpen.GeometricUtilities.AlongPathPatternPathOptions
) –New in version NX8.0.0.
License requirements: None.
YSpacing¶
-
AlongPathPattern.
YSpacing
¶ Returns the instance spacing along the y axis
-------------------------------------
Getter Method
Signature
YSpacing()
Returns: Return type: NXOpen.GeometricUtilities.DistancePatternSpacing
New in version NX7.5.0.
License requirements: None.
Method Detail¶
Validate¶
-
AlongPathPattern.
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.