ProjectTimeSignature Class Reference

#include <ProjectTimeSignature.h>

Inheritance diagram for ProjectTimeSignature:

Collaboration diagram for ProjectTimeSignature:

Public Member Functions
	ProjectTimeSignature ()
	~ProjectTimeSignature () override
double	GetTempo () const
void	SetTempo (double tempo)
int	GetUpperTimeSignature () const
void	SetUpperTimeSignature (int upperTimeSignature)
int	GetLowerTimeSignature () const
void	SetLowerTimeSignature (int lowerTimeSignature)
double	GetQuarterDuration () const
double	GetBeatDuration () const
double	GetBarDuration () const
Public Member Functions inherited from ClientData::Base
virtual	~Base ()
Public Member Functions inherited from Observer::Publisher< TimeSignatureChangedMessage >
	Publisher (ExceptionPolicy *pPolicy=nullptr, Alloc a={})
	Constructor supporting type-erased custom allocation/deletion. More...
	Publisher (Publisher &&)=default
Publisher &	operator= (Publisher &&)=default
Subscription	Subscribe (Callback callback)
	Connect a callback to the Publisher; later-connected are called earlier. More...
Subscription	Subscribe (Object &obj, Return(Object::*callback)(Args...))
	Overload of Subscribe takes an object and pointer-to-member-function. More...

Static Public Member Functions
static ProjectTimeSignature &	Get (AudacityProject &project)
static const ProjectTimeSignature &	Get (const AudacityProject &project)

Private Member Functions
void	PublishSignatureChange ()

Private Attributes
double	mTempo
int	mUpperTimeSignature
int	mLowerTimeSignature

Additional Inherited Members
Public Types inherited from Observer::Publisher< TimeSignatureChangedMessage >
using	message_type = TimeSignatureChangedMessage
using	CallbackReturn = std::conditional_t< true, void, bool >
using	Callback = std::function< CallbackReturn(const TimeSignatureChangedMessage &) >
	Type of functions that can be connected to the Publisher. More...
Static Public Attributes inherited from Observer::Publisher< TimeSignatureChangedMessage >
static constexpr bool	notifies_all
Protected Member Functions inherited from Observer::Publisher< TimeSignatureChangedMessage >
CallbackReturn	Publish (const TimeSignatureChangedMessage &message)
	Send a message to connected callbacks. More...

Detailed Description

Definition at line 25 of file ProjectTimeSignature.h.

Constructor & Destructor Documentation

ProjectTimeSignature()

ProjectTimeSignature::ProjectTimeSignature

(

)

Definition at line 35 of file ProjectTimeSignature.cpp.

    : mTempo { BeatsPerMinute.Read() }
    , mUpperTimeSignature { UpperTimeSignature.Read() }
    , mLowerTimeSignature { LowerTimeSignature.Read() }
{}

~ProjectTimeSignature()

ProjectTimeSignature::~ProjectTimeSignature ( )

overridedefault

Member Function Documentation

Get() [1/2]

ProjectTimeSignature & ProjectTimeSignature::Get ( AudacityProject &  project )

static

Definition at line 24 of file ProjectTimeSignature.cpp.

{
   return project.AttachedObjects::Get<ProjectTimeSignature&>(key);
}

References key, and project.

Referenced by BarStepCase(), BeatsCase(), anonymous_namespace{BeatsNumericConverterFormatter.cpp}::BeatsFormatter::BeatsFormatter(), anonymous_namespace{EditMenus.cpp}::DoPasteNothingSelected(), Get(), ProjectFileManager::Import(), BenchmarkDialog::OnRun(), TimeSignatureToolBar::Populate(), ProjectTempoListener::ProjectTempoListener(), AudacityMirProject::ReconfigureMusicGrid(), anonymous_namespace{TimeSignatureToolBar.cpp}::TimeSignatureRestorer::RestoreUndoRedoState(), anonymous_namespace{BeatsSnapFunctions.cpp}::SnapToBar(), anonymous_namespace{BeatsSnapFunctions.cpp}::SnapToBeat(), anonymous_namespace{BeatsSnapFunctions.cpp}::SnapToTriplets(), TEST_CASE(), and anonymous_namespace{BeatsNumericConverterFormatter.cpp}::BeatsFormatter::UpdateFormat().

Here is the caller graph for this function:

Get() [2/2]

const ProjectTimeSignature & ProjectTimeSignature::Get ( const AudacityProject &  project )

static

Definition at line 30 of file ProjectTimeSignature.cpp.

{
   return Get(const_cast<AudacityProject&>(project));
}

References Get(), and project.

Here is the call graph for this function:

GetBarDuration()

double ProjectTimeSignature::GetBarDuration

(

)

const

Definition at line 107 of file ProjectTimeSignature.cpp.

{
   return GetBeatDuration() * mUpperTimeSignature;
}

References GetBeatDuration(), and mUpperTimeSignature.

Here is the call graph for this function:

GetBeatDuration()

double ProjectTimeSignature::GetBeatDuration

(

)

const

Definition at line 102 of file ProjectTimeSignature.cpp.

{
   return GetQuarterDuration() * 4.0 / mLowerTimeSignature;
}

References GetQuarterDuration(), and mLowerTimeSignature.

