Eric Wilhelm > CAD-Drawing > CAD::Drawing::IO::Circ

Download:
CAD-Drawing-0.26.tar.gz

Dependencies

Annotate this POD

CPAN RT

Open  1
View/Report Bugs
Module Version: 0.03   Source  

NAME ^

CAD::Drawing::IO::Circ - load and save for circle data

NOTICE ^

This module and the format upon which it relies should be considered extremely experimental and should not be used in production except under short-term and disposable conditions.

INFO ^

This module is intended only as a backend to CAD::Drawing::IO. The only method from here which you may want to call directly is pingcirc(), which will return information stored in the ".circ_data" file.

For loading and saving, please use the front-end interface provided by load() and save() in CAD::Drawing::IO.

AUTHOR ^

Eric L. Wilhelm <ewilhelm at cpan dot org>

http://scratchcomputing.com

COPYRIGHT ^

This module is copyright (C) 2004-2006 by Eric L. Wilhelm. Portions copyright (C) 2003 by Eric L. Wilhelm and A. Zahner Co.

LICENSE ^

This module is distributed under the same terms as Perl. See the Perl source package for details.

You may use this software under one of the following licenses:

  (1) GNU General Public License
    (found at http://www.gnu.org/copyleft/gpl.html)
  (2) Artistic License
    (found at http://www.perl.com/pub/language/misc/Artistic.html)

NO WARRANTY ^

This software is distributed with ABSOLUTELY NO WARRANTY. The author, his former employer, and any other contributors will in no way be held liable for any loss or damages resulting from its use.

Modifications ^

The source code of this module is made freely available and distributable under the GPL or Artistic License. Modifications to and use of this software must adhere to one of these licenses. Changes to the code should be noted as such and this notification (as well as the above copyright information) must remain intact on all copies of the code.

Additionally, while the author is actively developing this code, notification of any intended changes or extensions would be most helpful in avoiding repeated work for all parties involved. Please contact the author with any such development plans.

SEE ALSO ^

  CAD::Drawing
  CAD::Drawing::IO

Requisite Plug-in Functions ^

See CAD::Drawing::IO for a description of the plug-in architecture.

check_type

Returns true if $type is "circ" or $filename is a directory containing a ".circ" file.

  $fact = check_type($filename, $type);

Methods ^

load

  @list = load($drw, $directory, $opts);

save

  $drw->save();

pingcirc

Returns a hash reference for colon-separated key-value pairs in the ".circ_data" file which is found inside of $directory. If the file is not found, returns undef.

The key may not contain colons. Colons in values will be preserved as-is.

  $drw->pingcirc($directory);

write_circdata

  $drw->write_circdata($directory, \%options);
syntax highlighting: