DeviceService Class Members
In This Topic
The following tables list the members exposed by DeviceService.
Public Constructors
Public Methods
| | Name | Description |
|---|
 | AssignMainFunction | Converts auxiliary function into main function. |
| CreateDevice | Overloaded. Creates a new device in the project and inserts it on a page. If the article has a macro specified, the macro is inserted onto the specified page. |
| CreateDeviceListItem | Overloaded. Create a new device list entry. |
| CreateFunctions | Creates new functions for a new or existing DT according to a particular numbering pattern. This functionality is only available for particular functions (terminals, pins, coil and relay contacts, device, and PLC connections and busbars). Depending on the selected function definition, the numbering pattern defines either terminal, contact, or connection point designations. |
| CreateTerminalDevice | Overloaded. Creates new terminals for a new or existing DT according to a particular numbering pattern. The terminals are generated from the function templates of the selected part, with the numbering pattern defining the terminal designations. The first terminal generated becomes the main terminal per device and receives the selected part. |
| DeleteDeviceList | Overloaded. This function deletes the device list in the given project. |
| DeleteDeviceListItem | Removes the entry from the project's device list. |
| Dispose | Destructor |
| ExportDeviceList | Overloaded. This function exports the device list of a given project. It is used for exporting devices from the planning list (but neither all devices from the project nor all from the bill of materials). |
| GetAllDeviceListItems | Returns an array of all device list items in the project. |
| GetTemplatesFromDeviceList | This method returns an array of DeviceService::TemplatesInfo containing information about function templates associated with specific part numbers existing in the device list of the given project. |
| ImportDeviceList | Overloaded. This function imports a device list into a given project. |
| ImportDevices | This function imports devices into a given project. |
| ImportDevicesExcel | This function imports devices from an Excel file into a given project. |
| ImportDevicesText | Overloaded. This function imports devices from an text file into a given project. |
| InsertAccessory3D | Creates and inserts accessories of a placement. |
| SortTerminalStrips | Sorts terminal strips with one of the following sort methods specified by sortKind parameter: - Default, - Numeric, - AlphaNumeric, - Position, - ExtCable, - Bridges, - WriteSortIdToAll |
| UpdateDevice | Overloaded. Updates a given device or a connection with data from the referenced article(s). This method can not be used for wire inside cable, but only for whole cable or single connection. |
TopSee Also
