nxopen.geometricutilities

Interface HelixPattern

All Superinterfaces:

IComponentBuilder, Remote, TaggedObject

public interface HelixPattern
extends TaggedObject, IComponentBuilder

the Helix pattern definition. Allows specification along both the angular and radial directions.
Created in NX9.0.0

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static class	HelixPattern.DirectionTypes This defines helix direction method
static class	HelixPattern.SizeOptions defines Helix size options for Helix type pattern.

Method Summary

Modifier and Type	Method and Description
Expression	anglePitch() Returns the angle pitch expression for the Helix type pattern License requirements: None.
Expression	countOfInstances() Returns the count of instances for the Helix type pattern License requirements: None.
HelixPattern.DirectionTypes	directionType() Returns the type of helix direction method License requirements: None.
Expression	distancePitch() Returns the distance pitch expression for the Helix type pattern License requirements: None.
Expression	helixPitch() Returns the helix pitch expression for the Helix type pattern License requirements: None.
Expression	helixSpan() Returns the helix span expression for the Helix type pattern License requirements: None.
Expression	numberOfTurns() Returns the number of turns for the Helix type pattern License requirements: None.
Axis	rotationAxis() Returns the rotation axis for the pattern.
void	setDirectionType(HelixPattern.DirectionTypes directionType) License requirements: None.
void	setRotationAxis(Axis rotationAxis) License requirements: None.
void	setSizeOption(HelixPattern.SizeOptions option) License requirements: None.
HelixPattern.SizeOptions	sizeOption() Returns the Helix size option License requirements: None.

Methods inherited from interface nxopen.TaggedObject

printTestData, printTestData, tag, tagValue

Methods inherited from interface nxopen.geometricutilities.IComponentBuilder

validate

Method Detail

rotationAxis

Axis rotationAxis()
           throws NXException,
                  RemoteException

Returns the rotation axis for the pattern.
License requirements: None.

Created in NX9.0.0

Throws:

NXException

RemoteException

setRotationAxis

void setRotationAxis(Axis rotationAxis)
              throws NXException,
                     RemoteException

License requirements: None.

Created in NX9.0.0

Parameters:

rotationAxis -

Throws:

NXException

RemoteException

directionType

HelixPattern.DirectionTypes directionType()
                                   throws NXException,
                                          RemoteException

Returns the type of helix direction method
License requirements: None.

Created in NX9.0.0

Throws:

NXException

RemoteException

setDirectionType

void setDirectionType(HelixPattern.DirectionTypes directionType)
               throws NXException,
                      RemoteException

License requirements: None.

Created in NX9.0.0

Parameters:

directionType -

Throws:

NXException

RemoteException

sizeOption

HelixPattern.SizeOptions sizeOption()
                             throws NXException,
                                    RemoteException

Returns the Helix size option
License requirements: None.

Created in NX9.0.0

Throws:

NXException

RemoteException

setSizeOption

void setSizeOption(HelixPattern.SizeOptions option)
            throws NXException,
                   RemoteException

License requirements: None.

Created in NX9.0.0

Parameters:

option -

Throws:

NXException

RemoteException

countOfInstances

Expression countOfInstances()
                     throws NXException,
                            RemoteException

Returns the count of instances for the Helix type pattern
License requirements: None.

Created in NX9.0.0

Throws:

NXException

RemoteException

anglePitch

Expression anglePitch()
               throws NXException,
                      RemoteException

Returns the angle pitch expression for the Helix type pattern
License requirements: None.

Created in NX9.0.0

Throws:

NXException

RemoteException

distancePitch

Expression distancePitch()
                  throws NXException,
                         RemoteException

Returns the distance pitch expression for the Helix type pattern
License requirements: None.

Created in NX9.0.0

Throws:

NXException

RemoteException

helixPitch

Expression helixPitch()
               throws NXException,
                      RemoteException

Returns the helix pitch expression for the Helix type pattern
License requirements: None.

Created in NX9.0.0

Throws:

NXException

RemoteException

helixSpan

Expression helixSpan()
              throws NXException,
                     RemoteException

Returns the helix span expression for the Helix type pattern
License requirements: None.

Created in NX9.0.0

Throws:

NXException

RemoteException

numberOfTurns

Expression numberOfTurns()
                  throws NXException,
                         RemoteException

Returns the number of turns for the Helix type pattern
License requirements: None.

Created in NX9.0.0

Throws:

NXException

RemoteException