tv.amwa.maj.iface
Interface Parameter

All Superinterfaces:

InterchangeObject

All Known Subinterfaces:

ConstantValue, VaryingValue

All Known Implementing Classes:

ConstantValue, Parameter, VaryingValue

public interface Parameter
extends InterchangeObject

Specifies an effect control value. Effect control values are parameters to operations specified by operation groups.

An example of a parameter value would be the level parameter of a video dissolve, which has control points with a value of zero (0 percent B material) at the start, to one (100 percent B material) at the end. The data value will actually be stored in either a constant value or one of the control points inside of a varying value.

Author:

Richard Cartwright

See Also:

ParameterDefinition, ParameterConstant, OperationGroup.addParameter(Parameter), OperationDefinition.addParameterDefinition(ParameterDefinition), Dictionary.getParameterDefinitions()

Method Summary

ParameterDefinition	getParameterDefinition() Returns the parameter definition of this operation parameter.
TypeDefinition	getTypeDefinition() Returns the type definition of the data value of this parameter.

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

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

Method Detail

getParameterDefinition

ParameterDefinition getParameterDefinition()

Returns the parameter definition of this operation parameter.

Returns:

Parameter definition of this operation parameter.

See Also:

ParameterDefinition.forIdentification(tv.amwa.maj.record.AUID), DefinitionObject.getAUID()

getTypeDefinition

TypeDefinition getTypeDefinition()

Returns the type definition of the data value of this parameter. It is often an integer or rational value and the value may vary with time.

Note that the type definition is stored in the base class because it should be the same for all control points inside of a varying value.

Returns:

Type definition of the data value inside the parameter.

See Also:

getParameterDefinition(), ParameterDefinition.getTypeDefinition()