TemplateInverseKinematicsPtr is a templated class that enables users to create a reference-counting InverseKinematicsPtr. More...

#include <InverseKinematicsPtr.hpp>

Public Types
typedef IkType	element_type

Public Member Functions
	TemplateInverseKinematicsPtr (const std::shared_ptr< element_type > &sptr)
	Constructor that accepts a shared_ptr.

	TemplateInverseKinematicsPtr (std::nullptr_t)
	Constructor that accepts a nullptr.

	TemplateInverseKinematicsPtr ()=default
	Default constructor.

template<class OtherIkT , class OtherJacNodePtrT >
	TemplateInverseKinematicsPtr (const TemplateInverseKinematicsPtr< OtherIkT, OtherJacNodePtrT > &_ptr)
	Constructor that takes in a strong InverseKinematicsPtr.

	operator std::shared_ptr< element_type > () const
	Implicit conversion to regular shared_ptr.

template<class OtherIkT >
	TemplateInverseKinematicsPtr (const std::shared_ptr< OtherIkT > &sptr)
	Constructor that takes in a shared_ptr.

template<class OtherIkT , class OtherJacNodePtrT >
TemplateInverseKinematicsPtr &	operator= (const TemplateInverseKinematicsPtr< OtherIkT, OtherJacNodePtrT > &_ptr)
	Assignment operator.

template<class SharedPtrT >
TemplateInverseKinematicsPtr &	operator= (const SharedPtrT &_ptr)
	Assignment operator for shared_ptr.

TemplateInverseKinematicsPtr &	operator= (std::nullptr_t)
	Assignment operator for nullptr.

	operator bool () const
	Implicit conversion to bool.

element_type &	operator* () const
	Dereferencing operator.

element_type *	operator-> () const
	Dereferencing operation.

element_type *	get () const
	Get the raw pointer.

std::shared_ptr< element_type >	get_shared () const
	Get the shared_ptr held by this InverseKinematicsPtr.

void	set (const std::shared_ptr< IkType > &sptr)
	Set the InverseKinematics module for this InverseKinematicsPtr from a shared_ptr.

Comparison operators
template<class OtherIkT , class OtherJacNodeT >
bool	operator== (const TemplateInverseKinematicsPtr< OtherIkT, OtherJacNodeT > &_rhs) const
	Equality.

template<class OtherIkT , class OtherJacNodeT >
bool	operator!= (const TemplateInverseKinematicsPtr< OtherIkT, OtherJacNodeT > &_rhs) const
	Inequality.

template<class OtherIkT , class OtherJacNodeT >
bool	operator< (const TemplateInverseKinematicsPtr< OtherIkT, OtherJacNodeT > &_rhs) const
	Less than.

template<class OtherIkT , class OtherJacNodeT >
bool	operator> (const TemplateInverseKinematicsPtr< OtherIkT, OtherJacNodeT > &_rhs) const
	Greater than.

template<class OtherIkT , class OtherJacNodeT >
bool	operator<= (const TemplateInverseKinematicsPtr< OtherIkT, OtherJacNodeT > &_rhs) const
	Less than or equal to.

template<class OtherIkT , class OtherJacNodeT >
bool	operator>= (const TemplateInverseKinematicsPtr< OtherIkT, OtherJacNodeT > &_rhs) const
	Greater than or equal to.

Protected Attributes
std::shared_ptr< element_type >	mIK
	Pointer to the IK module.

JacobianNodePtrT	mJacNodePtr
	Pointer to the Node associated with the IK module.

Friends
template<class , class >
class	TemplateInverseKinematicsPtr

Detailed Description

template<class IkType, class JacobianNodePtrT>
class dart::dynamics::TemplateInverseKinematicsPtr< IkType, JacobianNodePtrT >

TemplateInverseKinematicsPtr is a templated class that enables users to create a reference-counting InverseKinematicsPtr.

Holding onto an InverseKinematicsPtr will ensure that the JacobianNode associated with the InverseKinematics module will not get deleted, and will keep the InverseKinematics reference valid.

Member Typedef Documentation

◆ element_type

template<class IkType , class JacobianNodePtrT >

typedef IkType dart::dynamics::TemplateInverseKinematicsPtr< IkType, JacobianNodePtrT >::element_type

Constructor & Destructor Documentation

◆ TemplateInverseKinematicsPtr() [1/5]

template<class IkType , class JacobianNodePtrT >

