@MediaClass(uuid1=218169601, uuid2=257, uuid3=15360, uuid4={6,14,43,52,2,6,1,1}, definedName="Parameter", description="The Parameter class specifies an effect control value.", symbol="Parameter", isConcrete=false) public class ParameterImpl extends InterchangeObjectImpl implements Parameter, Serializable, Cloneable
Implements an effect control value. Effect control values are parameters to operations specified by operation groups.
ObjectClassPropertyID| Constructor and Description |
|---|
ParameterImpl() |
| Modifier and Type | Method and Description |
|---|---|
Parameter |
clone()
Create a cloned copy of this interchange object.
|
String |
getComment() |
ParameterDefinition |
getParameterDefinition()
Returns the parameter definition of
this operation parameter.
|
AUID |
getParameterDefinitionReference()
Returns the unique identifier for the parameter definition of this parameter.
|
String |
getParameterDefinitionReferenceString() |
TypeDefinition |
getTypeDefinition()
Returns the type definition of the data
value of this parameter.
|
static AUID |
initializeParameterDefinitionReference() |
void |
setParameterDefinition(ParameterDefinition parameterDefinition) |
void |
setParameterDefinitionReference(AUID parameterDefinitionReference) |
void |
setParameterDefinitionReferenceFromStream(AUID parameterDefinitionReference) |
void |
setParameterDefinitionReferenceString(String parameterDefinitionReference) |
addApplicationPlugin, appendXMLChildren, clearApplicationPlugins, containsApplicationPlugin, containsApplicationPlugin, countApplicationPlugins, deepEquals, disableGenerationTracking, enableGenerationTracking, equals, getApplicationPlugins, getGeneration, getLinkedGenerationID, getLinkedGenerationIDString, getObjectClass, getPersistentID, getPersistentIndex, hashCode, isGenerationTracked, removeApplicationPlugin, removeApplicationPlugin, setLinkedGenerationID, setLinkedGenerationIDString, setObjectClass, setPersistentID, setPersistentIndex, toStringaddApplicationPlugin, clearApplicationPlugins, containsApplicationPlugin, containsApplicationPlugin, countApplicationPlugins, deepEquals, disableGenerationTracking, enableGenerationTracking, equals, getApplicationPlugins, getGeneration, getLinkedGenerationID, getObjectClass, isGenerationTracked, removeApplicationPlugin, removeApplicationPlugin, setLinkedGenerationID, setObjectClass, toStringgetPersistentID, setPersistentIndexpublic ParameterDefinition getParameterDefinition()
ParameterReturns the parameter definition of this operation parameter.
getParameterDefinition in interface ParameterParameter.getParameterDefinitionReference(),
Warehouse.lookup(Class, String)public void setParameterDefinitionReference(AUID parameterDefinitionReference) throws NullPointerException, ParameterNotFoundException
@MediaPropertySetter(value="ParameterDefinitionReference") public void setParameterDefinitionReferenceFromStream(AUID parameterDefinitionReference) throws NullPointerException
NullPointerExceptionpublic void setParameterDefinition(ParameterDefinition parameterDefinition) throws NullPointerException
NullPointerExceptionpublic static final AUID initializeParameterDefinitionReference()
@MediaProperty(uuid1=100729092, uuid2=260, uuid3=0, uuid4={6,14,43,52,1,1,1,2}, definedName="ParameterDefinitionReference", aliases="Definition", typeName="AUID", optional=false, uniqueIdentifier=false, pid=19457, symbol="ParameterDefinitionReference") public AUID getParameterDefinitionReference()
Returns the unique identifier for the parameter definition of this parameter.
getParameterDefinitionReference in interface ParameterParameter.getParameterDefinition(),
DefinitionObject.getAUID(),
Warehouse.lookup(Class, AUID)public TypeDefinition getTypeDefinition()
ParameterReturns 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.
getTypeDefinition in interface ParameterParameter.getParameterDefinition(),
ParameterDefinition.getParameterType()public Parameter clone()
InterchangeObjectCreate a cloned copy of this interchange object.
clone in interface MediaEntityclone in interface InterchangeObjectclone in interface Parameterclone in class InterchangeObjectImplpublic String getComment()
getComment in class InterchangeObjectImplpublic String getParameterDefinitionReferenceString()
public void setParameterDefinitionReferenceString(String parameterDefinitionReference)
(c)2007-2016 Richard Cartwright, all rights reserved. Licensed under Apache 2 license and subject to the AMWA IPR policy.