vcRoutine

vcRoutine contains a collection of statements that can be executed in a robot program.

Inherits: vcScope

Properties

Name Type Access Description
IsPersistent Boolean RW Defines if the routine is saved with the program.

The default value is True.

Name String RW Defines the name of the routine.
Program vcProgram R Gets the program associated with the routine.
Properties List of vcProperty R Gets a list of properties in the routine.

Methods

Name Return Type Parameters Description
createProperty vcProperty Enumeration type, String name Creates a new property of a given type and name in the routine, and then returns the new property.

An optional constraints argument can be used to define constraints for new property, which must be defined at the time of creation.

See Property Constants for more information.

deleteProperty None vcProperty property Deletes a given property in the routine.
getProperty vcProperty String name Returns a property matching a given name in the routine; otherwise returns None.