Steffen Müller > Astro-Nova > Astro::Nova::DMS

Download:
Astro-Nova-0.07.tar.gz

Dependencies

Annotate this POD

CPAN RT

New  1
Open  0
View/Report Bugs
Source  

NAME ^

Astro::Nova::DMS - Perl representation of a libnova ln_dms (degrees, minutes, seconds)

SYNOPSIS ^

  use Astro::Nova qw(functions ...);
  my $date = Astro::Nova::DMS->new();
  $date->set_year(...);
  # ...
  print $date->as_ascii(), "\n";
  my @members = $date->get_all();

  my $dms = Astro::Nova::DMS->from_string("4°50'2'' W"); # sgn=-1, degrees=4, minutes=50, seconds=2
  $dms = Astro::Nova::DMS->from_string("-4°50'"); # sgn=-1, degrees=4, minutes=50, seconds=0

DESCRIPTION ^

This class represents a libnova ln_dms struct. The struct has the following layout:

  ln_dms {
    unsigned short  neg
    unsigned short  degrees
    unsigned short  minutes
    double          seconds
  }

METHODS ^

new

Constructor returns a new Astro::Nova::DMS. Optionally takes key/value pairs for setting the struct members. Extra arguments are ignored. Uninitialized struct members are set to zero.

get_... / set_...

Get or set any of the class attributes. (See list above)

get_all

Returns all members as a list.

set_all

Sets all members. Takes a list of values which must be in the order shown above. Any missing values are ignored, undefs are skipped.

from_string

Parses a string of the form X°Y'Z'' DIR where X, Y, Z are numbers and DIR may be a direction [EWNS] (W sets sign to negative). Omitted parts are set to zero.

If called as a class methods, returns a new DMS. If called on an existing object, that object is modified.

as_ascii

Returns a human-readable ASCII table of the date information.

members

Returns a list of all members in order.

to_degrees / to_radians / to_hms

Convert to degrees or radians (returns a number).

to_hms Converts to Astro::Nova::HMS (hours).

from_degrees / from_radians / from_dms

When called as a class method, creates a new Astro::Nova::HMS object from the given degrees/radians value or Astro::Nova::DMS object.

When called as an object method, sets the current object's state instead.

SEE ALSO ^

Astro::Nova

libnova website: http://libnova.sourceforge.net/

AUTHOR ^

Steffen Mueller, <smueller@cpan.org>

COPYRIGHT AND LICENSE ^

The Astro::Nova wrapper of libnova is copyright (C) 2009-2010 by Steffen Mueller.

The wrapper code is free software; you can redistribute it and/or modify it under the same terms as Perl itself, either Perl version 5.8.0 or, at your option, any later version of Perl 5 you may have available.

libnova is maintained by Liam Girdwood and Petr Kubanek.

libnova is released under the GNU LGPL. This may limit the licensing terms of the wrapper code. If in doubt, ask a lawyer.

syntax highlighting: