SMACC2
Loading...
Searching...
No Matches
cl_moveit2z::CbMoveit2zClientBehaviorBase Class Reference

#include <cb_moveit2z_client_behavior_base.hpp>

Inheritance diagram for cl_moveit2z::CbMoveit2zClientBehaviorBase:
Inheritance graph
Collaboration diagram for cl_moveit2z::CbMoveit2zClientBehaviorBase:
Collaboration graph

Public Member Functions

template<typename TOrthogonal , typename TSourceObject >
void onStateOrthogonalAllocation ()
 
virtual ~CbMoveit2zClientBehaviorBase ()
 
- Public Member Functions inherited from smacc2::SmaccAsyncClientBehavior
template<typename TOrthogonal , typename TSourceObject >
void onStateOrthogonalAllocation ()
 
virtual ~SmaccAsyncClientBehavior ()
 
template<typename TCallback , typename T >
smacc2::SmaccSignalConnection onSuccess (TCallback callback, T *object)
 
template<typename TCallback , typename T >
smacc2::SmaccSignalConnection onFinished (TCallback callback, T *object)
 
template<typename TCallback , typename T >
smacc2::SmaccSignalConnection onFailure (TCallback callback, T *object)
 
void requestForceFinish ()
 
void executeOnEntry () override
 
void executeOnExit () override
 
void waitOnEntryThread (bool requestFinish)
 
template<typename TCallbackMethod , typename T >
smacc2::SmaccSignalConnection onSuccess (TCallbackMethod callback, T *object)
 
template<typename TCallbackMethod , typename T >
smacc2::SmaccSignalConnection onFinished (TCallbackMethod callback, T *object)
 
template<typename TCallbackMethod , typename T >
smacc2::SmaccSignalConnection onFailure (TCallbackMethod callback, T *object)
 
- Public Member Functions inherited from smacc2::ISmaccClientBehavior
 ISmaccClientBehavior ()
 
virtual ~ISmaccClientBehavior ()
 
ISmaccStateMachinegetStateMachine ()
 
std::string getName () const
 
template<typename SmaccClientType >
void requiresClient (SmaccClientType *&storage)
 
template<typename SmaccComponentType >
void requiresComponent (SmaccComponentType *&storage, ComponentRequirement requirementType=ComponentRequirement::SOFT)
 
template<typename SmaccComponentType >
void requiresComponent (std::string name, SmaccComponentType *&storage, ComponentRequirement requirementType=ComponentRequirement::SOFT)
 
virtual void onEntry ()
 
virtual void onExit ()
 

Protected Member Functions

void postMotionSuccess ()
 
void postMotionFailure ()
 
- Protected Member Functions inherited from smacc2::SmaccAsyncClientBehavior
void postSuccessEvent ()
 
void postFailureEvent ()
 
virtual void dispose () override
 
bool isShutdownRequested ()
 onEntry is executed in a new thread. However the current state cannot be left until the onEntry thread finishes. This flag can be checked from the onEntry thread to force finishing the thread.
 
- Protected Member Functions inherited from smacc2::ISmaccClientBehavior
virtual void runtimeConfigure ()
 
template<typename EventType >
void postEvent (const EventType &ev)
 
template<typename EventType >
void postEvent ()
 
ISmaccStategetCurrentState ()
 
virtual rclcpp::Node::SharedPtr getNode () const
 
virtual rclcpp::Logger getLogger () const
 

Protected Attributes

CpMoveGroupInterfacecpMoveGroup_ = nullptr
 
CpMotionPlannercpMotionPlanner_ = nullptr
 
CpTrajectoryExecutorcpTrajectoryExecutor_ = nullptr
 
CpTrajectoryHistorycpTrajectoryHistory_ = nullptr
 

Detailed Description

Definition at line 43 of file cb_moveit2z_client_behavior_base.hpp.

Constructor & Destructor Documentation

◆ ~CbMoveit2zClientBehaviorBase()

virtual cl_moveit2z::CbMoveit2zClientBehaviorBase::~CbMoveit2zClientBehaviorBase ( )
inlinevirtual

Definition at line 60 of file cb_moveit2z_client_behavior_base.hpp.

60{}

Member Function Documentation

◆ onStateOrthogonalAllocation()

template<typename TOrthogonal , typename TSourceObject >
void cl_moveit2z::CbMoveit2zClientBehaviorBase::onStateOrthogonalAllocation ( )
inline

Definition at line 47 of file cb_moveit2z_client_behavior_base.hpp.

48 {
49 // CpMoveGroupInterface is always created by ClMoveit2z; the rest are
50 // optional per-SM opt-ins (preferred path when present, legacy fallback
51 // otherwise - same semantics the behaviors implemented individually)
56
58 }
void requiresComponent(SmaccComponentType *&storage, ComponentRequirement requirementType=ComponentRequirement::SOFT)

References cpMotionPlanner_, cpMoveGroup_, cpTrajectoryExecutor_, cpTrajectoryHistory_, smacc2::HARD, smacc2::SmaccAsyncClientBehavior::onStateOrthogonalAllocation(), smacc2::ISmaccClientBehavior::requiresComponent(), and smacc2::SOFT.

Referenced by cl_moveit2z::CbAttachObject::onStateOrthogonalAllocation(), cl_moveit2z::CbDetachObject::onStateOrthogonalAllocation(), and cl_moveit2z::CbMoveEndEffectorTrajectory::onStateOrthogonalAllocation().

Here is the call graph for this function:
Here is the caller graph for this function:

◆ postMotionFailure()

void cl_moveit2z::CbMoveit2zClientBehaviorBase::postMotionFailure ( )
inlineprotected

◆ postMotionSuccess()

void cl_moveit2z::CbMoveit2zClientBehaviorBase::postMotionSuccess ( )
inlineprotected

Member Data Documentation

◆ cpMotionPlanner_

CpMotionPlanner* cl_moveit2z::CbMoveit2zClientBehaviorBase::cpMotionPlanner_ = nullptr
protected

◆ cpMoveGroup_

◆ cpTrajectoryExecutor_

◆ cpTrajectoryHistory_

CpTrajectoryHistory* cl_moveit2z::CbMoveit2zClientBehaviorBase::cpTrajectoryHistory_ = nullptr
protected

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