Class MachineHelper
Helper methods for ICamApiMachine
Inherited Members
Namespace: CAMAPI.DotnetHelper
Assembly: CAMAPI.DotnetHelper.dll
Syntax
public static class MachineHelper
Methods
CreateEvaluator(ComWrapper<ICamApiMachine>)
Create instance of machine evaluator
Declaration
public static ComWrapper<ICamApiMachineEvaluator> CreateEvaluator(this ComWrapper<ICamApiMachine> machineCom)
Parameters
| Type | Name | Description |
|---|---|---|
| ComWrapper<ICamApiMachine> | machineCom | Machine |
Returns
| Type | Description |
|---|---|
| ComWrapper<ICamApiMachineEvaluator> |
GUID(ComWrapper<ICamApiMachine>)
Global identifier GUID of the machine schema
Declaration
public static string GUID(this ComWrapper<ICamApiMachine> machineCom)
Parameters
| Type | Name | Description |
|---|---|---|
| ComWrapper<ICamApiMachine> | machineCom | Machine |
Returns
| Type | Description |
|---|---|
| string |
LoadFromOperationXml(ComWrapper<ICamApiMachine>, ComWrapper<IST_XMLPropPointer>)
Update properties from operation XML
Declaration
public static void LoadFromOperationXml(this ComWrapper<ICamApiMachine> machineCom, ComWrapper<IST_XMLPropPointer> xmlProp)
Parameters
| Type | Name | Description |
|---|---|---|
| ComWrapper<ICamApiMachine> | machineCom | Machine |
| ComWrapper<IST_XMLPropPointer> | xmlProp | Operation XML properties |
MachineCaption(ComWrapper<ICamApiMachine>)
User friendly machine name
Declaration
public static string MachineCaption(this ComWrapper<ICamApiMachine> machineCom)
Parameters
| Type | Name | Description |
|---|---|---|
| ComWrapper<ICamApiMachine> | machineCom | Machine |
Returns
| Type | Description |
|---|---|
| string |
ToolPieceConnector(ComWrapper<ICamApiMachine>, int)
Get tool connector by index (0..ToolPieceConnectorsCount-1)
Declaration
public static ComWrapper<ICamApiToolConnector> ToolPieceConnector(this ComWrapper<ICamApiMachine> machineCom, int index)
Parameters
| Type | Name | Description |
|---|---|---|
| ComWrapper<ICamApiMachine> | machineCom | Machine |
| int | index | Connector index |
Returns
| Type | Description |
|---|---|
| ComWrapper<ICamApiToolConnector> |
ToolPieceConnectorsCount(ComWrapper<ICamApiMachine>)
Count of tool connectors
Declaration
public static int ToolPieceConnectorsCount(this ComWrapper<ICamApiMachine> machineCom)
Parameters
| Type | Name | Description |
|---|---|---|
| ComWrapper<ICamApiMachine> | machineCom | Machine |
Returns
| Type | Description |
|---|---|
| int |
WorkpieceConnector(ComWrapper<ICamApiMachine>, int)
Get workpiece connector by index (0..WorkpieceConnectorsCount-1)
Declaration
public static ComWrapper<ICamApiWorkpieceConnector> WorkpieceConnector(this ComWrapper<ICamApiMachine> machineCom, int index)
Parameters
| Type | Name | Description |
|---|---|---|
| ComWrapper<ICamApiMachine> | machineCom | Machine |
| int | index | Connector index |
Returns
| Type | Description |
|---|---|
| ComWrapper<ICamApiWorkpieceConnector> |
WorkpieceConnectorsCount(ComWrapper<ICamApiMachine>)
Count of workpiece connectors
Declaration
public static int WorkpieceConnectorsCount(this ComWrapper<ICamApiMachine> machineCom)
Parameters
| Type | Name | Description |
|---|---|---|
| ComWrapper<ICamApiMachine> | machineCom | Machine |
Returns
| Type | Description |
|---|---|
| int |
XMLNodeName(ComWrapper<ICamApiMachine>)
ID of machine's root XML node inside schema file
Declaration
public static string XMLNodeName(this ComWrapper<ICamApiMachine> machineCom)
Parameters
| Type | Name | Description |
|---|---|---|
| ComWrapper<ICamApiMachine> | machineCom | Machine |
Returns
| Type | Description |
|---|---|
| string |
XMLProp(ComWrapper<ICamApiMachine>)
Value in XML-file, describing operation
Declaration
public static ComWrapper<IST_XMLPropPointer> XMLProp(this ComWrapper<ICamApiMachine> machineCom)
Parameters
| Type | Name | Description |
|---|---|---|
| ComWrapper<ICamApiMachine> | machineCom | Machine |
Returns
| Type | Description |
|---|---|
| ComWrapper<IST_XMLPropPointer> |