1.3.1.0 ms.writehistory

NRAO Home > CASA > CASA Toolkit Reference Manual

ms.writehistory - Function

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

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 ’MSHistoryHandler::addMessage()’, the originating application is ’ms’ and the input parameters field is empty.

Arguments


Inputs
message	Message to be recorded in message field
	allowed:	string
	Default:
parms	String to be written to input parameter field
	allowed:	string
	Default:
origin	String to be written to origin field
	allowed:	string
	Default:	MSHistoryHandler::addMessage()
msname	name of selected measurement set
	allowed:	string
	Default:
app	String to be written to application field
	allowed:	string
	Default:	ms

Returns
bool

Example

      ms.open(’3C273XC1.MS’)
      ms.writehistory(’an arbitrary history message’)
      ms.listhistory()

    A row is appended to the measurement set history table.

__________________________________________________________________

[next] [prev] [prev-tail] [front] [up]

More information about CASA may be found at the CASA web page

This code is available under the terms of the GNU General Public Lincense