Public Types | Public Member Functions | Private Member Functions | Private Attributes | Friends | List of all members
tesseract_environment::AddTrajectoryLinkCommand Class Reference

#include <add_trajectory_link_command.h>

Inheritance diagram for tesseract_environment::AddTrajectoryLinkCommand:
Inheritance graph
[legend]

Public Types

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

Public Member Functions

 AddTrajectoryLinkCommand ()
 
 AddTrajectoryLinkCommand (std::string link_name, std::string parent_link_name, tesseract_common::JointTrajectory trajectory, bool replace_allowed=false)
 Adds or replace a trajectory link to the environment. More...
 
const std::string & getLinkName () const
 
const std::string & getParentLinkName () const
 
const tesseract_common::JointTrajectorygetTrajectory () const
 
bool operator!= (const AddTrajectoryLinkCommand &rhs) const
 
bool operator== (const AddTrajectoryLinkCommand &rhs) const
 
bool replaceAllowed () 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
 
Commandoperator= (Command &&)=default
 
Commandoperator= (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::string link_name_
 
std::string parent_link_name_
 
bool replace_allowed_ { false }
 
tesseract_common::JointTrajectory trajectory_
 

Friends

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

Detailed Description

Definition at line 45 of file add_trajectory_link_command.h.

Member Typedef Documentation

◆ ConstPtr

Definition at line 49 of file add_trajectory_link_command.h.

◆ Ptr

Definition at line 48 of file add_trajectory_link_command.h.

Constructor & Destructor Documentation

◆ AddTrajectoryLinkCommand() [1/2]

tesseract_environment::AddTrajectoryLinkCommand::AddTrajectoryLinkCommand ( )

Definition at line 40 of file add_trajectory_link_command.cpp.

◆ AddTrajectoryLinkCommand() [2/2]

tesseract_environment::AddTrajectoryLinkCommand::AddTrajectoryLinkCommand ( std::string  link_name,
std::string  parent_link_name,
tesseract_common::JointTrajectory  trajectory,
bool  replace_allowed = false 
)

Adds or replace a trajectory link to the environment.

If the link exists and replace_allowed equals true:

   This command should replace the current link with the new link

If the link exists and replace_allowed equals false:

   This command should result in an error

If the link does not exist:

   This command should attach the link to the parent link with a fixed joint
   with a joint name of joint_{link name}".
Parameters
link_nameThe link name
parent_link_nameThe parent link name
trajectoryThe trajectory to used for generating link
replace_allowedIf true then if the link exists it will be replaced, otherwise if false it will fail.

Definition at line 42 of file add_trajectory_link_command.cpp.

Member Function Documentation

◆ getLinkName()

const std::string & tesseract_environment::AddTrajectoryLinkCommand::getLinkName ( ) const

Definition at line 54 of file add_trajectory_link_command.cpp.

◆ getParentLinkName()

const std::string & tesseract_environment::AddTrajectoryLinkCommand::getParentLinkName ( ) const

Definition at line 55 of file add_trajectory_link_command.cpp.

◆ getTrajectory()

const tesseract_common::JointTrajectory & tesseract_environment::AddTrajectoryLinkCommand::getTrajectory ( ) const

Definition at line 56 of file add_trajectory_link_command.cpp.

◆ operator!=()

bool tesseract_environment::AddTrajectoryLinkCommand::operator!= ( const AddTrajectoryLinkCommand rhs) const

Definition at line 69 of file add_trajectory_link_command.cpp.

◆ operator==()

bool tesseract_environment::AddTrajectoryLinkCommand::operator== ( const AddTrajectoryLinkCommand rhs) const

Definition at line 59 of file add_trajectory_link_command.cpp.

◆ replaceAllowed()

bool tesseract_environment::AddTrajectoryLinkCommand::replaceAllowed ( ) const

Definition at line 57 of file add_trajectory_link_command.cpp.

◆ serialize()

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

Definition at line 72 of file add_trajectory_link_command.cpp.

Friends And Related Function Documentation

◆ boost::serialization::access

friend class boost::serialization::access
friend

Definition at line 92 of file add_trajectory_link_command.h.

◆ tesseract_common::Serialization

friend struct tesseract_common::Serialization
friend

Definition at line 93 of file add_trajectory_link_command.h.

Member Data Documentation

◆ link_name_

std::string tesseract_environment::AddTrajectoryLinkCommand::link_name_
private

Definition at line 87 of file add_trajectory_link_command.h.

◆ parent_link_name_

std::string tesseract_environment::AddTrajectoryLinkCommand::parent_link_name_
private

Definition at line 88 of file add_trajectory_link_command.h.

◆ replace_allowed_

bool tesseract_environment::AddTrajectoryLinkCommand::replace_allowed_ { false }
private

Definition at line 90 of file add_trajectory_link_command.h.

◆ trajectory_

tesseract_common::JointTrajectory tesseract_environment::AddTrajectoryLinkCommand::trajectory_
private

Definition at line 89 of file add_trajectory_link_command.h.


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


tesseract_environment
Author(s): Levi Armstrong
autogenerated on Sun May 18 2025 03:02:21