001/*
002 * Copyright (c) 2015 The Regents of the University of California.
003 * All rights reserved.
004 *
005 * '$Author: crawl $'
006 * '$Date: 2015-09-19 00:17:48 +0000 (Sat, 19 Sep 2015) $' 
007 * '$Revision: 33923 $'
008 * 
009 * Permission is hereby granted, without written agreement and without
010 * license or royalty fees, to use, copy, modify, and distribute this
011 * software and its documentation for any purpose, provided that the above
012 * copyright notice and the following two paragraphs appear in all copies
013 * of this software.
014 *
015 * IN NO EVENT SHALL THE UNIVERSITY OF CALIFORNIA BE LIABLE TO ANY PARTY
016 * FOR DIRECT, INDIRECT, SPECIAL, INCIDENTAL, OR CONSEQUENTIAL DAMAGES
017 * ARISING OUT OF THE USE OF THIS SOFTWARE AND ITS DOCUMENTATION, EVEN IF
018 * THE UNIVERSITY OF CALIFORNIA HAS BEEN ADVISED OF THE POSSIBILITY OF
019 * SUCH DAMAGE.
020 *
021 * THE UNIVERSITY OF CALIFORNIA SPECIFICALLY DISCLAIMS ANY WARRANTIES,
022 * INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF
023 * MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE. THE SOFTWARE
024 * PROVIDED HEREUNDER IS ON AN "AS IS" BASIS, AND THE UNIVERSITY OF
025 * CALIFORNIA HAS NO OBLIGATION TO PROVIDE MAINTENANCE, SUPPORT, UPDATES,
026 * ENHANCEMENTS, OR MODIFICATIONS.
027 *
028 */
029package org.kepler.module.ddpcommon;
030
031import org.kepler.ddp.director.DDPEngine;
032import org.kepler.module.ModuleShutdownable;
033
034import ptolemy.kernel.util.IllegalActionException;
035import ptolemy.util.MessageHandler;
036
037/** Perform cleanup for the ddp-common module.
038 * 
039 * @author Daniel Crawl
040 * @version $Id: Shutdown.java 33923 2015-09-19 00:17:48Z crawl $
041 */
042public class Shutdown implements ModuleShutdownable
043{
044    /** Perform any module-specific cleanup. */
045    @Override
046    public void shutdownModule()
047    {        
048        // close any effigies opened for UI actors in pattern actors.
049        try {
050            DDPEngine.closeAllEffigies();
051        } catch (IllegalActionException e) {
052            MessageHandler.error("Error closing effigies from replayed workflows.", e);
053        }
054    }
055}