ms.writehistory - Function

Add a row of arbitrary information to the measurement set history table

Synopsis
writehistory(message, parms, origin, msname, app)

Arguments

message	in	Message to be recorded in message field
		Allowed:	Any valid string
		Default:	no default
parms	in	String to be written to input parameter field
		Allowed:	Any valid string
		Default:	''
origin	in	String to be written to origin field
		Allowed:	Any valid string
		Default:	'ms::writehistory()'
msname	in	name of selected measurement set
		Allowed:	Any valid measurement set name; defaults to currently open measurement set
		Default:	''
app	in	String to be written to application field
		Allowed:	Any valid string
		Default:	'ms'

Description
This function adds a row to the history table of the specified measurement set containing any message that the user wishes to record. By default the history entry is written to the history table of the measurement set that is currently open, the message origin is recorded as 'ms::writehistory()', the originating application is 'ms' and the input parameters field is empty.

Example

      # Make test MS
      include 'imager.g'
      imagermaketestms('3C273XC1.ms')
      # Write history entry to the test MS
      include 'ms.g'
      myms := ms('3C273XC1.ms')
      myms.writehistory('an arbitrary history message')
      # Turn off pager and list the history of MS
      system.output.pager.limit:=-1
      myms.listhistory()

A row is appended to the measurement set history table.

Next: ms.range - Function Up: ms - Tool Previous: ms.listhistory - Function Contents Index

	Package	general
	Module	ms
	Tool	ms