NXOpen .NET Reference Guide  1899
 All Classes Namespaces Functions Variables Enumerations Enumerator Properties
Public Types | Public Member Functions | Properties | List of all members
NXOpen.GeometricUtilities.AlongPathPattern Class Reference

the AlongPath pattern definition. More...

Inheritance diagram for NXOpen.GeometricUtilities.AlongPathPattern:
NXOpen.TaggedObject NXOpen.GeometricUtilities.IComponentBuilder NXOpen.Utilities.NXRemotableObject IMessageSink

Public Types

enum  PathOptions { Rigid, Offset, Translate }
 This defines path options More...
 
enum  YDirectionOptions { Vector, Section }
 This defines y direction Types More...
 

Public Member Functions

unsafe bool Validate ()
 Validate whether the inputs to the component are sufficient for commit to be called. More...
 
- Public Member Functions inherited from NXOpen.TaggedObject
void PrintTestData (String variableName)
 <exclude> More...
 
void PrintTestData (String variableName, int lineNumber)
 <exclude> More...
 
override string ToString ()
 Returns a String that represents the current Object. More...
 
- Public Member Functions inherited from NXOpen.Utilities.NXRemotableObject
IMessageCtrl AsyncProcessMessage (IMessage msg, IMessageSink replySink)
 Asynchronously processes the given message. More...
 
IMessage SyncProcessMessage (IMessage msg)
 Synchronously processes the given message. More...
 

Properties

unsafe bool UseYDirectionToggle [get, set]
 Returns or sets the UseYDirection toggle attribute. More...
 
unsafe
NXOpen.GeometricUtilities.OnPathDistancePatternSpacing 
XOnPathSpacing [get]
 Returns the on path instance spacing along the x path More...
 
unsafe NXOpen.Section XPath [get, set]
 Returns or sets the x path More...
 
unsafe
NXOpen.GeometricUtilities.AlongPathPattern.PathOptions 
XPathOption [get, set]
 Returns or sets the x path options More...
 
unsafe NXOpen.Direction YDirection [get, set]
 Returns or sets the y axis, which can be any vector not parallel to the x axis More...
 
unsafe
NXOpen.GeometricUtilities.AlongPathPattern.YDirectionOptions 
YDirectionOption [get, set]
 Returns or sets the y direction options More...
 
unsafe
NXOpen.GeometricUtilities.OnPathDistancePatternSpacing 
YOnPathSpacing [get]
 Returns the on path instance spacing along the y path More...
 
unsafe NXOpen.Section YPath [get, set]
 Returns or sets the y path, which can be any continuous section More...
 
unsafe
NXOpen.GeometricUtilities.AlongPathPattern.PathOptions 
YPathOption [get, set]
 Returns or sets the y path options More...
 
unsafe
NXOpen.GeometricUtilities.DistancePatternSpacing 
YSpacing [get]
 Returns the instance spacing along the y axis More...
 
- Properties inherited from NXOpen.TaggedObject
Tag Tag [get]
 Returns the tag of this object. More...
 
- Properties inherited from NXOpen.Utilities.NXRemotableObject
IMessageSink NextSink [get]
 Gets the next message sink in the sink chain. More...
 

Additional Inherited Members

- Protected Member Functions inherited from NXOpen.TaggedObject
new void initialize ()
 <exclude> More...
 

Detailed Description

the AlongPath pattern definition.

Allows specification along two section pathes.

Created in NX7.5.0

Member Enumeration Documentation

This defines path options

Enumerator
Rigid 

path is the selected section.

Offset 

path is an offset from the selected path.

Translate 

path is a translation from the selected path.

This defines y direction Types

Enumerator
Vector 

y direction is a vector.

Section 

y direction is a section.

Member Function Documentation

unsafe bool NXOpen.GeometricUtilities.AlongPathPattern.Validate ( )
inline

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.

Created in NX3.0.1

License requirements: None.

Returns
Was self validation successful

Implements NXOpen.GeometricUtilities.IComponentBuilder.

Property Documentation

unsafe bool NXOpen.GeometricUtilities.AlongPathPattern.UseYDirectionToggle
getset

Returns or sets the UseYDirection toggle attribute.

This function gets the UseYDirection toggle value

Created in NX7.5.0

License requirements to get this property: None.

License requirements to set this property: None.

unsafe NXOpen.GeometricUtilities.OnPathDistancePatternSpacing NXOpen.GeometricUtilities.AlongPathPattern.XOnPathSpacing
get

Returns the on path instance spacing along the x path

Created in NX7.5.0

License requirements: None.

unsafe NXOpen.Section NXOpen.GeometricUtilities.AlongPathPattern.XPath
getset

Returns or sets the x path

Created in NX7.5.0

License requirements to get this property: None.

License requirements to set this property: None.

unsafe NXOpen.GeometricUtilities.AlongPathPattern.PathOptions NXOpen.GeometricUtilities.AlongPathPattern.XPathOption
getset

Returns or sets the x path options

Created in NX8.0.0

License requirements to get this property: None.

License requirements to set this property: None.

unsafe NXOpen.Direction NXOpen.GeometricUtilities.AlongPathPattern.YDirection
getset

Returns or sets the y axis, which can be any vector not parallel to the x axis

Created in NX7.5.0

License requirements to get this property: None.

License requirements to set this property: None.

unsafe NXOpen.GeometricUtilities.AlongPathPattern.YDirectionOptions NXOpen.GeometricUtilities.AlongPathPattern.YDirectionOption
getset

Returns or sets the y direction options

Created in NX7.5.0

License requirements to get this property: None.

License requirements to set this property: None.

unsafe NXOpen.GeometricUtilities.OnPathDistancePatternSpacing NXOpen.GeometricUtilities.AlongPathPattern.YOnPathSpacing
get

Returns the on path instance spacing along the y path

Created in NX7.5.0

License requirements: None.

unsafe NXOpen.Section NXOpen.GeometricUtilities.AlongPathPattern.YPath
getset

Returns or sets the y path, which can be any continuous section

Created in NX7.5.0

License requirements to get this property: None.

License requirements to set this property: None.

unsafe NXOpen.GeometricUtilities.AlongPathPattern.PathOptions NXOpen.GeometricUtilities.AlongPathPattern.YPathOption
getset

Returns or sets the y path options

Created in NX8.0.0

License requirements to get this property: None.

License requirements to set this property: None.

unsafe NXOpen.GeometricUtilities.DistancePatternSpacing NXOpen.GeometricUtilities.AlongPathPattern.YSpacing
get

Returns the instance spacing along the y axis

Created in NX7.5.0

License requirements: None.


The documentation for this class was generated from the following file:
Copyright 2019 Siemens Product Lifecycle Management Software Inc. All Rights Reserved.