Referenced by GetBarDuration().

Here is the call graph for this function:

Here is the caller graph for this function:

GetLowerTimeSignature()

int ProjectTimeSignature::GetLowerTimeSignature

(

)

const

Definition at line 79 of file ProjectTimeSignature.cpp.

{
   return mLowerTimeSignature;
}

References mLowerTimeSignature.

Referenced by BeatsFormat::BeatsFormat().

Here is the caller graph for this function:

GetQuarterDuration()

double ProjectTimeSignature::GetQuarterDuration

(

)

const

Definition at line 97 of file ProjectTimeSignature.cpp.

{
   return 60.0 / mTempo;
}

References mTempo.

Referenced by GetBeatDuration().

Here is the caller graph for this function:

GetTempo()

double ProjectTimeSignature::GetTempo

(

)

const

Definition at line 43 of file ProjectTimeSignature.cpp.

{
   return mTempo;
}

References mTempo.

Referenced by BeatsFormat::BeatsFormat(), anonymous_namespace{EditMenus.cpp}::DoPasteNothingSelected(), ProjectFileManager::Import(), BenchmarkDialog::OnRun(), and ProjectTempoListener::ProjectTempoListener().

Here is the caller graph for this function:

GetUpperTimeSignature()

int ProjectTimeSignature::GetUpperTimeSignature

(

)

const

Definition at line 61 of file ProjectTimeSignature.cpp.

{
   return mUpperTimeSignature;
}

References mUpperTimeSignature.

Referenced by BeatsFormat::BeatsFormat().

Here is the caller graph for this function:

PublishSignatureChange()

void ProjectTimeSignature::PublishSignatureChange ( )

private

Definition at line 112 of file ProjectTimeSignature.cpp.

{
   Publish(TimeSignatureChangedMessage { mTempo, mUpperTimeSignature,
                                         mLowerTimeSignature });
}

References mLowerTimeSignature, mTempo, mUpperTimeSignature, and Observer::Publisher< TimeSignatureChangedMessage >::Publish().

Referenced by SetLowerTimeSignature(), SetTempo(), and SetUpperTimeSignature().

Here is the call graph for this function:

Here is the caller graph for this function:

SetLowerTimeSignature()

void ProjectTimeSignature::SetLowerTimeSignature

(

int

lowerTimeSignature

)

Definition at line 84 of file ProjectTimeSignature.cpp.

{
   if (mLowerTimeSignature != lowerTimeSignature)
   {
      mLowerTimeSignature = lowerTimeSignature;
 
      LowerTimeSignature.Write(lowerTimeSignature);
      gPrefs->Flush();
 
      PublishSignatureChange();
   }
}

References audacity::BasicSettings::Flush(), gPrefs, LowerTimeSignature, mLowerTimeSignature, PublishSignatureChange(), and Setting< T >::Write().

Referenced by TimeSignatureToolBar::Populate().

Here is the call graph for this function:

Here is the caller graph for this function:

SetTempo()

void ProjectTimeSignature::SetTempo

(

double

tempo

)

Definition at line 48 of file ProjectTimeSignature.cpp.

{
   if (mTempo != tempo)
   {
      mTempo = tempo;
 
      BeatsPerMinute.Write(tempo);
      gPrefs->Flush();
 
      PublishSignatureChange();
   }
}

References BeatsPerMinute, audacity::BasicSettings::Flush(), gPrefs, mTempo, PublishSignatureChange(), and Setting< T >::Write().

Referenced by TimeSignatureToolBar::Populate().

Here is the call graph for this function:

Here is the caller graph for this function:

SetUpperTimeSignature()

void ProjectTimeSignature::SetUpperTimeSignature

(

int

upperTimeSignature

)

Definition at line 66 of file ProjectTimeSignature.cpp.

{
   if (mUpperTimeSignature != upperTimeSignature)
   {
      mUpperTimeSignature = upperTimeSignature;
 
      UpperTimeSignature.Write(upperTimeSignature);
      gPrefs->Flush();
 
      PublishSignatureChange();
   }
}

References audacity::BasicSettings::Flush(), gPrefs, mUpperTimeSignature, PublishSignatureChange(), UpperTimeSignature, and Setting< T >::Write().

Referenced by TimeSignatureToolBar::Populate().

Here is the call graph for this function:

Here is the caller graph for this function:

Member Data Documentation

mLowerTimeSignature

int ProjectTimeSignature::mLowerTimeSignature

private

Definition at line 54 of file ProjectTimeSignature.h.

Referenced by GetBeatDuration(), GetLowerTimeSignature(), PublishSignatureChange(), and SetLowerTimeSignature().

mTempo

double ProjectTimeSignature::mTempo

private

Definition at line 52 of file ProjectTimeSignature.h.

Referenced by GetQuarterDuration(), GetTempo(), PublishSignatureChange(), and SetTempo().

mUpperTimeSignature

int ProjectTimeSignature::mUpperTimeSignature

private

Definition at line 53 of file ProjectTimeSignature.h.

Referenced by GetBarDuration(), GetUpperTimeSignature(), PublishSignatureChange(), and SetUpperTimeSignature().

---

The documentation for this class was generated from the following files:

• ProjectTimeSignature.h
• ProjectTimeSignature.cpp