Skip to content
Snippets Groups Projects
Message.pm 1.65 KiB
Newer Older
  • Learn to ignore specific revisions
  • package Travel::Status::DE::HAFAS::Message;
    
    use strict;
    use warnings;
    use 5.014;
    
    use parent 'Class::Accessor';
    
    our $VERSION = '3.01';
    
    
    Travel::Status::DE::HAFAS::Message->mk_ro_accessors(
    	qw(short text code prio ref_count));
    
    
    sub new {
    	my ( $obj, %conf ) = @_;
    
    	my $ref = \%conf;
    	bless( $ref, $obj );
    
    	return $ref;
    }
    
    1;
    
    __END__
    
    =head1 NAME
    
    Travel::Status::DE::HAFAS::Message - An arrival/departure-related message.
    
    =head1 SYNOPSIS
    
    	if ($message->lead) {
    		printf("%s: %s\n", $message->header, $message->lead);
    	}
    	else {
    		say $message->header;
    	}
    
    =head1 VERSION
    
    version 3.01
    
    =head1 DESCRIPTION
    
    Travel::Status::DE::HAFAS::Message describes a message belonging to an
    arrival or departure. Messages may refer to planned schedule changes due to
    construction work, the expected passenger volume, or similar.
    
    =head1 METHODS
    
    =head2 ACCESSORS
    
    =over
    
    =item $message->header
    
    Message header. May be a concise single-sentence summary or a mostly useless
    string such as "Information". Does not contain newlines.
    
    =item $message->lead
    
    Detailed message content. Does not contain newlines.
    
    =item $message->ref_count
    
    Counter indicating how often this message is used by the requested
    arrivals/departures. ref_count is an integer between 1 and the number of
    results.  If ref_count is 1, it is referenced by a single result only.
    
    =back
    
    =head1 DIAGNOSTICS
    
    None.
    
    =head1 DEPENDENCIES
    
    =over
    
    =item Class::Accessor(3pm)
    
    =back
    
    =head1 BUGS AND LIMITATIONS
    
    None known.
    
    =head1 SEE ALSO
    
    Travel::Status::DE::HAFAS(3pm).
    
    =head1 AUTHOR
    
    Copyright (C) 2020 by Daniel Friesel E<lt>derf@finalrewind.orgE<gt>
    
    =head1 LICENSE
    
    This module is licensed under the same terms as Perl itself.