TypedVoidPtr.h

Go to the documentation of this file.

/*
 * Copyright (C) 2012 by
 *   MetraLabs GmbH (MLAB), GERMANY
 * and
 *   Neuroinformatics and Cognitive Robotics Labs (NICR) at TU Ilmenau, GERMANY
 * All rights reserved.
 *
 * Contact: info@mira-project.org
 *
 * Commercial Usage:
 *   Licensees holding valid commercial licenses may use this file in
 *   accordance with the commercial license agreement provided with the
 *   software or, alternatively, in accordance with the terms contained in
 *   a written agreement between you and MLAB or NICR.
 *
 * GNU General Public License Usage:
 *   Alternatively, this file may be used under the terms of the GNU
 *   General Public License version 3.0 as published by the Free Software
 *   Foundation and appearing in the file LICENSE.GPL3 included in the
 *   packaging of this file. Please review the following information to
 *   ensure the GNU General Public License version 3.0 requirements will be
 *   met: http://www.gnu.org/copyleft/gpl.html.
 *   Alternatively you may (at your option) use any later version of the GNU
 *   General Public License if such license has been publicly approved by
 *   MLAB and NICR (or its successors, if any).
 *
 * IN NO EVENT SHALL "MLAB" OR "NICR" BE LIABLE TO ANY PARTY FOR DIRECT,
 * INDIRECT, SPECIAL, INCIDENTAL, OR CONSEQUENTIAL DAMAGES ARISING OUT OF
 * THE USE OF THIS SOFTWARE AND ITS DOCUMENTATION, EVEN IF "MLAB" OR
 * "NICR" HAS BEEN ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
 *
 * "MLAB" AND "NICR" SPECIFICALLY DISCLAIM ANY WARRANTIES, INCLUDING,
 * BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND
 * FITNESS FOR A PARTICULAR PURPOSE. THE SOFTWARE PROVIDED HEREUNDER IS
 * ON AN "AS IS" BASIS, AND "MLAB" AND "NICR" HAVE NO OBLIGATION TO
 * PROVIDE MAINTENANCE, SUPPORT, UPDATES, ENHANCEMENTS OR MODIFICATIONS.
 */

#ifndef _MIRA_TYPEDVOIDPTR_H_
#define _MIRA_TYPEDVOIDPTR_H_

#include <error/Exceptions.h>
#include <factory/TypeId.h>
#include <platform/Typename.h>

namespace mira {


class TypedVoidPtr
{

public:

    TypedVoidPtr() : mType(-1), mPtr(NULL) {}

    template <typename T>
    TypedVoidPtr(T* ptr) :
        mType(typeId<T>()), mPtr(ptr) {}

public:

    bool isNull() const { return mPtr==NULL; }

public:

    template <typename T>
    operator T*() { return cast<T>(); }

    template <typename T>
    operator const T*() const { return cast<T>(); }

    template <typename T>
    T* cast() {
        if(mType!=typeId<T>())
            MIRA_THROW(XBadCast, "Cannot cast to type '" << typeName<T>() << "'");
        // cast is safe due to our above type id check
        return static_cast<T*>(mPtr);
    }

    template <typename T>
    const T* cast() const {
        TypedVoidPtr* This = const_cast<TypedVoidPtr*>(this);
        return This->cast<T>();
    }

private:

    TypeId mType;

    void* mPtr;
};


class TypedVoidConstPtr
{

public:

    TypedVoidConstPtr() : mType(-1), mPtr(NULL) {}

    template <typename T>
    TypedVoidConstPtr(const T* ptr) :
        mType(typeId<T>()), mPtr(ptr) {}

public:

    bool isNull() const { return mPtr==NULL; }

public:

    template <typename T>
    operator const T*() const { return cast<T>(); }

    template <typename T>
    const T* cast() const {
        if(mType!=typeId<T>())
            MIRA_THROW(XBadCast, "Cannot cast to type '" << typeName<T>() << "'");
        // cast is safe due to our above type name check
        return static_cast<const T*>(mPtr);
    }

private:

    TypeId mType;

    const void* mPtr;
};


}

#endif