FrameRate Class Reference

#include "lib/time/timevalue.hpp"

Description

Framerate specified as frames per second.

Implemented as rational number.

Definition at line 668 of file timevalue.hpp.

Static Public Attributes
static const FrameRate	PAL
	predefined constant for PAL framerate
static const FrameRate	NTSC
static const FrameRate	STEP
	1 frame per second
static const FrameRate	HALTED

Static Public Member Functions
static FrameRate	approx (double fps)

Public Member Functions
	FrameRate (uint fps)
	FrameRate (uint num, uint denom)
	FrameRate (size_t count, Duration timeReference)
	FrameRate (boost::rational< uint > fractionalRate)
double	asDouble () const
Duration	duration () const
	duration of one frame
std::strong_ordering	operator<=> (FrameRate const &) const =default
	derive total ordering from base class
	operator std::string () const

Constructor & Destructor Documentation

FrameRate() [1/4]

FrameRate ( uint  fps )

inline

Definition at line 811 of file timevalue.hpp.

FrameRate() [2/4]

FrameRate ( uint  num, uint  denom  )

inline

Definition at line 816 of file timevalue.hpp.

FrameRate() [3/4]

FrameRate ( size_t  count, Duration  timeReference  )

inline

Definition at line 829 of file timevalue.hpp.

FrameRate() [4/4]

FrameRate ( boost::rational< uint >  fractionalRate )

inlineexplicit

Definition at line 821 of file timevalue.hpp.

Member Function Documentation

approx()

FrameRate approx ( double  fps )

inlinestatic

Definition at line 834 of file timevalue.hpp.

References lib::time::__framerate_approximation().

Referenced by TimeValue_test::verify_invalidFramerateProtection().

Here is the call graph for this function:

Here is the caller graph for this function:

asDouble()

double asDouble ( ) const

inline

Definition at line 841 of file timevalue.hpp.

Referenced by TimeValue_test::buildDuration().

Here is the caller graph for this function:

duration()

Duration duration

(

)

const

duration of one frame

Returns

time span of one frame of this rate, cast into internal Lumiera time scale

Definition at line 286 of file time.cpp.

References FrameRate::HALTED.

Referenced by TimeGridBasics_test::createGrid_fullProcedure(), and TimeMutation_test::mutate_by_Increment().

Here is the caller graph for this function:

operator<=>()

std::strong_ordering operator<=> ( FrameRate const &  ) const

default

derive total ordering from base class

operator std::string()

operator std::string ( ) const

explicit

Member Data Documentation

PAL

const FrameRate PAL

static

predefined constant for PAL framerate

Definition at line 684 of file timevalue.hpp.

Referenced by lib::time::test::anonymous_namespace{time-control-test.cpp}::____verify_nudged(), JobPlanningPipeline_test::accessTopLevelJobTicket(), JobPlanningPipeline_test::buildBaseTickGenerator(), TimeValue_test::buildDuration(), JobPlanning_test::calculateDeadline(), PlayService::connect(), TimeGridBasics_test::createGrid_simplified(), TimeValue_test::createOffsets(), TimingConstraints_test::define_basicTimingConstraints(), TimeParsing_test::defineTestTimeGrids(), JobPlanningPipeline_test::exploreJobTickets(), JobPlanningPipeline_test::integration(), TimeMutation_test::mutate_by_Increment(), DispatcherInterface_test::pipelineBuilder(), TimeControl_test::run(), TimeMutation_test::run(), TimeFormats_test::run(), EngineInterface_test::run(), JobPlanning_test::setupDependentJob(), JobPlanning_test::simpleUsage(), TimeValue_test::verify_invalidFramerateProtection(), Timings_test::verify_next_startPoint(), and Timings_test::verify_simpleFrameStep().

NTSC

const FrameRate NTSC

static

Definition at line 685 of file timevalue.hpp.

Referenced by lib::time::build_time_from_ntsc_drop_frame(), TimeValue_test::buildDuration(), TimeQuantisation_test::checkMultipleGrids(), and TimeControl_test::run().

STEP

const FrameRate STEP

static

1 frame per second

Definition at line 686 of file timevalue.hpp.

Referenced by ChainFunctor::testGrid().

HALTED

const FrameRate HALTED

static

Definition at line 688 of file timevalue.hpp.

Referenced by FrameRate::duration().

Inheritance diagram for FrameRate:

Collaboration diagram for FrameRate:

---

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

• timevalue.hpp
• time.cpp