NAME

OpenGbg::Service::StyrOchStall::GetBikeStations - Get data on all bike stations

VERSION

Version 0.1404, released 2018-05-19.

SYNOPSIS

    my $service = OpenGbg->new->styr_och_stall;
    my $stations = $service->get_bike_stations;

    printf 'Time: %s', $stations->timestamp;
    print $stations->get_by_index(5)->to_text;

METHODS

timestamp

Returns the timestamp given in the response as a DateTime object.

all

Returns an array of the OpenGbg::Service::StyrOchStall::Station objects in the response.

count

Returns the number of Station objects in the response.

filter(sub { ... })

Allows filtering of the stations. Takes a sub routine reference, into which all Station objects are passed one-by-one into $_. Works like grep.

find(sub { ... })

Just like filter, except it returns the first station that matches.

get_by_index($index)

Returns the n:th OpenGbg::Service::StyrOchStall::Station object in the response.

get_by_id($id)

Returns the station with id $id.

map(sub { ... })

Like filter it takes a sub routine reference and passes each Station as $_. Eg, to get a total count of free bikes:

    use List::AllUtils 'sum';
    my $free_bikes_count = sum $response->stations->map( sub { $_->free_bikes });

sort(sub { ... })

Like filter it takes a sub routine reference. It works just like sort except the two Station objects to compare are passed as $_[0] and $_[1]

    my @most_bikes_first = $response->stations->sort( sub { $_[1]->free_bikes <=> $_[0]->free_bikes });

SOURCE

https://github.com/Csson/p5-OpenGbg

HOMEPAGE

https://metacpan.org/release/OpenGbg

AUTHOR

Erik Carlsson <info@code301.com>

COPYRIGHT AND LICENSE

This software is copyright (c) 2016 by Erik Carlsson.

This is free software; you can redistribute it and/or modify it under the same terms as the Perl 5 programming language system itself.

cpanm OpenGbg

perl -MCPAN -e shell
install OpenGbg