nxopen.routing

Interface OffsetPath

All Superinterfaces:

INXObject, IPath, NXObject, Remote, TaggedObject

public interface OffsetPath
extends NXObject, IPath

The Routing OffsetPath object is the set of information needed to define an offset route.
To obtain an instance of this class use OffsetPathCollection

Created in NX4.0.0

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static class	OffsetPath.OffsetReferenceAxesData This class holds the data returned from getOffsetReferenceAxes()

Nested classes/interfaces inherited from interface nxopen.NXObject

NXObject.AttributeInformation, NXObject.AttributeType, NXObject.ComputationalTime, NXObject.DateAndTimeFormat

Method Summary

Modifier and Type	Method and Description
double	bendRadius() Returns the bend radius for an offset object.
double	bendRatio() Returns the bend ratio for an offset object.
boolean	copyCornerFlag() Returns the copy corner flag for an offset object.
IPath	getMasterPath() The master path object for this offset object.
IPath[]	getOffsetPaths() Returns the list of all of the offset paths for a master path License requirements: routing_advanced ("Routing Advanced"), routing_base ("Routing Basic") .
ISegment[]	getOffsetPathSegments() The path segments for an offset object.
OffsetPath.OffsetReferenceAxesData	getOffsetReferenceAxes() The reference axes for an offset object.
boolean	isMaster() Returns the isMaster state for this offset object.
boolean	isSlave() Returns the isSlave state for this offset object.
boolean	maintainStockFlag() Returns the use maintain stock flag for an offset object.
Vector3d	offsetVector() Returns the vector for an offset object.
void	removePathAssociativityFromParent() Breaks the associativity of a child ( slave ) path to its parent ( master ) path.
void	removePathAssociativityToImmediateChildren() Breaks the associativity of a parent ( master ) path to its immediate children ( slave ) paths.
void	setBendRadius(double radius) License requirements: routing_advanced ("Routing Advanced"), routing_base ("Routing Basic") .
void	setBendRatio(double ratio) License requirements: routing_advanced ("Routing Advanced"), routing_base ("Routing Basic") .
void	setCopyCornerFlag(boolean copyCorner) License requirements: routing_advanced ("Routing Advanced"), routing_base ("Routing Basic") .
void	setMaintainStockFlag(boolean maintainStock) License requirements: routing_advanced ("Routing Advanced"), routing_base ("Routing Basic") .
void	setMaster(boolean masterState) License requirements: routing_advanced ("Routing Advanced"), routing_base ("Routing Basic") .
void	setMasterPath(IPath masterPath) The master path object for this offset object.
void	setOffsetPathSegments(ISegment[] segments) The path segments for an offset object.
void	setOffsetReferenceAxes(Point3d orgin, Vector3d xVector, Vector3d yVector) The reference axes for an offset object.
void	setOffsetVector(Vector3d vector) License requirements: routing_advanced ("Routing Advanced"), routing_base ("Routing Basic") .
void	setSlave(boolean masterState) License requirements: routing_advanced ("Routing Advanced"), routing_base ("Routing Basic") .
void	setUseBendRatio(boolean ratioState) License requirements: routing_advanced ("Routing Advanced"), routing_base ("Routing Basic") .
boolean	useBendRatio() Returns the use bend ratio flag for an offset object.

Methods inherited from interface nxopen.NXObject

deleteAllAttributesByType, deleteAllAttributesByType, deleteAttributeByTypeAndTitle, deleteAttributeByTypeAndTitle, deleteUserAttribute, deleteUserAttributes, getAttributeTitlesByType, getBooleanUserAttribute, getComputationalTimeUserAttribute, getIntegerAttribute, getIntegerUserAttribute, getRealAttribute, getRealUserAttribute, getReferenceAttribute, getStringAttribute, getStringUserAttribute, getTimeAttribute, getTimeUserAttribute, getUserAttribute, getUserAttribute, getUserAttributeAsString, getUserAttributeCount, getUserAttributeCount, getUserAttributeLock, getUserAttributes, getUserAttributes, getUserAttributes, getUserAttributesAsStrings, getUserAttributeSize, getUserAttributeSourceObjects, hasUserAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setBooleanUserAttribute, setReferenceAttribute, setReferenceAttribute, setTimeAttribute, setTimeAttribute, setTimeUserAttribute, setTimeUserAttribute, setUserAttribute, setUserAttribute, setUserAttribute, setUserAttribute, setUserAttribute, setUserAttributeLock

