tv.amwa.maj.iface
Interface EventMobSlot

All Superinterfaces:

InterchangeObject, MobSlot

All Known Implementing Classes:

EventMobSlot

public interface EventMobSlot
extends MobSlot

Specifies a container for a sequence of events.

The specified rules for an event mob slot are as follows:

• An event mob slot shall have a concrete segment that is either a concrete sub-class of Event or a Sequence.
• If an event mob slot has a sequence, then the sequence shall conform to the following rules:
  • All segments in the sequence shall be events.
  • All events in the sequence shall belong to the same concrete sub-class of event.
  • All events in the sequence shall have the same data definition as the sequence.
  • In a sequence, the position of each event shall be greater than or equal to the position of the event preceding it in the sequence.

Author:

Richard Cartwright

See Also:

makeEventMobSlot(), Segment, Sequence, Event

Method Summary

Rational	getEditRate() Returns the edit rate for this mob slot, which specifies the units in which the events specify their starting time and duration
long	getEventSlotOrigin() Gets the event slot origin of this event mob slot, which specifies the point, in edit units, in a slot from which relative times are measured.
void	setEditRate(Rational editRate) Sets the edit rate for this mob slot, which specifies the units in which the events specify their starting time and duration
void	setEventSlotOrigin(Long eventSlotOrigin) Sets the event slot origin of this event mob slot, which specifies the point, in edit units, in a slot from which relative times are measured.

Methods inherited from interface tv.amwa.maj.iface.MobSlot

getDataDefinition, getName, getPhysicalNumber, getSegment, getSlotID, setName, setPhysicalNumber, setSegment, setSlotID

Methods inherited from interface tv.amwa.maj.iface.InterchangeObject

countProperties, createOptionalPropertyValue, disableGenerationTracking, enableGenerationTracking, getDefinition, getGeneration, getGenerationAUID, getProperties, getPropertyValue, isGenerationTracked, isPropertyPresent, omitOpionalProperty, setPropertyValue

Method Detail

getEditRate

Rational getEditRate()

Returns the edit rate for this mob slot, which specifies the units in which the events specify their starting time and duration

Returns:

Edit rate for this mob slot.

setEditRate

void setEditRate(Rational editRate)
                 throws NullPointerException

Sets the edit rate for this mob slot, which specifies the units in which the events specify their starting time and duration

Parameters:

editRate - Edit rate for this mob slot.

Throws:

NullPointerException - The given edit rate is null

getEventSlotOrigin

@PositionType
long getEventSlotOrigin()
                        throws PropertyNotPresentException

Gets the event slot origin of this event mob slot, which specifies the point, in edit units, in a slot from which relative times are measured. This is an optional property.

Returns:

Event slot origin of this event mob slot.

Throws:

PropertyNotPresentException - The optional event slot origin property is not present in this event mob slot.

setEventSlotOrigin

void setEventSlotOrigin(@PositionType
                        Long eventSlotOrigin)

Sets the event slot origin of this event mob slot, which specifies the point, in edit units, in a slot from which relative times are measured. Set this optional property to null to omit it.

Parameters:

eventSlotOrigin - Event slot origin of this event mob slot.