All Frameworks Class Hierarchy This Framework Indexes
ManufacturingInterfaces Interface CATIMfgSetup
Usage: an implementation of this interface is supplied and you must use it as is. You should not reimplement it.
interface CATIMfgSetup
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
GetAllChildren(CATClassId&,CATListValCATBaseUnknown_var&)
- Retrieves the children of the product associated to the Part Operation.
- 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
GetIPMMainBodies(CATILinkableObject_var&,int)
- Retrieves one In Process Model Body at a given position.
- o
GetIPMMainBody(CATILinkableObject_var&)
- Do not use.
- o
GetMachineAndContext(CATBaseUnknown_var&,CATMathTransformation&,CATBaseUnknown_var&)
- Retrieves the machine on the Part Operation and the transformation
to switch from the absolute axis system to the machining axis sytem.
- o
GetMachine(CATBaseUnknown_var&)
- Retrieves the machine on the Part Operation.
- o
GetMachiningAxisDefinition(CATMathAxis&,CATBaseUnknown_var&)
- Retrieves the mathematical axis system associated to the Part Operation.
- o
GetMachiningAxis(CATBaseUnknown_var&,CATBaseUnknown_var&)
- Retrieves the Machining Axis System feature 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
GetNumberOfIPMMainBodies(int&)
- Gets the number of In Process Model Bodies associated to the Part Operation.
- o
GetOldProductInProductList(CATBaseUnknown_var&)
- Do not use this method.
- o
GetProductInProductList(CATBaseUnknown_var&)
- Retrieves the product associated to the Part Operation.
- o
GetProductReference(CATBaseUnknown_var&)
- Retrieves the product associated to the Part Operation.
- o
GetProduct(CATBaseUnknown_var&)
- Retrieves the product associated to the Part Operation.
- o
GetResource(CATBaseUnknown_var&)
- Retrieves the resource on the Part Operation.
- o
GetRotaryPlanes(CATBaseUnknown_var&)
- Retrieves the rotary planes associated to the Part Operation.
- o
GetSafetyPlaneResult(CATMathPlane&)
- Retrieves the mathematical definition of the safety plane associated to the Part Operation.
- o
GetSafetyPlane(CATBaseUnknown_var&)
- Retrieves the safety plane associated to 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
GetToolChangeLocation(CATMathPoint&)
- Do not use.
- o
GetTopPlaneDirectionInversion(int&)
- Gets the top plane direction inversion value.
- o
GetTransitionPlanes(CATBaseUnknown_var&)
- Retrieves the transition planes associated to the Part Operation.
- o
GetTraverseBoxPlanes(CATBaseUnknown_var&)
- Retrieves the traverse box planes associated to the Part Operation.
- 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
RemoveAllIPMMainBodies()
- Removes all the In Process Model Bodies.
- o
RemoveIPMMainBodies(int)
- Removes an In Process Model Body at a given index.
- o
RemoveIPMMainBodies(CATILinkableObject_var&)
- Removes an In Process Model Body.
- o
RemoveMachine(CATBaseUnknown_var&)
- Removes the machine associated to the Part Operation.
- o
RemoveResource(CATBaseUnknown_var&)
- Removes the resource associated to the Part Operation.
- o
SetActualStockMode(int)
- Sets the actual stock computation mode.
- o
SetIPMMainBodies(CATILinkableObject_var&,int)
- Associates one In Process Model Body to the Part Operation.
- o
SetMachine(CATBaseUnknown_var&)
- Associates a machine to the Part Operation.
- o
SetMachiningAxis(CATBaseUnknown_var&)
- Associates a Machining Axis System feature to the Part Operation.
- o
SetProduct(CATBaseUnknown_var&)
- Associates a product to the Part Operation.
- o
SetResource(CATBaseUnknown_var&)
- Associates a resource to the Part Operation.
- o
SetTopPlaneDirectionInversion(int)
- Sets the top plane direction inversion value in order to determine the traverse box position
relatively to the top plane.
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 GetAllChildren
| public virtual GetAllChildren( | const | iInterName, |
| | oList) |
-
Retrieves the children of the product associated to the Part Operation.
- Parameters:
-
- iInterName
- To get only children answering to interface iInterName
- oList
- The result list.
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:
- CATMathTransformation
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
CATICkeParm refering to the X, Y, Z coordinates of home point.
- oHomePointIJKListParms
- List of 3
CATICkeParm refering to the I, J, K coordinates of tool axis vector on the home point.
- oUseMachineHomePoint
- TRUE if the parameters have been copied from the machine,
FALSE otherwise.
o GetIPMMainBodies
| public virtual GetIPMMainBodies( | | oBody, |
| | iIndex | =0) |
-
Retrieves one In Process Model Body at a given position.
- Parameters:
-
- iBody
- The retrieved body.
- iIndex
- The position where oBody is
Legal values: This position must be between 1 and the number of
bodies in the list.
If 0, .
o GetIPMMainBody
| public virtual GetIPMMainBody( | | oBody) |
-
Do not use. Use
GetIPMMainBodies instead.
o GetMachineAndContext
| public virtual GetMachineAndContext( | | oMachine, |
| | oFromAbsoluteToSetup, |
| const | iSpindle | =NULL_var) |
-
Retrieves the machine on the Part Operation and the transformation
to switch from the absolute axis system to the machining axis sytem.
- Parameters:
-
- oMachine
- The machine associated to the Part Operation.
- oFromAbsoluteToSetup
- The computed mathematical transformation to switch from the absolute axis system to the machining axis system
- Returns:
- S_FALSE if no machine is associated to the Part Operation.
o GetMachine
| public virtual GetMachine( | | oMachine) |
-
Retrieves the machine on the Part Operation.
There can be only one machine per Part Operation.
- Parameters:
-
- oMachine
- The machine associated to the Part Operation.
- Returns:
- S_FALSE if no machine is associated to the Part Operation.
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:
- CATMathAxis
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 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:
- CATMathTransformation
o GetNumberOfIPMMainBodies
| public virtual GetNumberOfIPMMainBodies( | | oNumber) |
-
Gets the number of In Process Model Bodies associated to the Part Operation.
- Parameters:
-
- oNumber
- The number of In Process Model Bodies
o GetOldProductInProductList
| public virtual GetOldProductInProductList( | | oProduct) |
-
Do not use this method. Prefer use method: GetProductInProductList
o GetProductInProductList
| public virtual GetProductInProductList( | | oProduct) |
-
Retrieves the product associated to the Part Operation.
- Parameters:
-
- oProduct
- The associated product. It is an instance
o GetProductReference
| public virtual GetProductReference( | | oProduct) |
-
Retrieves the product associated to the Part Operation.
- Parameters:
-
- oProduct
- The associated product. It is a reference.
o GetProduct
| public virtual GetProduct( | | oProduct) |
-
Retrieves the product associated to the Part Operation.
- Parameters:
-
- oProduct
- The associated product. If we are in File Based context, oProduct is a reference
If we are in Manufacturing Hub context, oProduct is an instance
o GetResource
| public virtual GetResource( | | oResource) |
-
Retrieves the resource on the Part Operation.
There can be only one resource per Part Operation.
- Parameters:
-
- oResource
- The resource associated to the Part Operation.
- Returns:
- S_FALSE if no resource is associated to the Part Operation.
o GetRotaryPlanes
| public virtual GetRotaryPlanes( | | oRotaryPlanes) |
-
Retrieves the rotary planes associated to the Part Operation.
- Parameters:
-
- oRotaryPlanes
- The rotary planes. Use
CATIMfgAgregate on oRotaryPlanes to access each plane.
- Returns:
- E_FAIL if the rotary planes is not defined.
o GetSafetyPlaneResult
| public virtual GetSafetyPlaneResult( | | oPlane) |
-
Retrieves the mathematical definition of the safety plane associated to the Part Operation.
- Parameters:
-
- oPlane
- The mathematical safety plane.
- Returns:
- E_FAIL if the safety plane is not defined.
- See also:
- CATMathPlane
o GetSafetyPlane
| public virtual GetSafetyPlane( | | oSafetyPlane) |
-
Retrieves the safety plane associated to the Part Operation.
- Parameters:
-
- oSafetyPlane
- The safety plane.
- Returns:
- E_FAIL if the safety plane is not defined.
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
CATICkeParm refering to the X, Y, Z coordinates of tool change point.
- 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 GetToolChangeLocation
| public virtual GetToolChangeLocation( | | oPoint) |
-
Do not use. Use
GetToolChangeLocation (CATMathPoint&,CATMathVector&,CATBoolean&,CATMathTransformation&) instead.
o GetTopPlaneDirectionInversion
| public virtual GetTopPlaneDirectionInversion( | | oMode) |
-
Gets the top plane direction inversion value.
- Parameters:
-
- oMode
-
Legal values: 1 if the top plane direction has been inverted, 0 otherwise
o GetTransitionPlanes
| public virtual GetTransitionPlanes( | | oTransitionPlanes) |
-
Retrieves the transition planes associated to the Part Operation.
- Parameters:
-
- oTransitionPlanes
- The transition planes. Use
CATIMfgAgregate on oTransitionPlanes to access each plane.
- Returns:
- E_FAIL if the transition planes is not defined.
o GetTraverseBoxPlanes
| public virtual GetTraverseBoxPlanes( | | oTraverseBoxPlanes) |
-
Retrieves the traverse box planes associated to the Part Operation.
- Parameters:
-
- oTraverseBoxPlanes
- The traverse box planes. Use
CATIMfgAgregate on oTraverseBoxPlanes to access each plane.
- Returns:
- E_FAIL if the traverse box planes is not defined.
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 RemoveAllIPMMainBodies
| public virtual RemoveAllIPMMainBodies( | ) |
-
Removes all the In Process Model Bodies.
o RemoveIPMMainBodies
| public virtual RemoveIPMMainBodies( | | iIndex) |
-
Removes an In Process Model Body at a given index.
- Parameters:
-
- iIndex
- The position at which the body is to be removed
Legal values: This position must be between one and the number
of bodies in the list.
o RemoveIPMMainBodies
| public virtual RemoveIPMMainBodies( | const | ispIPMMainBodyToRemove) |
-
Removes an In Process Model Body.
- Parameters:
-
- ispIPMMainBodyToRemove
- The body to be removed
- Returns:
- S_FALSE if there is no In Process Body, or if ispIPMMainBodyToRemove is not in the list.
o RemoveMachine
| public virtual RemoveMachine( | const | iMachine) |
-
Removes the machine associated to the Part Operation.
The machine is not removed from the document.
- Parameters:
-
- iMachine
- The removed machine.
- Returns:
- E_FAIL if iMachine is NULL_var.
o RemoveResource
| public virtual RemoveResource( | const | iResource) |
-
Removes the resource associated to the Part Operation.
The resource is also removed from the document.
- Parameters:
-
- iResource
- The removed resource.
- Returns:
- E_INVALIDARG if iResource is NULL_var.
o SetActualStockMode
| public virtual SetActualStockMode( | const | iMode) |
-
Sets the actual stock computation mode.
- Parameters:
-
- iMode
- the actual stock mode.
Legal values: 1 if the stock is to be recomputed automatically for each Machining Operation,
0 otherwise.
- Returns:
- E_INVALIDARG if iMode is different from 0 or 1.
o SetIPMMainBodies
| public virtual SetIPMMainBodies( | const | iBody, |
| | iIndex | =0) |
-
Associates one In Process Model Body to the Part Operation.
Several In Process Bosies can be associated, they are stored in a list.
- Parameters:
-
- iBody
- The body to be added to the In Process Bodies list.
- iIndex
- The position where iBody is to be added
Legal values: This position must be between 0 and the number of
bodies in the list.
If 0 (default value), the body is appended at the end of the list.
o SetMachine
| public virtual SetMachine( | const | iMachine) |
-
Associates a machine to the Part Operation.
The previously associated machine is removed.
- Parameters:
-
- iMachine
- The machine to be associated.
- Returns:
- E_INVALIDARG if iMachine is NULL_var.
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 SetProduct
| public virtual SetProduct( | const | iProduct) |
-
Associates a product to the Part Operation.
- Parameters:
-
- iProduct
- The product to be associated. If iProduct is NULL_var, the previously associated product is removed.
o SetResource
| public virtual SetResource( | const | iResource) |
-
Associates a resource to the Part Operation.
The previously associated resource is removed.
- Parameters:
-
- iResource
- The resource to be associated.
- Returns:
- E_INVALIDARG if iResource is NULL_var or not a Delmia machine.
o SetTopPlaneDirectionInversion
| public virtual SetTopPlaneDirectionInversion( | const | iMode) |
-
Sets the top plane direction inversion value in order to determine the traverse box position
relatively to the top plane.
- Parameters:
-
- iMode
-
Legal values: 1 if the top plane direction is to be inverted, 0 otherwise
- Returns:
- E_INVALIDARG if iMode is different from 0 or 1.
This object is included in the file: CATIMfgSetup.h
If needed, your Imakefile.mk should include the module: MfgItfEnv