object_cast.h

Go to the documentation of this file.

/**
 *  \file IMP/object_cast.h
 *  \brief Up (or down) cast an \imp Object-derived class.
 *
 *  Copyright 2007-2022 IMP Inventors. All rights reserved.
 *
 */

#ifndef IMPKERNEL_OBJECT_CAST_H
#define IMPKERNEL_OBJECT_CAST_H

#include <IMP/kernel_config.h>
#include "Object.h"
#include "check_macros.h"

IMPKERNEL_BEGIN_NAMESPACE

//! Up (or down) cast an \imp Object-derived class.
/** If the cast does not succeed a ValueException will be thrown.
    Use a \c dynamic_cast if you prefer to have a nullptr returned.
 */
template <class O>
inline O *object_cast(Object *o) {
  O *ret = dynamic_cast<O *>(o);
  if (!ret) {
    if (!o) {
      IMP_THROW("Cannot cast nullptr pointer to desired type.", ValueException);
    } else {
      IMP_THROW("Object " << o->get_name() << " cannot be cast to "
                          << "desired type.",
                ValueException);
    }
  }
  return ret;
}

IMPKERNEL_END_NAMESPACE

#endif /* IMPKERNEL_OBJECT_CAST_H */