dart::dynamics::TemplateInverseKinematicsPtr< IkType, JacobianNodePtrT >::TemplateInverseKinematicsPtr ( const std::shared_ptr< element_type > & sptr )

inline

Constructor that accepts a shared_ptr.

◆ TemplateInverseKinematicsPtr() [2/5]

template<class IkType , class JacobianNodePtrT >

dart::dynamics::TemplateInverseKinematicsPtr< IkType, JacobianNodePtrT >::TemplateInverseKinematicsPtr ( std::nullptr_t )

inline

Constructor that accepts a nullptr.

◆ TemplateInverseKinematicsPtr() [3/5]

template<class IkType , class JacobianNodePtrT >

dart::dynamics::TemplateInverseKinematicsPtr< IkType, JacobianNodePtrT >::TemplateInverseKinematicsPtr ( )

default

Default constructor.

◆ TemplateInverseKinematicsPtr() [4/5]

template<class IkType , class JacobianNodePtrT >

template<class OtherIkT , class OtherJacNodePtrT >

dart::dynamics::TemplateInverseKinematicsPtr< IkType, JacobianNodePtrT >::TemplateInverseKinematicsPtr ( const TemplateInverseKinematicsPtr< OtherIkT, OtherJacNodePtrT > & _ptr )

inline

Constructor that takes in a strong InverseKinematicsPtr.

◆ TemplateInverseKinematicsPtr() [5/5]

template<class IkType , class JacobianNodePtrT >

template<class OtherIkT >

dart::dynamics::TemplateInverseKinematicsPtr< IkType, JacobianNodePtrT >::TemplateInverseKinematicsPtr ( const std::shared_ptr< OtherIkT > & sptr )

inline

Constructor that takes in a shared_ptr.

Member Function Documentation

◆ get()

template<class IkType , class JacobianNodePtrT >

element_type * dart::dynamics::TemplateInverseKinematicsPtr< IkType, JacobianNodePtrT >::get ( ) const

inline

Get the raw pointer.

◆ get_shared()

template<class IkType , class JacobianNodePtrT >

std::shared_ptr< element_type > dart::dynamics::TemplateInverseKinematicsPtr< IkType, JacobianNodePtrT >::get_shared ( ) const

inline

Get the shared_ptr held by this InverseKinematicsPtr.

◆ operator bool()

template<class IkType , class JacobianNodePtrT >

dart::dynamics::TemplateInverseKinematicsPtr< IkType, JacobianNodePtrT >::operator bool ( ) const

inline

Implicit conversion to bool.

◆ operator std::shared_ptr< element_type >()

template<class IkType , class JacobianNodePtrT >

dart::dynamics::TemplateInverseKinematicsPtr< IkType, JacobianNodePtrT >::operator std::shared_ptr< element_type > ( ) const

inline

Implicit conversion to regular shared_ptr.

◆ operator!=()

template<class IkType , class JacobianNodePtrT >

template<class OtherIkT , class OtherJacNodeT >

bool dart::dynamics::TemplateInverseKinematicsPtr< IkType, JacobianNodePtrT >::operator!= ( const TemplateInverseKinematicsPtr< OtherIkT, OtherJacNodeT > & _rhs ) const

inline

Inequality.

◆ operator*()

template<class IkType , class JacobianNodePtrT >

element_type & dart::dynamics::TemplateInverseKinematicsPtr< IkType, JacobianNodePtrT >::operator* ( ) const

inline

Dereferencing operator.

◆ operator->()

template<class IkType , class JacobianNodePtrT >

element_type * dart::dynamics::TemplateInverseKinematicsPtr< IkType, JacobianNodePtrT >::operator-> ( ) const

inline

Dereferencing operation.

◆ operator<()

template<class IkType , class JacobianNodePtrT >

template<class OtherIkT , class OtherJacNodeT >

bool dart::dynamics::TemplateInverseKinematicsPtr< IkType, JacobianNodePtrT >::operator< ( const TemplateInverseKinematicsPtr< OtherIkT, OtherJacNodeT > & _rhs ) const

inline

Less than.

◆ operator<=()

template<class IkType , class JacobianNodePtrT >

template<class OtherIkT , class OtherJacNodeT >

bool dart::dynamics::TemplateInverseKinematicsPtr< IkType, JacobianNodePtrT >::operator<= ( const TemplateInverseKinematicsPtr< OtherIkT, OtherJacNodeT > & _rhs ) const

