WMWriteTransferFunction.h 3.15 KB
Newer Older
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24
//---------------------------------------------------------------------------
//
// Project: OpenWalnut ( http://www.openwalnut.org )
//
// Copyright 2009 OpenWalnut Community, BSV-Leipzig and CNCF-CBS
// For more information see http://www.openwalnut.org/copying
//
// This file is part of OpenWalnut.
//
// OpenWalnut is free software: you can redistribute it and/or modify
// it under the terms of the GNU Lesser General Public License as published by
// the Free Software Foundation, either version 3 of the License, or
// (at your option) any later version.
//
// OpenWalnut is distributed in the hope that it will be useful,
// but WITHOUT ANY WARRANTY; without even the implied warranty of
// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
// GNU Lesser General Public License for more details.
//
// You should have received a copy of the GNU Lesser General Public License
// along with OpenWalnut. If not, see <http://www.gnu.org/licenses/>.
//
//---------------------------------------------------------------------------

Sebastian Eichelbaum's avatar
[STYLE]  
Sebastian Eichelbaum committed
25 26
#ifndef WMWRITETRANSFERFUNCTION_H
#define WMWRITETRANSFERFUNCTION_H
27 28 29

#include <string>

Sebastian Eichelbaum's avatar
[STYLE]  
Sebastian Eichelbaum committed
30 31 32 33
#include "core/kernel/WModule.h"
#include "core/kernel/WModuleOutputData.h"
#include "core/kernel/WModuleInputData.h"
#include "core/common/WProperties.h"
34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52

/**
 * Module to export transferfunctions
 *
 * \ingroup modules
 */
class WMWriteTransferFunction: public WModule
{
public:
    /**
     * Constructor.
     */
    WMWriteTransferFunction();

    /**
     * Destructor
     */
    virtual ~WMWriteTransferFunction();

Alexander Wiebel's avatar
Alexander Wiebel committed
53 54 55 56 57 58 59
    /**
     * Get the icon for this module in XPM format.
     *
     * \return The icon.
     */
    const char** getXPMIcon() const;

60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117
    /**
     * Gives back the name of this module.
     * \return the module's name.
     */
    virtual const std::string getName() const;

    /**
     * Gives back a description of this module.
     * \return description to module.
     */
    virtual const std::string getDescription() const;

    /**
     * Due to the prototype design pattern used to build modules, this method returns a new instance of this method. NOTE: it
     * should never be initialized or modified in some other way. A simple new instance is required.
     *
     * \return the prototype used to create every module in OpenWalnut.
     */
    virtual boost::shared_ptr< WModule > factory() const;

protected:
    /**
     * Entry point after loading the module. Runs in separate thread.
     */
    virtual void moduleMain();

    /**
     * Initialize the connectors this module is using.
     */
    virtual void connectors();

    /**
     * Initialize the properties for this module.
     */
    virtual void properties();

private:
    /**
     * Condition used throughout the module to notify the thread if some changes happened (like properties have changed and similar).
     */
    boost::shared_ptr< WCondition > m_propCondition;

    /**
     * The connector used to get the TF.
     */
    WModuleInputData< WDataSetSingle >::SPtr m_input;

    /**
     * Where to save the file to
     */
    WPropFilename m_savePath;

    /**
     * DO the save operation
     */
    WPropTrigger m_saveTrigger;
};

Sebastian Eichelbaum's avatar
[STYLE]  
Sebastian Eichelbaum committed
118
#endif  // WMWRITETRANSFERFUNCTION_H