Public Types | Public Member Functions | Public Attributes | Protected Member Functions | Protected Attributes | List of all members
pinocchio::GeometryPoolTpl< _Scalar, _Options, JointCollectionTpl > Class Template Reference

#include <geometry.hpp>

Inheritance diagram for pinocchio::GeometryPoolTpl< _Scalar, _Options, JointCollectionTpl >:
Inheritance graph
[legend]

Public Types

enum  { Options = _Options }
 
typedef Base::Data Data
 
typedef Base::DataVector DataVector
 
typedef ::pinocchio::GeometryData GeometryData
 
typedef std::vector< GeometryData, Eigen::aligned_allocator< GeometryData > > GeometryDataVector
 
typedef ::pinocchio::GeometryModel GeometryModel
 
typedef std::vector< GeometryModel, Eigen::aligned_allocator< GeometryModel > > GeometryModelVector
 
typedef Base::Model Model
 
typedef _Scalar Scalar
 
- Public Types inherited from pinocchio::ModelPoolTpl< _Scalar, _Options, JointCollectionTpl >
enum  { Options = _Options }
 
typedef DataTpl< Scalar, Options, JointCollectionTpl > Data
 
typedef std::vector< Data, Eigen::aligned_allocator< Data > > DataVector
 
typedef ModelTpl< Scalar, Options, JointCollectionTpl > Model
 
typedef std::vector< Model, Eigen::aligned_allocator< Model > > ModelVector
 

Public Member Functions

const GeometryDatageometry_data (const size_t index) const
 Returns the geometry_data at index. More...
 
GeometryDatageometry_data (const size_t index)
 Returns the geometry_data at index. More...
 
const GeometryDataVectorgeometry_datas () const
 Vector of Geometry Data. More...
 
GeometryDataVectorgeometry_datas ()
 Vector of Geometry Data. More...
 
const GeometryModelgeometry_model () const
 Returns the geometry model. More...
 
GeometryModelgeometry_model ()
 Returns the geometry model. More...
 
 GeometryPoolTpl (const Model &model, const GeometryModel &geometry_model, const int pool_size=omp_get_max_threads())
 Default constructor from a model and a pool size. More...
 
 GeometryPoolTpl (const GeometryPoolTpl &other)
 Copy constructor from an other GeometryPoolTpl. More...
 
void update (const GeometryData &geometry_data)
 Update the geometry datas with the new value. More...
 
void update (const GeometryModel &geometry_model)
 Update the geometry model with the new input value. In this case, all the geometry_datas will be replaced. More...
 
void update (const GeometryModel &geometry_model, const GeometryData &geometry_data)
 Update the geometry model and data with the new input values. In this case, all the geometry_datas will be replaced. More...
 
virtual ~GeometryPoolTpl ()
  . More...
 
- Public Member Functions inherited from pinocchio::ModelPoolTpl< _Scalar, _Options, JointCollectionTpl >
const Datadata (const size_t index) const
 Return a specific data. More...
 
Datadata (const size_t index)
 Returns a specific data. More...
 
const DataVectordatas () const
 Returns the data vectors. More...
 
DataVectordatas ()
 Returns the data vectors. More...
 
const Modelmodel () const
 Returns the model stored within the pool. More...
 
Modelmodel ()
 Returns the model stored within the pool. More...
 
 ModelPoolTpl (const Model &model, const int pool_size=omp_get_max_threads())
 Default constructor from a model and a pool size. More...
 
 ModelPoolTpl (const ModelPoolTpl &pool_model)
 Copy constructor from an other PoolModel. More...
 
void resize (const int new_size)
 Set the size of the pool and perform the appropriate resize. More...
 
int size () const
 Returns the size of the pool. More...
 
void update (const Model &model)
 Update the model, meaning that all the datas will be refreshed accordingly. More...
 
void update (const Data &data)
 Update all the datas with the input data value. More...
 
void update (const Model &model, const Data &data)
 Update the model and data with the new input values. In this case, all the geometry_datas will be replaced. More...
 
virtual ~ModelPoolTpl ()
  . More...
 

Public Attributes

EIGEN_MAKE_ALIGNED_OPERATOR_NEW typedef ModelPoolTpl< _Scalar, _Options, JointCollectionTpl > Base
 
- Public Attributes inherited from pinocchio::ModelPoolTpl< _Scalar, _Options, JointCollectionTpl >
EIGEN_MAKE_ALIGNED_OPERATOR_NEW typedef _Scalar Scalar
 

Protected Member Functions

virtual void do_resize (const int new_size)
  . More...
 

Protected Attributes

GeometryDataVector m_geometry_datas
 Vector of Geometry Data associated to the pool. More...
 
GeometryModel m_geometry_model
 Geometry Model associated to the pool. More...
 
- Protected Attributes inherited from pinocchio::ModelPoolTpl< _Scalar, _Options, JointCollectionTpl >
DataVector m_datas
  . More...
 
Model m_model
 Model stored within the pool. More...
 
int m_size
 Number of threads used for parallel computations. More...
 

Detailed Description

