Class TopSolidHostInstance
Represents a TopSolid host instance providing WCF services for automating.
Inherited Members
Namespace: TopSolid.Kernel.Automating
Assembly: TopSolid.Kernel.Automating.dll
Syntax
[AvailableSinceVersion(7, 10, 0, 0)]
public class TopSolidHostInstance
Remarks
When automating several instances of TopSolid at the same time one must make and use several instances of this class (one per TopSolid instance), otherwise if only one instance of TopSolid is to be automated, it is possible to simply use the TopSolidHost static class.
This class is available since v7.10.
Constructors
| Name | Description |
|---|---|
| TopSolidHostInstance() | Initializes a new instance of the TopSolidHostInstance class. |
Properties
| Name | Description |
|---|---|
| Application | Gets access to the application, or null if not available. |
| Arguments | Gets or sets the arguments to declare to the TopSolid process when the process needs to be started. To set before the call to the Connect() methods. |
| Classifications | Gets access to classifications, or null if not available. |
| ClientAddress | Gets the client IP address used for receiving events when using TCP, or null for not managing events. |
| ClientName | Gets the client name, or null if anonymous. |
| ClientPort | Gets the client port used for receiving events when using TCP, or 0 for not managing events. |
| Documents | Gets access to documents, or null if not available. |
| DocumentsEventsHost | Gets access to the documents events service host, or null if not created. |
| Elements | Gets access to elements, or null if not available. |
| Entities | Gets access to entities, or null if not available. |
| Families | Gets access to families, or null if not available. |
| Geometries2D | Gets access to 2D geometric entities, or null if not available. |
| Geometries3D | Gets access to 3D geometric entities, or null if not available. |
| Healing | Gets access to healing, or null if not available. |
| HostAddress | Gets the host IP address, or null if not using TCP. |
| HostPort | Gets the host port, or 0 if not using TCP. |
| IsConnected | Tells whether TopSolid is connected. |
| Layers | Gets access to layer entities, or null if not available. |
| Licenses | Gets access to licenses, or null if not available. |
| Materials | Gets access to materials, or null if not available. |
| Operations | Gets access to operations, or null if not available. |
| Options | Gets access to documents options, or null if not available. |
| Parameters | Gets access to parameter entities, or null if not available. |
| Pdm | Gets access to the PDM, or null if not available. |
| PdmAdmin | Gets access to the PDM administration, or null if not available. |
| PdmSecurity | Gets access to the PDM security, or null if not available. |
| PdmWorkflow | Gets access to the PDM administration, or null if not available. |
| PipeName | Gets or sets the name used to make named pipe, or null for default. |
| Shapes | Gets access to shape entities, or null if not available. |
| Sketches2D | Gets access to 2D sketches, or null if not available. |
| Sketches3D | Gets access to 3D sketches, or null if not available. |
| Textures | Gets access to textures, or null if not available. |
| Units | Gets access to units, or null if not available. |
| User | Gets access to the user, or null if not available. |
| Version | Gets the version of TopSolid host, or 0 if not connected. |
| Visualization3D | Gets access to 3D visualization, or null if not available. |
Methods
| Name | Description |
|---|---|
| Connect() | Connects to TopSolid application. |
| Connect(bool, int) | Connects to TopSolid application. |
| Connect(bool, int, string) | Connects to TopSolid application. |
| Connect(string) | Connects to TopSolid application. |
| DefineConnection(string, int, string, int) | Defines the connection between this client application and TopSolid host for remote access. |
| Disconnect() | Disconnects from TopSolid application. |
| HandleDocumentsEvents(Type) | Starts documents events handling. |
| MakeClientHost(Type, Type) | Makes a TopSolid client WCF host. |
Events
| Name | Description |
|---|---|
| Exited | This event is raised when the host process was running on the local machine and has exited. |