Gazebo Physics

API Reference

5.3.2
GetJointFromModel::Model< PolicyT, FeaturesT > Class Template Reference

#include <GetEntities.hh>

Public Types

using ConstJointPtrType = ConstJointPtr< PolicyT, FeaturesT >
 
using JointPtrType = JointPtr< PolicyT, FeaturesT >
 
- Public Types inherited from Entity< PolicyT, FeaturesT >
using Features = FeaturesT
 
using Pimpl = typename detail::DeterminePlugin< Policy, Features >::type
 
using Policy = PolicyT
 

Public Member Functions

JointPtrType GetJoint (const std::string &_name)
 Get a Joint that exists within this Model. More...
 
ConstJointPtrType GetJoint (const std::string &_name) const
 
JointPtrType GetJoint (std::size_t _index)
 Get a Joint that exists within this Model. More...
 
ConstJointPtrType GetJoint (std::size_t _index) const
 
std::size_t GetJointCount () const
 Get the number of Joints within this Model. More...
 
- Public Member Functions inherited from Feature::Model< PolicyT, FeaturesT >
virtual ~Model ()=default
 Virtual destructor. More...
 
- Public Member Functions inherited from Entity< PolicyT, FeaturesT >
virtual ~Entity ()=default
 Virtual destructor. More...
 
std::size_t EntityID () const
 Get the unique ID value of this Entity. More...
 
const std::shared_ptr< void > & EntityReference () const
 Get a reference-counting std::shared_ptr to the object inside the implementation that this object provides an abstraction for. More...
 
const Identity & FullIdentity () const
 Get the Identity object of this Entity. More...
 

Additional Inherited Members

- Protected Member Functions inherited from Entity< PolicyT, FeaturesT >
 Entity (const std::shared_ptr< Pimpl > &_pimpl=nullptr, const Identity &_identity=Identity())
 Constructor for the Entity. More...
 
 Entity (std::shared_ptr< Pimpl > &&_pimpl, const Identity &_identity)
 Constructor that allows the pimpl to be moved instead of copied. More...
 
template<typename FeatureT >
FeatureT::template Implementation< PolicyT > * Interface ()
 Get a pointer to the implementation of FeatureT. More...
 
template<typename FeatureT >
const FeatureT::template Implementation< PolicyT > * Interface () const
 Same as Interface(), but const-qualified so that const entities can request const-qualified interfaces from the implementation. More...
 
- Protected Attributes inherited from Entity< PolicyT, FeaturesT >
Identity identity
 This field contains information to identify the entity. More...
 
std::shared_ptr< Pimplpimpl
 This is a pointer to the physics engine implementation, and it can be used by the object features to find the interfaces that they need in order to function. More...
 

Member Typedef Documentation

◆ ConstJointPtrType

using ConstJointPtrType = ConstJointPtr<PolicyT, FeaturesT>

◆ JointPtrType

using JointPtrType = JointPtr<PolicyT, FeaturesT>

Member Function Documentation

◆ GetJoint() [1/4]

JointPtrType GetJoint ( const std::string _name)

Get a Joint that exists within this Model.

Parameters
[in]_nameName of the Joint within this Model.
Returns
A Joint reference. If a Joint named _name does not exist in this Model, this will be a nullptr.

◆ GetJoint() [2/4]

ConstJointPtrType GetJoint ( const std::string _name) const

◆ GetJoint() [3/4]

JointPtrType GetJoint ( std::size_t  _index)

Get a Joint that exists within this Model.

Parameters
[in]_indexIndex of the Joint within this Model.
Returns
A Joint reference. If _index is GetJointCount() or higher, this will be a nullptr.

◆ GetJoint() [4/4]

ConstJointPtrType GetJoint ( std::size_t  _index) const

◆ GetJointCount()

std::size_t GetJointCount ( ) const

Get the number of Joints within this Model.


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