NAME

STAR::Dictionary - Perl extension for handling dictionaries that were parsed from STAR compliant files.


Version

This documentation refers to version 0.56 of this module.


SYNOPSIS

  use STAR::Dictionary;

  $dict_obj = STAR::Dictionary->new(-file=>$file);
  @items_in_dict = $dict_obj->get_save_blocks;


DESCRIPTION

This package contains class and object methods for Dictionary objects created by STAR::Parser. This class is a sub class of STAR::DataBlock. It supports all methods from STAR::DataBlock (see related documentation), as well as the additional method get_save_blocks.


OBJECT METHODS


get_save_blocks

  Usage:   @save_blocks = $dict_obj->get_save_blocks; 

This methods returns an array with all save_ blocks found in the Dictionary object. Each item defined in the dictionary is described within a save block. In addition, items pertaining to the dictionary itself (such as _dictionary.version) are found outside of save blocks in the dictionary file. In the data structure of a Dictionary object, these items are gathered in a $s='-' save block.


AUTHOR

Wolfgang Bluhm, mail@wbluhm.com


Acknowledgments

Thanks to Phil Bourne, Helge Weissig, Anne Kuller, Doug Greer, Michele Bluhm, and others for support, help, and comments.


COPYRIGHT

Copyright (c) 2000 Wolfgang Bluhm, San Diego Supercomputer Center, University of California, San Diego. All rights reserved. This program is free software; you may redistribute it and/or modify it under the same terms as Perl itself.


SEE ALSO

STAR::Parser, STAR::DataBlock.