Public Member Functions | Public Attributes | List of all members
gazebo::buoyancy::BuoyancyObject Class Reference

A class for storing buoyancy object properties. More...

#include <buoyancy_gazebo_plugin.hh>

Public Member Functions

 BuoyancyObject ()
 Default constructor. More...
 
 BuoyancyObject (BuoyancyObject &&obj) noexcept
 Default move constructor. More...
 
 BuoyancyObject (BuoyancyObject &obj)=delete
 No copy constructor. More...
 
std::string Disp ()
 Display string for buoyancy object. More...
 
void Load (const physics::ModelPtr model, const sdf::ElementPtr elem)
 Load buoyancy object from SDF. More...
 

Public Attributes

int linkId
 Associated link ID. More...
 
std::string linkName
 Associated link name. More...
 
double mass
 Object mass (from inertial elem) More...
 
ignition::math::Pose3d pose
 Pose of buoyancy relative to link. More...
 
::buoyancy::ShapeVolumePtr shape
 Buoyancy object's shape properties. More...
 

Detailed Description

A class for storing buoyancy object properties.

Definition at line 42 of file buoyancy_gazebo_plugin.hh.

Constructor & Destructor Documentation

BuoyancyObject::BuoyancyObject ( )

Default constructor.

Definition at line 30 of file buoyancy_gazebo_plugin.cc.

BuoyancyObject::BuoyancyObject ( BuoyancyObject &&  obj)
noexcept

Default move constructor.

Definition at line 40 of file buoyancy_gazebo_plugin.cc.

gazebo::buoyancy::BuoyancyObject::BuoyancyObject ( BuoyancyObject obj)
delete

No copy constructor.

Member Function Documentation

std::string BuoyancyObject::Disp ( )

Display string for buoyancy object.

Definition at line 95 of file buoyancy_gazebo_plugin.cc.

void BuoyancyObject::Load ( const physics::ModelPtr  model,
const sdf::ElementPtr  elem 
)

Load buoyancy object from SDF.

Parameters
modelmodel associated with buoyancy object
elemsdf for buoyancy element

Definition at line 50 of file buoyancy_gazebo_plugin.cc.

Member Data Documentation

int gazebo::buoyancy::BuoyancyObject::linkId

Associated link ID.

Definition at line 63 of file buoyancy_gazebo_plugin.hh.

std::string gazebo::buoyancy::BuoyancyObject::linkName

Associated link name.

Definition at line 66 of file buoyancy_gazebo_plugin.hh.

double gazebo::buoyancy::BuoyancyObject::mass

Object mass (from inertial elem)

Definition at line 72 of file buoyancy_gazebo_plugin.hh.

ignition::math::Pose3d gazebo::buoyancy::BuoyancyObject::pose

Pose of buoyancy relative to link.

Definition at line 69 of file buoyancy_gazebo_plugin.hh.

::buoyancy::ShapeVolumePtr gazebo::buoyancy::BuoyancyObject::shape

Buoyancy object's shape properties.

Definition at line 75 of file buoyancy_gazebo_plugin.hh.


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


usv_gazebo_plugins
Author(s): Brian Bingham , Carlos Aguero
autogenerated on Thu May 7 2020 03:54:47