Methods inherited from interface nxopen.TaggedObject

printTestData, printTestData, tag, tagValue

Methods inherited from interface nxopen.routing.IPath

addSegmentsToList, controlPointEnd, controlPointStart, delSegmentsFromList, getSegmentList, setControlPointEnd, setControlPointStart

Methods inherited from interface nxopen.INXObject

findObject, isOccurrence, journalIdentifier, name, owningComponent, owningPart, print, prototype, setName

Method Detail

getOffsetPathSegments

ISegment[] getOffsetPathSegments()
                          throws NXException,
                                 RemoteException

The path segments for an offset object.
License requirements: routing_advanced ("Routing Advanced"), routing_base ("Routing Basic")

Created in NX4.0.0

Returns:

segment list for the offset object

Throws:

NXException

RemoteException

setOffsetPathSegments

void setOffsetPathSegments(ISegment[] segments)
                    throws NXException,
                           RemoteException

The path segments for an offset object.
License requirements: routing_advanced ("Routing Advanced"), routing_base ("Routing Basic")

Created in NX4.0.0

Parameters:

segments - segment list for the offset object

Throws:

NXException

RemoteException

offsetVector

Vector3d offsetVector()
               throws NXException,
                      RemoteException

Returns the vector for an offset object.
License requirements: routing_advanced ("Routing Advanced"), routing_base ("Routing Basic")

Created in NX4.0.0

Returns:

vector for the offset object

Throws:

NXException

RemoteException

setOffsetVector

void setOffsetVector(Vector3d vector)
              throws NXException,
                     RemoteException

License requirements: routing_advanced ("Routing Advanced"), routing_base ("Routing Basic")
.
Created in NX4.0.0

Parameters:

vector - vector for the offset object

Throws:

NXException

RemoteException

getOffsetReferenceAxes

OffsetPath.OffsetReferenceAxesData getOffsetReferenceAxes()
                                                   throws NXException,
                                                          RemoteException

The reference axes for an offset object.
License requirements: routing_advanced ("Routing Advanced"), routing_base ("Routing Basic")

Created in NX4.0.0

Throws:

NXException

RemoteException

setOffsetReferenceAxes

void setOffsetReferenceAxes(Point3d orgin,
                            Vector3d xVector,
                            Vector3d yVector)
                     throws NXException,
                            RemoteException

The reference axes for an offset object.
License requirements: routing_advanced ("Routing Advanced"), routing_base ("Routing Basic")

Created in NX4.0.0

Parameters:

orgin - origin for the offset object

xVector - X reference axes for the offset object

yVector - Y reference axes for the offset object

Throws:

NXException

RemoteException

getOffsetPaths

IPath[] getOffsetPaths()
                throws NXException,
                       RemoteException

Returns the list of all of the offset paths for a master path
License requirements: routing_advanced ("Routing Advanced"), routing_base ("Routing Basic")
.
Created in NX4.0.0

Returns:

list of all of the offset paths in this master object

Throws:

NXException

RemoteException

getMasterPath

IPath getMasterPath()
             throws NXException,
                    RemoteException

The master path object for this offset object.
License requirements: routing_advanced ("Routing Advanced"), routing_base ("Routing Basic")

Created in NX4.0.0

Returns:

master path for this offset object

Throws:

NXException

RemoteException

setMasterPath

void setMasterPath(IPath masterPath)
            throws NXException,
                   RemoteException

The master path object for this offset object.
License requirements: routing_advanced ("Routing Advanced"), routing_base ("Routing Basic")

Created in NX4.0.0

Parameters:

masterPath - master path for this offset object

Throws:

NXException

RemoteException

isMaster

boolean isMaster()
          throws NXException,
                 RemoteException

Returns the isMaster state for this offset object.
License requirements: routing_advanced ("Routing Advanced"), routing_base ("Routing Basic")

Created in NX4.0.0

Returns:

the state of the offset path object

Throws:

NXException

RemoteException

setMaster

void setMaster(boolean masterState)
        throws NXException,
               RemoteException

License requirements: routing_advanced ("Routing Advanced"), routing_base ("Routing Basic")
.
Created in NX4.0.0

