Mutation Class Reference

#include "lib/time/mutation.hpp"

Description

Interface: an opaque change imposed onto some time value.

See also

time::TimeSpan::accept(Mutation const&)

TimeMutation_test

polymorphic-value.hpp

Definition at line 91 of file mutation.hpp.

Static Public Member Functions
static EncapsulatedMutation	changeTime (Time)
	Convenience factory to yield a simple Mutation changing the absolute start time.
static EncapsulatedMutation	changeDuration (Duration)
	Convenience factory: simple Mutation to adjust the duration or length of a timespan.
static EncapsulatedMutation	adjust (Offset)
	Convenience factory: simple Mutation to adjust the duration or length of a timespan.
static EncapsulatedMutation	materialise (QuTime const &)
	Convenience factory: materialise the given quantised time into an explicit fixed internal time value, according to the underlying time grid; impose the resulting value then as new time point or start point to the target.
static EncapsulatedMutation	nudge (int adjustment)
	build a time mutation to nudge the target time value by an offset, defined as number of steps on an implicit nudge grid.
static EncapsulatedMutation	nudge (int adjustment, Symbol gridID)
	build a time mutation to nudge the target time value in steps based on a pre-defined grid.

Public Member Functions
virtual	~Mutation ()
virtual void	change (Duration &) const =0
virtual void	change (TimeSpan &) const =0
virtual void	change (QuTime &) const =0

Static Protected Member Functions
static TimeValue &	imposeChange (TimeValue &, TimeValue const &)
static TimeValue &	imposeChange (TimeValue &, Offset const &)
static TimeValue &	imposeChange (TimeValue &, int)
static TimeValue &	imposeChange (QuTime &, int)

Constructor & Destructor Documentation

~Mutation()

~Mutation ( )

virtual

Definition at line 56 of file mutation.cpp.

Member Function Documentation

change() [1/3]

virtual void change ( Duration &  ) const

pure virtual

Implemented in Control< TI >.

Referenced by Duration::accept(), TimeSpan::accept(), Mutation::adjust(), Link< TI, TAR >::mutateLength(), Link< TI, TAR >::mutateTimeSpan(), Link< TI, TAR >::processValueChange(), and Link< TI, TAR >::useLengthAsChange().

Here is the caller graph for this function:

change() [2/3]

virtual void change ( TimeSpan &  ) const

pure virtual

Implemented in Control< TI >.

change() [3/3]

virtual void change ( QuTime &  ) const

pure virtual

Implemented in Control< TI >.

changeTime()

EncapsulatedMutation changeTime ( Time  newStartTime )

static

Convenience factory to yield a simple Mutation changing the absolute start time.

This whole procedure might look quite inefficient, but actually most of the abstractions are removed at runtime, leaving only a single indirection through the VTable of the Mutation Interface.

Exceptions

error::Logic

when attempting to change the (non existent) start time of a Duration

Returns

EncapsulatedMutation, which is an "polymorphic value object", actually carrying an embedded Mutation subclass with the new start time

Definition at line 285 of file mutation.cpp.

Referenced by TimeFormats_test::checkTimecodeUsageCycle(), and TimeMutation_test::mutate_by_Value().

Here is the caller graph for this function:

changeDuration()

EncapsulatedMutation changeDuration ( Duration  changedDur )

static

Convenience factory: simple Mutation to adjust the duration or length of a timespan.

Exceptions

error::Logic

when attempting to change the "duration" of a quantised time point

Returns

EncapsulatedMutation, carrying the new duration value to impose

Definition at line 296 of file mutation.cpp.

Referenced by TimeMutation_test::mutate_by_Value().

Here is the caller graph for this function:

adjust()

EncapsulatedMutation adjust ( Offset  change )

static

Convenience factory: simple Mutation to adjust the duration or length of a timespan.

Exceptions

error::Logic

when attempting to change the "duration" of a quantised time point

Returns

EncapsulatedMutation, carrying the new duration value to impose

Definition at line 307 of file mutation.cpp.

References Mutation::change().

Referenced by TimeMutation_test::mutate_by_Offset().

Here is the call graph for this function:

Here is the caller graph for this function:

materialise()

EncapsulatedMutation materialise ( QuTime const &  gridAlignedTime )

static

Convenience factory: materialise the given quantised time into an explicit fixed internal time value, according to the underlying time grid; impose the resulting value then as new time point or start point to the target.

Note

same as materialising and then invoking changeTime

Definition at line 319 of file mutation.cpp.

Referenced by TimeMutation_test::mutate_quantised().

Here is the caller graph for this function:

nudge() [1/2]

EncapsulatedMutation nudge ( int  adjustment )

static

build a time mutation to nudge the target time value by an offset, defined as number of steps on an implicit nudge grid.

If the target is an continuous (not quantised) time value or duration, an internal 'default nudge grid' will be used to calculate the offset value. Typically, this grid counts in seconds. To the contrary, when the target is a quantised value, it will be aligned to the grid point relative to the current value's next grid point, measured in number of steps. This includes materialising the internal time to the exact grid position. If especially the adjustment is zero, the internal value will be changed to literally equal the current value's next grid point.

Definition at line 336 of file mutation.cpp.

Referenced by TimeFormats_test::checkTimecodeUsageCycle(), TimeMutation_test::mutate_by_Increment(), and Mutation::nudge().

Here is the caller graph for this function:

nudge() [2/2]

EncapsulatedMutation nudge ( int  adjustment, Symbol  gridID  )

static

build a time mutation to nudge the target time value in steps based on a pre-defined grid.

Note

defined in common-services.cpp

Parameters

adjustment	number of grid steps to apply as offset
gridID	symbolic reference to a grid, which needs to be defined "somewhere" within the system, typically within the session.

See also

#nudge(int,PQuant) variant of this function using a direct grid reference

Definition at line 124 of file common-services.cpp.

References Mutation::nudge(), and Quantiser::retrieve().

Here is the call graph for this function:

imposeChange() [1/4]

TimeValue & imposeChange ( TimeValue &  target, TimeValue const &  valueToSet  )

inlinestaticprotected

actually force a change into a target time entity to mutate. Mutation is declared fried to TimeValue and thus is allowed to influence the basic value stored in each time entity

Definition at line 138 of file mutation.hpp.

Referenced by Mutation::imposeChange(), Mutation::imposeChange(), Link< TI, TAR >::mutateLength(), Link< TI, TAR >::mutateTimeSpan(), and Link< TI, TAR >::processValueChange().

Here is the caller graph for this function:

imposeChange() [2/4]

TimeValue & imposeChange ( TimeValue &  target, Offset const &  offset  )

inlinestaticprotected

variation to mutate a target time value by applying an offset

Definition at line 145 of file mutation.hpp.

References Mutation::imposeChange().

Here is the call graph for this function:

imposeChange() [3/4]

TimeValue & imposeChange ( TimeValue &  target, int  steps  )

inlinestaticprotected

nudge a target time value by a step wise offset. The standard case uses a fixed offset of 1 second per step //////////////////TICKET #810

Definition at line 154 of file mutation.hpp.

References Mutation::imposeChange().

Here is the call graph for this function:

imposeChange() [4/4]

static TimeValue & imposeChange ( QuTime &  , int    )

staticprotected

Inheritance diagram for Mutation:

Collaboration diagram for Mutation:

---

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

• mutation.hpp
• common-services.cpp
• mutation.cpp