/*
@Copyright (c) 2008-2009 The Regents of the University of California.
All rights reserved.
Permission is hereby granted, without written agreement and without
license or royalty fees, to use, copy, modify, and distribute this
software and its documentation for any purpose, provided that the
above copyright notice and the following two paragraphs appear in all
copies of this software.
IN NO EVENT SHALL THE UNIVERSITY OF CALIFORNIA BE LIABLE TO ANY PARTY
FOR DIRECT, INDIRECT, SPECIAL, INCIDENTAL, OR CONSEQUENTIAL DAMAGES
ARISING OUT OF THE USE OF THIS SOFTWARE AND ITS DOCUMENTATION, EVEN IF
THE UNIVERSITY OF CALIFORNIA HAS BEEN ADVISED OF THE POSSIBILITY OF
SUCH DAMAGE.
THE UNIVERSITY OF CALIFORNIA SPECIFICALLY DISCLAIMS ANY WARRANTIES,
INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF
MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE. THE SOFTWARE
PROVIDED HEREUNDER IS ON AN "AS IS" BASIS, AND THE UNIVERSITY OF
CALIFORNIA HAS NO OBLIGATION TO PROVIDE MAINTENANCE, SUPPORT, UPDATES,
ENHANCEMENTS, OR MODIFICATIONS.
PT_COPYRIGHT_VERSION_2
COPYRIGHTENDKEY
*/
package ptolemy.domains.tdl.kernel;
import ptolemy.actor.TypedIOPort;
import ptolemy.data.expr.Parameter;
import ptolemy.kernel.ComponentEntity;
import ptolemy.kernel.util.IllegalActionException;
import ptolemy.kernel.util.NameDuplicationException;
import ptolemy.kernel.util.Settable;
import ptolemy.kernel.util.Workspace;
/**
* A TDL task output port has some TDL specific parameters. - initialValue: a
* TDL output port has an initial value.
*
* @author Patricia Derler
@version $Id$
@since Ptolemy II 7.1
*
*/
public class TDLTaskPort extends TypedIOPort {
/**
* Construct a TypedIOPort with no container and no name that is neither an
* input nor an output.
*
* @exception NameDuplicationException
* @exception IllegalActionException
*/
public TDLTaskPort() throws IllegalActionException,
NameDuplicationException {
super();
_init();
}
/**
* Construct a port in the specified workspace with an empty string as a
* name. You can then change the name with setName(). If the workspace
* argument is null, then use the default workspace. The object is added to
* the workspace directory. Increment the version number of the workspace.
*
* @param workspace
* The workspace that will list the port.
* @exception NameDuplicationException Thrown if the initial value parameter cannot be created.
* @exception IllegalActionException Thrown if the initial value parameter cannot be created.
*/
public TDLTaskPort(Workspace workspace) throws IllegalActionException,
NameDuplicationException {
super(workspace);
_init();
}
/**
* Construct a TypedIOPort with a containing actor and a name that is
* neither an input nor an output. The specified container must implement
* the TypedActor interface, or an exception will be thrown.
*
* @param container
* The container actor.
* @param name
* The name of the port.
* @exception IllegalActionException
* If the port is not of an acceptable class for the
* container, or if the container does not implement the
* TypedActor interface.
* @exception NameDuplicationException
* If the name coincides with a port already in the
* container.
*/
public TDLTaskPort(ComponentEntity container, String name)
throws IllegalActionException, NameDuplicationException {
super(container, name);
_init();
}
/**
* Construct a TypedIOPort with a container and a name that is either an
* input, an output, or both, depending on the third and fourth arguments.
* The specified container must implement the TypedActor interface or an
* exception will be thrown.
*
* @param container
* The container actor.
* @param name
* The name of the port.
* @param isInput
* True if this is to be an input port.
* @param isOutput
* True if this is to be an output port.
* @exception IllegalActionException
* If the port is not of an acceptable class for the
* container, or if the container does not implement the
* TypedActor interface.
* @exception NameDuplicationException
* If the name coincides with a port already in the
* container.
*/
public TDLTaskPort(ComponentEntity container, String name, boolean isInput,
boolean isOutput) throws IllegalActionException,
NameDuplicationException {
super(container, name, isInput, isOutput);
_init();
}
///////////////////////////////////////////////////////////////////
//// public parameter ////
/**
* The initial value of the task.
*/
public Parameter initialValue;
///////////////////////////////////////////////////////////////////
//// public methods ////
/**
* Sets the port of a task to an input port.
*
* @param isInput true if port is an input port.
* @exception IllegalActionException Thrown by parent class.
*/
public void setInput(boolean isInput) throws IllegalActionException {
super.setInput(isInput);
if (!isOutput()) {
initialValue.setVisibility(Settable.NONE);
}
}
/**
* Sets the port of a task to an output port.
*
* @param isOutput true if port is an output port.
* @exception IllegalActionException Thrown by parent class.
*/
public void setOutput(boolean isOutput) throws IllegalActionException {
super.setOutput(isOutput);
initialValue.setVisibility(Settable.FULL);
}
///////////////////////////////////////////////////////////////////
//// private methods ////
/**
* Initialize the task, set an initial value parameter.
* @exception IllegalActionException Thrown if the initial value parameter cannot be created.
* @exception NameDuplicationException Thrown if the initial value parameter cannot be created.
*/
private void _init() throws IllegalActionException,
NameDuplicationException {
initialValue = new Parameter(this, "initialValue");
initialValue.setVisibility(Settable.FULL);
}
}