HOM/HOM_InterruptableOperation.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.
 *
 * Produced by:
 *      Side Effects Software Inc
 *      123 Front Street West, Suite 1401
 *      Toronto, Ontario
 *      Canada   M5J 2M2
 *      416-504-9876
 *
 * COMMENTS:
 *      Class used to turn any Python code block into an interruptable
 *      operation.
 */

#ifndef __HOM_InterruptableOperation_h__
#define __HOM_InterruptableOperation_h__

#include "HOM_API.h"
#include "HOM_Errors.h"
#include "HOM_Module.h"

SWIGOUT(%feature("notabstract") HOM_InterruptableOperation;)
SWIGOUT(%rename(InterruptableOperation) HOM_InterruptableOperation;)

class HOM_API HOM_InterruptableOperation
{
public:

#ifdef SWIG
%extend
{
    %kwargs HOM_InterruptableOperation;
    HOM_InterruptableOperation(const char *operation_name,
        const char *long_operation_name=NULL, bool open_interrupt_dialog=false)
    {
        return HOM().newInterruptableOperation(operation_name,
            long_operation_name, open_interrupt_dialog);
    }
}
#else
    HOM_InterruptableOperation()
    { HOM_CONSTRUCT_OBJECT(this) }
    HOM_InterruptableOperation(const HOM_InterruptableOperation &operation)
    { HOM_CONSTRUCT_OBJECT(this) }
#endif
    virtual ~HOM_InterruptableOperation()
    { HOM_DESTRUCT_OBJECT(this) }

    // Let swig know we're overriding __repr__ for this class so it doesn't
    // provide its own __repr__.
    virtual std::string __repr__()
        throw(HOM_ObjectWasDeleted, HOM_Error) = 0;

    SWIGOUT(%kwargs updateLongProgress;)
    virtual void updateLongProgress(double percentage=-1.0,
            const char *long_op_status=NULL)
        throw(HOM_OperationInterrupted, HOM_OperationFailed, HOM_Error) = 0;

    SWIGOUT(%kwargs updateProgress;)
    virtual void updateProgress(double percentage=-1.0)
        throw(HOM_OperationInterrupted, HOM_OperationFailed, HOM_Error) = 0;

    virtual HOM_InterruptableOperation *__enter__()
        throw(HOM_OperationInterrupted, HOM_Error) = 0;

    SWIGOUT(%ignore opaqueExit;)
    virtual void opaqueExit()
        throw(HOM_OperationFailed, HOM_Error) = 0;

#ifdef SWIG
%extend
{
    // We can ignore the type, value, and traceback Python objects.
    SWIGOUT(virtual void __exit__(
            InterpreterObject type, InterpreterObject value, 
            InterpreterObject traceback)
        throw(HOM_OperationFailed, HOM_Error)
    { self->opaqueExit(); };)
}
#endif

};

#endif

---