CE_Error.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:        CE_Error.h ( CE Library, C++)
 *
 * COMMENTS:    Compute Engine Error.
 */

#ifndef __CE_Error__
#define __CE_Error__

#include "CE_API.h"

#ifdef CE_ENABLED

#include <UT/UT_StringHolder.h>

/// A class derived from cl::Error that allows arbitrary error messages to be
/// stored with the exception (as opposed to only globals like string
/// literals).
class CE_API CE_Error: public cl::Error
{
public:
    CE_Error(cl_int err, const char *err_str = nullptr)
        : cl::Error(err, nullptr), myErrStr(err_str)
    {
    }

    const char * what() const throw () override
    {
        return myErrStr.buffer();
    }
        
private:
    UT_StringHolder myErrStr;
};


#endif
#endif