Package ptolemy.domains.csp.lib

Class CSPBuffer

    • Field Detail

      • input

        public TypedIOPort input
        The input port for this actor.

      • output

        public TypedIOPort output
        The output port for this actor.

      • depth

        public Parameter depth
        The Parameter storing the depth of the buffer.

    • Constructor Detail

      • CSPBuffer

        @Deprecated
public CSPBuffer()
          throws IllegalActionException,
                 NameDuplicationException
        Deprecated.
        Use ptolemy.domains.csp.lib.Buffer instead.
        Construct a CSPBuffer in the default workspace with an empty string as its name. The actor is parameterized by its depth, which must be an integer. The default depth of the buffer is one. The actor is created with a single input port and a single output port, both of width one. The input port is called "input", and similarly, the output port is called "output". The object is added to the workspace directory. Increment the version number of the workspace.
        Throws:
        IllegalActionException - If the port or parameter cannot be contained by this actor.
        NameDuplicationException - If the port name coincides with a port already in this actor, or if the parameter name coincides with a parameter already in this actor.

      • CSPBuffer

        public CSPBuffer​(TypedCompositeActor container,
                 java.lang.String name)
          throws IllegalActionException,
                 NameDuplicationException
        Construct a CSPBuffer in the specified container with the specified name. The name must be unique within the container or an exception is thrown. The container argument must not be null, or a NullPointerException will be thrown. The actor is parameterized by its depth, which must be an integer. The default depth of the buffer is one. The actor is created with a single input port and a single output port, both of width one. The input port is called "input", and similarly, the output port is called "output".

        Parameters:
        container - The TypedCompositeActor that contains this actor.
        name - The actor's name.
        Throws:
        IllegalActionException - If the entity cannot be contained by the proposed container.
        NameDuplicationException - If the name argument coincides with an entity already in the container.

      • CSPBuffer

        public CSPBuffer​(TypedCompositeActor container,
                 java.lang.String name,
                 int theDepth)
          throws IllegalActionException,
                 NameDuplicationException
        Construct a CSPBuffer in the specified container with the specified name. The name must be unique within the container or an exception is thrown. The container argument must not be null, or a NullPointerException will be thrown. The actor is parameterized by its depth, which must be an integer. The buffer depth is assigned to the value passed in. The actor is created with a single input port and a single output port, both of width one. The input port is called "input", and similarly, the output port is called "output".

        Parameters:
        container - The TypedCompositeActor that contains this actor.
        name - The actor's name.
        theDepth - The depth of this buffer.
        Throws:
        IllegalActionException - If the entity cannot be contained by the proposed container.
        NameDuplicationException - If the name argument coincides with an entity already in the container.

    • Method Detail

      • fire

        public void fire()
          throws IllegalActionException
        Executes the code in this actor. This actor uses a CDO construct so that it is always able to receive or send a token, depending on the state of the buffer. It is the canonical example of using a CDO. This process continues executing until a TerminateProcessException is thrown.
        Specified by:
        fire in interface Executable
        Overrides:
        fire in class AtomicActor<TypedIOPort>
        Throws:
        IllegalActionException - If an error occurs during executing the process.