All Frameworks Class Hierarchy This Framework Indexes Previous Next

MachiningToolPathUseItf Interface DELIMfgTPCycleLinkingMotion

Usage: an implementation of this interface is supplied and you must use it as is. You should not reimplement it.

interface DELIMfgTPCycleLinkingMotion

Interface to manage linking motions between cycle location points.
This interface is available on object.
A linking motion has an index which is the number of relative cycle location point.
The linking motion index 'i' describes the linking traject between the cycle location point index 'i' and the cycle location point index 'i+1'.
The linking motion index '0' describes the approach traject to the first cycle location point.
The linking motion index 'N' with 'N' equal to the last cycle location point number is the retract traject from the last location point.
A linking motion can be composed of several 'polylines' (linear motions), 'circle arcs' (circular motions) and syntaxes.
If the linking motion index 'i' exists, it means that, in APT file, current CYCLE/ statement has to be stopped on cycle location point index 'i', that the linking motion has to be generated (with GOTO/,... statements) and a new CYCLE/ statement has to be generated on cycle location point index 'i+1'.

See also:

Method Index

o AddACircleArcSubMotion(int,CATUnicodeString&,CATUnicodeString&,CATListOfDouble&,CATListOfDouble&,CATListOfDouble&,CATMathVector&,CATMathPoint&,double): Adds a sub-motion describing a "Circle Arc" (circular motion).
o AddAPPCommandSubMotion(int,CATUnicodeString&,int): Adds a sub-motion describing a "PP command".
o AddAPolylineSubMotion(int,CATUnicodeString&,CATUnicodeString&,CATListOfDouble&,CATListOfDouble&,CATListOfDouble&): Adds a sub-motion describing a "Polyline" (set of linear motions).
o AddAUserSyntaxSubMotion(int,CATUnicodeString&): Adds a sub-motion describing a "user syntax".
o AddToolAxisInSubMotion(CATListOfDouble&,CATListOfDouble&,CATListOfDouble&): Adds tool axis on each point for a "Polyline" or a "Circle arc" for 5 Axis machining.
o AreThereLinkingMotions(): Retrieves if at least a location point owns linking sub-motions.
o GetCircleArcCharacteristics(int,int,CATUnicodeString&,CATListOfDouble&,CATListOfDouble&,CATListOfDouble&,CATMathVector&,CATMathPoint&,double&): Retrieves the characteristics of a "circle arc" sub-motion.
o GetCommandEvaluation(int,int,CATListValCATUnicodeString&): Evaluates syntax relative to a "PP command" sub-motion.
o GetNumberOfSubMotions(int,int&): Retrieves the number of linking sub-motions for a location point.
o GetPPCommandCharacteristics(int,int,CATUnicodeString&,int&): Retrieves the characteristics of a "PP command" sub-motion.
o GetPolylineCharacteristics(int,int,CATUnicodeString&,CATListOfDouble&,CATListOfDouble&,CATListOfDouble&): Retrieves the characteristics of a "polyline" sub-motion.
o GetSpecificFeedrate(int,int,DELIMfgToolPathFeedrate_var&): Retrieves the local feedrate stored on a sub-motion.
o GetSubMotionType(int,int,int&): Retrieves the type of a sub-motion.
o GetSymbolicFeedrate(int,int,CATUnicodeString&,double&): Retrieves the feedrate stored on a sub-motion.
o GetToolAxis(int,int,CATListOfDouble&,CATListOfDouble&,CATListOfDouble&): Retrieves the tool axis stored on a sub-motion.
o GetUserSyntaxCharacteristics(int,int,CATUnicodeString&): Retrieves the characteristics of a "User syntax" sub-motion.
o SetRatioOnFeedrate(int,int,double): Sets a ratio on the feedrate of a sub-motion.
o SetSpecificFeedrate(int,int,DELIMfgToolPathFeedrate_var&): Sets a local feedrate on a sub-motion.
o SetSymbolicFeedrate(int,int,CATUnicodeString&): Sets a symbolic feedrate on a sub-motion.

o SubMotionType: The type of sub-motion.

Methods

o AddACircleArcSubMotion

public virtual AddACircleArcSubMotion(		`iLocationPoint`,
	const	`iTrajectType`,
	const	`iFeedrateType`,
	const	`iX`,
	const	`iY`,
	const	`iZ`,
	const	`iNormal`,
	const	`iCenter`,
		`iRadius`)

Adds a sub-motion describing a "Circle Arc" (circular motion).

Parameters:

iLocationPoint

The index of location point
Legal values:

0 : approach traject to the first location point
last location point index : retract traject from the last location point
i : linking traject from the location point index i to the location point index i+1

iTrajectType

The type of traject
Legal values:

