Interface IProcesses

Gives access to processes.

Namespace: TopSolid.Cad.Design.Automating

Assembly: TopSolid.Cad.Design.Automating.dll

Syntax

[ServiceContract]
[AvailableSinceVersion(7, 19, 400, 140)]
public interface IProcesses

Remarks

This interface is available since v7.19.400.140

Methods

DefineProcess(DocumentId, ElementId, DocumentId, Boolean)

Method to define a process

Declaration

[OperationContract]
[AvailableSinceVersion(7, 19, 400, 140)]
void DefineProcess(DocumentId inDocument, ElementId inFunctionId, DocumentId inPartProcessDocument, bool inMakesSubComponentProcesses)

Parameters

Type	Name	Description
DocumentId	inDocument	the main document
ElementId	inFunctionId	the function in current document
DocumentId	inPartProcessDocument	the part process document
Boolean	inMakesSubComponentProcesses	whether to treat subcomponent processes

FindFunctionProcesses(DocumentId)

Finds available processes from a function document

Declaration

[OperationContract]
[AvailableSinceVersion(7, 19, 400, 140)]
List<PdmObjectId> FindFunctionProcesses(DocumentId inFunctionDocumentId)

Parameters

Type	Name	Description
DocumentId	inFunctionDocumentId	Function document to analyze

Returns

Type	Description
List<PdmObjectId>	List of available processes

FindLocalProcesses(DocumentId)

Finds local processes of a document

Declaration

[OperationContract]
[AvailableSinceVersion(7, 19, 400, 140)]
List<PdmObjectId> FindLocalProcesses(DocumentId inDocumentId)

Parameters

Type	Name	Description
DocumentId	inDocumentId	document to analyze.

Returns

Type	Description
List<PdmObjectId>	List of local available processes

GetProcess(DocumentId)

Gets process associated to a document

Declaration

[OperationContract]
[AvailableSinceVersion(7, 19, 400, 140)]
ElementId GetProcess(DocumentId inDocumentId)

Parameters

Type	Name	Description
DocumentId	inDocumentId	document to analyze

Returns

Type	Description
ElementId	process or empty if no process associated.

GetProcessDefinitionDocument(ElementId)

Gets process definition document

Declaration

[OperationContract]
[AvailableSinceVersion(7, 19, 400, 140)]
DocumentId GetProcessDefinitionDocument(ElementId inProcessId)

Parameters

Type	Name	Description
ElementId	inProcessId	process from host document

Returns

Type	Description
DocumentId	process definition document