vcHelpers.VcmFile
vcHelpers.VcmFile provides access to the metadata of a local component file.
Constructors
The object type for a local component file and its metadata is ComponentData.
| Name | Return Type | Parameters | Description |
| ComponentData | vcHelpers.VcmFile.ComponentData | String filepath | Create a new ComponentData object for a given file. |
Properties
| Name | Type | Access | Description |
| Author | String | RW | Defines the author of file. |
| Description | String | RW | Defines a short description about file and its use. |
| DetailedRevision | String | RW | Defines the version and change history of file, for example Major.Minor.Batch.Revision numbering. |
| String | RW | Defines the contact email address of file. | |
| Icon | String | R | Gets the URI of file's icon. |
| Logo | String | R | Gets the URI of file's logo. |
| Manufacturer | String | RW | Defines the manufacturer of file's real-world model. |
| MaxPayLoad | Integer | RW | Defines the maximum payload (in kilograms) of the component, for example a robot gripper. |
| Name | String | RW | Defines the name of component. |
| PreviewIcon | String | R | Gets the URI of the image displayed when a user previews file in the eCatalog panel. |
| Revision | Integer | RW | Defines the revision number of file. |
| Tags | List of Strings | RW | Defines a list of tokens used to describe application, industry and other information about the component. |
| Type | String | RW | Classifies the component by type. |
| Website | String | RW | Defines a web address/link to associate with component.
Note: This link is included with the component in a recorded 3D PDF. |
Methods
| Name | Return Type | Parameters | Description |
| write | None | None | Saves changes made to the file. |
Examples
Example. Access, edit and print component metadata
| from vcScript import * from vcHelpers.VcmFile import * cd = ComponentData(getComponent().Uri[8:]) cd.Description = 'A high volume feeder' print cd |