File Coverage

blib/lib/perfSONAR_PS/Time.pm

Criterion	Covered	Total	%
statement	44	46	95.6
branch	11	12	91.6
condition			n/a
subroutine	11	11	100.0
pod	6	6	100.0
total	72	75	96.0

package perfSONAR_PS::Time;

use strict;
use warnings;
use Log::Log4perl qw(get_logger);
use Data::Dumper;

use fields 'TYPE', 'STARTTIME', 'ENDTIME', 'DURATION', 'TIME';

our $VERSION = 0.09;

=head1 NAME

perfSONAR_PS::Time - A module that provides methods for the a simple time
element that can represent either single points in time or time ranges as unix
timestamps.

=cut

=head2 new ($package, $type, $arg1, $arg2)
    This allocates a perfSONAR_PS::Time element. The type parameter can be one
    of 'range', 'duration' or 'point'. If the type is 'point', then $arg1 is
    the time parameter as a unix timestamp. If the type is 'range', then $arg1
    is the startTime and $arg2 is the endTime. If the type is 'duration', then
    $arg1 is the startTime and $arg2 is the duration.
=cut
sub new {
	my ($package, $type, $arg1, $arg2) = @_;
	my $logger = get_logger("perfSONAR_PS::Time");

    my $self = fields::new($package);

	if ($type eq "range") {
		$self->{TYPE} = "range";
		$self->{STARTTIME} = $arg1;
		$self->{ENDTIME} = $arg2;
		$self->{DURATION} = $arg2 - $arg1;
	} elsif ($type eq "duration") {
		$self->{TYPE} = "duration";
		$self->{STARTTIME} = $arg1;
		$self->{DURATION} = $arg2;
	} elsif ($type eq "point") {
		$self->{TYPE} = "point";
		$self->{TIME} = $arg1;
	} else {
		$logger->error("Invalid type: $type");
		return;
	}

    return $self;
}

=head2 getType ($self)
    This function returns what type 'point', 'range' or 'duration' that this
    Time element is.
=cut
sub getType {
	my ($self) = @_;

	return $self->{TYPE};
}

=head2 getTime ($self)
    This function is valid for Time elements of type 'point' and simply returns
    the point in time that this element describes.
=cut
sub getTime {
	my ($self) = @_;

	return $self->{TIME};
}

=head2 getStartTime ($self)
    This function is valid for Time elements of type 'range' or 'duration' and
    returns the starting point of the time range.
=cut
sub getStartTime {
	my ($self) = @_;
	if ($self->{TYPE} eq "point") {
		return $self->{TIME};
	} else {
		return $self->{STARTTIME};
	}
}

=head2 getEndTime ($self)
    This function is valid for Time elements of type 'range' or 'duration' and
    returns the ending point of the time range.
=cut
sub getEndTime {
	my ($self) = @_;

	if ($self->{TYPE} eq "duration") {
		return $self->{STARTTIME} + $self->{DURATION};
	} elsif ($self->{TYPE} eq "range") {
		return $self->{ENDTIME};
	} else {
		return $self->{TIME};
	}
}

=head2 getDuration ($self)
    This function is valid for Time elements of type 'duration' and
    returns the duration of the time range.
=cut
sub getDuration {
	my ($self) = @_;

	return $self->{DURATION};
}

1;

__END__