Getting Started

Documentation

Glish

Learn More

Programming

Contact Us

Version 1.9 Build 1556

News	FAQ
Search	Home

servers.getplotter - Function

	Package	utility
	Module	tasking
	Tool	servers

Get the plotter used by a tool

Synopsis
getplotter(id, name)

Description
When a tool uses a plot command, a pgplotter is created. The plotter is stored by defaultservers, and a reference to it may be retrieved using the getplotter function. Since it is a glish reference to the pgplotter, commands that change the state of the plotter may be issued. The main use fot this is to allow script to issue print commands to the pgplotter.

The function needs the agentid field in the record returned from the id() function of the tool. All tools should have this function, but unfortunately some may not.

Arguments

id		agentid field from record returned by tool id() function
		Allowed:	A positive integer
		Default:	no default
name		Optional name of plotfile
		Allowed:	String
		Default:	''

Returns
A record containing pgplotters or a fail

Example

	myimager := imager('3C273XC1.ms');
	myimager.plotuv();
	imagerplotter := defaultservers.getplotter(myimager.id().agentid)
	imagerplotter[1].postscript('3C273XC1.uvplot.ps');
      }

This example illustrates how to retrieve and use the pgplotter. Note that We assume in this example that the only plotter is the first one. In more complex cases, one might have to use a different element in the returned record.