NAME

STAR::Writer - Perl extension for writing STAR::DataBlock objects as files.

Version

This documentation refers to version 0.01 of this module.

SYNOPSIS

  use STAR::Writer;
  
  STAR::Writer->write_cif( -dataref=>$data, -file=>$file );

DESCRIPTION

This module will provide several methods for writing STAR::DataBlocks as files in different format. Currently, there is a write_cif method, which writes a STAR::DataBlock or STAR::Dictionary object as a file in CIF (STAR) format.

CLASS METHODS

write_cif

  Usage:  STAR::Writer->write_cif( -dataref=>$data,
                                   -file=>$file [,
                                   -options=>$options ] );

Write the STAR::DataBlock object referenced by $data to the file specified by $file. $options are 'l' for logging activity (to STDERR) and 'd' for debugging.

COMMENTS

Categories and items are currently written out in alphabetical order. Obviously, this is of no importance to automated parsing. However, it may not be desirable for visual inspection of files.

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.