MUSX Document Model
Loading...
Searching...
No Matches
musx::dom::EntryInfo Class Reference

Information an entry along with the entry. More...

#include <Entries.h>

Public Member Functions

std::shared_ptr< const EntrygetEntry () const
 Get the entry.
 
util::Fraction calcNextElapsedDuration () const
 Calculates the next duration position after this entry.
 

Public Attributes

util::Fraction elapsedDuration {}
 
util::Fraction actualDuration {}
 
bool v2Launch {}
 indicates if this entry (which is voice1) launches a voice2 sequence
 
unsigned graceIndex {}
 
ClefIndex clefIndex {}
 the clef index in effect for the entry.
 
ClefIndex clefIndexConcert {}
 the concert clef index in effect for the entry.
 

Detailed Description

Information an entry along with the entry.

This class is used in iteration functions to supply information about the entry along with the entry itself.

Its pointers are owned by EntryFrame.

Member Function Documentation

◆ getEntry()

std::shared_ptr< const Entry > musx::dom::EntryInfo::getEntry ( ) const
inline

Get the entry.

Exceptions
std::logic_errorif the entry pointer is no longer valid

Member Data Documentation

◆ actualDuration

util::Fraction musx::dom::EntryInfo::actualDuration {}

the actual duration of entry (in fractions of a whole note), taking into account tuplets and grace notes This is a staff-level value and must be scaled for the global value. (Use EntryInfoPtr::calcGlobalActualDuration.)

◆ elapsedDuration

util::Fraction musx::dom::EntryInfo::elapsedDuration {}

the elapsed duration within the measure where this entry occurs (in fractions of a whole note) This is a staff-level position and must be scaled for the global value. (Use EntryInfoPtr::calcGlobalElapsedDuration.)

◆ graceIndex

unsigned musx::dom::EntryInfo::graceIndex {}

the Finale grace note index, counting from 1 starting from the leftmost grace note counting rightward. the main note has a grace index of zero.