CAMTemplate Object

Derived from: Base Object
Defined in namespace "adsk::cam" and the header file is <Cam/CAMTemplate/CAMTemplate.h>

Description

Object that represents a template for a set of operations. These can be created from operations, optionally stored to files or in a library. The template can be used to re-create those operations in another document.

Methods

Name Description
classType

Static function that all classes support that returns the type of the class as a string. The returned string matches the string returned by the objectType property. For example if you have a reference to an object and you want to check if it's a SketchLine you can use myObject.objectType == fusion.SketchLine.classType().

createEmptyHoleTemplate

Create an empty CAMTemplate. This template will represent a hole template.

createFromFile

Create a CAMTemplate from a file on disk, i.e. Import the template file. Invalid files will produce errors

createFromOperations

Create a CAMTemplate from a list of Operations

createFromXML

Creates a CAMTemplate from an XML string. Invalid template XML will produce errors

createHoleTemplateFromOperations

Create a hole CAMTemplate from a list of hole operations. Hole templates may be used in Hole Recognition

getHoleSignatureXML

Convert hole signature to XML. This will be empty if this is not a hole template, or if there is no signature.

save

Save the CAMTemplate to a file

setHoleSignatureXML

Provide an XML snippet to specify a hole signature. This will have no effect if this is not a hole template. This will fail if the provided snippet is not valid.

Properties

Name Description
attributes Returns the collection of attributes associated with this template.
description Gets and sets the description of the template.
isHoleTemplate Whether or not this is a hole template
isValid Indicates if this object is still valid, i.e. hasn't been deleted or some other action done to invalidate the reference.
isValidTemplate Whether or not this template is in an appropriate state to be used. This means it has operations and, for hole templates, has an appropriate hole signature.
name Gets and sets the name of the template.
objectType This property is supported by all objects in the API and returns a string that contains the full name (namespace::objecttype) describing the type of the object.

It's often useful to use this in combination with the classType method to see if an object is a certain type. For example: if obj.objectType == adsk.core.Point3D.classType():
operations Expose operations.

Accessed From

CAMTemplate.createEmptyHoleTemplate, CAMTemplate.createFromFile, CAMTemplate.createFromOperations, CAMTemplate.createFromXML, CAMTemplate.createHoleTemplateFromOperations, CAMTemplateLibrary.childTemplates, CAMTemplateLibrary.templateAtURL, CreateFromCAMTemplateInput.camTemplate

Version

Introduced in version April 2023