Controller Class Summary

The following pages provide detailed information on the properties and methods of the global Controller Class. This class provides access to the general facilities provided by the Guidance Controller, e.g. high power control, E-Stop logic, configuration database values, etc. As such, this class and all of its members are uniquely defined for PreciseFlex™ controller products and do not conform to any other standards. In the case of certain methods, such as the SleepTick, very similar functionality is provided by other means within the Basic language. However, the members of this class were selected based upon ease-of-use considerations or because they provide some slightly different, but important, functionality.

As is standard in GPL, conversions between different arithmetic types, e.g. Integer, Single, Double, are automatically performed as required. So, for numeric properties and methods of the Controller Class, it is not necessary to have different variations of these members to deal with the different possible mixes of input parameter data types. Also, as appropriate, the properties and methods generally produce results that are formatted as Doubles. These results will automatically be converted to smaller data types as necessary, e.g. Double -> Integer, and will not generate an error so long as numeric overflow does not occur.

The table below summarizes the properties and methods that are described in greater detail in the following sections.

 
Member Type Description

Controller.Command

Method

Executes a console command and returns any output as a String value.

Controller.ErrorLog

Property

Returns an entry from the system Error Log as a String value or clears the Error Log.

Controller.Load

Method

Loads a GPL project into memory and compiles it in preparation for execution.

Controller.PDb

Property

Sets and gets any accessible value in the configuration parameter database.

Controller.PDbNum

Property

Optimized means to set and get a numeric value in the configuration parameter database.

Controller.PowerEnabled

Property

Sends a request to either turn on or off high (motor) power to the amplifier. Returns whether high power is on or off.

Controller.PowerState

Property

Gets the current state of the high power sequence.

Controller.RecordButton

Property

Sets and gets the latched Boolean value that indicates if the hardware MCP RECORD button has been pressed.

Controller.ShowDialog - Basic

Method

Displays a pop-up dialog box on the web Operator Control Panel.

Controller.ShowDialog - Advanced

Method

Displays a pop-up dialog box on the web Operator Control Panel.

Controller.ShowDialogMCP

Method

Displays a pop-up dialog box on the LCD display of the PreciseFlex™ Hardware Manual Control Pendant.

Controller.SleepTick

Method

Delays further execution of a thread for a specified number of Trajectory Generator periods.

Controller.SoftEStop

Property

Sets and gets the Boolean flag that triggers a Soft E-Stop.

Controller.SystemMessage

Method

Enters a message into the GPL system message log that is displayed on the web Operator Control Panel.

Controller.SystemSpeed

Property

Sets and gets the property that can reduce the speed of all robot motions.

Controller.Tick

Property

Gets the execution repetition period for the Trajectory Generator.

Controller.Timer

Property

Gets the value of the controller’s usec clock in units of seconds.

Controller.Unload

Method

Unloads an idle GPL project from memory.