Public Member Functions | List of all members
sdf::SDF_VERSION_NAMESPACE::CustomInertiaCalcProperties Class Reference

#include <CustomInertiaCalcProperties.hh>

Public Member Functions

 CustomInertiaCalcProperties ()
 Default Constructor. More...
 
 CustomInertiaCalcProperties (const double _density, const sdf::Mesh _mesh, const sdf::ElementPtr _calculatorParams)
 Constructor with mesh properties. More...
 
const sdf::ElementPtr AutoInertiaParams () const
 Get the reference to the <auto_inertia_params> sdf element. More...
 
double Density () const
 Get the density of the mesh. More...
 
const std::optional< sdf::Mesh > & Mesh () const
 Get the reference to the mesh oject being used. More...
 
void SetAutoInertiaParams (sdf::ElementPtr _autoInertiaParamsElem)
 Function to set the calculator params sdf element object. More...
 
void SetDensity (double _density)
 Function to set the density of the interface object. More...
 
void SetMesh (sdf::Mesh &_mesh)
 Function to set the mesh object. More...
 

Constructor & Destructor Documentation

◆ CustomInertiaCalcProperties() [1/2]

sdf::SDF_VERSION_NAMESPACE::CustomInertiaCalcProperties::CustomInertiaCalcProperties ( )

Default Constructor.

◆ CustomInertiaCalcProperties() [2/2]

sdf::SDF_VERSION_NAMESPACE::CustomInertiaCalcProperties::CustomInertiaCalcProperties ( const double  _density,
const sdf::Mesh  _mesh,
const sdf::ElementPtr  _calculatorParams 
)

Constructor with mesh properties.

Parameters
[in]_densityDouble density value
[in]_meshsdf::Mesh object
[in]_calculatorParamssdf::ElementPtr for calculator params element

Member Function Documentation

◆ AutoInertiaParams()

const sdf::ElementPtr sdf::SDF_VERSION_NAMESPACE::CustomInertiaCalcProperties::AutoInertiaParams ( ) const

Get the reference to the <auto_inertia_params> sdf element.

User defined calculator params can be accessed through this element

Returns
sdf::ElementPtr for the tag

◆ Density()

double sdf::SDF_VERSION_NAMESPACE::CustomInertiaCalcProperties::Density ( ) const

Get the density of the mesh.

Returns
Double density of the mesh.

◆ Mesh()

const std::optional< sdf::Mesh > & sdf::SDF_VERSION_NAMESPACE::CustomInertiaCalcProperties::Mesh ( ) const

Get the reference to the mesh oject being used.

Returns
Reference to the sdf::Mesh object.

◆ SetAutoInertiaParams()

void sdf::SDF_VERSION_NAMESPACE::CustomInertiaCalcProperties::SetAutoInertiaParams ( sdf::ElementPtr  _autoInertiaParamsElem)

Function to set the calculator params sdf element object.

Parameters
[in]_autoInertiaParamsElemsdf::ElementPtr for calculator params

◆ SetDensity()

void sdf::SDF_VERSION_NAMESPACE::CustomInertiaCalcProperties::SetDensity ( double  _density)

Function to set the density of the interface object.

Parameters
[in]_densityDouble density value

◆ SetMesh()

void sdf::SDF_VERSION_NAMESPACE::CustomInertiaCalcProperties::SetMesh ( sdf::Mesh _mesh)

Function to set the mesh object.

Parameters
[in]_meshsdf::Mesh object

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