NAME

Astro::STSDAS::Table::HeaderPars - Container for header values

SYNOPSIS

  use Astro::STSDAS::Table::HeaderPars;

DESCRIPTION

Astro::STSDAS::Table::HeaderPars is a container for a set of Astro::STSDAS::Table::HeaderPar objects.

Column names are stored as upper case, but case is ignored when searching by name.

Methods

new

  $pars = Astro::STSDAS::Table::HeaderPars->new;

The constructor. It takes no arguments.

npars

  $npars = $pars->npars;

The number of header parameters.

add

  $hdrp = $hdrp->add( ... );

Add a parameter to the container. The argument list is the same as for the Astro::STSDAS::Table::HeaderPar constructor, except that the $idx argument should not be specified.

It returns a reference to the new header parameter object.

pars

  @pars = $pars->pars;

This returns a list of header parameters, as Astro::STSDAS::Table::HeaderPar objects, in the order in which they were added to the container.

byname

  $hdrp = $hdrp->byname( $name );

return the parameter with the specified name.

delbyname

  $pars->delbyname( $name )

Delete the parameter with the given name from the container.

rename

  $pars->rename( $oldname, $newname );

Rename the named header parameter. It is important to use this method rather than a header's name method, to ensure the integrity of the container.

copy

  $new_pars = $pars->copy;

This returns a new Astro::STSDAS::Table::HeaderPars object which is a copy of the current object. The contained Astro::STSDAS::Table::HeaderPar objects are copies of the originals.

EXPORT

None by default.

LICENSE

This software is released under the GNU General Public License. You may find a copy at

   http://www.fsf.org/copyleft/gpl.html

AUTHOR

Diab Jerius (djerius@cpan.org)

SEE ALSO

perl(1).