Package ptolemy.domains.ptera.lib

Class ListDirectory

    • Field Detail

      • directory

        public FileParameter directory
        The director in which files are to be listed.

      • files

        public Parameter files
        A parameter with an ArrayToken containing strings that are names of the files matching the given filter in the specified directory. It is updated every time this event is fired.

      • filter

        public StringParameter filter
        The filter that all the included file names must match.

      • includeDirectories

        public Parameter includeDirectories
        Whether directory names should be included.

      • includeFiles

        public Parameter includeFiles
        Whether file names should be included.

      • recursive

        public Parameter recursive
        Whether files in the subdirectories should be searched as well.

    • Constructor Detail

      • ListDirectory

        public ListDirectory​(CompositeEntity container,
                     java.lang.String name)
              throws IllegalActionException,
                     NameDuplicationException
        Construct an event with the given name contained by the specified composite entity. The container argument must not be null, or a NullPointerException will be thrown. This event will use the workspace of the container for synchronization and version counts. If the name argument is null, then the name is set to the empty string. Increment the version of the workspace. This constructor write-synchronizes on the workspace.
        Parameters:
        container - The container.
        name - The name of the state.
        Throws:
        IllegalActionException - If the state cannot be contained by the proposed container.
        NameDuplicationException - If the name coincides with that of an entity already in the container.

    • Method Detail

      • fire

        public Event.RefiringData fire​(Token arguments)
                        throws IllegalActionException
        Process this event with the given arguments. The number of arguments provided must be equal to the number of formal parameters defined for this event, and their types must match. The actions of this event are executed.
        Overrides:
        fire in class Event
        Parameters:
        arguments - The arguments used to process this event, which must be either an ArrayToken or a RecordToken.
        Returns:
        A refiring data structure that contains a non-negative double number if refire() should be called after that amount of model time, or null if refire() need not be called.
        Throws:
        IllegalActionException - If the number of the arguments or their types do not match, the actions cannot be executed, or any expression (such as guards and arguments to the next events) cannot be evaluated.
        See Also:
        Event.refire(Token, RefiringData)

      • setContainer

        public void setContainer​(CompositeEntity container)
                  throws IllegalActionException,
                         NameDuplicationException
        Specify the container, adding the entity to the list of entities in the container. If the container already contains an entity with the same name, then throw an exception and do not make any changes. Similarly, if the container is not in the same workspace as this entity, throw an exception. If this entity is a class element and the proposed container does not match the current container, then also throw an exception. If the entity is already contained by the container, do nothing. If this entity already has a container, remove it from that container first. Otherwise, remove it from the directory of the workspace, if it is present. If the argument is null, then unlink the ports of the entity from any relations and remove it from its container. It is not added to the workspace directory, so this could result in this entity being garbage collected. Derived classes may further constrain the container to subclasses of CompositeEntity by overriding the protected method _checkContainer(). This method validates all deeply contained instances of Settable, since they may no longer be valid in the new context. This method is write-synchronized to the workspace and increments its version number.
        Overrides:
        setContainer in class Event
        Parameters:
        container - The proposed container.
        Throws:
        IllegalActionException - If the action would result in a recursive containment structure, or if this entity and container are not in the same workspace, or if the protected method _checkContainer() throws it, or if a contained Settable becomes invalid and the error handler throws it.
        NameDuplicationException - If the name of this entity collides with a name already in the container.
        See Also:
        ComponentEntity.getContainer()