ProDeClipboard.hh

Go to the documentation of this file.

/*
    Copyright (c) 2002-2009 Tampere University.
 
    This file is part of TTA-Based Codesign Environment (TCE).
 
    Permission is hereby granted, free of charge, to any person obtaining a
    copy of this software and associated documentation files (the "Software"),
    to deal in the Software without restriction, including without limitation
    the rights to use, copy, modify, merge, publish, distribute, sublicense,
    and/or sell copies of the Software, and to permit persons to whom the
    Software is furnished to do so, subject to the following conditions:
 
    The above copyright notice and this permission notice shall be included in
    all copies or substantial portions of the Software.
 
    THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
    IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
    FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL
    THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
    LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
    FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER
    DEALINGS IN THE SOFTWARE.
 */
/**
 * @file ProDeClipboard.hh
 *
 * Declaration of ProDeClipboard class.
 *
 * @author Veli-Pekka Jääskeläinen 2004 (vjaaskel-no.spam-cs.tut.fi)
 */
 
#ifndef TTA_PRODE_CLIPBOARD_HH
#define TTA_PRODE_CLIPBOARD_HH
 
class ObjectState;
 
namespace TTAMachine {
    class Machine;
}
 
/**
 * A Clipboard class for copying machine components in ProDe.
 *
 * The clipboard can store one Component.
 * This class is implemented using the 'singleton' design pattern.
 */
class ProDeClipboard {
public:
    static ProDeClipboard* instance();
    static void destroy();
    void setContents(
        ObjectState* contents, const TTAMachine::Machine* sourceMachine);
    ObjectState* copyContents();
    const TTAMachine::Machine* sourceMachine() { return sourceMachine_; }
    bool isEmpty();
 
private:
    ProDeClipboard();
    ~ProDeClipboard();
 
    static ProDeClipboard* instance_;
    ObjectState* contents_;
    const TTAMachine::Machine* sourceMachine_;
};
#endif