1.4.2.0 componentlist.rename

NRAO Home > CASA > CasaRef

componentlist.rename - Function

1.4.2 Give the list a name so it can save itself.
Description

The rename function is used to specify the name of the table associated with this componentlist.

When a componentlist is created using the emptycomponentlist constructor it is not associated with an CASA table. So when the componentlist is removed from memory its contents are lost. But if a name is attached to the componentlist, using the rename function, then its contents are saved in a table with the specified name.

If the componentlist is created using the componentlist constructor then this function will rename the table associated with the list to the user specified name. You cannot rename a componentlist that has been opened read only.

If a table with the specified name already exists then the user is prompted, using a popup dialog window, to see whether it should be overwritten. In a non-windows environment the file is not overwritten.

Arguments


Inputs
filename	The filename of the table
	allowed:	string
	Default:
log	Send a message to the logger
	allowed:	bool
	Default:	true

Returns
bool

Example

      include ’componentlist.g’
      cl := emptycomponentlist();
      cl.simulate(1);
      cl.setshape(1, ’gaussian’, ’35mas’, ’27mas’, ’-10d’)
      cl.setflux(1, [1.0, 0.2, 0.1, 0.01]);
      cl.rename(’smallblob.cl’);
      cl.close();
      n := cl.length();

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

Please send any comments or questions about CASA or AIPS++ to aips2-requests@nrao.edu

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