Public Member Functions | Public Attributes | List of all members
Section Class Reference

Inherits ScriptObject.

Public Member Functions

Integer getId ()
 
PostPropertyMap::PropertyMap getOperationProperties ()
 
optional< StringgetStrategy ()
 
Integer getNumberOfRecords ()
 
Record getRecord (Integer id)
 
Integer getJobId ()
 
Integer getPatternId ()
 
Integer getNumberOfPatternInstances ()
 
Boolean isPatterned ()
 
Integer getChannel ()
 
Boolean getForceToolChange ()
 
Boolean isOptional ()
 
Integer getFirstCompensationOffset ()
 
Tool getTool ()
 
Integer getContent ()
 
Boolean isMultiAxis ()
 
Integer getUnit ()
 
Integer getType ()
 
Integer getMachiningType ()
 
Vector getPolarDirection ()
 
optional< BooleanisPolarRapidLinks ()
 
Integer getPolarMode ()
 
Integer getQuality ()
 
Integer getJetMode ()
 
Boolean getTailstock ()
 
Boolean getPartCatcher ()
 
Integer getSpindle ()
 
Integer getFeedMode ()
 
Number getToolOrientation ()
 
Vector getWorkOrigin ()
 
Matrix getWorkPlane ()
 
Boolean isXOriented ()
 
Boolean isYOriented ()
 
Boolean isZOriented ()
 
Boolean isTopWorkPlane ()
 
Vector getGlobalWorkOrigin ()
 
Matrix getGlobalWorkPlane ()
 
Integer getToolAxis ()
 
Vector getWCSOrigin ()
 
Matrix getWCSPlane ()
 
Vector getDynamicWCSOrigin ()
 
Matrix getDynamicWCSPlane ()
 
Vector getFCSOrigin ()
 
Matrix getFCSPlane ()
 
Vector getModelOrigin ()
 
Matrix getModelPlane ()
 
Vector getPartAttachPoint ()
 
Integer getWorkOffset ()
 
Integer getProbeWorkOffset ()
 
String getWCS ()
 
Integer getWCSIndex ()
 
Boolean hasDynamicWorkOffset ()
 
Integer getDynamicWorkOffset ()
 
Boolean getAxisSubstitution ()
 
Number getAxisSubstitutionRadius ()
 
Vector getGlobalPosition (Vector p)
 
Vector getWCSPosition (Vector p)
 
Vector getSectionPosition (Vector p)
 
Number getMaximumSpindleSpeed ()
 
Number getMaximumFeedrate ()
 
Number getCuttingDistance ()
 
Number getRapidDistance ()
 
Integer getMovements ()
 
Number getCycleTime ()
 
Integer getNumberOfCyclePoints ()
 
Range getZRange ()
 
Range getGlobalZRange ()
 
Range getGlobalRange (Vector direction)
 
BoundingBox getBoundingBox ()
 
BoundingBox getGlobalBoundingBox ()
 
BoundingBox getOptimizedBoundingBox (MachineConfiguration machine, Vector abc)
 
Boolean isCuttingMotionAwayFromRotary (Number distance, Number tolerance)
 
Boolean hasWellDefinedPosition ()
 
Vector getFirstPosition ()
 
Vector getInitialPosition ()
 
Vector getFinalPosition ()
 
Vector getInitialToolAxis ()
 
Vector getGlobalInitialToolAxis ()
 
Vector getInitialToolAxisABC ()
 
Vector getFinalToolAxis ()
 
Vector getFinalToolAxisABC ()
 
Vector getGlobalFinalToolAxis ()
 
Boolean getInitialSpindleOn ()
 
Number getInitialSpindleSpeed ()
 
Boolean getFinalSpindleOn ()
 
Number getFinalSpindleSpeed ()
 
Number getMaximumTilt ()
 
Vector getLowerToolAxisABC ()
 
Vector getUpperToolAxisABC ()
 
Boolean isOptimizedForMachine ()
 
Integer getOptimizedTCPMode ()
 
Boolean hasParameter (String name)
 
Value getParameter (String name, Value defaultValue)
 
Boolean hasCycle (String uri)
 
Boolean hasAnyCycle ()
 
Integer getNumberOfCyclesWithId (String uri)
 
Integer getNumberOfCycles ()
 
String getCycleId (Integer index)
 
String getFirstCycle ()
 
