Public Member Functions | Public Attributes | Private Attributes | List of all members
buoyancy::CylinderVolume Struct Reference

Cylinder shape volume. More...

#include <shape_volume.hh>

Inheritance diagram for buoyancy::CylinderVolume:
Inheritance graph
[legend]

Public Member Functions

Volume CalculateVolume (const ignition::math::Pose3d &pose, double fluidLevel) override
 Calculates volume + centroid of submerged shape if the shape is out of water returns Volume{}. More...
 
 CylinderVolume (double r, double l)
 Default constructor. More...
 
std::string Display () override
 Display string for cylinder shape. More...
 
- Public Member Functions inherited from buoyancy::ShapeVolume
virtual ~ShapeVolume ()=default
 Default destructor. More...
 

Public Attributes

double h
 Height of cylinder. More...
 
double r
 Radius of cylinder. More...
 
- Public Attributes inherited from buoyancy::ShapeVolume
double averageLength
 Average length of object estimate used for drag torque calculation. More...
 
ShapeType type
 Type of shape. More...
 
double volume
 Full volume of object. More...
 

Private Attributes

Polyhedron polyhedron
 Polyhedron defining a cylinder. More...
 

Additional Inherited Members

- Static Public Member Functions inherited from buoyancy::ShapeVolume
static std::unique_ptr< ShapeVolumemakeShape (const sdf::ElementPtr sdf)
 Factory method for shape. Parses a shape object from sdf data. More...
 

Detailed Description

Cylinder shape volume.

Definition at line 103 of file shape_volume.hh.

Constructor & Destructor Documentation

CylinderVolume::CylinderVolume ( double  r,
double  l 
)
explicit

Default constructor.

Parameters
rradius
llength

Definition at line 148 of file shape_volume.cc.

Member Function Documentation

Volume CylinderVolume::CalculateVolume ( const ignition::math::Pose3d &  pose,
double  fluidLevel 
)
overridevirtual

Calculates volume + centroid of submerged shape if the shape is out of water returns Volume{}.

Parameters
poseworld pose of volume
fluidLevelheight of fluid
Returns
volume object with volume + centroid (relative to world)

Implements buoyancy::ShapeVolume.

Definition at line 167 of file shape_volume.cc.

std::string CylinderVolume::Display ( )
overridevirtual

Display string for cylinder shape.

Reimplemented from buoyancy::ShapeVolume.

Definition at line 159 of file shape_volume.cc.

Member Data Documentation

double buoyancy::CylinderVolume::h

Height of cylinder.

Definition at line 121 of file shape_volume.hh.

Polyhedron buoyancy::CylinderVolume::polyhedron
private

Polyhedron defining a cylinder.

Definition at line 125 of file shape_volume.hh.

double buoyancy::CylinderVolume::r

Radius of cylinder.

Definition at line 118 of file shape_volume.hh.


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


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