UAbstractGymConnector

class UAbstractGymConnector : public UObject, public IGymConnector

用于 Unreal Engine 与 gym 环境之间连接器的抽象类。

该类为将 Unreal Engine 环境与外部 gym 环境连接以进行训练提供了基本结构和功能。

依赖项

此类型依赖于

• AAbstractScholaEnvironment
• FTrainingDefinition
• FTrainingState
• FTrainingStateUpdate
• IGymConnector

继承自: public UObject, public IGymConnector

子类: UExternalGymConnector

公共接口

构造函数

UAbstractGymConnector

UAbstractGymConnector()

抽象 gym 连接器的构造函数。

使用默认值初始化连接器。

来源: Schola/Source/Schola/Public/GymConnectors/AbstractGymConnector.h (第 74 行, 第 1 列)

实现: Schola/Source/Schola/Private/GymConnectors/AbstractGymConnector.cpp (第 5-7 行)

公共函数

初始化

virtual void Init(const FTrainingDefinition &AgentDefinitions)

初始化此 gym 连接器，设置服务并发送代理商定义。

注意: 此函数应由派生类实现。

参数

• AgentDefinitions (const FTrainingDefinition &) – [in] - 将被训练的代理商的定义。

属性: virtual

来源: Schola/Source/Schola/Public/GymConnectors/AbstractGymConnector.h (第 81 行, 第 14 列)

实现: Schola/Source/Schola/Private/GymConnectors/AbstractGymConnector.cpp (第 9 行)

初始化

void Init()

初始化此 gym 连接器，收集环境和训练定义。

注意: 使用 SharedTrainingDefinition 调用其他 Init 函数。

来源: Schola/Source/Schola/Public/GymConnectors/AbstractGymConnector.h (第 87 行, 第 6 列)

实现: Schola/Source/Schola/Private/GymConnectors/AbstractGymConnector.cpp (第 11-28 行)

ResetCompletedEnvironments

virtual void ResetCompletedEnvironments() override

重置所有已完成的环境。

属性: virtual

来源: Schola/Source/Schola/Public/GymConnectors/AbstractGymConnector.h (第 92 行, 第 14 列)

实现: Schola/Source/Schola/Private/GymConnectors/AbstractGymConnector.cpp (第 30-58 行)

UpdateEnvironments

virtual void UpdateEnvironments(FTrainingStateUpdate &StateUpdate) override

使用新的状态更新来更新环境。

参数

• StateUpdate (FTrainingStateUpdate &) – [in] 新的状态更新。

属性: virtual

来源: Schola/Source/Schola/Public/GymConnectors/AbstractGymConnector.h (第 98 行, 第 14 列)

实现: Schola/Source/Schola/Private/GymConnectors/AbstractGymConnector.cpp (第 129-157 行)

CollectEnvironmentStates

virtual void CollectEnvironmentStates()

收集所有环境状态。

属性: virtual

来源: Schola/Source/Schola/Public/GymConnectors/AbstractGymConnector.h (第 103 行, 第 14 列)

实现: Schola/Source/Schola/Private/GymConnectors/AbstractGymConnector.cpp (第 82-91 行)

SetStatus

void SetStatus(EConnectorStatus NewStatus)

设置连接器的状态。

参数

• NewStatus (EConnectorStatus) – [in] 连接器的新状态。

来源: Schola/Source/Schola/Public/GymConnectors/AbstractGymConnector.h (第 109 行, 第 6 列)

实现: Schola/Source/Schola/Private/GymConnectors/AbstractGymConnector.cpp (第 93-108 行)

SubmitEnvironmentStates

inline virtual void SubmitEnvironmentStates()

将环境状态提交到连接器的另一端。

注意: 此函数应由派生类实现。

属性： inline, virtual

来源: Schola/Source/Schola/Public/GymConnectors/AbstractGymConnector.h (第 115 行, 第 14 列)

ResolveEnvironmentStateUpdate

inline virtual FTrainingStateUpdate * ResolveEnvironmentStateUpdate()

解析环境状态更新。

对于基于 future 或需要同步的操作很有用。

返回值: 解析后的环境状态更新。

注意: 此函数应由派生类实现。

返回值: FTrainingStateUpdate *

属性： inline, virtual

来源: Schola/Source/Schola/Public/GymConnectors/AbstractGymConnector.h (第 122 行, 第 30 列)

SubmitPostResetState

inline virtual void SubmitPostResetState(const FTrainingState &States)

将环境重置后的初始状态提交到连接器的另一端。

注意: 此函数应由派生类实现。

参数

• States (const FTrainingState &) – [in] 要提交的状态。

属性： inline, virtual

来源: Schola/Source/Schola/Public/GymConnectors/AbstractGymConnector.h (第 129 行, 第 14 列)

UpdateConnectorStatus

void UpdateConnectorStatus(const FTrainingStateUpdate &StateUpdate)

根据状态更新更新连接器的状态。

参数

• StateUpdate (const FTrainingStateUpdate &) – [in] 用于确定新状态的状态更新。

来源: Schola/Source/Schola/Public/GymConnectors/AbstractGymConnector.h (第 135 行, 第 6 列)

实现: Schola/Source/Schola/Private/GymConnectors/AbstractGymConnector.cpp (第 110-122 行)

