logo
Free, unlimited AI code reviews that run on commit
git-lrc git-lrc GitHub Install Now We'd appreciate a star git-lrc - Free, unlimited AI code reviews that run on commit | Product Hunt git-lrc - Free, unlimited AI code reviews that run on commit | Product Hunt

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

Author

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

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.

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.

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.

See Also

       STAR::Parser, STAR::DataBlock.

perl v5.38.2                                       2024-02-16                              STAR::Dictionary(3pm)

Synopsis

         use STAR::Dictionary;

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

See Also