Public Types | Public Member Functions | Public Attributes | Private Member Functions | Friends | List of all members
tesseract_srdf::SRDFModel Class Reference

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

#include <srdf_model.h>

Public Types

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

Public Member Functions

void clear ()
 Clear the model. More...
 
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 operator!= (const SRDFModel &rhs) const
 
SRDFModeloperator= (const SRDFModel &)=default
 
SRDFModeloperator= (SRDFModel &&)=default
 
bool operator== (const SRDFModel &rhs) const
 
bool saveToFile (const std::string &file_path) const
 Save the model to a file. More...
 
 SRDFModel ()=default
 
 SRDFModel (const SRDFModel &)=default
 
 SRDFModel (SRDFModel &&)=default
 
virtual ~SRDFModel ()=default
 

Public Attributes

tesseract_common::AllowedCollisionMatrix acm
 The allowed collision matrix. More...
 
tesseract_common::CalibrationInfo calibration_info
 The calibration information. More...
 
std::shared_ptr< tesseract_common::CollisionMarginDatacollision_margin_data
 Collision margin data. More...
 
tesseract_common::ContactManagersPluginInfo contact_managers_plugin_info
 The contact managers plugin information. More...
 
KinematicsInformation kinematics_information
 Contact information related to kinematics. More...
 
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...
 

Private Member Functions

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

Friends

class boost::serialization::access
 
struct tesseract_common::Serialization
 

Detailed Description

Representation of semantic information about the robot.

Definition at line 54 of file srdf_model.h.

Member Typedef Documentation

◆ ConstPtr

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

Definition at line 62 of file srdf_model.h.

◆ Ptr

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

Definition at line 61 of file srdf_model.h.

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.

Definition at line 423 of file srdf_model.cpp.

◆ 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_exceptionif an error occurs during parsing srdf

Definition at line 62 of file srdf_model.cpp.

◆ 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_exceptionif an error occurs during parsing srdf

Definition at line 94 of file srdf_model.cpp.

◆ operator!=()

bool tesseract_srdf::SRDFModel::operator!= ( const SRDFModel rhs) const

Definition at line 446 of file srdf_model.cpp.

◆ 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

Definition at line 433 of file srdf_model.cpp.

◆ saveToFile()

bool tesseract_srdf::SRDFModel::saveToFile ( const std::string &  file_path) const

Save the model to a file.

Definition at line 253 of file srdf_model.cpp.

◆ serialize()

template<class Archive >
void tesseract_srdf::SRDFModel::serialize ( Archive &  ar,
const unsigned int  version 
)
private

Definition at line 449 of file srdf_model.cpp.

Friends And Related Function Documentation

◆ boost::serialization::access

friend class boost::serialization::access
friend

Definition at line 118 of file srdf_model.h.

◆ tesseract_common::Serialization

friend struct tesseract_common::Serialization
friend

Definition at line 119 of file srdf_model.h.

Member Data Documentation

◆ acm

tesseract_common::AllowedCollisionMatrix tesseract_srdf::SRDFModel::acm

The allowed collision matrix.

Definition at line 106 of file srdf_model.h.

◆ calibration_info

tesseract_common::CalibrationInfo tesseract_srdf::SRDFModel::calibration_info

The calibration information.

Definition at line 112 of file srdf_model.h.

◆ collision_margin_data

std::shared_ptr<tesseract_common::CollisionMarginData> tesseract_srdf::SRDFModel::collision_margin_data

Collision margin data.

Definition at line 109 of file srdf_model.h.

◆ contact_managers_plugin_info

tesseract_common::ContactManagersPluginInfo tesseract_srdf::SRDFModel::contact_managers_plugin_info

The contact managers plugin information.

Definition at line 103 of file srdf_model.h.

◆ kinematics_information

KinematicsInformation tesseract_srdf::SRDFModel::kinematics_information

Contact information related to kinematics.

Definition at line 100 of file srdf_model.h.

◆ name

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

The name of the srdf model.

Definition at line 94 of file srdf_model.h.

◆ version

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

The version number major.minor[.patch].

Definition at line 97 of file srdf_model.h.


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


tesseract_srdf
Author(s): Levi Armstrong
autogenerated on Sun May 18 2025 03:02:04