MachiningUseItf Interface DELIMfgPartOperationPosition
Usage: an implementation of this interface is supplied and you must use it as is. You should not reimplement it.
interface DELIMfgPartOperationPosition
Interface representing Part Operation Position
Method Index
- o
GetAlias()
- Get the alias of the position
- o
GetAttachStatus(CATBoolean&)
- Returns if the position is attached/detached on the machine
- o
GetPartOperation(DELIMfgPartOperation_var&)
- Associates a product to the Part Operation.
- o
GetProduct(CATBaseUnknown_var&)
- Retrieves the product associated to the Part Operation.
- o
GetProductOccurrence(CATBaseUnknown_var&)
- Retrieves the product associated to the Part Operation.
- o
GetRotaryPlanes(CATBaseUnknown_var&)
- Retrieves the rotary planes associated to the Part Operation.
- o
GetSafetyPlaneSO(CATBaseUnknown_var&)
- Retrieves the safety plane associated to the Part Operation.
- o
GetTopPlaneDirectionInversion(int&)
- Gets the top plane direction inversion value.
- o
GetTransitionPlanes(CATBaseUnknown_var&)
- Retrieves the transition planes associated to the Part Operation.
- o
SetAlias(CATUnicodeString&)
- Set the alias of the position
- o
SetProduct(CATBaseUnknown_var&)
- Associates a product to the Part Operation.
- o
SetSafetyPlaneSO(CATBaseUnknown_var&)
- Set the safety plane associated 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 GetAlias
| public virtual GetAlias( | ) |
-
Get the alias of the position
o GetAttachStatus
| public virtual GetAttachStatus( | | isAttached) |
-
Returns if the position is attached/detached on the machine
- Parameters:
-
- isAttached
-
Legal values: TRUE if the position is attached, FALSE else
- Returns:
- E_FAIL if the position is not mounted
o GetPartOperation
| public virtual GetPartOperation( | | ospPartOperation) |
-
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 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 GetProductOccurrence
| public virtual GetProductOccurrence( | | oProduct) |
-
Retrieves the product associated to the Part Operation.
- Parameters:
-
- oProduct
- The associated product. It is an Occurance
o GetRotaryPlanes
| public virtual GetRotaryPlanes( | | oRotaryPlanes) |
-
Retrieves the rotary planes associated to the Part Operation.
- Parameters:
-
- oRotaryPlanes
- The rotary planes. Use
on oRotaryPlanes to access each plane.
- Returns:
- E_FAIL if the rotary planes is not defined.
o GetSafetyPlaneSO
| public virtual GetSafetyPlaneSO( | | 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 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
on oTransitionPlanes to access each plane.
- Returns:
- E_FAIL if the transition planes is not defined.
o SetAlias
| public virtual SetAlias( | const | iNewAlias) |
-
Set the alias of the position
- Parameters:
-
- iNewAlias
- Alias of the position
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 SetSafetyPlaneSO
| public virtual SetSafetyPlaneSO( | | iSafetyPlane) |
-
Set the safety plane associated to the Part Operation.
- Parameters:
-
- iSafetyPlane
- The safety plane.
- Returns:
- E_FAIL if the safety plane is not defined.
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: DELIMfgPartOperationPosition.h
If needed, your Imakefile.mk should include the module: MachiningUseItf
Copyright © 1999-2014, Dassault Systèmes. All rights reserved.