HumdrumLine class

[Open all] [Close all] [Open all source code] [Close all source code]

The HumdrumLine class manages data conversions for the humlib library.

HumdrumLine Public functions

HumdrumLine — HumdrumLine constructor.

createLineFromTokens — Re-generate a HumdrumLine string from individual tokens on the line.

equalChar — return true if the character at the given index is the given char.

getBarlineDuration — Return the duration following a barline, or the duration of the previous barline in the data.

getBeat — Returns the beat number for the data on the current line given the input **recip representation for the duration of a beat.

getChar — Returns character at given index in string, or null if out of range.

getDuration — Get the duration of the line.

getDurationFromBarline — Returns the duration from the start of the given line to the first barline occurring before the given line.

getDurationFromStart — Get the duration from the start of the file to the start of the current line.

getDurationToBarline — Time from the starting of the current note to the next barline.

getDurationToEnd — Returns the duration from the start of the line to the end of the HumdrumFile which owns this HumdrumLine.

getLineIndex — Returns the index number of the line in the HumdrumFileBase storage for the lines.

getLineNumber — Returns the line index plus one.

getReferenceKey — Return reference key if a reference record.

getReferenceValue — Return reference value if a reference record.

getTokenCount — Returns the number of tokens on the line.

getTokenString — Returns a copy of the string component of a token.

getTokens — Returns an array of tokens pointers for a Humdrum line.

getTrackStart — Returns the starting exclusive interpretation for the given spine/track.

getXmlId — Return a unique ID for the current line.

getXmlIdPrefix — Return the pre-set XML ID attribute prefix from the owning HumdrumFile object.

hasSpines — Returns true if the line contains spines.

isAllNull — Returns true if all tokens on the line are null (".

isAllRhythmicNull — Returns true if all rhythmic data-type tokens on the line are null (".

isBarline — Returns true if starts with '=' character.

isComment — Returns true if the first character in the string is '!'.

isCommentGlobal — Returns true if a local comment.

isCommentLocal — Returns true if a local comment.

isData — Returns true if data (but not measure).

isEmpty — Returns true if no characters on line.

isExclusive — Returns true if the first two characters are "**".

isGlobal — Returns true if the line is a global record: either and empty record, a global comment or a reference record.

isInterp — Returns true if starts with '*' character.

isKernBoundaryEnd — Return true if the next data line contains no null tokens in the **kern spines.

isKernBoundaryStart — Return true if the line does not have any null tokens in **kern data which refer to data tokens above the line.

isManipulator — Returns true if any tokens on the line are manipulator interpretations.

isReference — Returns true if a reference record.

isTerminator — Returns true if all tokens on the line are terminators.

printCSV — print the line as a CSV (comma separate value) line.

printDataTypeInfo — Print the datatype of each token in the file.

printDurationInfo — Print the analyzed duration of each token in a file (for debugging).