String getLastCycle ()
 
Boolean doesStartWithCycle (String uri)
 
Boolean doesEndWithCycle (String &_uri) noexcept
 
Boolean doesStartWithCycleIgnoringPositioning (String uri)
 
Boolean doesEndWithCycleIgnoringPositioning (String uri)
 
Boolean doesStrictCycle (String uri)
 
Boolean hasCycleParameter (Integer index, String name)
 
Value getCycleParameter (Integer index, String name)
 
 optimizeMachineAnglesByMachine (MachineConfiguration machine, Integer optimizeType)
 
 optimize3DPositionsByMachine (MachineConfiguration machine, Vector abc, Integer optimizeType)
 
Vector getABCByPreference (MachineConfiguration machine, Matrix orientation, Vector current, Integer controllingAxis, Integer type, Integer options)
 
Boolean doesToolpathFitWithinLimits (MachineConfiguration machine, Vector current)
 
Boolean checkGroup (Integer groups)
 

Public Attributes

Integer unit
 Specifies the original unit of the section (this may be different from the output unit).
 
Vector workOrigin
 The work origin in the WCS.
 
Matrix workPlane
 The work plane in the WCS.
 
Vector wcsOrigin
 The work coordinate system (WCS) origin.
 
Matrix wcsPlane
 The work coordinate system (WCS) plane.
 
Integer workOffset
 The work offset corresponding to the WCS.
 
Integer probeWorkOffset
 The work offset corresponding to the Probe WCS.
 
Integer wcsIndex
 The index used in the WCS.
 
String wcs
 The WCS.
 
Integer dynamicWorkOffset
 
Boolean axisSubstitution
 Specifies that the section uses axis substitution.
 
Number axisSubstitutionRadius
 Specifies the nominal axis substitution radius.
 
Integer type
 Specifies the type of the section (TYPE_MILLING, TYPE_TURNING, or TYPE_JET).
 
Integer quality
 Specifies the associated quality.
 
Boolean tailstock
 Specifies that tailstock is used.
 
Boolean partCatcher
 Specifies that part catcher should be activated if available.
 
Integer spindle
 Specifies the active spindle.
 
Map properties
 The operation properties.
 
String strategy
 Specifies the strategy type of the section.
 
Integer machiningType
 Specifies machining type for section (3-Axis, 5-Axis, Polar and so on).
 
Vector polarDirection
 User-specified polar direction for Polar machining type.
 
Boolean polarRapidLinks
 True if polar rapid links requested by user.
 
Integer polarMode
 Returns type of polar mode requested: in computer or in control.
 

Detailed Description

An NC section. A section is a group of NC data which shares the same work plane, tool, and related data.

Member Function Documentation

◆ checkGroup()

Boolean checkGroup ( Integer  groups)

Returns true if the toolpath belongs to one or several specific strategy groups.

Parameters
groupsThe group flags to be checked. The available group flags are:
  • STRATEGY_2D
  • STRATEGY_3D
  • STRATEGY_ROUGHING
  • STRATEGY_FINISHING
  • STRATEGY_MILLING
  • STRATEGY_TURNING
  • STRATEGY_JET
  • STRATEGY_ADDITIVE
  • STRATEGY_PROBING
  • STRATEGY_INSPECTION
  • STRATEGY_DRILLING
  • STRATEGY_HOLEMILLING
  • STRATEGY_THREAD
  • STRATEGY_SAMPLING
  • STRATEGY_ROTARY
  • STRATEGY_SECONDARYSPINDLE
  • STRATEGY_SURFACE
  • STRATEGY_CHECKSURFACE
  • STRATEGY_MULTIAXIS

The function can take more than one flag as argurments. e.g.

if (currentSection.checkGroup(STRATEGY_2D, STRATEGY_FINISHING)) {
...// check if the current operation startegy is a 2D finishing strategy
}
Since
r45615

◆ doesEndWithCycle()

Boolean doesEndWithCycle ( String _uri)
noexcept

Returns true if the given cycle is the last effective move within the section. E.g. if onLinear() would be called after onCycle() this method will return false. onParameter() and onComment() are ignored.

Since
r42100

◆ doesEndWithCycleIgnoringPositioning()

Boolean doesEndWithCycleIgnoringPositioning ( String  uri)