template<typename _Scalar, int _Options, template< typename, int > class JointCollectionTpl>
class pinocchio::GeometryPoolTpl< _Scalar, _Options, JointCollectionTpl >

Definition at line 16 of file src/multibody/pool/geometry.hpp.

Member Typedef Documentation

◆ Data

template<typename _Scalar, int _Options, template< typename, int > class JointCollectionTpl>
typedef Base::Data pinocchio::GeometryPoolTpl< _Scalar, _Options, JointCollectionTpl >::Data

Definition at line 28 of file src/multibody/pool/geometry.hpp.

◆ DataVector

template<typename _Scalar, int _Options, template< typename, int > class JointCollectionTpl>
typedef Base::DataVector pinocchio::GeometryPoolTpl< _Scalar, _Options, JointCollectionTpl >::DataVector

Definition at line 29 of file src/multibody/pool/geometry.hpp.

◆ GeometryData

template<typename _Scalar, int _Options, template< typename, int > class JointCollectionTpl>
typedef ::pinocchio::GeometryData pinocchio::GeometryPoolTpl< _Scalar, _Options, JointCollectionTpl >::GeometryData

Definition at line 31 of file src/multibody/pool/geometry.hpp.

◆ GeometryDataVector

template<typename _Scalar, int _Options, template< typename, int > class JointCollectionTpl>
typedef std::vector<GeometryData,Eigen::aligned_allocator<GeometryData> > pinocchio::GeometryPoolTpl< _Scalar, _Options, JointCollectionTpl >::GeometryDataVector

Definition at line 34 of file src/multibody/pool/geometry.hpp.

◆ GeometryModel

template<typename _Scalar, int _Options, template< typename, int > class JointCollectionTpl>
typedef ::pinocchio::GeometryModel pinocchio::GeometryPoolTpl< _Scalar, _Options, JointCollectionTpl >::GeometryModel

Definition at line 30 of file src/multibody/pool/geometry.hpp.

◆ GeometryModelVector

template<typename _Scalar, int _Options, template< typename, int > class JointCollectionTpl>
typedef std::vector<GeometryModel,Eigen::aligned_allocator<GeometryModel> > pinocchio::GeometryPoolTpl< _Scalar, _Options, JointCollectionTpl >::GeometryModelVector

Definition at line 33 of file src/multibody/pool/geometry.hpp.

◆ Model

template<typename _Scalar, int _Options, template< typename, int > class JointCollectionTpl>
typedef Base::Model pinocchio::GeometryPoolTpl< _Scalar, _Options, JointCollectionTpl >::Model

Definition at line 27 of file src/multibody/pool/geometry.hpp.

◆ Scalar

template<typename _Scalar, int _Options, template< typename, int > class JointCollectionTpl>
typedef _Scalar pinocchio::GeometryPoolTpl< _Scalar, _Options, JointCollectionTpl >::Scalar

Definition at line 24 of file src/multibody/pool/geometry.hpp.

Member Enumeration Documentation

◆ anonymous enum

template<typename _Scalar, int _Options, template< typename, int > class JointCollectionTpl>
anonymous enum
Enumerator
Options 

Definition at line 25 of file src/multibody/pool/geometry.hpp.

Constructor & Destructor Documentation

◆ GeometryPoolTpl() [1/2]

template<typename _Scalar, int _Options, template< typename, int > class JointCollectionTpl>
pinocchio::GeometryPoolTpl< _Scalar, _Options, JointCollectionTpl >::GeometryPoolTpl ( const Model model,
const GeometryModel geometry_model,
const int  pool_size = omp_get_max_threads() 
)
inline

Default constructor from a model and a pool size.

Parameters
[in]modelinput model used for parallel computations.
[in]geometry_modelinput geometry model used for parallel computations.
[in]pool_sizetotal size of the pool.

Definition at line 42 of file src/multibody/pool/geometry.hpp.

◆ GeometryPoolTpl() [2/2]

template<typename _Scalar, int _Options, template< typename, int > class JointCollectionTpl>
pinocchio::GeometryPoolTpl< _Scalar, _Options, JointCollectionTpl >::GeometryPoolTpl ( const GeometryPoolTpl< _Scalar, _Options, JointCollectionTpl > &  other)
inline

Copy constructor from an other GeometryPoolTpl.

Parameters
[in]otherGeometryPoolTpl to copy.

Definition at line 53 of file src/multibody/pool/geometry.hpp.

◆ ~GeometryPoolTpl()

template<typename _Scalar, int _Options, template< typename, int > class JointCollectionTpl>
virtual pinocchio::GeometryPoolTpl< _Scalar, _Options, JointCollectionTpl >::~GeometryPoolTpl ( )
inlinevirtual

 .

Destructor

Definition at line 130 of file src/multibody/pool/geometry.hpp.

Member Function Documentation

◆ do_resize()

template<typename _Scalar, int _Options, template< typename, int > class JointCollectionTpl>
virtual void pinocchio::GeometryPoolTpl< _Scalar, _Options, JointCollectionTpl >::do_resize ( const int  new_size)
inlineprotectedvirtual

 .

Method to implement in the derived classes.