"TPApproachTraject" : approach traject
"TPMachiningTraject" : machining traject
"TPRetractTraject" : retract traject
"TPLinkingTraject" : linking traject
"TPBetweenPathTraject" : traject between path

iFeedrateType

The type of feedrate
Legal values:

"TPApproachFeedrate" : approach feedrate
"TPMachiningFeedrate": machining feedrate
"TPRetractFeedrate" : retract feedrate
"TPRapidFeedrate" : rapid feedrate
"TPFinishingFeedrate" : finishing feedrate
"TPChamferingFeedrate" : chamfering feedrate
"TPPlungeFeedrate" : plunge feedrate

iX,iY,iZ

The coordinates of tip points (discretization of the circle arc)

iNormal

The oriented normal to the plane containing the circle arc

iCenter

The center of the circle arc

iRadius

The radius of the circle arc.

o AddAPPCommandSubMotion

public virtual AddAPPCommandSubMotion(		`iLocationPoint`,
	const	`iPPCommand`,
		`iSequenceNumber`	`= 1`)

Adds a sub-motion describing a "PP command". A PP Syntax is a "NC Command" described in PP Table and evaluated from it during generation of APT file.

Parameters:

iLocationPoint

The index of location point
Legal values:

0 : approach traject to the first location point
last location point index : retract traject from the last location point
i : linking traject from the location point index i to the location point index i+1

iPPCommand

The name of "NC Command"

iSequenceNumber

The number of sequence in the PP Table

o AddAPolylineSubMotion

public virtual AddAPolylineSubMotion(		`iLocationPoint`,
	const	`iTrajectType`,
	const	`iFeedrateType`,
	const	`iX`,
	const	`iY`,
	const	`iZ`)

Adds a sub-motion describing a "Polyline" (set of linear motions).

Parameters:

iLocationPoint

The index of location point
Legal values:

0 : approach traject to the first location point
last location point index : retract traject from the last location point
i : linking traject from the location point index i to the location point index i+1

iTrajectType

The type of traject
Legal values:

"TPApproachTraject" : approach traject
"TPMachiningTraject" : machining traject
"TPRetractTraject" : retract traject
"TPLinkingTraject" : linking traject
"TPBetweenPathTraject" : traject between path

iFeedrateType

The type of feedrate
Legal values:

"TPApproachFeedrate" : approach feedrate
"TPMachiningFeedrate": machining feedrate
"TPRetractFeedrate" : retract feedrate
"TPRapidFeedrate" : rapid feedrate
"TPFinishingFeedrate" : finishing feedrate
"TPChamferingFeedrate" : chamfering feedrate
"TPPlungeFeedrate" : plunge feedrate

iX,iY,iZ

The coordinates of tip points

o AddAUserSyntaxSubMotion

public virtual AddAUserSyntaxSubMotion(		`iLocationPoint`,
	const	`iUserSyntax`)

Adds a sub-motion describing a "user syntax". A user syntax is a string generated as it is in APT file.

Parameters:

iLocationPoint

The index of location point
Legal values:

0 : approach traject to the first location point
last location point index : retract traject from the last location point
i : linking traject from the location point index i to the location point index i+1

iUserSyntax

The user syntax

o AddToolAxisInSubMotion

public virtual AddToolAxisInSubMotion(	const	`iX`,
	const	`iY`,
	const	`iZ`)

Adds tool axis on each point for a "Polyline" or a "Circle arc" for 5 Axis machining. This method should be called just after "AddAPolylineSubMotion" or "AddACircleArcSubMotion" in 5 Axis Machining.

Parameters:

iX,iY,iZ: The tool axis values

o AreThereLinkingMotions

public virtual AreThereLinkingMotions(

)

Retrieves if at least a location point owns linking sub-motions.

Returns:

The return code
Legal values:

0 : no location point owns linking sub-motions
>0 : at least one location point owns one or several linking sub-motions

o GetCircleArcCharacteristics

public virtual GetCircleArcCharacteristics(		`iLocationPoint`,
		`iSubMotion`,
		`oTrajectType`,
		`oX`,
		`oY`,
		`oZ`,
		`oNormal`,
		`oCenter`,
		`oRadius`)

Retrieves the characteristics of a "circle arc" sub-motion.

Parameters:

iLocationPoint

The index of location point
Legal values:

0 : approach traject to the first location point
last location point index : retract traject from the last location point
i : linking traject from the location point index i to the location point index i+1

iSubMotion

The index of sub-motion (must be a "circle arc" one)

oTrajectType

The type of traject
Legal values:

"TPApproachTraject" : approach traject
"TPMachiningTraject" : machining traject
"TPRetractTraject" : retract traject
"TPLinkingTraject" : linking traject
"TPBetweenPathTraject" : traject between path

oFeedrateType

The type of feedrate
Legal values:

