annotate src/uk/ac/qmul/eecs/depic/patterns/Sequence.java @ 4:473da40f3d39 tip

added html formatting to Daw/package-info.java
author Fiore Martin <f.martin@qmul.ac.uk>
date Thu, 25 Feb 2016 17:50:09 +0000
parents 3074a84ef81e
children
rev   line source
f@0 1 /*
f@0 2 Cross-Modal DAW Prototype - Prototype of a simple Cross-Modal Digital Audio Workstation.
f@0 3
f@0 4 Copyright (C) 2015 Queen Mary University of London (http://depic.eecs.qmul.ac.uk/)
f@0 5
f@0 6 This program is free software: you can redistribute it and/or modify
f@0 7 it under the terms of the GNU General Public License as published by
f@0 8 the Free Software Foundation, either version 3 of the License, or
f@0 9 (at your option) any later version.
f@0 10
f@0 11 This program is distributed in the hope that it will be useful,
f@0 12 but WITHOUT ANY WARRANTY; without even the implied warranty of
f@0 13 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
f@0 14 GNU General Public License for more details.
f@0 15
f@0 16 You should have received a copy of the GNU General Public License
f@0 17 along with this program. If not, see <http://www.gnu.org/licenses/>.
f@0 18 */
f@0 19 package uk.ac.qmul.eecs.depic.patterns;
f@0 20
f@0 21 /**
f@0 22 *
f@0 23 * A sequence of values arranged over time.
f@0 24 *
f@0 25 * The values are ordered by time, therefore given @ {@code i} and {@code j} such that {@code (i < j)}, the following expression is always true :
f@0 26 * {@code sequence.getValueAt(i).getTimePosition() <= sequence.getValueAt(j).getTimePosition()}
f@0 27 *
f@0 28 * The values are limited in range. {@code getRange()) returns the range
f@0 29 * of float values that a sequence value can assume.
f@0 30 *
f@0 31 */
f@0 32 public interface Sequence {
f@0 33 public float getBegin();
f@0 34
f@0 35 public float getEnd();
f@0 36
f@0 37 public int getValuesNum();
f@0 38
f@0 39 public Value getValueAt(int index);
f@0 40
f@0 41 public Range<Float> getRange();
f@0 42
f@0 43 public void addSequenceListener(SequenceListener l);
f@0 44
f@0 45 public void removeSequenceListener(SequenceListener l);
f@0 46
f@0 47 /**
f@0 48 * The length of the sequence in millisecons
f@0 49 * @return
f@0 50 */
f@0 51 public float getLen();
f@0 52
f@0 53 public interface Value {
f@0 54 public float getValue();
f@0 55
f@0 56 public float getTimePosition();
f@0 57
f@0 58 public Sequence getSequence();
f@0 59
f@0 60 public int index();
f@0 61 }
f@0 62 }