NX Open C++ Reference Guide
Public Types | Public Member Functions
NXOpen::GeometricUtilities::AlongPathPattern Class Reference

the AlongPath pattern definition. More...

Inheritance diagram for NXOpen::GeometricUtilities::AlongPathPattern:
NXOpen::TaggedObject NXOpen::GeometricUtilities::IComponentBuilder

List of all members.

Public Types

enum  PathOptions { PathOptionsRigid, PathOptionsOffset, PathOptionsTranslate }
 This defines path options. More...
enum  YDirectionOptions { YDirectionOptionsVector, YDirectionOptionsSection }
 This defines y direction Types. More...

Public Member Functions

void SetUseYDirectionToggle (bool toggle)
 Sets the UseYDirection toggle attribute.
void SetXPath (NXOpen::Section *xPath)
 Sets the x path
Created in NX7.5.0.
void SetXPathOption (NXOpen::GeometricUtilities::AlongPathPattern::PathOptions xPathOption)
 Sets the x path options
Created in NX8.0.0.
void SetYDirection (NXOpen::Direction *yDirection)
 Sets the y axis, which can be any vector not parallel to the x axis
Created in NX7.5.0.
void SetYDirectionOption (NXOpen::GeometricUtilities::AlongPathPattern::YDirectionOptions yDirectionOption)
 Sets the y direction options
Created in NX7.5.0.
void SetYPath (NXOpen::Section *yPath)
 Sets the y path, which can be any continuous section
Created in NX7.5.0.
void SetYPathOption (NXOpen::GeometricUtilities::AlongPathPattern::PathOptions yPathOption)
 Sets the y path options
Created in NX8.0.0.
bool UseYDirectionToggle ()
 Returns the UseYDirection toggle attribute.
virtual bool Validate ()
 Validate whether the inputs to the component are sufficient for commit to be called.
NXOpen::GeometricUtilities::OnPathDistancePatternSpacingXOnPathSpacing ()
 Returns the on path instance spacing along the x path
Created in NX7.5.0.
NXOpen::SectionXPath ()
 Returns the x path
Created in NX7.5.0.
NXOpen::GeometricUtilities::AlongPathPattern::PathOptions XPathOption ()
 Returns the x path options
Created in NX8.0.0.
NXOpen::DirectionYDirection ()
 Returns the y axis, which can be any vector not parallel to the x axis
Created in NX7.5.0.
NXOpen::GeometricUtilities::AlongPathPattern::YDirectionOptions YDirectionOption ()
 Returns the y direction options
Created in NX7.5.0.
NXOpen::GeometricUtilities::OnPathDistancePatternSpacingYOnPathSpacing ()
 Returns the on path instance spacing along the y path
Created in NX7.5.0.
NXOpen::SectionYPath ()
 Returns the y path, which can be any continuous section
Created in NX7.5.0.
NXOpen::GeometricUtilities::AlongPathPattern::PathOptions YPathOption ()
 Returns the y path options
Created in NX8.0.0.
NXOpen::GeometricUtilities::DistancePatternSpacingYSpacing ()
 Returns the instance spacing along the y axis
Created in NX7.5.0.

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:
PathOptionsRigid 

path is the selected section.

PathOptionsOffset 

path is an offset from the selected path.

PathOptionsTranslate 

path is a translation from the selected path.

This defines y direction Types.

Enumerator:
YDirectionOptionsVector 

y direction is a vector.

YDirectionOptionsSection 

y direction is a section.


Member Function Documentation

Sets the UseYDirection toggle attribute.

This function gets the UseYDirection toggle value
Created in NX7.5.0.

License requirements : None

Parameters:
toggletoggle

Sets the x path
Created in NX7.5.0.



License requirements : None

Parameters:
xPathxpath

Sets the x path options
Created in NX8.0.0.



License requirements : None

Parameters:
xPathOptionxpathoption

Sets the y axis, which can be any vector not parallel to the x axis
Created in NX7.5.0.



License requirements : None

Parameters:
yDirectionydirection

Sets the y direction options
Created in NX7.5.0.



License requirements : None

Parameters:
yDirectionOptionydirectionoption

Sets the y path, which can be any continuous section
Created in NX7.5.0.



License requirements : None

Parameters:
yPathypath

Sets the y path options
Created in NX8.0.0.



License requirements : None

Parameters:
yPathOptionypathoption

Returns the UseYDirection toggle attribute.

This function gets the UseYDirection toggle value
Created in NX7.5.0.

License requirements : None

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.

Returns:
Was self validation successful
Created in NX3.0.1.

License requirements : None

Implements NXOpen::GeometricUtilities::IComponentBuilder.

Returns the on path instance spacing along the x path
Created in NX7.5.0.



License requirements : None

Returns the x path
Created in NX7.5.0.



License requirements : None

Returns the x path options
Created in NX8.0.0.



License requirements : None

Returns the y axis, which can be any vector not parallel to the x axis
Created in NX7.5.0.



License requirements : None

Returns the y direction options
Created in NX7.5.0.



License requirements : None

Returns the on path instance spacing along the y path
Created in NX7.5.0.



License requirements : None

Returns the y path, which can be any continuous section
Created in NX7.5.0.



License requirements : None

Returns the y path options
Created in NX8.0.0.



License requirements : None

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 2011 Siemens Product Lifecycle Management Software Inc. All Rights Reserved.