The time-interval Reference Manual

Table of Contents

The time-interval Reference Manual

This is the time-interval Reference Manual, version 0.0.1, generated automatically by Declt version 3.0 "Montgomery Scott" on Fri Jun 26 12:23:59 2020 GMT+0.

1 Introduction

time-interval

Cyrus Harmon

time-interval is a common lisp library for flexibly encoding time intervals. It relies heavily on the local-time library for the representation of particular points in time, or as local-time calls them, timestamps.

The primary motivation for time-interval is to be able to represent periods of time such as "6 months from July 1, 2008". The idea here isn't to represent the start and dates (or times) explicitly, but rather to flexibly represent the interval. The difficulty arises from the fact that a length of time such as "6 months" can't be uniquely represented as a number of days, hours, minutes, etc... Depending on what the starting point is, the number of days (hours, etc...) in a 6-month interval will change. Therefore, we need a way of representing the time intervals and for computing a new exact time given a starting time and a time interval.

Required Libraries:

cl-ppcre, local-time

Classes:

time-interval

The time-interval class is used for representing a given interval of time, such as 6 months, 2 days, 4 hours and 3 seconds. Each of the components can independenly be positive or negative, so we can have, for instance, an interval that represents 1 hour less than two days, by doing:

(make-instance 'time-interval :hours -1 :days 2)

or:

(time-interval :hours -1 :days 2)

2 Systems

The main system appears first, followed by any subsystem dependency.

2.1 time-interval

Author

Cyrus Harmon <ch-lisp@bobobeach.com>

License

BSD

Description

A library for representing intervals of time

Version

0.0.1

Dependencies

• cl-ppcre
• local-time

Source

time-interval.asd (file)

Components

• package.lisp (file)
• time-interval.lisp (file)

3 Files

Files are sorted by type and then listed depth-first from the systems components trees.

3.1 Lisp

3.1.1 time-interval.asd

Location

time-interval.asd

Systems

time-interval (system)

3.1.2 time-interval/package.lisp

Parent

time-interval (system)

Location

package.lisp

Packages

time-interval

3.1.3 time-interval/time-interval.lisp

Dependency

package.lisp (file)

Parent

time-interval (system)

Location

time-interval.lisp

Exported Definitions

• copy-time-interval (function)
• make-timestamp* (function)
• negate-time-interval (function)
• parse-time-interval-string (function)
• t+ (generic function)
• t+ (method)
• t+ (method)
• t+ (method)
• t- (generic function)
• t- (method)
• t- (method)
• t- (method)
• time-interval (function)
• time-interval (class)
• timestamp-decoded-difference (function)

Internal Definitions

• *unit-hash* (special variable)
• interval-days (method)
• (setf interval-days) (method)
• interval-hours (method)
• (setf interval-hours) (method)
• interval-minutes (method)
• (setf interval-minutes) (method)
• interval-months (method)
• (setf interval-months) (method)
• interval-nanoseconds (method)
• (setf interval-nanoseconds) (method)
• interval-seconds (method)
• (setf interval-seconds) (method)
• interval-weeks (method)
• (setf interval-weeks) (method)
• interval-years (method)
• (setf interval-years) (method)
• or-zero (macro)
• timestamp-add-interval (function)

4 Packages

Packages are listed by definition order.

4.1 time-interval

Source

package.lisp (file)

Nickname

interval

Use List

common-lisp

Exported Definitions

• copy-time-interval (function)
• make-timestamp* (function)
• negate-time-interval (function)
• parse-time-interval-string (function)
• t+ (generic function)
• t+ (method)
• t+ (method)
• t+ (method)
• t- (generic function)
• t- (method)
• t- (method)
• t- (method)
• time-interval (function)
• time-interval (class)
• timestamp-decoded-difference (function)

Internal Definitions

• *unit-hash* (special variable)
• interval-days (generic function)
• interval-days (method)
• (setf interval-days) (method)
• (setf interval-days) (generic function)
• interval-hours (generic function)
• interval-hours (method)
• (setf interval-hours) (method)
• (setf interval-hours) (generic function)
• interval-minutes (generic function)
• interval-minutes (method)
• (setf interval-minutes) (method)
• (setf interval-minutes) (generic function)
• interval-months (generic function)
• interval-months (method)
• (setf interval-months) (method)
• (setf interval-months) (generic function)
• interval-nanoseconds (generic function)
• interval-nanoseconds (method)
• (setf interval-nanoseconds) (method)
• (setf interval-nanoseconds) (generic function)
• interval-seconds (generic function)
• interval-seconds (method)
• (setf interval-seconds) (method)
• (setf interval-seconds) (generic function)
• interval-weeks (generic function)
• interval-weeks (method)
• (setf interval-weeks) (method)
• (setf interval-weeks) (generic function)
• interval-years (generic function)
• interval-years (method)
• (setf interval-years) (method)
• (setf interval-years) (generic function)
• or-zero (macro)
• timestamp-add-interval (function)

5 Definitions

Definitions are sorted by export status, category, package, and then by lexicographic order.

5.1 Exported definitions

5.1.1 Functions

Function: copy-time-interval ORIG

Package

time-interval

Source

time-interval.lisp (file)

Function: make-timestamp* &key YEAR MONTH DAY HOUR MINUTE SECOND NANOSECOND

Package

time-interval

Source

time-interval.lisp (file)

Function: negate-time-interval ORIG

Package

time-interval

Source

time-interval.lisp (file)

Function: parse-time-interval-string STRING

Package

time-interval

Source

time-interval.lisp (file)

Function: time-interval &rest ARGS

Package

time-interval

Source

time-interval.lisp (file)

Function: timestamp-decoded-difference TEND TSTART

Computes the difference between the individual components of local-time:timestamp t1 and t2. Returns 8 values: dyear dmonth dday dhh dmm dss dns dday-of-week where dyear is the difference in years, etc...

Package

time-interval

Source

time-interval.lisp (file)

5.1.2 Generic functions

Generic Function: t+ TIME-OR-INTERVAL-1 TIME-OR-INTERVAL-2

Package

time-interval

Source

time-interval.lisp (file)

Methods

Method: t+ (T1 time-interval) (T2 time-interval)

Method: t+ (T1 time-interval) (T2 timestamp)

Method: t+ (T1 timestamp) (T2 time-interval)

Generic Function: t- TIME-OR-INTERVAL-1 TIME-OR-INTERVAL-2

Package

time-interval

Source

time-interval.lisp (file)

Methods

Method: t- (T1 timestamp) (T2 timestamp)

Method: t- (T1 time-interval) (T2 time-interval)

Method: t- (T1 timestamp) (T2 time-interval)

5.1.3 Classes

Class: time-interval ()

Package

time-interval

Source

time-interval.lisp (file)

Direct superclasses

standard-object (class)

Direct methods

• t- (method)
• t- (method)
• t+ (method)
• t+ (method)
• t+ (method)
• print-object (method)
• interval-nanoseconds (method)
• interval-nanoseconds (method)
• interval-seconds (method)
• interval-seconds (method)
• interval-minutes (method)
• interval-minutes (method)
• interval-hours (method)
• interval-hours (method)
• interval-days (method)
• interval-days (method)
• interval-weeks (method)
• interval-weeks (method)
• interval-months (method)
• interval-months (method)
• interval-years (method)
• interval-years (method)

Direct slots

Slot: years

Initargs

:years

Initform

0

Readers

interval-years (generic function)

Writers

(setf interval-years) (generic function)

Slot: months

Initargs

:months

Initform

0

Readers

interval-months (generic function)

Writers

(setf interval-months) (generic function)

Slot: weeks

Initargs

:weeks

Initform

0

Readers

interval-weeks (generic function)

Writers

(setf interval-weeks) (generic function)

Slot: days

Initargs

:days

Initform

0

Readers

interval-days (generic function)

Writers

(setf interval-days) (generic function)

Slot: hours

Initargs

:hours

Initform

0

Readers

interval-hours (generic function)

Writers

(setf interval-hours) (generic function)

Slot: minutes

Initargs

:minutes

Initform

0

Readers

interval-minutes (generic function)

Writers

(setf interval-minutes) (generic function)

Slot: seconds

Initargs

:seconds

Initform

0

Readers

interval-seconds (generic function)

Writers

(setf interval-seconds) (generic function)

Slot: nanoseconds

Initargs

:nanoseconds

Initform

0

Readers

interval-nanoseconds (generic function)

Writers

(setf interval-nanoseconds) (generic function)

5.2 Internal definitions

5.2.1 Special variables

Special Variable: *unit-hash*

Package

time-interval

Source

time-interval.lisp (file)

5.2.2 Macros

Macro: or-zero VALUE

Package

time-interval

Source

time-interval.lisp (file)

5.2.3 Functions

Function: timestamp-add-interval TIME INTERVAL

Package

time-interval

Source

time-interval.lisp (file)

5.2.4 Generic functions

Generic Function: interval-days OBJECT

Generic Function: (setf interval-days) NEW-VALUE OBJECT

Package

time-interval

Methods

Method: interval-days (TIME-INTERVAL time-interval)

automatically generated reader method

Source

time-interval.lisp (file)

Method: (setf interval-days) NEW-VALUE (TIME-INTERVAL time-interval)

automatically generated writer method

Source

time-interval.lisp (file)

Generic Function: interval-hours OBJECT

Generic Function: (setf interval-hours) NEW-VALUE OBJECT

Package

time-interval

Methods

Method: interval-hours (TIME-INTERVAL time-interval)

automatically generated reader method

Source

time-interval.lisp (file)

Method: (setf interval-hours) NEW-VALUE (TIME-INTERVAL time-interval)

automatically generated writer method

Source

time-interval.lisp (file)

Generic Function: interval-minutes OBJECT

Generic Function: (setf interval-minutes) NEW-VALUE OBJECT

Package

time-interval

Methods

Method: interval-minutes (TIME-INTERVAL time-interval)

automatically generated reader method

Source

time-interval.lisp (file)

Method: (setf interval-minutes) NEW-VALUE (TIME-INTERVAL time-interval)

automatically generated writer method

Source

time-interval.lisp (file)

Generic Function: interval-months OBJECT

Generic Function: (setf interval-months) NEW-VALUE OBJECT

Package

time-interval

Methods

Method: interval-months (TIME-INTERVAL time-interval)

automatically generated reader method

Source

time-interval.lisp (file)

Method: (setf interval-months) NEW-VALUE (TIME-INTERVAL time-interval)

automatically generated writer method

Source

time-interval.lisp (file)

Generic Function: interval-nanoseconds OBJECT

Generic Function: (setf interval-nanoseconds) NEW-VALUE OBJECT

Package

time-interval

Methods

Method: interval-nanoseconds (TIME-INTERVAL time-interval)

automatically generated reader method

Source

time-interval.lisp (file)

Method: (setf interval-nanoseconds) NEW-VALUE (TIME-INTERVAL time-interval)

automatically generated writer method

Source

time-interval.lisp (file)

Generic Function: interval-seconds OBJECT

Generic Function: (setf interval-seconds) NEW-VALUE OBJECT

Package

time-interval

Methods

Method: interval-seconds (TIME-INTERVAL time-interval)

automatically generated reader method

Source

time-interval.lisp (file)

Method: (setf interval-seconds) NEW-VALUE (TIME-INTERVAL time-interval)

automatically generated writer method

Source

time-interval.lisp (file)

Generic Function: interval-weeks OBJECT

Generic Function: (setf interval-weeks) NEW-VALUE OBJECT

Package

time-interval

Methods

Method: interval-weeks (TIME-INTERVAL time-interval)

automatically generated reader method

Source

time-interval.lisp (file)

Method: (setf interval-weeks) NEW-VALUE (TIME-INTERVAL time-interval)

automatically generated writer method

Source

time-interval.lisp (file)

Generic Function: interval-years OBJECT

Generic Function: (setf interval-years) NEW-VALUE OBJECT

Package

time-interval

Methods

Method: interval-years (TIME-INTERVAL time-interval)

automatically generated reader method

Source

time-interval.lisp (file)

Method: (setf interval-years) NEW-VALUE (TIME-INTERVAL time-interval)

automatically generated writer method

Source

time-interval.lisp (file)

Appendix A Indexes

A.1 Concepts

A.2 Functions

A.3 Variables

A.4 Data types