PTOLEMY II - CiteSeerX

MoML
A common convention, used in Ptolemy II, is to add doc elements with the name “tooltip” to
define a tooltip for GUI views of the component. A tooltip is a small window with short documentation
that pops up when the mouse lingers on the graphical component.
Note that the same limitation of using markup within configure elements also applies to doc elements.
7.3.8 Ports
An entity can declare a port:
In the above example, no class is given for the port. If a port with the specified name already exists in
the class for entity A, then that port is the one referenced. Otherwise, a new port is created in Ptolemy
II by calling the newPort() method of the container. Alternatively, we can specify a class name, as in
In this case, a port will be created if one does not already exist. If it does already exist, then its class is
checked for consistency with the declared class (the pre-existing port must be an instance of the
declared class). In Ptolemy II, the typical classname for a port would be
ptolemy.actor.TypedIOPort
In Ptolemy II, the container of a port is required to be an instance of ptolemy.kernel.Entity or a derived
class.
It is often useful to declare a port to be an input, an output, or both. To do this, enclose in the port a
property named “input” or “output” or both, as in the following example:
This is an example of a pure property. Optionally, the property can be given a boolean value, as in
The value can be either “true” or “false”, where the latter will define the port to not be an output. A
port can be defined to be both an input and an output, as follows
204 Ptolemy II