Getting Started

Documentation

Glish

Learn More

Programming

Contact Us

Version 1.9 Build 1556

News	FAQ
Search	Home

componentlist - Constructor

	Package	synthesis
	Module	componentmodels
	Tool	componentlist

Construct an componentlist from the data in an AIPS++ table

Synopsis
componentlist(filename, readonly, log)

Description

Use this constructor to construct a componentlist tool by reading the data from an AIPS++ table. To ensure that this table contains all the necessary columns and to allow the table format to be enhanced in the future, it is highly recommended that the table be created using a componentlist tool^1.3.

The table that contains the componentlist may be opened read-only by setting the readonly flag to True. When this is done some of the functions in the componentlist tool cannot be used. These include the ``set'', ``convert'', ``remove'', ``replace'', ``purge'', ``recover'', and ``sort'' functions.

Arguments

filename		The filename of the table
		Allowed:	Any valid componentlist table
		Default:	no default
readonly		Should the table be opened read only
		Allowed:	T or F
		Default:	F
log		Send a message to the logger
		Allowed:	Boolean
		Default:	T

Returns
A componentlist tool

Example

include 'componentlist.g'
cl := componentlist('crux.cl');