Parameters:

masterState - the state of the offset path object

Throws:

NXException

RemoteException

isSlave

boolean isSlave()
         throws NXException,
                RemoteException

Returns the isSlave state for this offset object.
License requirements: routing_advanced ("Routing Advanced"), routing_base ("Routing Basic")

Created in NX4.0.0

Throws:

NXException

RemoteException

setSlave

void setSlave(boolean masterState)
       throws NXException,
              RemoteException

License requirements: routing_advanced ("Routing Advanced"), routing_base ("Routing Basic")
.
Created in NX4.0.0

Parameters:

masterState - the state of the offset path object

Throws:

NXException

RemoteException

bendRadius

double bendRadius()
           throws NXException,
                  RemoteException

Returns the bend radius for an offset object.
License requirements: routing_advanced ("Routing Advanced"), routing_base ("Routing Basic")

Created in NX4.0.0

Throws:

NXException

RemoteException

setBendRadius

void setBendRadius(double radius)
            throws NXException,
                   RemoteException

License requirements: routing_advanced ("Routing Advanced"), routing_base ("Routing Basic")
.
Created in NX4.0.0

Parameters:

radius -

Throws:

NXException

RemoteException

bendRatio

double bendRatio()
          throws NXException,
                 RemoteException

Returns the bend ratio for an offset object.
License requirements: routing_advanced ("Routing Advanced"), routing_base ("Routing Basic")

Created in NX4.0.0

Throws:

NXException

RemoteException

setBendRatio

void setBendRatio(double ratio)
           throws NXException,
                  RemoteException

License requirements: routing_advanced ("Routing Advanced"), routing_base ("Routing Basic")
.
Created in NX4.0.0

Parameters:

ratio -

Throws:

NXException

RemoteException

useBendRatio

boolean useBendRatio()
              throws NXException,
                     RemoteException

Returns the use bend ratio flag for an offset object.
License requirements: routing_advanced ("Routing Advanced"), routing_base ("Routing Basic")

Created in NX4.0.0

Throws:

NXException

RemoteException

setUseBendRatio

void setUseBendRatio(boolean ratioState)
              throws NXException,
                     RemoteException

License requirements: routing_advanced ("Routing Advanced"), routing_base ("Routing Basic")
.
Created in NX4.0.0

Parameters:

ratioState -

Throws:

NXException

RemoteException

copyCornerFlag

boolean copyCornerFlag()
                throws NXException,
                       RemoteException

Returns the copy corner flag for an offset object.
License requirements: routing_advanced ("Routing Advanced"), routing_base ("Routing Basic")

Created in NX4.0.0

Throws:

NXException

RemoteException

setCopyCornerFlag

void setCopyCornerFlag(boolean copyCorner)
                throws NXException,
                       RemoteException

License requirements: routing_advanced ("Routing Advanced"), routing_base ("Routing Basic")
.
Created in NX4.0.0

Parameters:

copyCorner -

Throws:

NXException

RemoteException

maintainStockFlag

boolean maintainStockFlag()
                   throws NXException,
                          RemoteException

Returns the use maintain stock flag for an offset object.
License requirements: routing_advanced ("Routing Advanced"), routing_base ("Routing Basic")

Created in NX4.0.0

Throws:

NXException

RemoteException

setMaintainStockFlag

void setMaintainStockFlag(boolean maintainStock)
                   throws NXException,
                          RemoteException

License requirements: routing_advanced ("Routing Advanced"), routing_base ("Routing Basic")
.
Created in NX4.0.0

Parameters:

maintainStock -

Throws:

NXException

RemoteException

removePathAssociativityToImmediateChildren

void removePathAssociativityToImmediateChildren()
                                         throws NXException,
                                                RemoteException

Breaks the associativity of a parent ( master ) path to its immediate children ( slave ) paths.
License requirements: routing_advanced ("Routing Advanced"), routing_base ("Routing Basic")

Created in NX5.0.0

Throws:

NXException

RemoteException

removePathAssociativityFromParent

void removePathAssociativityFromParent()
                                throws NXException,
                                       RemoteException

Breaks the associativity of a child ( slave ) path to its parent ( master ) path.
License requirements: routing_advanced ("Routing Advanced"), routing_base ("Routing Basic")

Created in NX5.0.0

Throws:

NXException

RemoteException