IMP Reference Guide
develop.7cb8855c60,2024/10/08
The Integrative Modeling Platform
|
A smart pointer to a ref-counted Object that is a class member. More...
#include <IMP/Pointer.h>
Inherits PointerBase< IMP::internal::PointerMemberTraits< O > >.
A smart pointer to a ref-counted Object that is a class member.
This class is identical to Pointer, but in addition, Object::set_was_used(true) will be called so you don't get warnings about unused objects once the object is stored in the owning class.
[in] | O | The type of IMP::RefCounted-derived object to point to |
Public Types | |
typedef IMP::internal::PointerBase < IMP::internal::PointerMemberTraits < O > > | P |
Public Member Functions | |
template<class Any > | |
PointerMember (const Any &o) | |
O * | get () const |
get the raw pointer to the object More... | |
template<class OT > | |
PointerMember< O > & | operator= (const IMP::internal::PointerBase< OT > &o) |
template<class OT > | |
PointerMember< O > & | operator= (OT *o) |
PointerMember< O > & | operator= (std::nullptr_t o) |
PointerMember< O > & | operator= (const P &o) |
O * | release () |
Relinquish control of the raw pointer stored in the PointerMember. More... | |
O* IMP::PointerMember< O >::get | ( | ) | const |
get the raw pointer to the object
O* IMP::PointerMember< O >::release | ( | ) |
Relinquish control of the raw pointer stored in the PointerMember.
Use this to safely return objects allocated within functions. The reference count of the object will be decreased by one, but even it it becomes 0, the object will not be destroyed.