casadi::WeakRef Class Reference

Weak reference type. More...

#include <shared_object.hpp>

Detailed Description

A weak reference to a GenericShared

Author

Joel Andersson

Date

2013

Extra doc: https://github.com/casadi/casadi/wiki/L_ax

Definition at line 114 of file shared_object.hpp.

Inheritance diagram for casadi::WeakRef:

Public Member Functions
	WeakRef (int dummy=0)
	WeakRef (SharedObject shared)
SharedObject	shared () const
	Get a shared (owning) reference. More...
bool	alive () const
	Check if alive. More...
bool	shared_if_alive (SharedObject &shared) const
	Thread-safe alternative to alive()/shared() More...
GenericWeakRefInternal< SharedObject, SharedObjectInternal > *	operator-> ()
	Access functions of the node. More...
const GenericWeakRefInternal< SharedObject, SharedObjectInternal > *	operator-> () const
	Const access functions of the node. More...
std::string	debug_repr () const
bool	is_null () const
	Is a null pointer? More...
casadi_int	__hash__ () const
	Returns a number that is unique for a given Node. More...

Constructor & Destructor Documentation

WeakRef() [1/2]

casadi::WeakRef::WeakRef ( int  dummy = 0 )

inline

Definition at line 117 of file shared_object.hpp.

WeakRef() [2/2]

casadi::WeakRef::WeakRef ( SharedObject  shared )

inline

Definition at line 119 of file shared_object.hpp.

Member Function Documentation

__hash__()

casadi_int casadi::GenericShared< SharedObject , SharedObjectInternal >::__hash__

inherited

If the Object does not point to any node, "0" is returned.

Extra doc: https://github.com/casadi/casadi/wiki/L_av

Definition at line 124 of file generic_shared_impl.hpp.

alive()

bool casadi::GenericWeakRef< SharedObject , SharedObjectInternal >::alive

inherited

Extra doc: https://github.com/casadi/casadi/wiki/L_b1

Definition at line 166 of file generic_shared_impl.hpp.

debug_repr()

std::string casadi::GenericShared< SharedObject , SharedObjectInternal >::debug_repr

inherited

Definition at line 113 of file generic_shared_impl.hpp.

is_null()

bool casadi::GenericShared< SharedObject , SharedObjectInternal >::is_null

inherited

Definition at line 117 of file generic_shared_impl.hpp.

operator->() [1/2]

GenericWeakRefInternal< SharedObject , SharedObjectInternal > * casadi::GenericWeakRef< SharedObject , SharedObjectInternal >::operator->

inherited

Extra doc: https://github.com/casadi/casadi/wiki/L_b2

Definition at line 176 of file generic_shared_impl.hpp.

operator->() [2/2]

const GenericWeakRefInternal< SharedObject , SharedObjectInternal > * casadi::GenericWeakRef< SharedObject , SharedObjectInternal >::operator->

inherited

Extra doc: https://github.com/casadi/casadi/wiki/L_b3

Definition at line 181 of file generic_shared_impl.hpp.

shared()

SharedObject casadi::GenericWeakRef< SharedObject , SharedObjectInternal >::shared

inherited

Extra doc: https://github.com/casadi/casadi/wiki/L_b0

Definition at line 161 of file generic_shared_impl.hpp.

shared_if_alive()

bool casadi::GenericWeakRef< SharedObject , SharedObjectInternal >::shared_if_alive ( SharedObject &  shared ) const

inherited

Extra doc: https://github.com/casadi/casadi/wiki/L_29i

Definition at line 171 of file generic_shared_impl.hpp.

---

The documentation for this class was generated from the following file:

• shared_object.hpp