ptolemy.actor.util

Class ArrayOfTypesFunction

java.lang.Object

ptolemy.data.type.MonotonicFunction

ptolemy.actor.util.ArrayOfTypesFunction

All Implemented Interfaces:

InequalityTerm

public class ArrayOfTypesFunction
extends MonotonicFunction

This class implements a monotonic function that returns an array type with the element type equal to its argument.

Since:

Ptolemy II 10.0

Author:

Edward A. Lee, Marten Lohstroh

Pt.AcceptedRating:

Red (cxh)

Pt.ProposedRating:

Red (eal)

Constructor Summary

Constructors

Constructor and Description
ArrayOfTypesFunction(Typeable typeable) Construct a ArrayElementTypeFunction whose argument is the type of the specified object.
ArrayOfTypesFunction(Typeable typeable, int arrayLength) Construct a ArrayElementTypeFunction whose argument is the type of the specified object.

Method Summary

Modifier and Type	Method and Description
java.lang.Object	getValue() Return the current value of this monotonic function.
InequalityTerm[]	getVariables() Return the type variables for this function, which is the type term of the specified typeable, unless it has a constant type, in which case return an empty array.

Methods inherited from class ptolemy.data.type.MonotonicFunction

getAssociatedObject, getVerboseString, initialize, isSettable, isValueAcceptable, setValue, toString

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

ArrayOfTypesFunction

public ArrayOfTypesFunction(Typeable typeable)

Construct a ArrayElementTypeFunction whose argument is the type of the specified object.

Parameters:

typeable - A Typeable object.

ArrayOfTypesFunction

public ArrayOfTypesFunction(Typeable typeable,
                            int arrayLength)

Construct a ArrayElementTypeFunction whose argument is the type of the specified object.

Parameters:

typeable - A Typeable object.

arrayLength - The length of the array.

Method Detail

getValue

public java.lang.Object getValue()
                          throws IllegalActionException

Return the current value of this monotonic function.

Specified by:

getValue in interface InequalityTerm

Specified by:

getValue in class MonotonicFunction

Returns:

A Type.

Throws:

IllegalActionException - If the type of the argument cannot be determined.

See Also:

MonotonicFunction.setValue(Object)

getVariables

public InequalityTerm[] getVariables()

Return the type variables for this function, which is the type term of the specified typeable, unless it has a constant type, in which case return an empty array.

Specified by:

getVariables in interface InequalityTerm

Specified by:

getVariables in class MonotonicFunction

Returns:

An array of InequalityTerms.