UROS2Spawnable Class Reference

BaseComponents which is used when spawning Actor from ROS 2 service in ASimulationState. More...

#include <ROS2Spawnable.h>

Inheritance diagram for UROS2Spawnable:

Collaboration diagram for UROS2Spawnable:

Public Member Functions
virtual void	InitializeParameters (const FROSSpawnEntityReq &InRequest)
	Set Actor name and ROS 2 namespace from SpawnEntity service request. More...
void	SetActorModelName (const FString &InModelName)
virtual void	SetName (const FString &InName)
virtual void	SetNamespace (const FString &InNamespace)
virtual void	AddTag (const FString &InTag)
virtual FString	GetName () const
virtual FString	GetNamespace () const
virtual int32	GetNetworkPlayerId () const
virtual void	SetNetworkPlayerId (const int32 InNetworkPlayerId)
virtual void	GetLifetimeReplicatedProps (TArray< FLifetimeProperty > &OutLifetimeProps) const override

Public Attributes
FString	ActorModelName
FString	ActorName
FString	ActorNamespace
TArray< FString >	ActorTags
FString	ActorJsonConfigs
FString	ActorReferenceFrame

Protected Member Functions
virtual void	OnComponentCreated () override

Protected Attributes
int32	NetworkPlayerId
	Player ID No. This is used to check which network client posses this Robot. More...

Detailed Description

BaseComponents which is used when spawning Actor from ROS 2 service in ASimulationState.

Set Actor Name and ROS 2 namespace of the ROS2Node with SpawnEntity srv.

See also

ue_msgs/SpawnEntity.srv

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

Member Function Documentation

AddTag()

virtual void UROS2Spawnable::AddTag ( const FString &  InTag )

virtual

UFUNCTION(BlueprintCallable)

GetLifetimeReplicatedProps()

virtual void UROS2Spawnable::GetLifetimeReplicatedProps ( TArray< FLifetimeProperty > &  OutLifetimeProps ) const

overridevirtual

GetName()

virtual FString UROS2Spawnable::GetName ( ) const

virtual

UFUNCTION(BlueprintCallable)

GetNamespace()

virtual FString UROS2Spawnable::GetNamespace ( ) const

virtual

UFUNCTION(BlueprintCallable)

GetNetworkPlayerId()

virtual int32 UROS2Spawnable::GetNetworkPlayerId ( ) const

virtual

UFUNCTION(BlueprintCallable)

InitializeParameters()

virtual void UROS2Spawnable::InitializeParameters ( const FROSSpawnEntityReq &  InRequest )

virtual

Set Actor name and ROS 2 namespace from SpawnEntity service request.

See also

ue_msgs/SpawnEntity.srv

Parameters

InRequest

UFUNCTION(BlueprintCallable)

OnComponentCreated()

virtual void UROS2Spawnable::OnComponentCreated ( )

overrideprotectedvirtual

SetActorModelName()

void UROS2Spawnable::SetActorModelName

(

const FString &

InModelName

)

UFUNCTION(BlueprintCallable)

SetName()

virtual void UROS2Spawnable::SetName ( const FString &  InName )

virtual

UFUNCTION(BlueprintCallable)

SetNamespace()

virtual void UROS2Spawnable::SetNamespace ( const FString &  InNamespace )

virtual

UFUNCTION(BlueprintCallable)

SetNetworkPlayerId()

virtual void UROS2Spawnable::SetNetworkPlayerId ( const int32  InNetworkPlayerId )

virtual

UFUNCTION(BlueprintCallable)

Member Data Documentation

ActorJsonConfigs

FString UROS2Spawnable::ActorJsonConfigs

UPROPERTY(VisibleAnywhere, BlueprintReadWrite, Replicated)

ActorModelName

FString UROS2Spawnable::ActorModelName

UPROPERTY(EditAnywhere, BlueprintReadWrite, Replicated)

ActorName

FString UROS2Spawnable::ActorName

UPROPERTY(EditAnywhere, BlueprintReadWrite, Replicated)

ActorNamespace

FString UROS2Spawnable::ActorNamespace

UPROPERTY(EditAnywhere, BlueprintReadWrite, Replicated)

ActorReferenceFrame

FString UROS2Spawnable::ActorReferenceFrame

UPROPERTY(VisibleAnywhere, BlueprintReadWrite, Replicated)

ActorTags

TArray<FString> UROS2Spawnable::ActorTags

UPROPERTY(EditAnywhere, BlueprintReadWrite, Replicated)

NetworkPlayerId

int32 UROS2Spawnable::NetworkPlayerId

protected

Player ID No. This is used to check which network client posses this Robot.

UPROPERTY(Replicated)

---

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

• /home/docs/checkouts/readthedocs.org/user_builds/rapyutasimulationplugins/checkouts/devel/Source/RapyutaSimulationPlugins/Public/Tools/ROS2Spawnable.h