Returns true if the given cycle is the first effective move within the section ignoring positioning moves (ie. rapid and high feed moves). E.g. if onLinear() would be called before onCycle() this method will return false. onParameter(), onComment() and onDwell() are ignored.

Since
r42100

◆ doesStartWithCycle()

Boolean doesStartWithCycle ( String  uri)

Returns true if the given cycle is the first effective move within the section. E.g. if onLinear() would be called before onCycle() this method will return false. onParameter() and onComment() are ignored.

Since
r41184

◆ doesStartWithCycleIgnoringPositioning()

Boolean doesStartWithCycleIgnoringPositioning ( String  uri)

Returns true if the given cycle is the first effective move within the section ignoring positioning moves (ie. rapid and high feed moves). E.g. if onLinear() would be called before onCycle() this method will return false. onParameter(), onComment() and onDwell() are ignored.

Since
r41215

◆ doesStrictCycle()

Boolean doesStrictCycle ( String  uri)

Returns true if the given cycle is the only effective move within the section. onParameter() and onComment() are ignored.

Since
r41184

◆ doesToolpathFitWithinLimits()

Boolean doesToolpathFitWithinLimits ( MachineConfiguration  machine,
Vector  current 
)

Returns 'true' if the section's toolpath fits within the linear axis limits of the machine.

Parameters
machineThe machine configuration.
currentThe current machine angles.
Since
r45860

◆ getABCByPreference()

Vector getABCByPreference ( MachineConfiguration  machine,
Matrix  orientation,
Vector  current,
Integer  controllingAxis,
Integer  type,
Integer  options 
)

Returns the preferred ABC angles for the specified orientation such that the forward and optionally right directions are maintained. The preferences are defined in the 'controllingAxis', 'control', and 'options' parameters.

Parameters
machineThe machine configuration.
orientationThe desired orientation (work plane).
currentThe current machine angles.
controllingAxisThe axis used to determine the preferred solution. It can be A, B, C for a single axis or ABC to consider all axes.
typeThe preference type. PREFER_PREFERENCE - the preference specified in the createAxis definition. PREFER_CLOSEST- the closest solution. PREFER_POSITIVE - a positive angle. Not valid with ABC. PREFER_NEGATIVE - a negative angle. Not valid with ABC. PREFER_CW - axis moves in a clockwise direction. Not valid with ABC. PREFER_CCW - axis moves in a counter-clockwise direction. Not valid with ABC.
options- Options used to control the ABC selection. ENABLE_NONE - disables all options. ENABLE_RESET - respects the 'reset' parameter in the createAxis definition. ENABLE_WCS - solves for a rotary axis perpendicular to the spindle vector as defined by the tool orientation of the operation. ENABLE_LIMITS - solves for a rotary table perpendiculr to the spindle vector in order to keep the linear axes within the limits of the machine. ENABLE_ALL - enables all options (ENABLE_RESET, ENABLE_WCS, and ENABLE_LIMITS).
Since
r45860

◆ getAxisSubstitution()

Boolean getAxisSubstitution ( )

Returns true if the section uses axis substitution. In axis substitution mode the coordinates are the following meaning:

X: The offset along the substitution axis. Y: The rotation angle in radians. Z: Radius (always positive)

◆ getAxisSubstitutionRadius()

Number getAxisSubstitutionRadius ( )

Returns the nominal axis substitution radius.

◆ getBoundingBox()

BoundingBox getBoundingBox ( )

Returns the bounding box of the toolpath of the section.

◆ getChannel()

Integer getChannel ( )

Returns the channel ID. Sections with the same channel ID belongs to the same channel.

◆ getContent()

Integer getContent ( )

Returns the content flags.

◆ getCuttingDistance()

Number getCuttingDistance ( )

Returns the cutting distance for the section (excluding rapid traversal).

◆ getCycleId()

String getCycleId ( Integer  index)

Returns the ID of the given cycle within the section. Raises exception if index exceeds limit returned by Section.getNumberOfCycles().

Since
r41215

◆ getCycleParameter()

Value getCycleParameter ( Integer  index,
String  name 
)

Returns the value of the first occurrence of the specified parameter within the given cycle.

Parameters
indexThe index of the cycle.
nameThe name of the parameter.
Since
r41215

◆ getCycleTime()

Number getCycleTime ( )

Returns the cycle time for the cutting moves the section (rapid traversal is ignored).

