All Frameworks Class Hierarchy This Framework Indexes Previous Next

MachiningUseItf Interface DELIMfgPartOperation

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

interface DELIMfgPartOperation

Interface to manage Part Operation (Setup).
Role: Manage the information related to the Part Operation object like associated resource, product and machining axis system.

Method Index

o GetActualStockMode(int&): Gets the actual stock computation mode.
o GetContext(CATMathTransformation&,CATMathTransformation&,CATBaseUnknown_var&): Computes the mathematical transformations to switch from the machining axis system to the absolute axis sytem and vice versa.
o GetHomePoint(CATListValCATBaseUnknown_var&,CATListValCATBaseUnknown_var&,CATBoolean&): Gets the setup parameters defining the home point.
o GetMachine(CATBaseUnknown_var&): Retrieves the machine.
o GetMachineLocalParameters(CATBaseUnknown_var&): Retrieves the local parameters of machine.
o GetMachiningAxis(CATBaseUnknown_var&,CATBaseUnknown_var&): Retrieves the Machining Axis System feature associated to the Part Operation.
o GetMachiningAxisDefinition(CATMathAxis&,CATBaseUnknown_var&): Retrieves the mathematical axis system associated to the Part Operation.
o GetMachiningContext(CATMathTransformation&,CATMathTransformation&,CATBaseUnknown_var&): Computes the mathematical transformations to switch from the machining axis system to the absolute axis sytem and vice versa.
o GetPrograms(CATListValCATBaseUnknown_var&): Retrieves Programs of the Part Operation
o GetToolChangeLocation(CATListValCATBaseUnknown_var&,CATBoolean&): Gets the setup parameters defining the Tool Change point.
o GetToolChangeLocation(CATMathPoint&,CATMathVector&,CATBoolean&,CATMathTransformation&,CATBaseUnknown_var&): Gets the mathematical definition of the Tool Change point.
o InsertNewProgram(CATBaseUnknown_var&,CATBaseUnknown_var&): Creates and insert a Program in the Part Operation.
o MoveProgramAfter(CATBaseUnknown_var&,CATBaseUnknown_var&): Moves a Program inside the Part Operation.
o SetMachine(CATBaseUnknown_var&): Replace current machine.
o SetMachiningAxis(CATBaseUnknown_var&): Associates a Machining Axis System feature to the Part Operation.
o SetToolChangeLocation(double,double,double): Set the mathematical definition of the Tool Change point.

Methods

o GetActualStockMode

public virtual GetActualStockMode( oMode)

Gets the actual stock computation mode.

Parameters:

oMode: the actual stock mode.
Legal values: 1 if the stock is recomputed automatically for each Machining Operation, 0 otherwise.

o GetContext

public virtual GetContext(		`oFromAbsoluteToSetup`,
		`oFromSetupToAbsolute`,
	const	`iSpindle`	`= NULL_var`)

Computes the mathematical transformations to switch from the machining axis system to the absolute axis sytem and vice versa.

Parameters:

oFromAbsoluteToSetup: The computed mathematical transformation to switch from the absolute axis system to the machining axis system
oFromSetupToAbsolute: The computed mathematical transformation to switch from the machining axis system to the absolute axis system
iSpindle: Do not use this parameter: keep the default value.

See also:

o GetHomePoint

public virtual GetHomePoint(		`oHomePointXYZListParms`,
		`oHomePointIJKListParms`,
		`oUseMachineHomePoint`)

Gets the setup parameters defining the home point. WARNING : The values of these parameters are defined in the Part Operation axis system.

Parameters:

oHomePointXYZListParms: List of 3
oHomePointIJKListParms: List of 3
oUseMachineHomePoint: TRUE if the parameters have been copied from the machine, FALSE otherwise.

o GetMachine

public virtual GetMachine( oMachine)

Retrieves the machine. There can be only one machine.

Parameters:

oMachine: The instance of machine associated.

o GetMachineLocalParameters

public virtual GetMachineLocalParameters( oMachineLocalParam)

Retrieves the local parameters of machine.

Parameters:

oMachine: The instance of machine associated.

o GetMachiningAxis

public virtual GetMachiningAxis(		`oMachiningAxis`,
	const	`iSpindle`	`= NULL_var`)

Retrieves the Machining Axis System feature associated to the Part Operation.

Parameters:

oMachiningAxis: The associated Machining Axis System
iSpindle: Do not use this parameter: keep the default value.

