tesseract_srdf::SRDFModel Class Reference

Representation of semantic information about the robot. More...

#include <srdf_model.h>

Collaboration diagram for tesseract_srdf::SRDFModel:

Public Types
using	Ptr = std::shared_ptr< SRDFModel >
using	ConstPtr = std::shared_ptr< const SRDFModel >

Public Member Functions
	SRDFModel ()=default
virtual	~SRDFModel ()=default
	SRDFModel (const SRDFModel &)=default
SRDFModel &	operator= (const SRDFModel &)=default
	SRDFModel (SRDFModel &&)=default
SRDFModel &	operator= (SRDFModel &&)=default
void	initFile (const tesseract_scene_graph::SceneGraph &scene_graph, const std::string &filename, const tesseract_common::ResourceLocator &locator)
	Load Model given a filename. More...
void	initString (const tesseract_scene_graph::SceneGraph &scene_graph, const std::string &xmlstring, const tesseract_common::ResourceLocator &locator)
	Load Model from a XML-string. More...
bool	saveToFile (const std::string &file_path) const
	Save the model to a file. More...
void	clear ()
	Clear the model. More...
bool	operator== (const SRDFModel &rhs) const
bool	operator!= (const SRDFModel &rhs) const

Public Attributes
std::string	name { "undefined" }
	The name of the srdf model. More...
std::array< int, 3 >	version { { 1, 0, 0 } }
	The version number major.minor[.patch]. More...
KinematicsInformation	kinematics_information
	Contact information related to kinematics. More...
tesseract_common::ContactManagersPluginInfo	contact_managers_plugin_info
	The contact managers plugin information. More...
tesseract_common::AllowedCollisionMatrix	acm
	The allowed collision matrix. More...
tesseract_common::CollisionMarginData::Ptr	collision_margin_data
	Collision margin data. More...
tesseract_common::CalibrationInfo	calibration_info
	The calibration information. More...

Private Member Functions
template<class Archive >
void	serialize (Archive &ar, const unsigned int version)

Friends
class	boost::serialization::access

Detailed Description

Representation of semantic information about the robot.

Member Typedef Documentation

ConstPtr

using tesseract_srdf::SRDFModel::ConstPtr = std::shared_ptr<const SRDFModel>

Ptr

using tesseract_srdf::SRDFModel::Ptr = std::shared_ptr<SRDFModel>

Constructor & Destructor Documentation

SRDFModel() [1/3]

tesseract_srdf::SRDFModel::SRDFModel ( )

default

~SRDFModel()

virtual tesseract_srdf::SRDFModel::~SRDFModel ( )

virtualdefault

SRDFModel() [2/3]

tesseract_srdf::SRDFModel::SRDFModel ( const SRDFModel &  )

default

SRDFModel() [3/3]

tesseract_srdf::SRDFModel::SRDFModel ( SRDFModel &&  )

default

Member Function Documentation

clear()

void tesseract_srdf::SRDFModel::clear

(

)

Clear the model.

initFile()

void tesseract_srdf::SRDFModel::initFile	(	const tesseract_scene_graph::SceneGraph &	scene_graph,
		const std::string &	filename,
		const tesseract_common::ResourceLocator &	locator
	)

Load Model given a filename.

Exceptions

std::nested_exception

if an error occurs during parsing srdf

initString()

void tesseract_srdf::SRDFModel::initString	(	const tesseract_scene_graph::SceneGraph &	scene_graph,
		const std::string &	xmlstring,
		const tesseract_common::ResourceLocator &	locator
	)

Load Model from a XML-string.

Exceptions

std::nested_exception

if an error occurs during parsing srdf

operator!=()

bool tesseract_srdf::SRDFModel::operator!=

(

const SRDFModel &

rhs

)

const

operator=() [1/2]

SRDFModel & tesseract_srdf::SRDFModel::operator= ( const SRDFModel &  )

default

operator=() [2/2]

SRDFModel & tesseract_srdf::SRDFModel::operator= ( SRDFModel &&  )

default

operator==()

bool tesseract_srdf::SRDFModel::operator==

(

const SRDFModel &

rhs

)

const

saveToFile()

bool tesseract_srdf::SRDFModel::saveToFile

(

const std::string &

file_path

)

const

Save the model to a file.

serialize()

template<class Archive >

void tesseract_srdf::SRDFModel::serialize ( Archive &  ar, const unsigned int  version  )

private

Friends And Related Function Documentation

boost::serialization::access

friend class boost::serialization::access

friend

Member Data Documentation

acm

tesseract_common::AllowedCollisionMatrix tesseract_srdf::SRDFModel::acm

The allowed collision matrix.

calibration_info

tesseract_common::CalibrationInfo tesseract_srdf::SRDFModel::calibration_info

The calibration information.

collision_margin_data

tesseract_common::CollisionMarginData::Ptr tesseract_srdf::SRDFModel::collision_margin_data

Collision margin data.

contact_managers_plugin_info

tesseract_common::ContactManagersPluginInfo tesseract_srdf::SRDFModel::contact_managers_plugin_info

The contact managers plugin information.

kinematics_information

KinematicsInformation tesseract_srdf::SRDFModel::kinematics_information

Contact information related to kinematics.

name

std::string tesseract_srdf::SRDFModel::name { "undefined" }

The name of the srdf model.

version

std::array<int, 3> tesseract_srdf::SRDFModel::version { { 1, 0, 0 } }

The version number major.minor[.patch].

---

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

• tesseract_srdf/include/tesseract_srdf/srdf_model.h
• tesseract_srdf/src/srdf_model.cpp