◆ getDynamicWCSOrigin()

Vector getDynamicWCSOrigin ( )

Returns the dynamic origin of the WCS. Only use if the dynamic work offset is set.

◆ getDynamicWCSPlane()

Matrix getDynamicWCSPlane ( )

Returns the dynamic WCS plane. Only use if the dynamic work offset is set.

◆ getDynamicWorkOffset()

Integer getDynamicWorkOffset ( )

Returns the dynamic work offset for the WCS. The dynamic work offset is used to control the display coordinates.

◆ getFCSOrigin()

Vector getFCSOrigin ( )

Returns the origin of the fixture coordinate system (FCS).

Since
r40294

◆ getFCSPlane()

Matrix getFCSPlane ( )

Returns the fixture coordinate system (FCS) plane.

Since
r40294

◆ getFeedMode()

Integer getFeedMode ( )

Returns the feed mode. For multi-axis operations it will return the feedrate mode as defined in the machine configuration for multi-axis feedrates if TCP is not enabled. If TCP is enabled, then FEED_PER_MINUTE will be returned for multi-axis operations.

The available modes are:

  • FEED_PER_MINUTE
  • FEED_PER_REVOLUTION
  • FEED_INVERSE_TIME
  • FEED_DEGREES_MINUTE

◆ getFinalPosition()

Vector getFinalPosition ( )

Returns the final position for the section.

◆ getFinalSpindleOn()

Boolean getFinalSpindleOn ( )

Returns true if the spindle speed is on at the end of the section. Might be turned off due to final canned cycle.

Since
r42100

◆ getFinalSpindleSpeed()

Number getFinalSpindleSpeed ( )

Returns the final spindle speed which can be different from the tool spindle speed. Might be turned off due to final canned cycle.

Since
r42100

◆ getFinalToolAxis()

Vector getFinalToolAxis ( )

Returns the final tool axis for the section as the direction vector.

◆ getFinalToolAxisABC()

Vector getFinalToolAxisABC ( )

Returns the final tool axis machine angles for the section. The section must have been optimized for the machine using optimizeMachineAngles() or similar before called this method.

◆ getFirstCompensationOffset()

Integer getFirstCompensationOffset ( )

Returns the first active compensation for the section.

◆ getFirstCycle()

String getFirstCycle ( )

Returns the first cycle within the section. Returns empty string is no cycle occurs within the section.

Since
r41184

◆ getFirstPosition()

Vector getFirstPosition ( )

Returns the first position for the section. This method has been replaced by getInitialPosition().

Deprecated:

◆ getForceToolChange()

Boolean getForceToolChange ( )

Returns true if tool change should be forced.

◆ getGlobalBoundingBox()

BoundingBox getGlobalBoundingBox ( )

Returns the bounding box of the toolpath of the section in the global coordinate system.

◆ getGlobalFinalToolAxis()

Vector getGlobalFinalToolAxis ( )

Returns the final tool axis for the section in the WCS frame. Always returns the direction vector.

◆ getGlobalInitialToolAxis()

Vector getGlobalInitialToolAxis ( )

Returns the initial tool axis for the section in the WCS frame. Always returns the direction vector.

◆ getGlobalPosition()

Vector getGlobalPosition ( Vector  p)

Returns the global position for the specified local position.

◆ getGlobalRange()

Range getGlobalRange ( Vector  direction)

Returns the range of the toolpath of the section along the global direction.

Since
r39501

◆ getGlobalWorkOrigin()

Vector getGlobalWorkOrigin ( )

Returns the work origin in the global coordinate system (top view).

◆ getGlobalWorkPlane()

Matrix getGlobalWorkPlane ( )

Returns the work plane in the global coordinate system (top view).

◆ getGlobalZRange()

Range getGlobalZRange ( )

Returns the Z-coordinate range of the toolpath of the section in the global coordinate system.

◆ getId()

Integer getId ( )

Returns the zero-based id of the section.

◆ getInitialPosition()

Vector getInitialPosition ( )

Returns the initial position for the section.

◆ getInitialSpindleOn()

Boolean getInitialSpindleOn ( )

Returns true if the spindle speed is on initially. Might be turned off due to initial canned cycle when it starts with positioning moves.

Since
r41215

◆ getInitialSpindleSpeed()

Number getInitialSpindleSpeed ( )

