NAME

Astro::App::Satpass2::Wrap::Array - Wrap an array reference.

SYNOPSIS

 use Astro::App::Satpass2::Wrap::Array;

 my @array = qw{ foo bar baz };
 my $wrap = Astro::App::Satpass2::Wrap::Array->new( \@array );
 foreach ( $wrap->dereference() ) {
     say;
 }

DESCRIPTION

This class is private to the Astro-App-Satpass2 package. It can be changed or revoked without notice. All documentation is for the benefit of the author.

This class exists to mark arguments to Template-Toolkit that, when passed back through to other code, need to be dereferenced before use.

Well, honestly, it exists because I can't figure out how to get Template-Toolkit to do this on its own, and having all the relevant Astro-App-Satpass2 methods simply expand all array references has too many undesirable side effects. So what I intend to do is bless arguments that are to be expanded into this class.

METHODS

This class supports the following public methods:

new

 my $wrap = Astro::App::Satpass2::Wrap::Array->new( \@foo );

This method instantiates the object. The array reference is required, and that array reference is blessed into this class.

dereference

 my @array = $wrap->dereference();

This method returns the elements in the original array.

SUPPORT

Support is by the author. Please file bug reports at http://rt.cpan.org, or in electronic mail to the author.

AUTHOR

Thomas R. Wyant, III wyant at cpan dot org

COPYRIGHT AND LICENSE

Copyright (C) 2011-2015 by Thomas R. Wyant, III

This program is free software; you can redistribute it and/or modify it under the same terms as Perl 5.10.0. For more details, see the full text of the licenses in the directory LICENSES.

This program is distributed in the hope that it will be useful, but without any warranty; without even the implied warranty of merchantability or fitness for a particular purpose.