Tuplet (abc4j API Documentation)

Overview

Package

Class

Use

Tree

Deprecated

Index

Help

abc4j API Specification

PREV CLASS NEXT CLASS

FRAMES NO FRAMES

SUMMARY: NESTED | FIELD | CONSTR | METHOD

DETAIL: FIELD | CONSTR | METHOD

abc.notation
Class Tuplet

java.lang.Object
  abc.notation.Tuplet

public class Tuplet
extends java.lang.Object
extends java.lang.Object

A class to define tuplets.

Constructor Summary
`Tuplet(java.util.Vector notes, int totalRelativeLength, short defaultNoteLength)` Creates a new tuplet composed of the specified notes.

Method Summary
`java.util.Vector`	`getNotesAsVector()` Returns a new vector containing all notes of this multi note.
`short`	`getTotalDuration()` Returns the total duration of this tuplet.
`int`	`getTotalRelativeLength()` Deprecated. use totalDuration() instead. Reference to relative length should be avoided in the API bacause this is only related to the "abc world".

Methods inherited from class java.lang.Object
`equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait`

Constructor Detail

Tuplet

public Tuplet(java.util.Vector notes,
              int totalRelativeLength,
              short defaultNoteLength)

Creates a new tuplet composed of the specified notes. The total length of this tuplet will be equals to the totalRelativeLength * defaultLength.

Parameters:: notes - The NoteAbstract obejcts composing this tuplet, encapsulated inside a Vector.; totalRelativeLength - The total relative length of this tuplet multiplied by the delfault relative length gives the total absolute length of this tuplet.

Method Detail

getTotalRelativeLength

public int getTotalRelativeLength()

Deprecated. use totalDuration() instead. Reference to relative length should be avoided in the API bacause this is only related to the "abc world".

Returns the total relative length of this tuplet.

Returns:: The total relative length of this tuplet. The total relative length of this tuplet multiplied by the default relative length gives the total absolute length of this tuplet.
See Also:: getTotalDuration()

getTotalDuration

public short getTotalDuration()

Returns the total duration of this tuplet.

Returns:: The total duration of this tuplet.

getNotesAsVector

public java.util.Vector getNotesAsVector()

Returns a new vector containing all notes of this multi note.

Returns:: A new vector containing all notes of this multi note.