Interface IOperations
Gives access to machining operations.
Namespace: TopSolid.Cam.NC.Kernel.Automating
Assembly: TopSolid.Cam.NC.Kernel.Automating.dll
Syntax
public interface IOperationsMethods
Execute(ElementId)
Execute only the given operation.
Declaration
void Execute(ElementId inElementId)Parameters
| Type | Name | Description |
|---|---|---|
| ElementId | inElementId | Identifier of the operation to execute. |
ExecuteMethod(DocumentId, DocumentId, MethodExecutionOptions)
Execute the method document in the target document.
Declaration
List<ElementId> ExecuteMethod(DocumentId inTargetDocument, DocumentId inMethodDocument, MethodExecutionOptions inExecutionOptions)Parameters
| Type | Name | Description |
|---|---|---|
| DocumentId | inTargetDocument | The target document to modify. |
| DocumentId | inMethodDocument | The method document to execute. |
| MethodExecutionOptions | inExecutionOptions | Execution options for the method. |
Returns
| Type | Description |
|---|---|
| System.Collections.Generic.List<ElementId> | All created tasks operations. |
Remarks
StartModification(String, Boolean) and EnsureIsDirty(ref DocumentId) must be called before calling this method.
This method is available since v7.15.
ExecuteMethodWithPredefinedSelection(DocumentId, DocumentId, MethodExecutionOptions, List<ElementItemId>)
Execute the method document in the target document.
Declaration
List<ElementId> ExecuteMethodWithPredefinedSelection(DocumentId inTargetDocument, DocumentId inMethodDocument, MethodExecutionOptions inExecutionOptions, List<ElementItemId> inSelections)Parameters
| Type | Name | Description |
|---|---|---|
| DocumentId | inTargetDocument | The target document to modify. |
| DocumentId | inMethodDocument | The method document to execute. |
| MethodExecutionOptions | inExecutionOptions | Execution options for the method. |
| System.Collections.Generic.List<ElementItemId> | inSelections | Execution options for the method. |
Returns
| Type | Description |
|---|---|
| System.Collections.Generic.List<ElementId> | All created tasks operations. |
Remarks
StartModification(String, Boolean) and EnsureIsDirty(ref DocumentId) must be called before calling this method.
This method is available since v7.15.
GetAllCuttingConditionsAbacus(ElementId, DocumentId)
Gets all cutting condition abacus available for an operation.
Declaration
List<ElementId> GetAllCuttingConditionsAbacus(ElementId inElementId, DocumentId inDocumentId)Parameters
| Type | Name | Description |
|---|---|---|
| ElementId | inElementId | Identifier of the operation to analyze. |
| DocumentId | inDocumentId | Identifier of the cutting condition document. |
Returns
| Type | Description |
|---|---|
| System.Collections.Generic.List<ElementId> | All cutting condition entities. |
GetAllCuttingConditionsDocuments(ElementId)
Gets all cutting condition documents available for an operation.
Declaration
List<DocumentId> GetAllCuttingConditionsDocuments(ElementId inElementId)Parameters
| Type | Name | Description |
|---|---|---|
| ElementId | inElementId | Identifier of the operation to analyze. |
Returns
| Type | Description |
|---|---|
| System.Collections.Generic.List<DocumentId> | All cutting condition documents. |
GetCurrentCuttingConditionsAbacus(ElementId)
Gets the current cutting condition abacus of an operation.
Declaration
ElementId GetCurrentCuttingConditionsAbacus(ElementId inElementId)Parameters
| Type | Name | Description |
|---|---|---|
| ElementId | inElementId | Identifier of the operation to analyze. |
Returns
| Type | Description |
|---|---|
| ElementId | The current cutting condition entity. |
GetCurrentCuttingConditionsDocument(ElementId)
Gets the current cutting condition document of an operation.
Declaration
DocumentId GetCurrentCuttingConditionsDocument(ElementId inElementId)Parameters
| Type | Name | Description |
|---|---|---|
| ElementId | inElementId | Identifier of the operation to analyze. |
Returns
| Type | Description |
|---|---|
| DocumentId | The current cutting condition document. |
GetDescription(ElementExId)
Gets a Cam operation description.
Declaration
string GetDescription(ElementExId inElementId)Parameters
| Type | Name | Description |
|---|---|---|
| ElementExId | inElementId | Identifier of the operation to analyze. |
Returns
| Type | Description |
|---|---|
| System.String | Operation description. |
GetNCOperation(ElementExId)
Gets the NC operation from the given operation.
Declaration
ElementExId GetNCOperation(ElementExId inElementId)Parameters
| Type | Name | Description |
|---|---|---|
| ElementExId | inElementId | Identifier of the operation to analyze. |
Returns
| Type | Description |
|---|---|
| ElementExId | Path operation found. |
GetOperationLinkInMovementsMethod(ElementExId, out LinkMovementsMethod, out String)
Get nc operation link-in movement method
Declaration
void GetOperationLinkInMovementsMethod(ElementExId inElementExId, out LinkMovementsMethod outLinkMovementsMethod, out string outDocumentName)Parameters
| Type | Name | Description |
|---|---|---|
| ElementExId | inElementExId | Identifier of the operation to analyze |
| LinkMovementsMethod | outLinkMovementsMethod | Link-in movement method to get |
| System.String | outDocumentName | Linked document name to get, empty if automatic method |
Remarks
The document name is only for information, it may not be unique in the pdm.
GetOperationLinkOutMovementsMethod(ElementExId, out LinkMovementsMethod, out String)
Get nc operation link-out movement method
Declaration
void GetOperationLinkOutMovementsMethod(ElementExId inElementExId, out LinkMovementsMethod outLinkMovementsMethod, out string outDocumentName)Parameters
| Type | Name | Description |
|---|---|---|
| ElementExId | inElementExId | Identifier of the operation to analyze |
| LinkMovementsMethod | outLinkMovementsMethod | Link-out movement method to get |
| System.String | outDocumentName | Linked document name to get, empty if automatic method |
Remarks
The document name is only for information, it may not be unique in the pdm.
GetOperations(DocumentId)
Gets the Cam operations of a document.
Declaration
List<ElementId> GetOperations(DocumentId inDocumentId)Parameters
| Type | Name | Description |
|---|---|---|
| DocumentId | inDocumentId | Identifier of the document to analyze. |
Returns
| Type | Description |
|---|---|
| System.Collections.Generic.List<ElementId> | Cam operations found. |
Remarks
The operations are sorted in chronological order (i.e. first operation of the list is executed first).
GetPart(ElementExId)
Gets the part entity from the given operation.
Declaration
ElementId GetPart(ElementExId inElementId)Parameters
| Type | Name | Description |
|---|---|---|
| ElementExId | inElementId | Identifier of the operation to analyze. |
Returns
| Type | Description |
|---|---|
| ElementId | Part entity. |
GetScenarioOperations(DocumentId)
Gets the Cam scenario operations of a document.
Declaration
List<ElementId> GetScenarioOperations(DocumentId inDocumentId)Parameters
| Type | Name | Description |
|---|---|---|
| DocumentId | inDocumentId | Identifier of the document to analyze. |
Returns
| Type | Description |
|---|---|
| System.Collections.Generic.List<ElementId> | Cam operations found. |
Remarks
The operations are sorted in chronological order of the scenario (i.e. first operation of the list is executed first).
GetSetupOperation(ElementExId)
Gets the geometry setup operation from the given operation.
Declaration
ElementExId GetSetupOperation(ElementExId inElementId)Parameters
| Type | Name | Description |
|---|---|---|
| ElementExId | inElementId | Identifier of the operation to analyze. |
Returns
| Type | Description |
|---|---|
| ElementExId | Geometry setup operation found. |
GetStockUpdateOperation(ElementExId)
Gets the stock update operation from the given operation.
Declaration
ElementExId GetStockUpdateOperation(ElementExId inElementId)Parameters
| Type | Name | Description |
|---|---|---|
| ElementExId | inElementId | Identifier of the operation to analyze. |
Returns
| Type | Description |
|---|---|
| ElementExId | Stock update operation found. |
GetStrongTuningOperation(ElementExId)
Gets the strong tuning operation from the given operation.
Declaration
ElementExId GetStrongTuningOperation(ElementExId inElementId)Parameters
| Type | Name | Description |
|---|---|---|
| ElementExId | inElementId | Identifier of the operation to analyze. |
Returns
| Type | Description |
|---|---|
| ElementExId | Strong tuning operation found. |
GetTool(ElementExId)
Gets the tool entity from the given operation.
Declaration
ElementId GetTool(ElementExId inElementId)Parameters
| Type | Name | Description |
|---|---|---|
| ElementExId | inElementId | Identifier of the operation to analyze. |
Returns
| Type | Description |
|---|---|
| ElementId | Tool entity. |
GetWeakTuningOperation(ElementExId)
Gets the weak tuning operation from the given operation.
Declaration
ElementExId GetWeakTuningOperation(ElementExId inElementId)Parameters
| Type | Name | Description |
|---|---|---|
| ElementExId | inElementId | Identifier of the operation to analyze. |
Returns
| Type | Description |
|---|---|
| ElementExId | Weak tuning operation found. |
GetWorldCoordinateSystem(ElementExId)
Gets the WCS entity from the given operation.
Declaration
ElementId GetWorldCoordinateSystem(ElementExId inElementId)Parameters
| Type | Name | Description |
|---|---|---|
| ElementExId | inElementId | Identifier of the operation to analyze. |
Returns
| Type | Description |
|---|---|
| ElementId | WCS entity. |
IsLinkOutMovementMethodModifiable(ElementExId)
Test if link out movement of an operation can be edited.
Declaration
bool IsLinkOutMovementMethodModifiable(ElementExId inElementExId)Parameters
| Type | Name | Description |
|---|---|---|
| ElementExId | inElementExId | Identifier of the operation to analyse |
Returns
| Type | Description |
|---|---|
| System.Boolean | True if can be set, false either |
IsNCOperation(ElementExId)
Tells whether an operation is a path computing operation.
Declaration
bool IsNCOperation(ElementExId inElementId)Parameters
| Type | Name | Description |
|---|---|---|
| ElementExId | inElementId | Identifier of the operation to analyze. |
Returns
| Type | Description |
|---|---|
| System.Boolean | The operation is a path operation. |
IsOperation(ElementExId)
Tells whether an operation is a Cam operation.
Declaration
bool IsOperation(ElementExId inElementId)Parameters
| Type | Name | Description |
|---|---|---|
| ElementExId | inElementId | Identifier of the operation to analyze. |
Returns
| Type | Description |
|---|---|
| System.Boolean | The operation is a Cam operation. |
IsSetupOperation(ElementExId)
Tells whether an operation is a Cam geometry setup operation.
Declaration
bool IsSetupOperation(ElementExId inElementId)Parameters
| Type | Name | Description |
|---|---|---|
| ElementExId | inElementId | Identifier of the operation to analyze. |
Returns
| Type | Description |
|---|---|
| System.Boolean | The operation is a Cam geometry setup operation. |
IsStockUpdateOperation(ElementExId)
Tells whether an operation is a stock update operation.
Declaration
bool IsStockUpdateOperation(ElementExId inElementId)Parameters
| Type | Name | Description |
|---|---|---|
| ElementExId | inElementId | Identifier of the operation to analyze. |
Returns
| Type | Description |
|---|---|
| System.Boolean | The operation is a stock update operation. |
IsStrongTuningOperation(ElementExId)
Tells whether an operation is a strong tuning operation.
Declaration
bool IsStrongTuningOperation(ElementExId inElementId)Parameters
| Type | Name | Description |
|---|---|---|
| ElementExId | inElementId | Identifier of the operation to analyze. |
Returns
| Type | Description |
|---|---|
| System.Boolean | The operation is a string tuning operation. |
IsUpToDate(ElementExId)
Gets the state of the given operation.
Declaration
bool IsUpToDate(ElementExId inElementId)Parameters
| Type | Name | Description |
|---|---|---|
| ElementExId | inElementId | Identifier of the operation to check. |
Returns
| Type | Description |
|---|---|
| System.Boolean | Returns the value of the flag. |
Remarks
This state is really the state of the NCOperation. All other operations in the owner task have the same state.
If the given operation is a task, the state of its NCOpration will be returned.
IsWeakTuningOperation(ElementExId)
Tells whether an operation is a weak tuning operation.
Declaration
bool IsWeakTuningOperation(ElementExId inElementId)Parameters
| Type | Name | Description |
|---|---|---|
| ElementExId | inElementId | Identifier of the operation to analyze. |
Returns
| Type | Description |
|---|---|
| System.Boolean | The operation is a weak tuning operation. |
MoveOperations(List<ElementId>, ElementId, Boolean)
Moves the list of specified operations before or after the given reference operation.
Declaration
void MoveOperations(List<ElementId> inSortedOperations, ElementId inReferenceOperation, bool inBefore)Parameters
| Type | Name | Description |
|---|---|---|
| System.Collections.Generic.List<ElementId> | inSortedOperations | Identifiers of operations to move. |
| ElementId | inReferenceOperation | Identifier of the reference operation. |
| System.Boolean | inBefore | Whether specified operations are before the reference operation. |
RefreshOperations(ElementExId, ElementExId)
Refresh operations from given start operation to given end operation. If only one operation to refresh, start and end operations are the same operation.
Declaration
void RefreshOperations(ElementExId inStartOperationId, ElementExId inEndOperationId)Parameters
| Type | Name | Description |
|---|---|---|
| ElementExId | inStartOperationId | Identifier of the operation from witch start the refresh |
| ElementExId | inEndOperationId | Identifier of the operation to which do the refresh |
SetCuttingConditionsAbacus(ElementId, ElementId)
Sets the cutting condition abacus for an operation.
Declaration
void SetCuttingConditionsAbacus(ElementId inElementId, ElementId inAbacusId)Parameters
| Type | Name | Description |
|---|---|---|
| ElementId | inElementId | Identifier of the operation to modify. |
| ElementId | inAbacusId | Identifier of the abacus to use. |
SetOperationLinkInMovementsMethod(ElementExId, LinkMovementsMethod, DocumentId)
Set given operation link-in movement method. If method is manual, load given document.
Declaration
bool SetOperationLinkInMovementsMethod(ElementExId inElementExId, LinkMovementsMethod inLinkMethod, DocumentId inDocumentId)Parameters
| Type | Name | Description |
|---|---|---|
| ElementExId | inElementExId | Identifier of the operation to modify |
| LinkMovementsMethod | inLinkMethod | Link-in movement method to set |
| DocumentId | inDocumentId | Identifier of the document to load in case of manual method |
Returns
| Type | Description |
|---|---|
| System.Boolean | True if link method has been set |
SetOperationLinkOutMovementsMethod(ElementExId, LinkMovementsMethod, DocumentId)
Set given operation link-out movement method. If method is manual, load given document.
Declaration
bool SetOperationLinkOutMovementsMethod(ElementExId inElementExId, LinkMovementsMethod inLinkMethod, DocumentId inDocumentId)Parameters
| Type | Name | Description |
|---|---|---|
| ElementExId | inElementExId | Identifier of the operation to modify |
| LinkMovementsMethod | inLinkMethod | Link-out movement method to set |
| DocumentId | inDocumentId | Identifier of the document to load in case of manual method |
Returns
| Type | Description |
|---|---|
| System.Boolean | True if link method has been set |
SetUpToDateState(ElementId, Boolean)
Changes the state of the given operation.
Declaration
bool SetUpToDateState(ElementId inElementId, bool inState)Parameters
| Type | Name | Description |
|---|---|---|
| ElementId | inElementId | Identifier of the operation to modify. |
| System.Boolean | inState | True if the operation will be up to date, otherwise false. |
Returns
| Type | Description |
|---|---|
| System.Boolean | Returns the old value of the flag. |