Interface IWireTechnologyDocuments

Gives access to wire technology documents.

Namespace: TopSolid.Cam.NC.Wire.Automating

Assembly: TopSolid.Cam.NC.Wire.Automating.dll

Syntax

[ServiceContract]
public interface IWireTechnologyDocuments

Methods

AddTechnology(DocumentId)

Add a wire technology entity in a document.

Declaration

[OperationContract]
ElementId AddTechnology(DocumentId inDocumentId)

Parameters

Type	Name	Description
DocumentId	inDocumentId	Identifier of the document to modify.

Returns

Type	Description
ElementId	Identifier of the created wire technology entity.

FileExtension()

Gets wire technology documents file extension.

Declaration

[OperationContract]
string FileExtension()

Returns

Type	Description
System.String

GetMachines(DocumentId)

Set machine list.

Declaration

[OperationContract]
List<PdmObjectId> GetMachines(DocumentId inDocumentId)

Parameters

Type	Name	Description
DocumentId	inDocumentId	Identifier of the document to modify.

Returns

Type	Description
System.Collections.Generic.List<PdmObjectId>	Identifier list of machine document.

GetMachiningRange(DocumentId)

Set machining range state.

Declaration

[OperationContract]
bool GetMachiningRange(DocumentId inDocumentId)

Parameters

Type	Name	Description
DocumentId	inDocumentId	Identifier of the document to modify.

Returns

Type	Description
System.Boolean	Machining range state.

GetPartMaterial(DocumentId)

Set part material.

Declaration

[OperationContract]
PdmObjectId GetPartMaterial(DocumentId inDocumentId)

Parameters

Type	Name	Description
DocumentId	inDocumentId	Identifier of the document to modify.

Returns

Type	Description
PdmObjectId	Identifier of part material document.

GetTableName(DocumentId)

Get table name.

Declaration

[OperationContract]
string GetTableName(DocumentId inDocumentId)

Parameters

Type	Name	Description
DocumentId	inDocumentId	Identifier of the document to modify.

Returns

Type	Description
System.String	Table name.

GetTechnologies(DocumentId)

Get the list of wire technology in the document.

Declaration

[OperationContract]
List<ElementId> GetTechnologies(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 wire technology.

GetWireDiameter(DocumentId)

Get wire diameter.

Declaration

[OperationContract]
double? GetWireDiameter(DocumentId inDocumentId)

Parameters

Type	Name	Description
DocumentId	inDocumentId	Identifier of the document to modify.

Returns

Type	Description
System.Nullable<System.Double>	Wire diameter in SI units.

GetWireMaterial(DocumentId)

Get wire material name.

Declaration

[OperationContract]
PdmObjectId GetWireMaterial(DocumentId inDocumentId)

Parameters

Type	Name	Description
DocumentId	inDocumentId	Identifier of the document to modify.

Returns

Type	Description
PdmObjectId	Identifier of wire material document.

GetWireTableName(DocumentId)

Get wire table name.

Declaration

[OperationContract]
string GetWireTableName(DocumentId inDocumentId)

Parameters

Type	Name	Description
DocumentId	inDocumentId	Identifier of the document to modify.

Returns

Type	Description
System.String	Wire table name.

RemoveAllTechnologies(DocumentId)

Remove all wire technology entity in a document.

Declaration

[OperationContract]
void RemoveAllTechnologies(DocumentId inDocumentId)

Parameters

Type	Name	Description
DocumentId	inDocumentId	Identifier of the document to modify.

RemoveTechnology(DocumentId, ElementId)

Remove a wire technology entity in a document.

Declaration

[OperationContract]
void RemoveTechnology(DocumentId inDocumentId, ElementId inElementId)

Parameters

Type	Name	Description
DocumentId	inDocumentId	Identifier of the document to modify.
ElementId	inElementId	Identifier of the element to remove.

SetMachines(DocumentId, List<DocumentId>)

Set machine list.

Declaration

[OperationContract]
void SetMachines(DocumentId inDocumentId, List<DocumentId> inMachinesDocumentId)

Parameters

Type	Name	Description
DocumentId	inDocumentId	Identifier of the document to modify.
System.Collections.Generic.List<DocumentId>	inMachinesDocumentId	Identifier list of machine document.

Remarks

StartModification(String, Boolean) and EnsureIsDirty(ref DocumentId) must be called before calling this method.

SetMachiningRange(DocumentId, SmartBoolean)

Set machining range state.

Declaration

[OperationContract]
void SetMachiningRange(DocumentId inDocumentId, SmartBoolean inMachiningRange)

Parameters

Type	Name	Description
DocumentId	inDocumentId	Identifier of the document to modify.
SmartBoolean	inMachiningRange	Machining range

Remarks

StartModification(String, Boolean) and EnsureIsDirty(ref DocumentId) must be called before calling this method.

SetPartMaterial(DocumentId, DocumentId)

Set part material.

Declaration

[OperationContract]
void SetPartMaterial(DocumentId inDocumentId, DocumentId inMaterialDocumentId)

Parameters

Type	Name	Description
DocumentId	inDocumentId	Identifier of the document to modify.
DocumentId	inMaterialDocumentId	Identifier of part material document.

Remarks

StartModification(String, Boolean) and EnsureIsDirty(ref DocumentId) must be called before calling this method.

SetTableName(DocumentId, SmartText)

Set table name.

Declaration

[OperationContract]
void SetTableName(DocumentId inDocumentId, SmartText inTableName)

Parameters

Type	Name	Description
DocumentId	inDocumentId	Identifier of the document to modify.
SmartText	inTableName	Table name.

Remarks

StartModification(String, Boolean) and EnsureIsDirty(ref DocumentId) must be called before calling this method.

SetWireDiameter(DocumentId, SmartReal)

Set wire diameter.

Declaration

[OperationContract]
void SetWireDiameter(DocumentId inDocumentId, SmartReal inDiameter)

Parameters

Type	Name	Description
DocumentId	inDocumentId	Identifier of the document to modify.
SmartReal	inDiameter	Wire diameter in SI units.

Remarks

StartModification(String, Boolean) and EnsureIsDirty(ref DocumentId) must be called before calling this method.

SetWireMaterial(DocumentId, DocumentId)

Set wire material name.

Declaration

[OperationContract]
void SetWireMaterial(DocumentId inDocumentId, DocumentId inMaterialDocumentId)

Parameters

Type	Name	Description
DocumentId	inDocumentId	Identifier of the document to modify.
DocumentId	inMaterialDocumentId	Identifier of wire material document.

Remarks

StartModification(String, Boolean) and EnsureIsDirty(ref DocumentId) must be called before calling this method.

SetWireTableName(DocumentId, SmartText)

Set wire table name.

Declaration

[OperationContract]
void SetWireTableName(DocumentId inDocumentId, SmartText inWireTableName)

Parameters

Type	Name	Description
DocumentId	inDocumentId	Identifier of the document to modify.
SmartText	inWireTableName	Wire table name.

Remarks

StartModification(String, Boolean) and EnsureIsDirty(ref DocumentId) must be called before calling this method.