Net::GPSD3::Return::POLL - Net::GPSD3 Return POLL Object

Net-GPSD3 documentation Contained in the Net-GPSD3 distribution.

Index

Code Index:

NAME

Top

Net::GPSD3::Return::POLL - Net::GPSD3 Return POLL Object

SYNOPSIS

Top

  use Net::GPSD3;
  use Data::Dumper qw{Dumper};
  my $gpsd = Net::GPSD3->new;
  my $poll = $gpsd->poll;
  print Dumper($poll);

DESCRIPTION

Top

Provides a Perl object interface to the POLL object returned by the GPSD daemon.

METHODS

Top

class

Returns the object class

string

Returns the JSON string

parent

Return the parent Net::GPSD3 object

time

timestamp

datetime

active

fix, tpv

Returns the first fix from the Fixes array or undef if none.

  my $fix=$poll->fix #isa Net::GPSD3::Return::TPV or undef

Note: I will try to keep this method consistant

Fixes

Object wrapper around JSON data

  my $fix=$poll->Fixes #isa [] of Net::GPSD3::Return::TPV objects
  my @fix=$poll->Fixes #isa () of Net::GPSD3::Return::TPV objects

Note: I'm not sure why this is an array from the protocol but do not count on this staying the same

sky

Returns the first object from the Skyviews array or undef if none.

  my $sky=$poll->sky #isa Net::GPSD3::Return::SKY or undef

Note: I will try to keep this method consistant

Skyviews

Object wrapper around JSON data

  my $sky=$poll->Skyviews #isa [] of Net::GPSD3::Return::SKY objects
  my @sky=$poll->Skyviews #isa () of Net::GPSD3::Return::SKY objects

Note: I'm not sure why this is an array from the protocol but do not count on this staying the same

Gst

Object wrapper around JSON data

  my $gst=$poll->Gst #isa [] of Net::GPSD3::Return::GST objects
  my @gst=$poll->Gst #isa () of Net::GPSD3::Return::GST objects

Note: I'm not sure why this is an array from the protocol but do not count on this staying the same

BUGS

Top

Log on RT and send to gpsd-dev email list

SUPPORT

Top

DavisNetworks.com supports all Perl applications including this package.

Try gpsd-dev email list

AUTHOR

Top

  Michael R. Davis
  CPAN ID: MRDVT
  STOP, LLC
  domain=>michaelrdavis,tld=>com,account=>perl
  http://www.stopllc.com/

COPYRIGHT

Top

This program is free software licensed under the...

  The BSD License

The full text of the license can be found in the LICENSE file included with this module.

SEE ALSO

Top

Net::GPSD3, Net::GPSD3::Return::Unknown::Timestamp

Net-GPSD3 documentation Contained in the Net-GPSD3 distribution. 
package Net::GPSD3::Return::POLL;
use strict;
use warnings;
use base qw{Net::GPSD3::Return::Unknown::Timestamp};

our $VERSION='0.14';


sub active {shift->{"active"}};


sub fix {shift->Fixes->[0]};
sub tpv {shift->Fixes->[0]};


sub Fixes {
  my $self=shift;
  $self->{"Fixes"}=[map {$self->parent->constructor(%$_, string=>$self->parent->encode($_))} $self->_fixes]
    unless defined $self->{"Fixes"};
  return wantarray ? @{$self->{"Fixes"}} : $self->{"Fixes"};
}

sub _fixes {
  my $self=shift;
  $self->{"fixes"}=[] unless ref($self->{"fixes"}) eq "ARRAY";
  return wantarray ? @{$self->{"fixes"}} : $self->{"fixes"};
}


sub sky {shift->Skyviews->[0]};


sub Skyviews {
  my $self=shift;
  $self->{"Skyviews"}=[map {$self->parent->constructor(%$_, string=>$self->parent->encode($_))} $self->_skyviews]
    unless defined $self->{"Skyviews"};
  return wantarray ? @{$self->{"Skyviews"}} : $self->{"Skyviews"};
}

sub _skyviews {
  my $self=shift;
  $self->{"skyviews"}=[] unless ref($self->{"skyviews"}) eq "ARRAY";
  return wantarray ? @{$self->{"skyviews"}} : $self->{"skyviews"};
}


sub Gst {
  my $self=shift;
  $self->{"Gst"}=[map {$self->parent->constructor(%$_, string=>$self->parent->encode($_))} $self->_gst]
    unless defined $self->{"Gst"};
  return wantarray ? @{$self->{"Gst"}} : $self->{"Gst"};
}

sub _gst {
  my $self=shift;
  $self->{"gst"}=[] unless ref($self->{"gst"}) eq "ARRAY";
  return wantarray ? @{$self->{"gst"}} : $self->{"gst"};
}


1;