Interface IDocuments
Gives access to Cam documents.
Namespace: TopSolid.Cam.NC.Kernel.Automating
Assembly: TopSolid.Cam.NC.Kernel.Automating.dll
Syntax
public interface IDocumentsMethods
CreateNCPartInclusion(DocumentId, DocumentId, SolidType, ElementId)
Creates an NC part inside the target millturn document
Declaration
ElementId CreateNCPartInclusion(DocumentId inPartSetupSourceDocument, DocumentId inMillTurnTargetDocument, SolidType inSolidType, ElementId inPartHolder)Parameters
| Type | Name | Description |
|---|---|---|
| DocumentId | inPartSetupSourceDocument | Source part setup document. |
| DocumentId | inMillTurnTargetDocument | Target millturn document. |
| SolidType | inSolidType | The solid type. |
| ElementId | inPartHolder | Tells wether it eliminates the weak portions of stock. |
Returns
| Type | Description |
|---|---|
| ElementId | Returns the inclusion operation. |
DoDiagnostic(Guid, out String)
Check TopSolid Cam application. Do not use. Internal purpose only.
Declaration
bool DoDiagnostic(Guid inId, out string outResults)Parameters
| Type | Name | Description |
|---|---|---|
| System.Guid | inId | Diagnostic Id. |
| System.String | outResults | Results. |
Returns
| Type | Description |
|---|---|
| System.Boolean | True if checked. |
Remarks
Do not use. Internal purpose only.
GetMachine(DocumentId)
Get the machine in the document.
Declaration
ElementId GetMachine(DocumentId inDocumentId)Parameters
| Type | Name | Description |
|---|---|---|
| DocumentId | inDocumentId | Identifier of the document to analyze. |
Returns
| Type | Description |
|---|---|
| ElementId | Machine of the Cam document. |
GetParts(DocumentId)
Get the list of machining parts in the document.
Declaration
List<ElementId> GetParts(DocumentId inDocumentId)Parameters
| Type | Name | Description |
|---|---|---|
| DocumentId | inDocumentId | Identifier of the document to analyze. |
Returns
| Type | Description |
|---|---|
| System.Collections.Generic.List<ElementId> | List of all machining parts. |
GetTools(DocumentId, Boolean)
Get the list of mounted tools in the document.
Declaration
List<ElementId> GetTools(DocumentId inDocumentId, bool inUsed)Parameters
| Type | Name | Description |
|---|---|---|
| DocumentId | inDocumentId | Identifier of the document to analyze. |
| System.Boolean | inUsed | True if the tools in the list are used by operations. |
Returns
| Type | Description |
|---|---|
| System.Collections.Generic.List<ElementId> | List of all mounted tools, used of not. |
GetWCSs(DocumentId)
Get the list of WCSs in the document.
Declaration
List<ElementId> GetWCSs(DocumentId inDocumentId)Parameters
| Type | Name | Description |
|---|---|---|
| DocumentId | inDocumentId | Identifier of the document to analyze. |
Returns
| Type | Description |
|---|---|
| System.Collections.Generic.List<ElementId> | List of all WCSs. |
IsCam(DocumentId)
Tells whether a document is a Cam document.
Declaration
bool IsCam(DocumentId inDocumentId)Parameters
| Type | Name | Description |
|---|---|---|
| DocumentId | inDocumentId | Identifier of the document to analyze. |
Returns
| Type | Description |
|---|---|
| System.Boolean | The document is a Cam document. |
SetMachine(DocumentId, DocumentId)
Sets the machine in the document.
Declaration
void SetMachine(DocumentId inDocumentId, DocumentId inMachineDocumentId)Parameters
| Type | Name | Description |
|---|---|---|
| DocumentId | inDocumentId | Identifier of the document to modify. |
| DocumentId | inMachineDocumentId | Identifier of the machine document to include. |
Remarks
StartModification(String, Boolean) and EnsureIsDirty(ref DocumentId) must be called before calling this method.
This method is available since v7.15.400.100.