"TPApproachFeedrate" : approach feedrate
"TPMachiningFeedrate": machining feedrate
"TPRetractFeedrate" : retract feedrate
"TPRapidFeedrate" : rapid feedrate
"TPFinishingFeedrate" : finishing feedrate
"TPChamferingFeedrate" : chamfering feedrate
"TPPlungeFeedrate" : plunge feedrate

oX,oY,oZ

The coordinates of tip points

oNormal

The oriented normal to the plane containing the circle arc

oCenter

The center of the circle arc

oRadius

The radius of the circle arc.

o GetCommandEvaluation

public virtual GetCommandEvaluation(		`iLocationPoint`,
		`iSubMotion`,
		`oSyntax`)

Evaluates syntax relative to a "PP command" sub-motion.

Parameters:

iLocationPoint

The index of location point
Legal values:

0 : approach traject to the first location point
last location point index : retract traject from the last location point
i : linking traject from the location point index i to the location point index i+1

iSubMotion

The index of sub-motion (must be a "PP command" one)

oSyntax

The value of syntax

o GetNumberOfSubMotions

public virtual GetNumberOfSubMotions(		`iLocationPoint`,
		`oNumberOfMotions`)

Retrieves the number of linking sub-motions for a location point.

Parameters:

iLocationPoint

The index of location point
Legal values:

0 : approach traject to the first location point
last location point index : retract traject from the last location point
i : linking traject from the location point index i to the location point index i+1

oNumberOfMotions

The number of linking sub-motions

o GetPPCommandCharacteristics

public virtual GetPPCommandCharacteristics(		`iLocationPoint`,
		`iSubMotion`,
		`oPPCommand`,
		`oSequenceNumber`)

Retrieves the characteristics of a "PP command" sub-motion.

Parameters:

iLocationPoint

The index of location point
Legal values:

0 : approach traject to the first location point
last location point index : retract traject from the last location point
i : linking traject from the location point index i to the location point index i+1

iSubMotion

The index of sub-motion (must be a "PP command" one)

oPPCommand

The name of "NC Command"

oSequenceNumber

The number of sequence in the PP Table

o GetPolylineCharacteristics

public virtual GetPolylineCharacteristics(		`iLocationPoint`,
		`iSubMotion`,
		`oTrajectType`,
		`oX`,
		`oY`,
		`oZ`)

Retrieves the characteristics of a "polyline" sub-motion.

Parameters:

iLocationPoint

The index of location point
Legal values:

0 : approach traject to the first location point
last location point index : retract traject from the last location point
i : linking traject from the location point index i to the location point index i+1

iSubMotion

The index of sub-motion (must be a "polyline" one)

oTrajectType

The type of traject
Legal values:

"TPApproachTraject" : approach traject
"TPMachiningTraject" : machining traject
"TPRetractTraject" : retract traject
"TPLinkingTraject" : linking traject
"TPBetweenPathTraject" : traject between path

oFeedrateType

The type of feedrate
Legal values:

"TPApproachFeedrate" : approach feedrate
"TPMachiningFeedrate": machining feedrate
"TPRetractFeedrate" : retract feedrate
"TPRapidFeedrate" : rapid feedrate
"TPFinishingFeedrate" : finishing feedrate
"TPChamferingFeedrate" : chamfering feedrate
"TPPlungeFeedrate" : plunge feedrate

oX,oY,oZ

The coordinates of tip points

o GetSpecificFeedrate

public virtual GetSpecificFeedrate(		`iLocationPoint`,
		`iSubMotion`,
		`oFeedrate`)

Retrieves the local feedrate stored on a sub-motion. The sub-motion must be a "Polyline" or a "Circle Arc". The feedrate must be a local one.

Parameters:

iLocationPoint

The index of location point
Legal values:

0 : approach traject to the first location point
last location point index : retract traject from the last location point
i : linking traject from the location point index i to the location point index i+1

iSubMotion

The number of sub-motion

oFeedrate

The feedrate

Returns:

The return code
Legal values:

FALSE : the feedrate is a not a local one (use "GetSymbolicFeedrate" method)

o GetSubMotionType

public virtual GetSubMotionType(		`iLocationPoint`,
		`iSubMotion`,
		`oMotionType`)

Retrieves the type of a sub-motion.

Parameters:

iLocationPoint

The index of location point
Legal values:

0 : approach traject to the first location point
last location point index : retract traject from the last location point
i : linking traject from the location point index i to the location point index i+1

iSubMotion

The index of sub-motion

oMotionType

The type of sub-motion

o GetSymbolicFeedrate

public virtual GetSymbolicFeedrate(		`iLocationPoint`,
		`iSubMotion`,
		`oFeedrate`,
		`oRatio`)

Retrieves the feedrate stored on a sub-motion. The sub-motion must be a "Polyline" or a "Circle Arc". The feedrate must not be a local one.