inline

Less than or equal to.

◆ operator=() [1/3]

template<class IkType , class JacobianNodePtrT >

template<class SharedPtrT >

TemplateInverseKinematicsPtr & dart::dynamics::TemplateInverseKinematicsPtr< IkType, JacobianNodePtrT >::operator= ( const SharedPtrT & _ptr )

inline

Assignment operator for shared_ptr.

◆ operator=() [2/3]

template<class IkType , class JacobianNodePtrT >

template<class OtherIkT , class OtherJacNodePtrT >

TemplateInverseKinematicsPtr & dart::dynamics::TemplateInverseKinematicsPtr< IkType, JacobianNodePtrT >::operator= ( const TemplateInverseKinematicsPtr< OtherIkT, OtherJacNodePtrT > & _ptr )

inline

Assignment operator.

◆ operator=() [3/3]

template<class IkType , class JacobianNodePtrT >

TemplateInverseKinematicsPtr & dart::dynamics::TemplateInverseKinematicsPtr< IkType, JacobianNodePtrT >::operator= ( std::nullptr_t )

inline

Assignment operator for nullptr.

◆ operator==()

template<class IkType , class JacobianNodePtrT >

template<class OtherIkT , class OtherJacNodeT >

bool dart::dynamics::TemplateInverseKinematicsPtr< IkType, JacobianNodePtrT >::operator== ( const TemplateInverseKinematicsPtr< OtherIkT, OtherJacNodeT > & _rhs ) const

inline

Equality.

◆ operator>()

template<class IkType , class JacobianNodePtrT >

template<class OtherIkT , class OtherJacNodeT >

bool dart::dynamics::TemplateInverseKinematicsPtr< IkType, JacobianNodePtrT >::operator> ( const TemplateInverseKinematicsPtr< OtherIkT, OtherJacNodeT > & _rhs ) const

inline

Greater than.

◆ operator>=()

template<class IkType , class JacobianNodePtrT >

template<class OtherIkT , class OtherJacNodeT >

bool dart::dynamics::TemplateInverseKinematicsPtr< IkType, JacobianNodePtrT >::operator>= ( const TemplateInverseKinematicsPtr< OtherIkT, OtherJacNodeT > & _rhs ) const

inline

Greater than or equal to.

◆ set()

template<class IkType , class JacobianNodePtrT >

void dart::dynamics::TemplateInverseKinematicsPtr< IkType, JacobianNodePtrT >::set ( const std::shared_ptr< IkType > & sptr )

inline

Set the InverseKinematics module for this InverseKinematicsPtr from a shared_ptr.

Friends And Related Symbol Documentation

◆ TemplateInverseKinematicsPtr

template<class IkType , class JacobianNodePtrT >

template<class , class >

friend class TemplateInverseKinematicsPtr

friend

Member Data Documentation

◆ mIK

template<class IkType , class JacobianNodePtrT >

std::shared_ptr<element_type> dart::dynamics::TemplateInverseKinematicsPtr< IkType, JacobianNodePtrT >::mIK

protected

Pointer to the IK module.

◆ mJacNodePtr

template<class IkType , class JacobianNodePtrT >

JacobianNodePtrT dart::dynamics::TemplateInverseKinematicsPtr< IkType, JacobianNodePtrT >::mJacNodePtr

protected

Pointer to the Node associated with the IK module.

Public Types

Public Member Functions

Protected Attributes

Friends

Detailed Description

Member Typedef Documentation

◆ element_type

Constructor & Destructor Documentation

◆ TemplateInverseKinematicsPtr() [1/5]

◆ TemplateInverseKinematicsPtr() [2/5]

◆ TemplateInverseKinematicsPtr() [3/5]

◆ TemplateInverseKinematicsPtr() [4/5]

◆ TemplateInverseKinematicsPtr() [5/5]

Member Function Documentation

◆ get()

◆ get_shared()

◆ operator bool()

◆ operator std::shared_ptr< element_type >()

◆ operator!=()

◆ operator*()

◆ operator->()

◆ operator<()

◆ operator<=()

◆ operator=() [1/3]

◆ operator=() [2/3]

◆ operator=() [3/3]

◆ operator==()

◆ operator>()

◆ operator>=()

◆ set()

Friends And Related Symbol Documentation

◆ TemplateInverseKinematicsPtr

Member Data Documentation

◆ mIK

◆ mJacNodePtr