tesseract_environment::AddSceneGraphCommand Class Reference

#include <add_scene_graph_command.h>

Inheritance diagram for tesseract_environment::AddSceneGraphCommand:

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

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

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

Private Attributes
std::shared_ptr< const tesseract_scene_graph::Joint >	joint_
std::string	prefix_
std::shared_ptr< const tesseract_scene_graph::SceneGraph >	scene_graph_

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

Detailed Description

Definition at line 46 of file add_scene_graph_command.h.

Member Typedef Documentation

ConstPtr

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

Definition at line 50 of file add_scene_graph_command.h.

Ptr

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

Definition at line 49 of file add_scene_graph_command.h.

Constructor & Destructor Documentation

AddSceneGraphCommand() [1/3]

tesseract_environment::AddSceneGraphCommand::AddSceneGraphCommand

(

)

Definition at line 42 of file add_scene_graph_command.cpp.

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

Definition at line 44 of file add_scene_graph_command.cpp.

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

Definition at line 52 of file add_scene_graph_command.cpp.

Member Function Documentation

getJoint()

const std::shared_ptr< const tesseract_scene_graph::Joint > & tesseract_environment::AddSceneGraphCommand::getJoint

(

)

const

Definition at line 66 of file add_scene_graph_command.cpp.

getPrefix()

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

(

)

const

Definition at line 67 of file add_scene_graph_command.cpp.

getSceneGraph()

const std::shared_ptr< const tesseract_scene_graph::SceneGraph > & tesseract_environment::AddSceneGraphCommand::getSceneGraph

(

)

const

Definition at line 62 of file add_scene_graph_command.cpp.

operator!=()

bool tesseract_environment::AddSceneGraphCommand::operator!=

(

const AddSceneGraphCommand &

rhs

)

const

Definition at line 78 of file add_scene_graph_command.cpp.

operator==()

bool tesseract_environment::AddSceneGraphCommand::operator==

(

const AddSceneGraphCommand &

rhs

)

const

Definition at line 69 of file add_scene_graph_command.cpp.

serialize()

template<class Archive >

void tesseract_environment::AddSceneGraphCommand::serialize ( Archive &  ar, const unsigned int  version  )

private

Definition at line 81 of file add_scene_graph_command.cpp.

Friends And Related Function Documentation

boost::serialization::access

friend class boost::serialization::access

friend

Definition at line 91 of file add_scene_graph_command.h.

tesseract_common::Serialization

friend struct tesseract_common::Serialization

friend

Definition at line 92 of file add_scene_graph_command.h.

Member Data Documentation

joint_

std::shared_ptr<const tesseract_scene_graph::Joint> tesseract_environment::AddSceneGraphCommand::joint_

private

Definition at line 88 of file add_scene_graph_command.h.

prefix_

std::string tesseract_environment::AddSceneGraphCommand::prefix_

private

Definition at line 89 of file add_scene_graph_command.h.

scene_graph_

std::shared_ptr<const tesseract_scene_graph::SceneGraph> tesseract_environment::AddSceneGraphCommand::scene_graph_

private

Definition at line 87 of file add_scene_graph_command.h.

---

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

• add_scene_graph_command.h
• add_scene_graph_command.cpp