UpdateConnectorStatus

void UpdateConnectorStatus()

根据上次的状态更新更新连接器的状态。

来源: Schola/Source/Schola/Public/GymConnectors/AbstractGymConnector.h (第 140 行, 第 6 列)

实现: Schola/Source/Schola/Private/GymConnectors/AbstractGymConnector.cpp (第 124-127 行)

Enable

inline virtual void Enable()

启用连接器。

对于多阶段设置很有用，因为它在初始化后被调用。

注意: 此函数应由派生类实现。

属性： inline, virtual

来源: Schola/Source/Schola/Public/GymConnectors/AbstractGymConnector.h (第 146 行, 第 14 列)

CheckForStart

inline virtual bool CheckForStart()

检查连接器是否已准备好开始。

返回值: 如果连接器已准备好开始，则返回 True。

注意: 此函数应由派生类实现。

返回: bool

属性： inline, virtual

来源: Schola/Source/Schola/Public/GymConnectors/AbstractGymConnector.h (第 153 行, 第 14 列)

GetCurrentStateUpdate

inline virtual FTrainingStateUpdate * GetCurrentStateUpdate()

获取最新的状态更新。

返回值: 上次的状态更新。

返回值: FTrainingStateUpdate *

属性： inline, virtual

来源: Schola/Source/Schola/Public/GymConnectors/AbstractGymConnector.h (第 159 行, 第 30 列)

IsRunning

inline bool IsRunning()

获取连接器是否正在运行。

返回值: 如果连接器正在运行，则返回 True。

返回: bool

属性: inline

来源: Schola/Source/Schola/Public/GymConnectors/AbstractGymConnector.h (第 165 行, 第 6 列)

IsNotStarted

inline bool IsNotStarted()

获取连接器是否已关闭。

返回值: 如果连接器已关闭，则返回 True。

返回: bool

属性: inline

来源: Schola/Source/Schola/Public/GymConnectors/AbstractGymConnector.h (第 171 行, 第 6 列)

CollectEnvironments

virtual void CollectEnvironments() override

收集模拟中的所有 EnvironmentManagers。

属性: virtual

来源: Schola/Source/Schola/Public/GymConnectors/AbstractGymConnector.h (第 176 行, 第 6 列)

实现: Schola/Source/Schola/Private/GymConnectors/AbstractGymConnector.cpp (第 60-70 行)

RegisterEnvironment

void RegisterEnvironment(AAbstractScholaEnvironment *Env)

注册一个环境到子系统，以便子系统可以控制它。

参数

• Env (AAbstractScholaEnvironment *) – [in] 要注册的环境的指针。

来源: Schola/Source/Schola/Public/GymConnectors/AbstractGymConnector.h (第 182 行, 第 6 列)

实现: Schola/Source/Schola/Private/GymConnectors/AbstractGymConnector.cpp (第 72-80 行)

公共成员

FTrainingStateUpdate * CurrentStateUpdate

FTrainingStateUpdate * CurrentStateUpdate

来自环境的当前状态更新。

来源: Schola/Source/Schola/Public/GymConnectors/AbstractGymConnector.h (第 44 行, 第 22 列)

FConnectorStartedDelegate OnConnectorStarted

FConnectorStartedDelegate OnConnectorStarted

连接器启动时的委托。

来源: Schola/Source/Schola/Public/GymConnectors/AbstractGymConnector.h (第 47 行, 第 27 列)

FConnectorClosedDelegate OnConnectorClosed

FConnectorClosedDelegate OnConnectorClosed

连接器关闭时的委托。

来源: Schola/Source/Schola/Public/GymConnectors/AbstractGymConnector.h (第 50 行, 第 27 列)

FConnectorErrorDelegate OnConnectorError

FConnectorErrorDelegate OnConnectorError

连接器遇到错误时的委托。

来源: Schola/Source/Schola/Public/GymConnectors/AbstractGymConnector.h (第 53 行, 第 26 列)

EConnectorStatus Status

EConnectorStatus Status = = EConnectorStatus::Running

连接器的状态。

来源: Schola/Source/Schola/Public/GymConnectors/AbstractGymConnector.h (第 57 行, 第 18 列)

TArray<AAbstractScholaEnvironment *> Environments

TArray<AAbstractScholaEnvironment *> Environments = = TArray<AAbstractScholaEnvironment*>()

当前正在训练的环境。

来源: Schola/Source/Schola/Public/GymConnectors/AbstractGymConnector.h (第 61 行, 第 8 列)

FTrainingState TrainingState

FTrainingState TrainingState = = FTrainingState()

当前正在训练的环境的状态。

来源: Schola/Source/Schola/Public/GymConnectors/AbstractGymConnector.h (第 65 行, 第 16 列)

FTrainingDefinition TrainingDefinition

FTrainingDefinition TrainingDefinition = = FTrainingDefinition()

将要训练的环境的共享训练定义。

来源: Schola/Source/Schola/Public/GymConnectors/AbstractGymConnector.h (第 69 行, 第 21 列)

使用方: UExternalGymConnector, UScholaManagerSubsystem, UScholaManagerSubsystemSettings

来源: Schola/Source/Schola/Public/GymConnectors/AbstractGymConnector.h (第 38 行, 第 1 列)