o GetMachiningAxisDefinition

public virtual GetMachiningAxisDefinition(		`oMachiningAxis`,
	const	`iSpindle`	`=NULL_var`)

Retrieves the mathematical axis system associated to the Part Operation. This is the mathematical definition of the Machining Axis System.

Parameters:

oMachiningAxis: The associated mathematical axis system
iSpindle: Do not use this parameter: keep the default value.

See also:

o GetMachiningContext

public virtual GetMachiningContext(		`oFromAbsoluteToMachiningAxis`,
		`oFromMachiningAxisToAbsolute`,
	const	`iSpindle`	`= NULL_var`)

Computes the mathematical transformations to switch from the machining axis system to the absolute axis sytem and vice versa.

Parameters:

oFromAbsoluteToMachiningAxis: The computed mathematical transformation to switch from the absolute axis system to the machining axis system
oFromMachiningAxisToAbsolute: The computed mathematical transformation to switch from the machining axis system to the absolute axis system
iSpindle: Do not use this parameter: keep the default value.

See also:

o GetPrograms

public virtual GetPrograms( oListPrograms)

Retrieves Programs of the Part Operation

Parameters:

oListPrograms: List of Programs

o GetToolChangeLocation

public virtual GetToolChangeLocation(		`oToolChangeXYZListParms`,
		`oFromMachine`)

Gets the setup parameters defining the Tool Change point.
WARNING : The values of these parameters are defined in the Part Operation axis system.

Parameters:

oToolChangeXYZListParms: List of 3
oFromMachine: TRUE if the parameters have been copied from the machine. In this case the tool length is NOT take into account in the point definition.
FALSE otherwise, and the tool change point is the tip point.

o GetToolChangeLocation

public virtual GetToolChangeLocation(		`oTCPoint`,
		`oTCAxis`,
		`oFromMachine`,
		`oTheLocXform`,
	const	`iToolChangeOperation`	`=NULL_var`)

Gets the mathematical definition of the Tool Change point.
WARNING : The values of these parameters are defined in absolute axis system. Units are mm.

Parameters:

oTCPoint: The mathematical tool change point. This is the tool mounting point if oFromMachine is TRUE, the tool tip point otherwise.
oTCAxis: The tool axis vector on the tool change point.
oFromMachine: TRUE if the parameters have been copied from the machine, The tool length is then NOT take into account in the point definition, and oTheLocXform is valuated.
FALSE otherwise. The tool change point is then the tip point.
oTheLocXform: Transformation in order to compute the tip point with the tool length. This is the Identity if oFromMachine is FALSE.
iToolChangeOperation: Tool change operation defining the context (optional). Only used if oFromMachine is TRUE. If valued : the returned location takes the contextual position of the machine into account.

o InsertNewProgram

public virtual InsertNewProgram(		`oProgram`,
	const	`iInsertionLevel`	`=NULL_var`)

Creates and insert a Program in the Part Operation.

Parameters:

oProgram: The new created Program
iInsertionLevel: The Program after which the new program is inserted. If NULL_var, the Program is inserted at the beginning of the Part Operation (default behaviour).

Returns:

E_FAIL If the insertion program does not belong to the Part Operation.
S_OK, if the program has been correctly created.

o MoveProgramAfter

public virtual MoveProgramAfter(		`iProgramToMove`,
	const	`iInsertionLevel`	`= NULL_var`)

Moves a Program inside the Part Operation.

Parameters:

iProgramToMove: The Program to be moved
iInsertionLevel: The Program after which the program is moved. If NULL_var, the Program is moved at the beginning of the Part Operation (default behaviour).

Returns:

E_FAIL If the program to move or the insertion program do not belong to the Part Operation.
S_OK, if the program has been correctly moved.

o SetMachine

public virtual SetMachine( iMachine)

Replace current machine. There can be only one machine.

Parameters:

iMachine: The instance of machine

o SetMachiningAxis

public virtual SetMachiningAxis( const iMachiningAxis)

Associates a Machining Axis System feature to the Part Operation.

Parameters:

iMachiningAxis: The Machining Axis System to be associated

o SetToolChangeLocation

public virtual SetToolChangeLocation(		`iX`,
		`iY`,
		`iZ`)

Set the mathematical definition of the Tool Change point.

Parameters:

iX: [in] X coordonate
iY: [in] Y coordonate
iZ: [in] Z coordonate

Returns:

S_OK if succeeded

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