UROS2Action Class Reference

Base class implementing ROS2 actions from which ActionServer and ActionClient should inherit. More...

#include <ROS2Action.h>

Inheritance diagram for UROS2Action:

Collaboration diagram for UROS2Action:

Public Member Functions
virtual bool	InitializeWithROS2 (UROS2NodeComponent *InROS2Node)
	Initialize action. More...
virtual bool	Init ()
	Initialize action and action component. More...
virtual bool	InitializeAction ()
	Create and Initize action. More...
virtual void	Destroy ()
	Destroy this actor component. More...
virtual void	ProcessReady (rcl_wait_set_t *wait_set)
	Determine the relevant action functions to call. More...

Public Attributes
FString	ActionName
TSubclassOf< UROS2GenericAction >	ActionClass
	type of action More...
UROS2GenericAction *	Action
	ROS2 Action Instance. More...
UROS2NodeComponent *	OwnerNode
	ROS2Node which own this action. More...
TEnumAsByte< UROS2State >	State = UROS2State::Created
	Action state. More...
UROS2QoS	CancelQoS = UROS2QoS::Services
	Quality of Cancel. More...
UROS2QoS	GoalQoS = UROS2QoS::Services
	Quality of Goal. More...
UROS2QoS	ResultQoS = UROS2QoS::Services
	Quality of Result. More...
UROS2QoS	FeedbackQoS = UROS2QoS::Default
	Quality of Feedback. More...

Protected Member Functions
virtual void	InitializeActionComponent ()
	Initialize ROS2 Action. Should be implemented in UROS2ActionServer and UROS2ActionClient. More...

Detailed Description

Base class implementing ROS2 actions from which ActionServer and ActionClient should inherit.

type of action is defined by ActionClass

UCLASS(ClassGroup = (Custom), Blueprintable, BlueprintType, meta = (BlueprintSpawnableComponent))

Member Function Documentation

Destroy()

virtual void UROS2Action::Destroy ( )

virtual

Destroy this actor component.

UFUNCTION()

Reimplemented in UROS2ActionClient, and UROS2ActionServer.

Init()

virtual bool UROS2Action::Init ( )

virtual

Initialize action and action component.

Returns

true

false

UFUNCTION(BlueprintCallable)

InitializeAction()

virtual bool UROS2Action::InitializeAction ( )

virtual

Create and Initize action.

Returns

true

false

UFUNCTION(BlueprintCallable)

InitializeActionComponent()

virtual void UROS2Action::InitializeActionComponent ( )

protectedvirtual

Initialize ROS2 Action. Should be implemented in UROS2ActionServer and UROS2ActionClient.

See also

ROS2 QoS

UFUNCTION()

Reimplemented in UROS2ActionClient, and UROS2ActionServer.

InitializeWithROS2()

virtual bool UROS2Action::InitializeWithROS2 ( UROS2NodeComponent *  InROS2Node )

virtual

Initialize action.

Parameters

InROS2Node

ROS2Node which this action belongs to

Returns

true

false

ProcessReady()

virtual void UROS2Action::ProcessReady ( rcl_wait_set_t *  wait_set )

virtual

Determine the relevant action functions to call.

Should be implemented in UROS2ActionServer and UROS2ActionClient

Parameters

wait_set

Reimplemented in UROS2ActionClient, and UROS2ActionServer.

Member Data Documentation

Action

UROS2GenericAction* UROS2Action::Action

ROS2 Action Instance.

UPROPERTY(VisibleAnywhere, BlueprintReadOnly)

ActionClass

TSubclassOf<UROS2GenericAction> UROS2Action::ActionClass

type of action

UPROPERTY(EditAnywhere, BlueprintReadWrite)

ActionName

FString UROS2Action::ActionName

UPROPERTY(EditAnywhere, BlueprintReadWrite)

CancelQoS

UROS2QoS UROS2Action::CancelQoS = UROS2QoS::Services

Quality of Cancel.

See also

ROS2 QoS

UPROPERTY(EditAnywhere, BlueprintReadWrite)

FeedbackQoS

UROS2QoS UROS2Action::FeedbackQoS = UROS2QoS::Default

Quality of Feedback.

See also

ROS2 QoS

UPROPERTY(EditAnywhere, BlueprintReadWrite)

GoalQoS

UROS2QoS UROS2Action::GoalQoS = UROS2QoS::Services

Quality of Goal.

See also

ROS2 QoS

UPROPERTY(EditAnywhere, BlueprintReadWrite)

OwnerNode

UROS2NodeComponent* UROS2Action::OwnerNode

ROS2Node which own this action.

UPROPERTY(VisibleAnywhere, BlueprintReadOnly)

ResultQoS

UROS2QoS UROS2Action::ResultQoS = UROS2QoS::Services

Quality of Result.

See also

ROS2 QoS

UPROPERTY(EditAnywhere, BlueprintReadWrite)

State

TEnumAsByte<UROS2State> UROS2Action::State = UROS2State::Created

Action state.

UPROPERTY(VisibleAnywhere, BlueprintReadOnly)

---

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

• /home/docs/checkouts/readthedocs.org/user_builds/rclue/checkouts/latest/Source/rclUE/Public/ROS2Action.h