Getting Started Documentation Glish Learn More Programming Contact Us
Version 1.9 Build 1556
News FAQ
Search Home


next up previous contents index
Next: componentlist.setlabel - Function Up: componentlist - Tool Previous: componentlist.selected - Function


componentlist.getlabel - Function



Package synthesis
Module componentmodels
Tool componentlist


Get the label of the specified component


Synopsis
getlabel(which)


Description
The getlabel function returns the label associated with the specified component. The label is an arbitrary text string that can be used to tag a component.


Arguments

which An index specifying which component
Allowed: An integer between 1 and the list length
Default: no default


Returns
A string


Example
      include 'componentlist.g'
      cl := componentlist('crux.cl');
      print cl.getlabel(1);
This example prints the label associated with the first component. It returns 'Alpha Crux'.



next up previous contents index
Next: componentlist.setlabel - Function Up: componentlist - Tool Previous: componentlist.selected - Function   Contents   Index
Please send questions or comments about AIPS++ to aips2-request@nrao.edu.
Copyright © 1995-2000 Associated Universities Inc., Washington, D.C.

Return to AIPS++ Home Page
2006-10-15