Reimplemented from pinocchio::ModelPoolTpl< _Scalar, _Options, JointCollectionTpl >.

Definition at line 141 of file src/multibody/pool/geometry.hpp.

◆ geometry_data() [1/2]

template<typename _Scalar, int _Options, template< typename, int > class JointCollectionTpl>
const GeometryData& pinocchio::GeometryPoolTpl< _Scalar, _Options, JointCollectionTpl >::geometry_data ( const size_t  index) const
inline

Returns the geometry_data at index.

Definition at line 66 of file src/multibody/pool/geometry.hpp.

◆ geometry_data() [2/2]

template<typename _Scalar, int _Options, template< typename, int > class JointCollectionTpl>
GeometryData& pinocchio::GeometryPoolTpl< _Scalar, _Options, JointCollectionTpl >::geometry_data ( const size_t  index)
inline

Returns the geometry_data at index.

Definition at line 74 of file src/multibody/pool/geometry.hpp.

◆ geometry_datas() [1/2]

template<typename _Scalar, int _Options, template< typename, int > class JointCollectionTpl>
const GeometryDataVector& pinocchio::GeometryPoolTpl< _Scalar, _Options, JointCollectionTpl >::geometry_datas ( ) const
inline

Vector of Geometry Data.

Definition at line 82 of file src/multibody/pool/geometry.hpp.

◆ geometry_datas() [2/2]

template<typename _Scalar, int _Options, template< typename, int > class JointCollectionTpl>
GeometryDataVector& pinocchio::GeometryPoolTpl< _Scalar, _Options, JointCollectionTpl >::geometry_datas ( )
inline

Vector of Geometry Data.

Definition at line 85 of file src/multibody/pool/geometry.hpp.

◆ geometry_model() [1/2]

template<typename _Scalar, int _Options, template< typename, int > class JointCollectionTpl>
const GeometryModel& pinocchio::GeometryPoolTpl< _Scalar, _Options, JointCollectionTpl >::geometry_model ( ) const
inline

Returns the geometry model.

Definition at line 60 of file src/multibody/pool/geometry.hpp.

◆ geometry_model() [2/2]

template<typename _Scalar, int _Options, template< typename, int > class JointCollectionTpl>
GeometryModel& pinocchio::GeometryPoolTpl< _Scalar, _Options, JointCollectionTpl >::geometry_model ( )
inline

Returns the geometry model.

Definition at line 63 of file src/multibody/pool/geometry.hpp.

◆ update() [1/3]

template<typename _Scalar, int _Options, template< typename, int > class JointCollectionTpl>
void pinocchio::GeometryPoolTpl< _Scalar, _Options, JointCollectionTpl >::update ( const GeometryData geometry_data)
inline

Update the geometry datas with the new value.

 

Parameters
[in]geometry_datanew geometry data value

Definition at line 97 of file src/multibody/pool/geometry.hpp.

◆ update() [2/3]

template<typename _Scalar, int _Options, template< typename, int > class JointCollectionTpl>
void pinocchio::GeometryPoolTpl< _Scalar, _Options, JointCollectionTpl >::update ( const GeometryModel geometry_model)
inline

Update the geometry model with the new input value. In this case, all the geometry_datas will be replaced.

Parameters
[in]geometry_modelnew geometry model value.

Definition at line 108 of file src/multibody/pool/geometry.hpp.

◆ update() [3/3]

template<typename _Scalar, int _Options, template< typename, int > class JointCollectionTpl>
void pinocchio::GeometryPoolTpl< _Scalar, _Options, JointCollectionTpl >::update ( const GeometryModel geometry_model,
const GeometryData geometry_data 
)
inline

Update the geometry model and data with the new input values. In this case, all the geometry_datas will be replaced.

Parameters
[in]geometry_modelnew geometry model value.
[in]geometry_datanew geometry data value

Definition at line 122 of file src/multibody/pool/geometry.hpp.

Member Data Documentation

◆ Base

template<typename _Scalar, int _Options, template< typename, int > class JointCollectionTpl>
EIGEN_MAKE_ALIGNED_OPERATOR_NEW typedef ModelPoolTpl<_Scalar,_Options,JointCollectionTpl> pinocchio::GeometryPoolTpl< _Scalar, _Options, JointCollectionTpl >::Base

Definition at line 23 of file src/multibody/pool/geometry.hpp.

◆ m_geometry_datas

template<typename _Scalar, int _Options, template< typename, int > class JointCollectionTpl>
GeometryDataVector pinocchio::GeometryPoolTpl< _Scalar, _Options, JointCollectionTpl >::m_geometry_datas
protected

Vector of Geometry Data associated to the pool.

Definition at line 138 of file src/multibody/pool/geometry.hpp.

◆ m_geometry_model

template<typename _Scalar, int _Options, template< typename, int > class JointCollectionTpl>
GeometryModel pinocchio::GeometryPoolTpl< _Scalar, _Options, JointCollectionTpl >::m_geometry_model
protected

Geometry Model associated to the pool.

Definition at line 130 of file src/multibody/pool/geometry.hpp.


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


pinocchio
Author(s):
autogenerated on Fri Jun 23 2023 02:38:34