|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Object ptolemy.data.type.MonotonicFunction
public abstract class MonotonicFunction
Actors often need to implement monotonic functions as part of the declaration of type constraints. This base class makes it easy to do so. In most cases, it is simply necessary to implement the getValue() and getVariables() abstract methods.
Red (neuendor) |
Yellow (neuendor) |
Constructor Summary | |
---|---|
MonotonicFunction()
|
Method Summary | |
---|---|
java.lang.Object |
getAssociatedObject()
Return null. |
abstract java.lang.Object |
getValue()
Return the result of this monotonic function. |
abstract InequalityTerm[] |
getVariables()
Return the type variables in this inequality term. |
java.lang.String |
getVerboseString()
Return an additional string describing the current value of this function. |
void |
initialize(java.lang.Object e)
Throw an Exception. |
boolean |
isSettable()
Return false. |
boolean |
isValueAcceptable()
Return true. |
void |
setValue(java.lang.Object e)
Throw an Exception. |
java.lang.String |
toString()
Override the base class to give a description of this term. |
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait |
Constructor Detail |
---|
public MonotonicFunction()
Method Detail |
---|
public java.lang.Object getAssociatedObject()
getAssociatedObject
in interface InequalityTerm
public abstract java.lang.Object getValue() throws IllegalActionException
getValue
in interface InequalityTerm
IllegalActionException
- Thrown in derived classes if
there is a problem getting the value.setValue(Object)
public abstract InequalityTerm[] getVariables()
getVariables
in interface InequalityTerm
public java.lang.String getVerboseString()
public final void initialize(java.lang.Object e) throws IllegalActionException
initialize
in interface InequalityTerm
e
- An Object representing an element in the underlying CPO.
IllegalActionException
- Always thrown.public final boolean isSettable()
isSettable
in interface InequalityTerm
public boolean isValueAcceptable()
isValueAcceptable
in interface InequalityTerm
public final void setValue(java.lang.Object e) throws IllegalActionException
setValue
in interface InequalityTerm
e
- An Object representing an element in the
underlying CPO.
IllegalActionException
- Always thrown.getValue()
public java.lang.String toString()
toString
in class java.lang.Object
|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |