annotate base/constructors.lisp @ 102:59e69a32b8d9

More docstrings

darcs-hash:20070726091550-f76cc-32dfc4cc3e4922d6801b3b2717e5c19f15a1ef92.gz

(cl:in-package #:amuse)

;; Time classes

(defun make-moment (time)
  (make-instance 'moment :time time))

;; N.B. period should never be constructed directly - it's either
;; floating or anchored or some other subclass.

(defun make-floating-period (interval)
  (make-instance 'floating-period :interval interval))


;; Should this take a moment and/or a period too?
(defun make-anchored-period (onset interval)
  (make-instance 'anchored-period
		 :time onset
		 :interval interval))

;; Pitch classes (no, not that sort of pitch class)

(defun make-chromatic-pitch (pitch-number)
  (make-instance 'chromatic-pitch :number pitch-number))

(defun make-diatonic-pitch (name accidental octave)
  (make-instance 'diatonic-pitch
		 :name name
		 :accidental accidental
		 :octave octave))

(defun make-mips-pitch (cp mp)
  (make-instance 'mips-pitch :cp cp :mp mp))

(defun make-pitch-interval (span)
  (make-instance 'pitch-interval :span span))

;; Events

(defun make-chromatic-pitched-event (pitch-number onset duration)
  (make-instance 'chromatic-pitched-event
		 :number pitch-number
		 :time onset
		 :interval duration))

(defun make-basic-time-signature (numerator denominator onset duration)
  (make-instance 'basic-time-signature
		 :numerator numerator
		 :denominator denominator
		 :time onset
		 :interval duration))

(defun make-basic-key-signature (sharp-count onset duration)
  (make-instance 'basic-key-signature
		 :sharp-count sharp-count
		 :time onset
		 :interval duration))

(defun make-midi-key-signature (sharp-count mode onset duration)
  (make-instance 'midi-key-signature
		 :sharp-count sharp-count
		 :mode mode
		 :time onset
		 :interval duration))

(defun make-tempo (bpm onset duration)
  (make-instance 'tempo
		 :bpm bpm
		 :time onset
		 :interval duration))