Returns the initial spindle speed which can be different from the tool spindle speed. Might be turned off due to initial canned cycle.

Since
r41215

◆ getInitialToolAxis()

Vector getInitialToolAxis ( )

Returns the initial tool axis for the section as the direction vector.

◆ getInitialToolAxisABC()

Vector getInitialToolAxisABC ( )

Returns the initial tool axis machine angles for the section. The section must have been optimized for the machine using optimizeMachineAngles() or similar before called this method.

◆ getJetMode()

Integer getJetMode ( )

Returns the type of waterjet, laser, and plasma cutting of the section.

The available modes are:

  • JET_MODE_THROUGH
  • JET_MODE_ETCHING
  • JET_MODE_VAPORIZE

◆ getJobId()

Integer getJobId ( )

Returns the job id of the section.

◆ getLastCycle()

String getLastCycle ( )

Returns the last cycle within the section. Returns empty string is no cycle occurs within the section.

Since
r42100

◆ getLowerToolAxisABC()

Vector getLowerToolAxisABC ( )

Returns the upper machine angles for a multi-axis section. The section must have been optimized for the machine using optimizeMachineAngles() or similar before called this method.

◆ getMachiningType()

Integer getMachiningType ( )

Returns machining type of the section

The available types are:

  • MACHINING_TYPE_UNDEFINED
  • MACHINING_TYPE_3AXIS
  • MACHINING_TYPE_POLAR
  • MACHINING_TYPE_4AXIS
  • MACHINING_TYPE_5AXIS

◆ getMaximumFeedrate()

Number getMaximumFeedrate ( )

Returns the maximum feedrate for the section.

◆ getMaximumSpindleSpeed()

Number getMaximumSpindleSpeed ( )

Returns the maximum spindle speed for the section.

◆ getMaximumTilt()

Number getMaximumTilt ( )

Returns the maximum tilt in the range [-1; 1] for the given multi-axis section. 1 corresponds to 0deg tilt. -1 corresponds to 180deg tilt.

◆ getModelOrigin()

Vector getModelOrigin ( )

Returns the origin of the Model coordinate system.

Since
r42226

◆ getModelPlane()

Matrix getModelPlane ( )

Returns the Model coordinate system plane.

Since
r42226

◆ getMovements()

Integer getMovements ( )

Returns the movements (as a mask) in use for the section.

if (currentSection.getMovements() & (1 << MOVEMENT_CUTTING)) {
// cutting move is present in section
}
if (currentSection.getMovements() & (1 << MOVEMENT_LEAD_IN)) {
// lead in is present in section
}

◆ getNumberOfCyclePoints()

Integer getNumberOfCyclePoints ( )

Returns the number of cycle points for the entire section.

◆ getNumberOfCycles()

Integer getNumberOfCycles ( )

Returns the number cycles within the section.

Since
r41215

◆ getNumberOfCyclesWithId()

Integer getNumberOfCyclesWithId ( String  uri)

Returns the number of times the given cycle occurs within the section.

Since
r41215

◆ getNumberOfPatternInstances()

Integer getNumberOfPatternInstances ( )

Returns the number of pattern instances for the section.

◆ getNumberOfRecords()

Integer getNumberOfRecords ( )

Returns the number of records in the section.

◆ getOperationProperties()

PostPropertyMap::PropertyMap getOperationProperties ( )

Returns the operation property map.

◆ getOptimizedBoundingBox()

BoundingBox getOptimizedBoundingBox ( MachineConfiguration  machine,
Vector  abc 
)

Returns the bounding box of the toolpath of the section in the coordinate system optimized for the rotary axes.

Parameters
machineThe machine configuration.
abcThe rotary axis positions.
Since
r45861

◆ getOptimizedTCPMode()

Integer getOptimizedTCPMode ( )

Returns the TCP mode used for the section when it was optimized for a machine configuration.

◆ getParameter()

Value getParameter ( String  name,
Value  defaultValue 
)

Returns the value of the first occurrence of the specified parameter.

Parameters
nameThe name of the parameter to return.
defaultValue(optional, since r45615) The default value of the parameter to return if it is not defined.

◆ getPartAttachPoint()

Vector getPartAttachPoint ( )

Returns the part attach point in the world coordinate system. The return position is undefined if the machine configuration does not use a machine simulation model.

Since
r45964

