mc_rbdyn::CylindricalSurface Struct Reference

#include <mc_rbdyn/CylindricalSurface.h>

Inheritance diagram for mc_rbdyn::CylindricalSurface:

Collaboration diagram for mc_rbdyn::CylindricalSurface:

Public Member Functions
	CylindricalSurface (const std::string &name, const std::string &bodyName, const sva::PTransformd &X_b_s, const std::string &materialName, const double &radius, const double &width)
	~CylindricalSurface () override
void	computePoints () override
const double &	radius () const
const double &	width () const
void	width (const double &width)
std::shared_ptr< Surface >	copy () const override
std::string	type () const override
tinyxml2::XMLElement *	toXML (tinyxml2::XMLDocument &doc) const override
Public Member Functions inherited from mc_rbdyn::Surface
	Surface (const std::string &name, const std::string &bodyName, const sva::PTransformd &X_b_s, const std::string &materialName)
virtual	~Surface ()
const std::string &	name () const
void	name (const std::string &name)
const std::string &	bodyName () const
const std::string &	materialName () const
const std::vector< sva::PTransformd > &	points () const
unsigned int	bodyIndex (const mc_rbdyn::Robot &robot) const
sva::PTransformd	X_0_s (const mc_rbdyn::Robot &robot) const
sva::PTransformd	X_0_s (const mc_rbdyn::Robot &robot, const rbd::MultiBodyConfig &mbc) const
const sva::PTransformd &	X_b_s () const
void	X_b_s (const sva::PTransformd &X_b_s)
std::string	toStr ()
bool	operator== (const Surface &rhs)
bool	operator!= (const Surface &rhs)

Static Public Member Functions
static std::unique_ptr< CylindricalSurface >	fromXML (const tinyxml2::XMLElement &elem)
	Construct a CylindricalSurface from an XML element. More...
Static Public Member Functions inherited from mc_rbdyn::Surface
static std::unique_ptr< Surface >	fromXML (const tinyxml2::XMLElement &elem)
	Construct a Surface (of the appropriate derived type) from an XML element. More...

Additional Inherited Members
Protected Member Functions inherited from mc_rbdyn::Surface
std::vector< sva::PTransformd > &	points ()

Constructor & Destructor Documentation

CylindricalSurface()

mc_rbdyn::CylindricalSurface::CylindricalSurface	(	const std::string &	name,
		const std::string &	bodyName,
		const sva::PTransformd &	X_b_s,
		const std::string &	materialName,
		const double &	radius,
		const double &	width
	)

~CylindricalSurface()

mc_rbdyn::CylindricalSurface::~CylindricalSurface ( )

override

Member Function Documentation

computePoints()

void mc_rbdyn::CylindricalSurface::computePoints ( )

overridevirtual

Implements mc_rbdyn::Surface.

copy()

std::shared_ptr<Surface> mc_rbdyn::CylindricalSurface::copy ( ) const

overridevirtual

Implements mc_rbdyn::Surface.

fromXML()

static std::unique_ptr<CylindricalSurface> mc_rbdyn::CylindricalSurface::fromXML ( const tinyxml2::XMLElement &  elem )

static

Construct a CylindricalSurface from an XML element.

Example XML:

<cylindrical_surface name="Cylinder" link="some_link" radius="0.05" width="0.2">
  <origin rpy="0.0 0.0 0.0" xyz="0.0 0.0 0.0" />
  <material name="plastic" />
</cylindrical_surface>

Parameters

elem	The XML element describing the cylindrical surface.

Returns

Unique pointer to the constructed CylindricalSurface.

radius()

const double& mc_rbdyn::CylindricalSurface::radius

(

)

const

toXML()

tinyxml2::XMLElement* mc_rbdyn::CylindricalSurface::toXML ( tinyxml2::XMLDocument &  doc ) const

overridevirtual

Implements mc_rbdyn::Surface.

type()

std::string mc_rbdyn::CylindricalSurface::type ( ) const

overridevirtual

Implements mc_rbdyn::Surface.

width() [1/2]

const double& mc_rbdyn::CylindricalSurface::width

(

)

const

width() [2/2]

void mc_rbdyn::CylindricalSurface::width

(

const double &

width

)

---

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

• include/mc_rbdyn/CylindricalSurface.h