tesseract_environment::AddSceneGraphCommand Class Reference

#include <add_scene_graph_command.h>

Inheritance diagram for tesseract_environment::AddSceneGraphCommand:

Collaboration diagram for tesseract_environment::AddSceneGraphCommand:

Public Types
using	Ptr = std::shared_ptr< AddSceneGraphCommand >
using	ConstPtr = std::shared_ptr< const AddSceneGraphCommand >
Public Types inherited from tesseract_environment::Command
using	Ptr = std::shared_ptr< Command >
using	ConstPtr = std::shared_ptr< const Command >

Public Member Functions
	AddSceneGraphCommand ()
	AddSceneGraphCommand (const tesseract_scene_graph::SceneGraph &scene_graph, std::string prefix="")
	Merge a graph into the current environment. More...
	AddSceneGraphCommand (const tesseract_scene_graph::SceneGraph &scene_graph, const tesseract_scene_graph::Joint &joint, std::string prefix="")
	Merge a graph into the current environment. More...
const tesseract_scene_graph::SceneGraph::ConstPtr &	getSceneGraph () const
const tesseract_scene_graph::Joint::ConstPtr &	getJoint () const
const std::string &	getPrefix () const
bool	operator== (const AddSceneGraphCommand &rhs) const
bool	operator!= (const AddSceneGraphCommand &rhs) const
Public Member Functions inherited from tesseract_environment::Command
	Command (CommandType type=CommandType::UNINITIALIZED)
virtual	~Command ()=default
	Command (const Command &)=default
Command &	operator= (const Command &)=default
	Command (Command &&)=default
Command &	operator= (Command &&)=default
CommandType	getType () const
bool	operator== (const Command &rhs) const
bool	operator!= (const Command &rhs) const

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

Private Attributes
tesseract_scene_graph::SceneGraph::ConstPtr	scene_graph_
tesseract_scene_graph::Joint::ConstPtr	joint_
std::string	prefix_

Friends
class	boost::serialization::access

Member Typedef Documentation

ConstPtr

using tesseract_environment::AddSceneGraphCommand::ConstPtr = std::shared_ptr<const AddSceneGraphCommand>

Ptr

using tesseract_environment::AddSceneGraphCommand::Ptr = std::shared_ptr<AddSceneGraphCommand>

Constructor & Destructor Documentation

AddSceneGraphCommand() [1/3]

tesseract_environment::AddSceneGraphCommand::AddSceneGraphCommand ( )

inline

AddSceneGraphCommand() [2/3]

tesseract_environment::AddSceneGraphCommand::AddSceneGraphCommand	(	const tesseract_scene_graph::SceneGraph &	scene_graph,
		std::string	prefix = ""
	)

Merge a graph into the current environment.

Parameters

scene_graph	Const ref to the graph to be merged (said graph will be copied)
prefix	string Will be prepended to every link and joint of the merged graph

Returns

Return False if any link or joint name collides with current environment, otherwise True Merge a subgraph into the current environment, considering that the root of the merged graph is attached to the root of the environment by a fixed joint and no displacement. Every joint and link of the subgraph will be copied into the environment graph. The prefix argument is meant to allow adding multiple copies of the same subgraph with different names

AddSceneGraphCommand() [3/3]

tesseract_environment::AddSceneGraphCommand::AddSceneGraphCommand	(	const tesseract_scene_graph::SceneGraph &	scene_graph,
		const tesseract_scene_graph::Joint &	joint,
		std::string	prefix = ""
	)

Merge a graph into the current environment.

Parameters

scene_graph	Const ref to the graph to be merged (said graph will be copied)
root_joint	Const ptr to the joint that connects current environment with root of the merged graph
prefix	string Will be prepended to every link and joint of the merged graph

Returns

Return False if any link or joint name collides with current environment, otherwise True Merge a subgraph into the current environment. Every joint and link of the subgraph will be copied into the environment graph. The prefix argument is meant to allow adding multiple copies of the same subgraph with different names

Member Function Documentation

getJoint()

const tesseract_scene_graph::Joint::ConstPtr & tesseract_environment::AddSceneGraphCommand::getJoint ( ) const

inline

getPrefix()

const std::string & tesseract_environment::AddSceneGraphCommand::getPrefix ( ) const

inline

getSceneGraph()

const tesseract_scene_graph::SceneGraph::ConstPtr & tesseract_environment::AddSceneGraphCommand::getSceneGraph ( ) const

inline

operator!=()

bool tesseract_environment::AddSceneGraphCommand::operator!=

(

const AddSceneGraphCommand &

rhs

)

const

operator==()

bool tesseract_environment::AddSceneGraphCommand::operator==

(

const AddSceneGraphCommand &

rhs

)

const

serialize()

template<class Archive >

void tesseract_environment::AddSceneGraphCommand::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

joint_

tesseract_scene_graph::Joint::ConstPtr tesseract_environment::AddSceneGraphCommand::joint_

private

prefix_

std::string tesseract_environment::AddSceneGraphCommand::prefix_

private

scene_graph_

tesseract_scene_graph::SceneGraph::ConstPtr tesseract_environment::AddSceneGraphCommand::scene_graph_

private

---

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

• tesseract_environment/include/tesseract_environment/commands/add_scene_graph_command.h
• tesseract_environment/src/commands/add_scene_graph_command.cpp