◆ getPartCatcher()

Boolean getPartCatcher ( )

Returns true if part catcher should be activated if available for turning.

◆ getPatternId()

Integer getPatternId ( )

Returns the pattern id of the section. You can use this to tell which sections are pattern instances of the same original section. The motion coordinates will be identical for patterned sections but the work plane can be different. Note that, the pattern ids can be different for some types of patterns when the actual motion coordinates are mapped.

Attention
By default the work origins are mapped to the WCS origin to simplify the post customization. This results in a displacement between the pattern instances. You can get the displacement by subtracting the initial section positions.
Returns
0 means that the section is not patterned.

◆ getPolarDirection()

Vector getPolarDirection ( )

Returns user-specified direction for polar machining type

◆ getPolarMode()

Integer getPolarMode ( )

Returns polar mode type

The available types are:

  • POLAR_MODE_OFF
  • POLAR_MODE_COMPUTER
  • POLAR_MODE_CONTROL

◆ getProbeWorkOffset()

Integer getProbeWorkOffset ( )

Returns the work offset for the WCS.

◆ getQuality()

Integer getQuality ( )

Returns the associated quality. Used for waterjet, laser, and plasma cutting.

◆ getRapidDistance()

Number getRapidDistance ( )

Returns the rapid traversal distance for the section.

◆ getRecord()

Record getRecord ( Integer  id)

Returns the specified record within the section.

Since
r41192

◆ getSectionPosition()

Vector getSectionPosition ( Vector  p)

Returns the local position for the specified global position.

◆ getSpindle()

Integer getSpindle ( )

Returns the active spindle.

The available values are:

  • SPINDLE_PRIMARY - The main/primary spindle.
  • SPINDLE_SECONDARY - The sub-spindle/secondary spindle.

◆ getStrategy()

optional< String > getStrategy ( )

Returns the strategy of the section.

◆ getTailstock()

Boolean getTailstock ( )

Returns true if tailstock is active for turning.

◆ getTool()

Tool getTool ( )

Returns the tool.

◆ getToolAxis()

Integer getToolAxis ( )

Returns the tool axis coordinate index (0:X, 1:Y, and 2:Z).

◆ getToolOrientation()

Number getToolOrientation ( )

Returns the turning tool orientation (radians).

◆ getType()

Integer getType ( )

Returns the type of the section.

The available types are:

  • TYPE_MILLING
  • TYPE_TURNING
  • TYPE_WIRE
  • TYPE_JET

◆ getUnit()

Integer getUnit ( )

Returns the original unit of the section. This may be different from the output unit.

The available values are:

  • IN - Inches
  • MM - Millimeters

◆ getUpperToolAxisABC()

Vector getUpperToolAxisABC ( )

Returns the upper machine angles for a multi-axis section. The section must have been optimized for the machine using optimizeMachineAngles() or similar before called this method.

◆ getWCS()

String getWCS ( )

Returns the WCS code string. If there is no WCS definition defined or the work offset is out of range, it will return an empty string.

◆ getWCSIndex()

Integer getWCSIndex ( )

Returns the WCS code index (without format). If there is no WCS definition defined or the work offset is out of range, it will return -1.

◆ getWCSOrigin()

Vector getWCSOrigin ( )

Returns the origin of the WCS.

◆ getWCSPlane()

Matrix getWCSPlane ( )

Returns the WCS plane.

◆ getWCSPosition()

Vector getWCSPosition ( Vector  p)

Returns the WCS position for the specified local position.

◆ getWorkOffset()

Integer getWorkOffset ( )

Returns the work offset for the WCS.

◆ getWorkOrigin()

Vector getWorkOrigin ( )

Returns the work origin in the WCS.

◆ getWorkPlane()

Matrix getWorkPlane ( )

Returns the work plane in the WCS.

◆ getZRange()

Range getZRange ( )

Returns the Z-coordinate range of the toolpath of the section.

◆ hasAnyCycle()

Boolean hasAnyCycle ( )

Returns true if the section has any cycle.

Since
r41184

◆ hasCycle()

Boolean hasCycle ( String  uri)

Returns true if the specified cycle occurs anywhere within the section.

Since
r41184

◆ hasCycleParameter()

Boolean hasCycleParameter ( Integer  index,
String  name 
)

Returns true if the specified parameter has been defined in the given cycle.

