ptolemy.actor.util

Class ConstructAssociativeType

java.lang.Object

ptolemy.data.type.MonotonicFunction

ptolemy.actor.util.ConstructAssociativeType

All Implemented Interfaces:

InequalityTerm

public class ConstructAssociativeType
extends MonotonicFunction

A function that, given a list of ports, returns a StructuredType of which the fields names and field types correspond with the given ports. The arguments to this function (the array returned by getVariables()) represent the types of the ports, in the same order as the ports are defined. The concrete subclass of StructuredType that is to be instantiated by this function depends on the type parameter passed to the constructor.

Since:

Ptolemy II 10.0

Version:

$Id: ConstructAssociativeType.java 70402 2014-10-23 00:52:20Z cxh $

Author:

Edward A. Lee, Marten Lohstroh

Accepted Rating:

Red

Proposed Rating:

Red (marten)

Constructor Summary

Constructors

Constructor and Description
ConstructAssociativeType(java.util.Collection<TypedIOPort> ports, java.lang.Class<? extends AssociativeType> type) Construct a new monotonic function.

Method Summary

Modifier and Type	Method and Description
java.lang.Object	getValue() Return a RecordType with field names equal to the given port names, and field types equal to the current inferred or declared type of the corresponding ports.
InequalityTerm[]	getVariables() Return the type variables for this function, which are the type variables for all the ports that do not have declared types.

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

ConstructAssociativeType

public ConstructAssociativeType(java.util.Collection<TypedIOPort> ports,
                                java.lang.Class<? extends AssociativeType> type)

Construct a new monotonic function.

Parameters:

ports - A list of ports used to construct the AssociativeType

type - A specific subclass to instantiate

Method Detail

getValue

public java.lang.Object getValue()
                          throws IllegalActionException

Return a RecordType with field names equal to the given port names, and field types equal to the current inferred or declared type of the corresponding ports.

Specified by:

getValue in interface InequalityTerm

Specified by:

getValue in class MonotonicFunction

Returns:

A RecordType.

Throws:

IllegalActionException - If thrown while getting the value of the typeTerm of the port or while instantiating a type.

See Also:

MonotonicFunction.setValue(Object)

getVariables

public InequalityTerm[] getVariables()

Return the type variables for this function, which are the type variables for all the ports that do not have declared types.

Specified by:

getVariables in interface InequalityTerm

Specified by:

getVariables in class MonotonicFunction

Returns:

An array of InequalityTerm.