DEP_DirtyAlertMicroNode.h

Go to the documentation of this file.

/*
 * PROPRIETARY INFORMATION.  This software is proprietary to
 * Side Effects Software Inc., and is not to be reproduced,
 * transmitted, or disclosed in any way without written permission.
 *
 * NAME:        DEP_MicroNode.h (DEP Library, C++)
 *
 * COMMENTS:
 */

#ifndef __DEP_DIRTYALERTMICRONODE_H__
#define __DEP_DIRTYALERTMICRONODE_H__

#include "DEP_API.h"
#include "DEP_MicroNode.h"

// Very simple micronode "end point" that can execute a function whenever
// any inputs to this micro node become dirty. It is still up to the creator
// to manage any inputs to this micro node, including re-establishing inputs
// every time the callback occurs.
//
// Do not export this class, it is purely inline.
template<class FuncType>
class DEP_DirtyAlertMicroNode : public DEP_MicroNode
{
public:
                    DEP_DirtyAlertMicroNode(FuncType dirty_callback)
                        : myDirtyCallback(dirty_callback)
                    { }

    void            becameDirty(DEP_MicroNode &src,
                            const DEP_PropagateData &prop_data) override
                    { myDirtyCallback(); }

private:
    FuncType        myDirtyCallback;
};

#endif // __DEP_DIRTYALERTMICRONODE_H__