Parameters
indexThe index of the cycle.
nameThe name of the parameter.
Since
r41215

◆ hasDynamicWorkOffset()

Boolean hasDynamicWorkOffset ( )

Returns true if the dynamic work offset is defined.

◆ hasParameter()

Boolean hasParameter ( String  name)

Returns true if the specified parameter has been defined in the section.

◆ hasWellDefinedPosition()

Boolean hasWellDefinedPosition ( )

Returns true if the section has a well-defined position. Sections with no position would cause getInitialPosition() and getFinalPosition() to fail.

Since
r41192

◆ isCuttingMotionAwayFromRotary()

Boolean isCuttingMotionAwayFromRotary ( Number  distance,
Number  tolerance 
)

Returns true if the milling motion for the section is further away from X0 Y0 than the given distance. Can be used to check if motion gets close to the rotary axis for XZC milling.

Parameters
distanceThe minimum allowed distance from motion to X0 Y0.
toleranceTolerance used to linearize toolpath.
Returns
Returns false for non-milling toolpath.
Since
r41324

◆ isMultiAxis()

Boolean isMultiAxis ( )

Returns true is the section contains multi-axis toolpath.

◆ isOptimizedForMachine()

Boolean isOptimizedForMachine ( )

Returns true if the section has been optimized for a machine configuration.

◆ isOptional()

Boolean isOptional ( )

Returns true if the section is optional.

◆ isPatterned()

Boolean isPatterned ( )

Returns true if the section is patterned. Ie. at least one other section shares the same pattern id.

◆ isPolarRapidLinks()

optional< Boolean > isPolarRapidLinks ( )

Returns true, if rapid polar links should be used, false - for linear rapid links, undefined - if not specified (Fusion assumes they are linear)

◆ isTopWorkPlane()

Boolean isTopWorkPlane ( )

Returns true if the work plane is set to the top plane (i.e. looking down the Z-axis) in the WCS.

This method has been deprecated. See isZOriented() instead.

◆ isXOriented()

Boolean isXOriented ( )

Returns true if the work plane is oriented such that forward is along the +X in the WCS.

The same as checking "currentSection.workPlane.forward.x >= (1 - EPSILON)".

◆ isYOriented()

Boolean isYOriented ( )

Returns true if the work plane is oriented such that forward is along the +Y in the WCS.

The same as checking "currentSection.workPlane.forward.y >= (1 - EPSILON)".

◆ isZOriented()

Boolean isZOriented ( )

Returns true if the work plane is oriented such that forward is along the +Z in the WCS.

The same as checking "currentSection.workPlane.forward.z >= (1 - EPSILON)".

◆ optimize3DPositionsByMachine()

optimize3DPositionsByMachine ( MachineConfiguration  machine,
Vector  abc,
Integer  optimizeType 
)

Adjusts the tool end points for the rotary axes positions in 3+2 operations for the active machine configuration.

The directions for onRapid(), onLinear(), onCyclePoint(), and onCircular() are hereafter mapped according to the input rotary axis angles.

Parameters
machineThe machine configuration.
abcThe rotary axis positions.
optimizeTypeCan be one of the following. OPTIMIZE_NONE: Maintain tool tip position (TCPM). OPTIMIZE_BOTH: Adjust for tables and heads OPTIMIZE_TABLES: Adjust for tables only. OPTIMIZE_HEADS: Adjust for heads only. OPTIMIZE_AXIS: Adjust per axis definition.

◆ optimizeMachineAnglesByMachine()

optimizeMachineAnglesByMachine ( MachineConfiguration  machine,
Integer  optimizeType 
)

Optimizes the machine angles for 5-axis motion given the specified machine configuration.

The directions for onRapid5D() and onLinear5D() are hereafter mapped to machine angles from the initial direction vector. The work plane and origin are mapped into the WCS plane and origin.

Parameters
machineThe machine configuration.
optimizeType0 = TCP, 1 = adjust for tables and heads, 2 = adjust for tables, 3 = adjust for heads, 4 = adjust per axis definition.

Member Data Documentation

◆ dynamicWorkOffset

Integer dynamicWorkOffset

The dynamic work offset corresponding to the WCS used for controlling the display coordinates.



Generated by Autodesk, Inc. 19 April 2024
Copyright (c) 2012-2024 by Autodesk, Inc.