Parameters:

iLocationPoint

The index of location point
Legal values:

0 : approach traject to the first location point
last location point index : retract traject from the last location point
i : linking traject from the location point index i to the location point index i+1

iSubMotion

The number of sub-motion

oFeedrate

The feedrate
Legal values:

"TPApproachFeedrate" : approach feedrate
"TPMachiningFeedrate": machining feedrate
"TPRetractFeedrate" : retract feedrate
"TPRapidFeedrate" : rapid feedrate
"TPFinishingFeedrate" : finishing feedrate
"TPChamferingFeedrate" : chamfering feedrate
"TPPlungeFeedrate" : plunge feedrate

oRatio

The ratio value

Returns:

The return code
Legal values:

FALSE : the feedrate is a local one (use "GetSpecificFeedrate" method)

o GetToolAxis

public virtual GetToolAxis(		`iLocationPoint`,
		`iSubMotion`,
		`oX`,
		`oY`,
		`oZ`)

Retrieves the tool axis stored on a sub-motion.

Parameters:

iLocationPoint

The index of location point
Legal values:

0 : approach traject to the first location point
last location point index : retract traject from the last location point
i : linking traject from the location point index i to the location point index i+1

iSubMotion

The index of sub-motion (must be a "polyline" or a "circle" one)

oX,oY,oZ

The tool axis values

Returns:

The return code
Legal values:

FALSE : no tool axis stored for the sub-motion

o GetUserSyntaxCharacteristics

public virtual GetUserSyntaxCharacteristics(		`iLocationPoint`,
		`iSubMotion`,
		`oUserSyntax`)

Retrieves the characteristics of a "User syntax" sub-motion.

Parameters:

iLocationPoint

The index of location point
Legal values:

0 : approach traject to the first location point
last location point index : retract traject from the last location point
i : linking traject from the location point index i to the location point index i+1

iSubMotion

The index of sub-motion (must be a "user syntax" one)

oUserSyntax

The user syntax

o SetRatioOnFeedrate

public virtual SetRatioOnFeedrate(		`iLocationPoint`,
		`iSubMotion`,
		`iRatio`)

Sets a ratio on the feedrate of a sub-motion. The sub-motion must be a "Polyline" or a "Circle Arc". The feedrate must be a symbolic one.

Parameters:

iLocationPoint

The index of location point
Legal values:

0 : approach traject to the first location point
last location point index : retract traject from the last location point
i : linking traject from the location point index i to the location point index i+1

iSubMotion

The number of sub-motion

iRatio

The ratio to apply to the symbolic feedrate

o SetSpecificFeedrate

public virtual SetSpecificFeedrate(		`iLocationPoint`,
		`iSubMotion`,
		`iFeedrate`)

Sets a local feedrate on a sub-motion. The sub-motion must be a "Polyline" or a "Circle Arc".

Parameters:

iLocationPoint

The index of location point
Legal values:

0 : approach traject to the first location point
last location point index : retract traject from the last location point
i : linking traject from the location point index i to the location point index i+1

iSubMotion

The number of sub-motion

iFeedrate

The local feedrate

o SetSymbolicFeedrate

public virtual SetSymbolicFeedrate(		`iLocationPoint`,
		`iSubMotion`,
	const	`iFeedrateType`)

Sets a symbolic feedrate on a sub-motion. The sub-motion must be a "Polyline" or a "Circle Arc".

Parameters:

iLocationPoint

The index of location point
Legal values:

0 : approach traject to the first location point
last location point index : retract traject from the last location point
i : linking traject from the location point index i to the location point index i+1

iSubMotion

The number of sub-motion

iFeedrateType

The type of feedrate
Legal values:

"TPApproachFeedrate" : approach feedrate
"TPMachiningFeedrate": machining feedrate
"TPRetractFeedrate" : retract feedrate
"TPRapidFeedrate" : rapid feedrate
"TPFinishingFeedrate" : finishing feedrate
"TPChamferingFeedrate" : chamfering feedrate
"TPPlungeFeedrate" : plunge feedrate

Enumerated Types

o SubMotionType

enum SubMotionType {
  PolyLine,
  Circle,
  PPCommand,
  UserSyntax
}

The type of sub-motion.
Legal values:

Polyline : sub-motion describing a "polyline" (Set of linear motions)
Circle : sub-motion describing a "circle arc" (circular motion)
PPCommand : sub-motion describing a "PP command"
UserSyntax : sub-motion describing a "user syntax"

This object is included in the file: DELIMfgTPCycleLinkingMotion.h
If needed, your Imakefile.mk should include the module: MachiningToolPathUseItf

MachiningToolPathUseItf Interface DELIMfgTPCycleLinkingMotion

Method Index

Enumerated Type Index

Methods

Enumerated Types