public interface ParameterDefinition extends DefinitionObject
Specifies the definition of a kind of parameter required to control an effect.
Parameter,
ParameterConstant,
Warehouse.lookup(Class, String),
Dictionary.getParameterDefinitions(),
OperationDefinition.getOperationParametersDefined(),
TypeDefinitions.ParameterDefinitionWeakReference,
TypeDefinitions.ParameterDefinitionWeakReferenceSet,
TypeDefinitions.ParameterDefinitionStrongReference,
TypeDefinitions.ParameterDefinitionStrongReferenceSet| Modifier and Type | Method and Description |
|---|---|
ParameterDefinition |
clone()
Create a cloned copy of this parameter definition.
|
String |
getParameterDisplayUnits()
Returns the display unit property of this parameter definition, which is a displayable
string identifying the units in which the parameter is measured.
|
TypeDefinition |
getParameterType()
Returns the type definition attached to
this parameter definition, which specifies the data type of the parameter.
|
void |
setParameterDisplayUnits(String displayUnits)
Sets the display units of this parameter definition, which is a displayable string
identifying the units in which the parameter is measured.
|
getAUID, getDescription, getName, setDescription, setNameaddApplicationPlugin, clearApplicationPlugins, containsApplicationPlugin, containsApplicationPlugin, countApplicationPlugins, deepEquals, disableGenerationTracking, enableGenerationTracking, equals, getApplicationPlugins, getGeneration, getLinkedGenerationID, getObjectClass, isGenerationTracked, removeApplicationPlugin, removeApplicationPlugin, setLinkedGenerationID, setObjectClass, toStringgetPersistentID, setPersistentIndexgetWeakTargetReferenceTypeDefinition getParameterType()
Returns the type definition attached to this parameter definition, which specifies the data type of the parameter.
void setParameterDisplayUnits(@AAFString String displayUnits)
Sets the display units of this parameter definition, which is a displayable string
identifying the units in which the parameter is measured. For example: "% of
picture width". Set this optional property to null to omit
it.
displayUnits - Display units of this parameter definition.@AAFString String getParameterDisplayUnits() throws PropertyNotPresentException
Returns the display unit property of this parameter definition, which is a displayable string identifying the units in which the parameter is measured. For example: "% of picture width". This property is optional.
PropertyNotPresentException - The optional display units property
is not present in this parameter definition.ParameterDefinition clone()
Create a cloned copy of this parameter definition.
clone in interface DefinitionObjectclone in interface InterchangeObjectclone in interface MediaEntity(c)2007-2016 Richard Cartwright, all rights reserved. Licensed under Apache 2 license and subject to the AMWA IPR policy.